# Copyright (c) 1992 The Regents of the University of California. # Copyright (c) 1994-1996 Sun Microsystems, Inc. # Copyright (c) 2002 O'Reilly & Associates Inc. # See the file "license.terms" for information on usage and redistribution # of this file, and for a DISCLAIMER OF ALL WARRANTIES. # # =head1 NAME Tk::Text - Create and manipulate Text widgets =for category Tk Widget Classes =head1 SYNOPSIS I<$text> = I<$parent>-EB(?I?); B<-background> B<-highlightbackground> B<-insertontime> B<-selectborderwidth> B<-borderwidth> B<-highlightcolor> B<-insertwidth> B<-selectforeground> B<-cursor> B<-highlightthickness> B<-padx> B<-setgrid> B<-exportselection> B<-insertbackground> B<-pady> B<-takefocus> B<-font> B<-insertborderwidth> B<-relief> B<-xscrollcommand> B<-foreground> B<-insertofftime> B<-selectbackground> B<-yscrollcommand> =head1 WIDGET-SPECIFIC OPTIONS =over 4 =item Name: B =item Class: B =item Switch: B<-height> Specifies the desired height for the window, in units of characters in the font given by the B<-font> option. Must be at least one. =item Name: B =item Class: B =item Switch: B<-spacing1> Requests additional space above each text line in the widget, using any of the standard forms for screen distances. If a line wraps, this option only applies to the first line on the display. This option may be overriden with B<-spacing1> options in tags. =item Name: B =item Class: B =item Switch: B<-spacing2> For lines that wrap (so that they cover more than one line on the display) this option specifies additional space to provide between the display lines that represent a single line of text. The value may have any of the standard forms for screen distances. This option may be overriden with B<-spacing2> options in tags. =item Name: B =item Class: B =item Switch: B<-spacing3> Requests additional space below each text line in the widget, using any of the standard forms for screen distances. If a line wraps, this option only applies to the last line on the display. This option may be overriden with B<-spacing3> options in tags. =item Name: B =item Class: B =item Switch: B<-state> Specifies one of two states for the text: B or B. If the text is disabled then characters may not be inserted or deleted and no insertion cursor will be displayed, even if the input focus is in the widget. =item Name: B =item Class: B =item Switch: B<-tabs> Specifies a set of tab stops for the window. The option's value consists of a list of screen distances giving the positions of the tab stops. Each position may optionally be followed in the next list element by one of the keywords B, B, B
, or B, which specifies how to justify text relative to the tab stop. B is the default; it causes the text following the tab character to be positioned with its left edge at the tab position. B means that the right edge of the text following the tab character is positioned at the tab position, and B
means that the text is centered at the tab position. B means that the decimal point in the text is positioned at the tab position; if there is no decimal point then the least significant digit of the number is positioned just to the left of the tab position; if there is no number in the text then the text is right-justified at the tab position. For example, B<-tabs =E [qw/2c left 4c 6c center/]> creates three tab stops at two-centimeter intervals; the first two use left justification and the third uses center justification. If the list of tab stops does not have enough elements to cover all of the tabs in a text line, then Tk extrapolates new tab stops using the spacing and alignment from the last tab stop in the list. The value of the B option may be overridden by B<-tabs> options in tags. If no B<-tabs> option is specified, or if it is specified as an empty list, then Tk uses default tabs spaced every eight (average size) characters. =item Name: B =item Class: B =item Switch: B<-width> Specifies the desired width for the window in units of characters in the font given by the B<-font> option. If the font doesn't have a uniform width then the width of the character ``0'' is used in translating from character units to screen units. =item Name: B =item Class: B =item Switch: B<-wrap> Specifies how to handle lines in the text that are too long to be displayed in a single line of the text's window. The value must be B or B or B. A wrap mode of B means that each line of text appears as exactly one line on the screen; extra characters that don't fit on the screen are not displayed. In the other modes each line of text will be broken up into several screen lines if necessary to keep all the characters visible. In B mode a screen line break may occur after any character; in B mode a line break will only be made at word boundaries. =back =head1 DESCRIPTION The B method creates a new window (given by the $text argument) and makes it into a text widget. Additional options, described above, may be specified on the command line or in the option database to configure aspects of the text such as its default background color and relief. The B command returns the path name of the new window. A text widget displays one or more lines of text and allows that text to be edited. Text widgets support four different kinds of annotations on the text, called tags, marks, embedded windows or embedded images. Tags allow different portions of the text to be displayed with different fonts and colors. In addition, LTk callbacks|Tk::callbacks> can be associated with tags so that scripts are invoked when particular actions such as keystrokes and mouse button presses occur in particular ranges of the text. See L<"TAGS"> below for more details. The second form of annotation consists of marks, which are floating markers in the text. Marks are used to keep track of various interesting positions in the text as it is edited. See L<"MARKS"> below for more details. The third form of annotation allows arbitrary windows to be embedded in a text widget. See L<"EMBEDDED WINDOWS"> below for more details. The fourth form of annotation allows Tk images to be embedded in a text widget. See L<"EMBEDDED IMAGES"> below for more details. The Perl/Tk B widget does not support undo/redo, use the B widget instead. =head1 INDICES Many of the methods for texts take one or more indices as arguments. An index is a string used to indicate a particular place within a text, such as a place to insert characters or one endpoint of a range of characters to delete. Indices have the syntax base modifier modifier modifier ... Where I gives a starting point and the Is adjust the index from the starting point (e.g. move forward or backward one character). Every index must contain a I, but the Is are optional. The I for an index must have one of the following forms: =over 4 =item IB<.>I Indicates I'th character on line I. Lines are numbered from 1 for consistency with other UNIX programs that use this numbering scheme. Within a line, characters are numbered from 0. If I is B then it refers to the newline character that ends the line. =item B<@>IB<,>I Indicates the character that covers the pixel whose x and y coordinates within the text's window are I and I. =item B Indicates the end of the text (the character just after the last newline). =item I Indicates the character just after the mark whose name is I. =item IB<.first> Indicates the first character in the text that has been tagged with I. This form generates an error if no characters are currently tagged with I. =item IB<.last> Indicates the character just after the last one in the text that has been tagged with I. This form generates an error if no characters are currently tagged with I. =item I<$widget> Indicates the position of the embedded window referenced by I<$widget>. This form generates an error if I<$widget> does not reference to an embedded window. =item I Indicates the position of the embedded image whose name is I. This form generates an error if there is no embedded image by the given name. =back If the I could match more than one of the above forms, such as a I and I both having the same value, then the form earlier in the above list takes precedence. If modifiers follow the base index, each one of them must have one of the forms listed below. Keywords such as B and B may be abbreviated as long as the abbreviation is unambiguous. =over 4 =item B<+ >IB< chars> Adjust the index forward by I characters, moving to later lines in the text if necessary. If there are fewer than I characters in the text after the current index, then set the index to the last character in the text. Spaces on either side of I are optional. =item B<- >IB< chars> Adjust the index backward by I characters, moving to earlier lines in the text if necessary. If there are fewer than I characters in the text before the current index, then set the index to the first character in the text. Spaces on either side of I are optional. =item B<+ >IB< lines> Adjust the index forward by I lines, retaining the same character position within the line. If there are fewer than I lines after the line containing the current index, then set the index to refer to the same character position on the last line of the text. Then, if the line is not long enough to contain a character at the indicated character position, adjust the character position to refer to the last character of the line (the newline). Spaces on either side of I are optional. =item B<- >IB< lines> Adjust the index backward by I lines, retaining the same character position within the line. If there are fewer than I lines before the line containing the current index, then set the index to refer to the same character position on the first line of the text. Then, if the line is not long enough to contain a character at the indicated character position, adjust the character position to refer to the last character of the line (the newline). Spaces on either side of I are optional. =item B Adjust the index to refer to the first character on the line. =item B Adjust the index to refer to the last character on the line (the newline). =item B Adjust the index to refer to the first character of the word containing the current index. A word consists of any number of adjacent characters that are letters, digits, or underscores, or a single character that is not one of these. =item B Adjust the index to refer to the character just after the last one of the word containing the current index. If the current index refers to the last character of the text then it is not modified. =back If more than one modifier is present then they are applied in left-to-right order. For example, the index ``B'' refers to the next-to-last character in the text and ``B'' refers to the character just before the first one in the word containing the insertion cursor. =head1 TAGS The first form of annotation in text widgets is a tag. A tag is a textual string that is associated with some of the characters in a text. Tags may contain arbitrary characters, but it is probably best to avoid using the the characters `` '' (space), B<+>, or B<->: these characters have special meaning in indices, so tags containing them can't be used as indices. There may be any number of tags associated with characters in a text. Each tag may refer to a single character, a range of characters, or several ranges of characters. An individual character may have any number of tags associated with it. A priority order is defined among tags, and this order is used in implementing some of the tag-related functions described below. When a tag is defined (by associating it with characters or setting its display options or binding callbacks to it), it is given a priority higher than any existing tag. The priority order of tags may be redefined using the ``I<$text>-EB'' and ``I<$text>-EB'' methods. Tags serve three purposes in text widgets. First, they control the way information is displayed on the screen. By default, characters are displayed as determined by the B, B, and B options for the text widget. However, display options may be associated with individual tags using the ``I<$text>-EB'' method. If a character has been tagged, then the display options associated with the tag override the default display style. The following options are currently supported for tags: =over 4 =item B<-background> =E I I specifies the background color to use for characters associated with the tag. It may have any of the forms accepted by B. =item B<-bgstipple> =E I I specifies a bitmap that is used as a stipple pattern for the background. It may have any of the forms accepted by B. If I hasn't been specified, or if it is specified as an empty string, then a solid fill will be used for the background. =item B<-borderwidth> =E I I specifies the width of a 3-D border to draw around the background. It may have any of the forms accepted by B. This option is used in conjunction with the B<-relief> option to give a 3-D appearance to the background for characters; it is ignored unless the B<-background> option has been set for the tag. =item B<-elide> =E boolean Elide specifies whether the data should be elided. Elided data is not displayed and takes no space on screen, but further on behaves just as normal data. =item B<-data> =E I Allows an arbitrary perl scalar I to be associated with the tag. =item B<-fgstipple> =E I I specifies a bitmap that is used as a stipple pattern when drawing text and other foreground information such as underlines. It may have any of the forms accepted by B. If I hasn't been specified, or if it is specified as an empty string, then a solid fill will be used. =item B<-font> =E I I is the name of a font to use for drawing characters. It may have any of the forms accepted by B. =item B<-foreground> =E I I specifies the color to use when drawing text and other foreground information such as underlines. It may have any of the forms accepted by B. =item B<-justify> =E I If the first character of a display line has a tag for which this option has been specified, then I determines how to justify the line. It must be one of B, B, or B
. If a line wraps, then the justification for each line on the display is determined by the first character of that display line. =item B<-lmargin1> =E I If the first character of a text line has a tag for which this option has been specified, then I specifies how much the line should be indented from the left edge of the window. I may have any of the standard forms for screen distances. If a line of text wraps, this option only applies to the first line on the display; the B<-lmargin2> option controls the indentation for subsequent lines. =item B<-lmargin2> =E I If the first character of a display line has a tag for which this option has been specified, and if the display line is not the first for its text line (i.e., the text line has wrapped), then I specifies how much the line should be indented from the left edge of the window. I may have any of the standard forms for screen distances. This option is only used when wrapping is enabled, and it only applies to the second and later display lines for a text line. =item B<-offset> =E I I specifies an amount by which the text's baseline should be offset vertically from the baseline of the overall line, in pixels. For example, a positive offset can be used for superscripts and a negative offset can be used for subscripts. I may have any of the standard forms for screen distances. =item B<-overstrike> =E I Specifies whether or not to draw a horizontal rule through the middle of characters. I may have any of the forms accepted by B. =item B<-relief> =E I I specifies the 3-D relief to use for drawing backgrounds, in any of the forms accepted by B. This option is used in conjunction with the B<-borderwidth> option to give a 3-D appearance to the background for characters; it is ignored unless the B<-background> option has been set for the tag. =item B<-rmargin> =E I If the first character of a display line has a tag for which this option has been specified, then I specifies how wide a margin to leave between the end of the line and the right edge of the window. I may have any of the standard forms for screen distances. This option is only used when wrapping is enabled. If a text line wraps, the right margin for each line on the display is determined by the first character of that display line. =item B<-spacing1> =E I I specifies how much additional space should be left above each text line, using any of the standard forms for screen distances. If a line wraps, this option only applies to the first line on the display. =item B<-spacing2> =E I For lines that wrap, this option specifies how much additional space to leave between the display lines for a single text line. I may have any of the standard forms for screen distances. =item B<-spacing3> =E I I specifies how much additional space should be left below each text line, using any of the standard forms for screen distances. If a line wraps, this option only applies to the last line on the display. =item B<-tabs> =E I I specifies a set of tab stops in the same form as for the B<-tabs> option for the text widget. This option only applies to a display line if it applies to the first character on that display line. If this option is specified as an empty string, it cancels the option, leaving it unspecified for the tag (the default). If the option is specified as a non-empty string that is an empty list, such as B<-tabs => " ">, then it requests default 8-character tabs as described for the B widget option. =item B<-underline> =E I I specifies whether or not to draw an underline underneath characters. It may have any of the forms accepted by B. =item B<-wrap> =E I I specifies how to handle lines that are wider than the text's window. It has the same legal values as the B<-wrap> option for the text widget: B, B, or B. If this tag option is specified, it overrides the B<-wrap> option for the text widget. =back If a character has several tags associated with it, and if their display options conflict, then the options of the highest priority tag are used. If a particular display option hasn't been specified for a particular tag, or if it is specified as an empty string, then that option will never be used; the next-highest-priority tag's option will used instead. If no tag specifies a particular display option, then the default style for the widget will be used. The second purpose for tags is event bindings. You can associate bindings with a tag in much the same way you can associate bindings with a widget class: whenever particular X events occur on characters with the given tag, a given will be executed. Tag bindings can be used to give behaviors to ranges of characters; among other things, this allows hypertext-like features to be implemented. For details, see the description of the B widget method below. The third use for tags is in managing the selection. See L<"THE SELECTION"> below. =head1 MARKS The second form of annotation in text widgets is a mark. Marks are used for remembering particular places in a text. They are something like tags, in that they have names and they refer to places in the file, but a mark isn't associated with particular characters. Instead, a mark is associated with the gap between two characters. Only a single position may be associated with a mark at any given time. If the characters around a mark are deleted the mark will still remain; it will just have new neighbor characters. In contrast, if the characters containing a tag are deleted then the tag will no longer have an association with characters in the file. Marks may be manipulated with the ``I<$text>-EB'' text widget method, and their current locations may be determined by using the mark name as an index in methods. Each mark also has a I, which is either B or B. The gravity for a mark specifies what happens to the mark when text is inserted at the point of the mark. If a mark has left gravity, then the mark is treated as if it were attached to the character on its left, so the mark will remain to the left of any text inserted at the mark position. If the mark has right gravity, new text inserted at the mark position will appear to the right of the mark. The gravity for a mark defaults to B. The name space for marks is different from that for tags: the same name may be used for both a mark and a tag, but they will refer to different things. Two marks have special significance. First, the mark B is associated with the insertion cursor, as described under L<"THE INSERTION CURSOR"> below. Second, the mark B is associated with the character closest to the mouse and is adjusted automatically to track the mouse position and any changes to the text in the widget (one exception: B is not updated in response to mouse motions if a mouse button is down; the update will be deferred until all mouse buttons have been released). Neither of these special marks may be deleted. =head1 EMBEDDED WINDOWS The third form of annotation in text widgets is an embedded window. Each embedded window annotation causes a window to be displayed at a particular point in the text. There may be any number of embedded windows in a text widget, and any widget may be used as an embedded window (subject to the usual rules for geometry management, which require the text window to be the parent of the embedded window or a descendant of its parent). The embedded window's position on the screen will be updated as the text is modified or scrolled, and it will be mapped and unmapped as it moves into and out of the visible area of the text widget. Each embedded window occupies one character's worth of index space in the text widget, and it may be referred to either by the name of its embedded window or by its position in the widget's index space. If the range of text containing the embedded window is deleted then the window is destroyed. When an embedded window is added to a text widget with the B method, several configuration options may be associated with it. These options may be modified later with the B method. The following options are currently supported: =over 4 =item B<-align> =E I If the window is not as tall as the line in which it is displayed, this option determines where the window is displayed in the line. I must have one of the values B (align the top of the window with the top of the line), B
(center the window within the range of the line), B (align the bottom of the window with the bottom of the line's area), or B (align the bottom of the window with the baseline of the line). =item B<-create> =E I Specifies a L that may be evaluated to create the window for the annotation. If no B<-window> option has been specified for the annotation this I will be evaluated when the annotation is about to be displayed on the screen. I must create a window for the annotation and return the name of that window as its result. If the annotation's window should ever be deleted, I will be evaluated again the next time the annotation is displayed. =item B<-padx> =E I I specifies the amount of extra space to leave on each side of the embedded window. It may have any of the usual forms defined for a screen distance (see B). =item B<-pady> =E I I specifies the amount of extra space to leave on the top and on the bottom of the embedded window. It may have any of the usual forms defined for a screen distance (see B). =item B<-stretch> =E I If the requested height of the embedded window is less than the height of the line in which it is displayed, this option can be used to specify whether the window should be stretched vertically to fill its line. If the B<-pady> option has been specified as well, then the requested padding will be retained even if the window is stretched. =item B<-window> =E I<$widget> Specifies the name of a window to display in the annotation. =back =head1 EMBEDDED IMAGES The final form of annotation in text widgets is an embedded image. Each embedded image annotation causes an image to be displayed at a particular point in the text. There may be any number of embedded images in a text widget, and a particular image may be embedded in multiple places in the same text widget. The embedded image's position on the screen will be updated as the text is modified or scrolled. Each embedded image occupies one character's worth of index space in the text widget, and it may be referred to either by its position in the widget's index space, or the name it is assigned when the image is inserted into the text widget with B. If the range of text containing the embedded image is deleted then that copy of the image is removed from the screen. When an embedded image is added to a text widget with the B create method, a name unique to this instance of the image is returned. This name may then be used to refer to this image instance. The name is taken to be the value of the B<-name> option (described below). If the B<-name> option is not provided, the B<-image> name is used instead. If the I is already in use in the text widget, then B<#>I is added to the end of the I, where I is an arbitrary integer. This insures the I is unique. Once this name is assigned to this instance of the image, it does not change, even though the B<-image> or B<-name> values can be changed with B. When an embedded image is added to a text widget with the B method, several configuration options may be associated with it. These options may be modified later with the B method. The following options are currently supported: =over 4 =item B<-align> =E I If the image is not as tall as the line in which it is displayed, this option determines where the image is displayed in the line. I must have one of the values B (align the top of the image with the top of the line), B
(center the image within the range of the line), B (align the bottom of the image with the bottom of the line's area), or B (align the bottom of the image with the baseline of the line). =item B<-image> =E I Specifies the name of the Tk image to display in the annotation. If I is not a valid Tk image, then an error is returned. =item B<-name> =E I Specifies the name by which this image instance may be referenced in the text widget. If I is not supplied, then the name of the Tk image is used instead. If the I is already in use, I<#nn> is appended to the end of the name as described above. =item B<-padx> =E I I specifies the amount of extra space to leave on each side of the embedded image. It may have any of the usual forms defined for a screen distance. =item B<-pady> =E I I specifies the amount of extra space to leave on the top and on the bottom of the embedded image. It may have any of the usual forms defined for a screen distance. =back =head1 THE SELECTION Selection support is implemented via tags. If the B option for the text widget is true then the B tag will be associated with the selection: =over 4 =item [1] Whenever characters are tagged with B the text widget will claim ownership of the selection. =item [2] Attempts to retrieve the selection will be serviced by the text widget, returning all the characters with the B tag. =item [3] If the selection is claimed away by another application or by another window within this application, then the B tag will be removed from all characters in the text. =item [4] Whenever the sel tag range changes a virtual event B<<>> is generated. The B tag is automatically defined when a text widget is created, and it may not be deleted with the ``I<$text>-EB'' method. Furthermore, the B, B, and B options for the text widget are tied to the B<-background>, B<-borderwidth>, and B<-foreground> options for the B tag: changes in either will automatically be reflected in the other. =back =head1 THE INSERTION CURSOR The mark named B has special significance in text widgets. It is defined automatically when a text widget is created and it may not be unset with the ``I<$text>-EB'' widget command. The B mark represents the position of the insertion cursor, and the insertion cursor will automatically be drawn at this point whenever the text widget has the input focus. =head1 THE MODIFIED FLAG The text widget can keep track of changes to the content of the widget by means of the modified flag. Inserting or deleting text will set this flag. The flag can be queried, set and cleared programatically as well. Whenever the flag changes state a B<<>> virtual event is gener- ated. See the edit modified widget command for more details. =head1 WIDGET METHODS The B method creates a widget object. This object supports the B and B methods described in L which can be used to enquire and modify the options described above. The widget also inherits all the methods provided by the generic L class. The following additional methods are available for text widgets. In addition, the extended text widget methods as documented in I<"Mastering Perl/Tk"> are included in this pod (with permission from the publisher, B). =over 4 =item I<$text>-EB Moves the end point of the selection and anchor point to the mouse pointer location. =item I<$text>-EB(I) Returns a list of four elements describing the screen area of the character given by I. The first two elements of the list give the x and y coordinates of the upper-left corner of the area occupied by the character, and the last two elements give the width and height of the area. If the character is only partially visible on the screen, then the return value reflects just the visible part. If the character is not visible on the screen then the return value is an empty list. =item I<$text>-EB Performs a rectangular copy of the currently selected text with basic compensation for tab characters. =item I<$text>-EB Performs a rectangular cut of the currently selected text with basic compensation for tab characters. =item I<$text>-EB Performs a rectangular paste of the text in the clipboard. The upper-left corner is specified by the current position of the insert mark with basic compensation for tab characters. =item I<$text>-EB(I) Compares the indices given by I and I according to the relational operator given by I, and returns 1 if the relationship is satisfied and 0 if it isn't. I must be one of the operators E, E=, ==, E=, E, or !=. If I is == then 1 is returned if the two indices refer to the same character, if I is E then 1 is returned if I refers to an earlier character in the text than I, and so on. =item I<$text>-EB(I?) Query or change the entire contents of the text widget. If no arguments are given, the entire contents of the text widget are returned. If any arguments are given, the entire contents of the text widget are deleted and replaced by the argument list. =item I<$text>-EB(?I?) If I is specified, then it must have one of the true or false values accepted by Tcl_GetBoolean. If the value is a true one then internal consistency checks will be turned on in the B-tree code associated with text widgets. If I has a false value then the debugging checks will be turned off. In either case the command returns an empty string. If I is not specified then the command returns B or B to indicate whether or not debugging is turned on. There is a single debugging switch shared by all text widgets: turning debugging on or off in any widget turns it on or off for all widgets. For widgets with large amounts of text, the consistency checks may cause a noticeable slow-down. =item I<$text>-EB(I?I?) Delete a range of characters from the text. If both I and I are specified, then delete all the characters starting with the one given by I and stopping just before I (i.e. the character at I is not deleted). If I doesn't specify a position later in the text than I then no characters are deleted. If I isn't specified then the single character at I is deleted. It is not allowable to delete characters in a way that would leave the text without a newline as the last character. The command returns an empty string. If more indices are given, multiple ranges of text will be deleted. All indices are first checked for validity before any deletions are made. They are sorted and the text is removed from the last range to the first range to deleted text does not cause a undesired index shifting side-effects. If multiple ranges with the same start index are given, then the longest range is used. If overlapping ranges are given, then they will be merged into spans that do not cause deletion of text outside the given ranges due to text shifted during deletion. =item I<$text>-EB Delete the currently selected text. =item I<$text>-EB(I) Delete the text tagged with the I parameter. =item I<$text>-EB Delete from the insert mark location to the end of line. =item I<$text>-EB(I) Returns a list with five elements describing the area occupied by the display line containing I. The first two elements of the list give the x and y coordinates of the upper-left corner of the area occupied by the line, the third and fourth elements give the width and height of the area, and the fifth element gives the position of the baseline for the line, measured down from the top of the area. All of this information is measured in pixels. If the current wrap mode is B and the line extends beyond the boundaries of the window, the area returned reflects the entire area of the line, including the portions that are out of the window. If the line is shorter than the full width of the window then the area returned reflects just the portion of the line that is occupied by characters and embedded windows. If the display line containing I is not visible on the screen then the return value is an empty list. =item I<$text>-EB(?I?, I?I?) Return the contents of the text widget from I up to, but not including I, including the text and information about marks, tags, and embedded windows. If I is not specified, then it defaults to one character past I. The information is returned in the following format: I ... The possible I values are B, B, B, B, and I<$text>. The corresponding I is the text, mark name, tag name, or window name. The I information is the index of the start of the text, the mark, the tag transition, or the window. One or more of the following switches (or abbreviations thereof) may be specified to control the dump: =over 4 =item B<-all> Return information about all elements: text, marks, tags, and windows. This is the default. =item B<-command> =E I Instead of returning the information as the result of the dump operation, invoke the I on each element of the text widget within the range. The callback has three arguments appended to it before it is evaluated: the I, I, and I. =item B<-mark> Include information about marks in the dump results. =item B<-tag> Include information about tag transitions in the dump results. Tag information is returned as B and B elements that indicate the begin and end of each range of each tag, respectively. =item B<-text> Include information about text in the dump results. The value is the text up to the next element or the end of range indicated by I. A text element does not span newlines. A multi-line block of text that contains no marks or tag transitions will still be dumped as a set of text seqments that each end with a newline. The newline is part of the value. =item B<-window> =back Include information about embedded windows in the dump results. The value of a window is its Tk pathname, unless the window has not been created yet. (It must have a create script.) In this case an empty string is returned, and you must query the window by its index position to get more information. =item I<$text>-EB( I< option, ?arg, arg ...?> ); This command controls the undo mechanism and the modified flag. The exact behavior of the command depends on the option argument that follows the edit argument. The following forms of the command are currently supported: =over 4 =item I<$text>-EB( ?boolean? ); If boolean is not specified, returns the modified flag of the widget. The insert, delete, edit undo and edit redo commands or the user can set or clear the modified flag. If boolean is specified, sets the modified flag of the widget to boolean. =item I<$text>-EB; (Not implemented, use B.) When the B<-undo> option is true, reapplies the last undone edits provided no other edits were done since then. Generates an error when the redo stack is empty. Does nothing when the B<-undo> option is false. =item I<$text>-EB; (Not implemented, use B.) Clears the undo and redo stacks. =item I<$text>-EB; (Not implemented, use B.) Inserts a separator (boundary) on the undo stack. Does nothing when the -undo option is false. =item I<$text>-EB; (Not implemented, use B.) Undoes the last edit action when the -undo option is true. An edit action is defined as all the insert and delete commands that are recorded on the undo stack in between two separators. Generates an error when the undo stack is empty. Does nothing when the -undo option is false. =back =item I<$text>-EB(I) Removes any current selections and then performs a global text search. All matches are tagged with the B tag. I can be be B<-exact> or B<-regexp>. See the B command for more information I can be B<-nocase> or B<-case>. See the B command for more information I is an exact string to match if I is B<-exact> or a regular expression if the match I is B<-regexp>. =item I<$text>-EB(I) Same as the B method, however additionally substitutes the matched text with the characters I. =item I<$text>-EB Creates a find-and-replace popup window if one does not already exist. If there is currently selected text, then the 'find' field will be 'pre-filled' with the selection. =item I<$text>-EB(I) Removes any current selections and then performs a forward or reverse text search. All matches are tagged with the B tag. I can be B<-forwards> or B<-backwards>. I and I are as for the B method. =item I<$text>-EB Creates a find popup, if one does not yet exist. If there is currently selected text, then the 'find' field will be 'pre-filled' with the selection. =item I<$text>-EB Gets the currently selected text and removes all selections. It then finds the next exact, case-sensitive string that matches in a forward direction and selects the text and makes the new selection visible. =item I<$text>-EB Gets the currently selected text and removes all selections. It then finds the next exact, case-sensitive string that matches in a reverse direction and selects the text and makes the new selection visible. =item I<$text>-EB(I?I?) Return a range of characters from the text. The return value will be all the characters in the text starting with the one whose index is I and ending just before the one whose index is I (the character at I will not be returned). If I is omitted then the single character at I is returned. If there are no characters in the specified range (e.g. I is past the end of the file or I is less than or equal to I) then an empty string is returned. If the specified range contains embedded windows, no information about them is included in the returned string. If multiple index pairs are given, multiple ranges of text will be returned in a list. Invalid ranges will not be represented with empty strings in the list. The ranges are returned in the order passed to B. =item I<$text>-EB Return the currently selected text. =item I<$text>-EB(I) Return the text tagged with the I parameter. =item I<$text>-EB(I) Set the insert mark to I and ensures the line is visible. =item I<$text>-EB(I) Displays a popup, pre-filling it with selected numeric text (if any), or the line number from B (if any). =item I<$text>-EB(I