home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _77dd6dfeff5b53054adba621d46c84c5 < prev    next >
Encoding:
Text File  |  2000-03-23  |  4.8 KB  |  127 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>Tk::Reindex - change the base index of Text-like widgets</TITLE>
  5. <LINK REL="stylesheet" HREF="../../../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> Tk::Reindex - change the base index of Text-like widgets</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25.     <LI><A HREF="#standard options">STANDARD OPTIONS</A></LI>
  26.     <LI><A HREF="#widgetspecific options">WIDGET-SPECIFIC OPTIONS</A></LI>
  27.     <LI><A HREF="#class methods">CLASS METHODS</A></LI>
  28.     <LI><A HREF="#bugs">BUGS</A></LI>
  29.     <LI><A HREF="#author">AUTHOR</A></LI>
  30. </UL>
  31. <!-- INDEX END -->
  32.  
  33. <HR>
  34. <P>
  35. <H1><A NAME="name">NAME</A></H1>
  36. <P>Tk::Reindex - change the base index of Text-like widgets</P>
  37. <P>
  38. <HR>
  39. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  40. <UL>
  41. <LI>Linux</LI>
  42. <LI>Solaris</LI>
  43. <LI>Windows</LI>
  44. </UL>
  45. <HR>
  46. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  47. <PRE>
  48.     use Tk::ReindexedText;
  49.     $t1=$w->ReindexedText(-linestart => 2);</PRE>
  50. <PRE>
  51.     use Tk::ReindexedROText;
  52.     $t2=$w->ReindexedROText(-linestart => 0);</PRE>
  53. <P>
  54. <HR>
  55. <H1><A NAME="description">DESCRIPTION</A></H1>
  56. <P>Creates a new widget class based on <STRONG>Text</STRONG>-like widgets that can
  57. redefine the line number base (normally <STRONG>Text</STRONG> widgets start line
  58. numbers at 1), or possibly other manipulations on indexes.</P>
  59. <P>
  60. <HR>
  61. <H1><A NAME="standard options">STANDARD OPTIONS</A></H1>
  62. <P>The newly-defined widget takes all the same options as the base
  63. widget, which defaults to <STRONG>Text</STRONG>.</P>
  64. <P>
  65. <HR>
  66. <H1><A NAME="widgetspecific options">WIDGET-SPECIFIC OPTIONS</A></H1>
  67. <DL>
  68. <DT><STRONG><A NAME="item_Name%3A_lineStart">Name:   <STRONG>lineStart</STRONG></A></STRONG><BR>
  69. <DD>
  70. <DT><STRONG><A NAME="item_Class%3A_LineStart">Class:  <STRONG>LineStart</STRONG></A></STRONG><BR>
  71. <DD>
  72. <DT><STRONG><A NAME="item_Switch%3A_%2Dlinestart">Switch: <STRONG>-linestart</STRONG></A></STRONG><BR>
  73. <DD>
  74. Sets the line number of the first line in the <STRONG>Text</STRONG> widget. The
  75. default <STRONG>-toindexcmd</STRONG> and <STRONG>-fromindexcmd</STRONG> use this configuration
  76. option.
  77. <P>-item Name:   <STRONG>toIndexCmd</STRONG>  <STRONG>fromIndexCmd</STRONG></P>
  78. <P>-item Class:  <STRONG>ToIndexCmd</STRONG>  <STRONG>FromIndexCmd</STRONG></P>
  79. <P>-item Switch: <STRONG>-toindexcmd</STRONG> <STRONG>-fromindexcmd</STRONG></P>
  80. <P>These two options specify callbacks that are called with a list of
  81. indexes and are responsible for translating them to/from indexes that
  82. the base <STRONG>Text</STRONG> widget can understand. The callback is passed the
  83. widget followed by a list of indexes, and should return a list of
  84. translated indexes. <STRONG>-toindexcmd</STRONG> should translate from 'user'
  85. indexes to 'native' <STRONG>Text</STRONG>-compatible indexes, and <STRONG>-fromindexcmd</STRONG>
  86. should translate from 'native' indexes to 'user' indexes.</P>
  87. <P>The default callbacks simply add/subtract the offset given by the
  88. <STRONG>-linestart</STRONG> option for all indexes in 'line.character' format.</P>
  89. <P>It would probably be prudent to make these functions inverses of each
  90. other.</P>
  91. <P></P></DL>
  92. <P>
  93. <HR>
  94. <H1><A NAME="class methods">CLASS METHODS</A></H1>
  95. <DL>
  96. <DT><STRONG><A NAME="item_import">import</A></STRONG><BR>
  97. <DD>
  98. To make new Reindex widgets, this function should be called via <STRONG>use</STRONG>
  99. with the name of the Text-like base class that you are extending with
  100. ``Reindex'' capability.  'use base(Tk::Reindex Tk::nameofbasewidget)'
  101. should also be specified for that widget.
  102. <P></P></DL>
  103. <P>
  104. <HR>
  105. <H1><A NAME="bugs">BUGS</A></H1>
  106. <P>I've used the word ``indexes'' instead of ``indices'' throughout the
  107. documentation.</P>
  108. <P>All the built-in perl code for widget bindings & methods will use the
  109. new 'user' indexes.  Which means all this index manipulation might
  110. might break code that is trying to parse/manipulate indexes. Or even
  111. assume that '1.0' is the beginning index.  <STRONG>Tk::Text::Contents</STRONG> comes
  112. to mind.</P>
  113. <P>
  114. <HR>
  115. <H1><A NAME="author">AUTHOR</A></H1>
  116. <P>Andrew Allen <<A HREF="mailto:ada@fc.hp.com">ada@fc.hp.com</A>></P>
  117. <P>This code may be distributed under the same conditions as Perl.</P>
  118. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  119. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  120. <STRONG><P CLASS=block> Tk::Reindex - change the base index of Text-like widgets</P></STRONG>
  121. </TD></TR>
  122. </TABLE>
  123.  
  124. </BODY>
  125.  
  126. </HTML>
  127.