Specifies the normal background color to use when displaying the widget.
Specifies a non-negative value indicating the width
of the 3-D border to draw around the outside of the widget (if such a
border is being drawn; the -relief option typically determines
this). The value may also be used when drawing 3-D effects in the
interior of the widget. The value specifies a screen distance as
described in section ![[*]](crossref.png)
.
Specifies the mouse cursor to be used for the widget. Please refer to the Tk documentation for details on specifying mouse cursors.
.
If the selection is exported, then selecting in the widget deselects the current X selection, selecting outside the widget deselects any widget selection, and the widget will respond to selection retrieval requests when it has a selection. The default is to export the selection.
Specifies the font to use when drawing text inside the widget.
This option is supported for compatibility with other Tk widgets and
applications only. Using the more flexible options -family,
-size, -bold, and -italic (see below) is
preferred since these options provide smoother interaction with the
text property inheritance scheme described in section .
Specifies the normal foreground color to use when displaying the widget.
Specifies the color to display in the traversal highlight region when the widget does not have the input focus.
Specifies the color to use for the traversal highlight rectangle that is drawn around the widget when it has the input focus.
Specifies a non-negative value indicating the width of the highlight
rectangle to draw around the outside of the widget when it has the
input focus. The value specifies a screen distance as described in
section .
If the value is zero, no focus highlight is drawn around the widget.
Specifies the color to use as background in the area covered by the insertion cursor. This color will normally override either the normal background for the widget (or the selection background if the insertion cursor happens to fall in the selection).
Specifies a non-negative value indicating the width of the 3-D border to draw around the insertion cursor.
Specifies a non-negative integer value indicating the number of milliseconds the insertion cursor should remain ``off'' in each blink cycle. If this option is zero then the cursor doesn't blink: it is on all the time.
Specifies a non-negative integer value indicating the number of milliseconds the insertion cursor should remain ``on'' in each blink cycle.
Specifies a value indicating the total width of the insertion cursor.
The value specifies a screen distance as described in
section .
If a border has been specified for the insertion cursor (using the -insertBorderWidth option), the border will be drawn inside the width specified by the -insertWidth option.
Specifies a non-negative screen distance indicating how much extra space to request for the widget in the X-direction.
When computing how large a window it needs, the widget will add this amount to the width it would normally need (as determined by the width of the things displayed in the widget); if the geometry manager can satisfy this request, the widget will end up with extra internal space to the left and/or right of what it displays inside.
Specifies a non-negative value indicating how much extra space to request for the widget in the Y-direction. When computing how large a window it needs, the widget will add this amount to the height it would normally need (as determined by the height of the things displayed in the widget); if the geometry manager can satisfy this request, the widget will end up with extra internal space above and/or below what it displays inside.
Specifies the 3-D effect desired for the widget. Acceptable values are raised, sunken, flat, ridge, solid , and groove.
The value indicates how the interior of the widget should appear relative to its exterior; for example, raised means the interior of the widget should appear to protrude from the screen, relative to the exterior of the widget.
Specifies the background color to use when displaying selected items.
Specifies a non-negative value indicating the width of the 3-D border to draw around selected items.
Specifies the foreground color to use when displaying selected items.
If the -setGrid option is set to true then the widget will communicate with the window manager so that when the user interactively resizes the top-level window that contains the widget, the dimensions of the window will be displayed to the user in grid units and the window size will be constrained to integral numbers of grid units.
Determines whether the window accepts the focus during keyboard traversal (e.g., Tab and Shift-Tab). Before setting the focus to a window, the traversal scripts consult the value of the -takeFocus option. A value of 0 means that the window should be skipped entirely during keyboard traversal. 1 means that the window should receive the input focus as long as it is viewable (it and all of its ancestors are mapped). An empty value for the option means that the traversal scripts make the decision about whether or not to focus on the window: the current algorithm is to skip the window if it is disabled, if it has no key bindings, or if it is not viewable. If the value has any other form, then the traversal scripts take the value, append the name of the window to it (with a separator space), and evaluate the resulting string as a Tcl script. The script must return 0, 1, or an empty string: a 0 or 1 value specifies whether the window will receive the input focus, and an empty string results in the default decision described above.
Note: this interpretation of the option is defined entirely by the Tcl scripts that implement traversal: the widget implementation ignores the option entirely, so you can change its meaning if you redefine the keyboard traversal scripts.
Specifies the prefix for a command used to communicate with horizontal scrollbars. When the view in the widget's window changes (or whenever anything else occurs that could change the display in a scrollbar, such as a change in the total size of the widget's contents), the widget will generate a Tcl command by concatenating the scroll command and two numbers. Each of the numbers is a fraction between 0 and 1, which indicates a position in the document. 0 indicates the beginning of the document, 1 indicates the end, .333 indicates a position one third the way through the document, and so on. The first fraction indicates the first information in the document that is visible in the window, and the second fraction indicates the information just after the last portion that is visible. The command is then passed to the Tcl interpreter for execution.
Typically the -xScrollCommand option consists of the path name of a scrollbar widget followed by set, e.g. .x.scrollbar set: this will cause the scrollbar to be updated whenever the view in the window changes. If this option is not specified, then no command will be executed.
Specifies the prefix for a command used to communicate with vertical scrollbars. This option is treated in the same way as the -xScrollCommand option, except that it is used for vertical scrollbars and is provided by widgets that support vertical scrolling.
See the description of -xScrollCommand for details on how this option is used.
This option controls how the sgml widget should behave if a DTD can not be loaded or does not contain a definition of the document element. If the option is set to false, the sgml widget refuses to load such documents. If this option is set to true, the widget will load the document and switch to DTDless mode (if no DTD was found) or imply a content model of ANY for the document element (if it's declaration did not occur in the DTD).
Specifies a command to be executed whenever the attributes of an
element are changed. See section for details.
Specifies whether the sgml widget should insert a line break between adjacent element end tags and element start tags that occur in element content. Settings this value to false will turn automatic insertion of line breaks off. See the description of the pcrm-breaklimit for additional details on avoiding all automatic insertions of line breaks.
This option specifies if line breaks should be removed from elements with mixed content when a document is loaded. If this option is set to true, all line breaks (RE/RS combinations) are stripped from elements that allow mixed content. If this option is set to false, all line breaks in the document are retained.
Specifies whether characters are to be shown in bold font or not.
Specifies the maximum number of characters that may be read without an intervening line break. If this value is greater than zero when loading a document, the sgml widget will automatically insert a line break at the next possible location after breaklimit characters have been encountered without seing a line break. Setting this value to zero turns automatic creation of line breaks off.
Specifies the background color for comments. Comment text in the document is shown with this background color. If this option is not specified, the default background color is used.
If this option is set to true, the text of comments is shown in bold font.
This option specifies the font family to use for displaying comments.
Specifies the forground color for comment text.
If this option is set to true, the text of comments is shown in a slanted font.
If this option is set to true, a horizontal line is drawn through the text of comments.
Specifies the font size for comment text.
If this option is set to true, a horizontal line is drawn below the characters in the text of comments.
Specifies a command to be executed whenever the context of the
insertion mark changes. See section for details.
Specifies a command to be executed whenever an element is deleted
from the sgml widget. See section for details.
Specifies whether text entities should be expanded or shown as entity references.
Specifies the default font family of the widget. Tk guarantees to support the font families named Courier (a monospaced ``typewriter'' font), Times (a serifed ``newspaper'' font), and Helvetica (a sans-serif ``European'' font). The most closely matching native font family will automatically be substituted when one of the above font families is used. The name may also be the name of a native, platform-specific font family; in that case it will work as desired on one platform but may not display correctly on other platforms. If the family is unspecified or unrecognized, a platform-specific default font will be chosen.
Specifies the desired height for the window, in units of characters in the font given by the -font option. Must be at least one.
This option controls whether default values for attributes will be implied if they are not specified in the document instance. If this option is set to true, unspecified attributes for which a default value is provided in the DTD will be implied as if they had been specified with the default value in the document instance. Setting this option to false turns this feature off.
This option controls whether fixed values for attributes will be implied if they are not specified in the document instance. If this option is set to true, unspecified attributes for which a fixed value is provided in the DTD will be implied as if they had been specified with this value in the document instance. Setting this option to false turns this feature off.
Specifies a command to be executed whenever a new element is inserted
into the sgml widget. See section for details.
Specifies whether characters are to be italicized or not.
If this option is set, ignorable whitespace in the document instance is retained when a document is loaded. If this option is not set, ignorable whitespace characters are removed from the document.
The value of this option is the width of the left margin inside the sgml widget. This value is only relevant for the fixed width layout mode.
Specifies the maximum number of error messages to generate when loading or validating an SGML or XML document.
This option specifies whether character references should be displayed as numerical references or as the character that is specified by the character reference.
Specifies whether or not to draw an horizontal line through the middle
of characters. The value may have any of the forms described in
section .
Specifies a command to be executed whenever the parent element of an
element changes. See section for details.
This option governs the case normalisation of names if the SGML declaration specifies that case is not significant If set to true, all names are normalized to lower case. They are converted to upper case if this option is set to false. Because XML documents are always case-sensitive, this option applies only to SGML documents.
Specifies a command to be executed during loading, validating, and
printing a document. See section for details.
Specifies a command to execute when an SGML document is loaded. When a document is loaded and the prolog of the document has been processed, the widget will generate a Tcl command by concatenating the prologCmd and the pathname of the widget. The command is then passed to the Tcl interpreter for execution.
Since the command is executed during the load process immediately after the prolog of the document has been processed, but before the document content is read, the operations that can be performed by this command are limited. The most common use is to modify configure options for certain elements so that the load process can be customized.
Specifies the character to show at the end of a line that is terminated by a record end (RE). If the value of this option is an empty string, REs will not be shown. If the value of this option is a non-empty string, the first character of this string will be displayed where a record end occurred in the document.
Specifies the font for the record end character and white space characters.
Specifies a command to be executed when the selection in the sgml
widget changes. See section for details.
Specifies whether attributes should be shown inside sgml tags. The value may have any of the forms accepted by Tcl_GetBoolean, such as true, false, 0, 1, yes, or no.
Specifies the default font size of the widget. If the size argument is a positive number, it is interpreted as a size in points. If size is a negative number, its absolute value is interpreted as a size in pixels. If a font cannot be displayed at the specified size, a nearby size will be chosen. If size is unspecified or zero, a platform-dependent default size will be chosen.
Specifies a command to be executed when the window geometry of a slave
widget under control of the sgml widget changes. See
section for details.
Specifies the character to show where ignorable space characters occur. If the value of this option is an empty string, ignorable white space will be represented by a blank character. The settings of the pcrm-refont determine the font to use.
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 overridden with -spacing1 options in tags and elements.
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 overridden with -spacing2 options in tags and elements.
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 overridden with -spacing3 options in tags and elements.
Specifies one of two states for the widget: normal or disabled. If the widget 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.
Specifies whether rules checking should be strict or relaxed for the
deletion of elements. The value may have any of the forms accepted for
boolean values as described in section .
Specifies whether rules checking should be strict or relaxed for the
insertion of elements. The value may have any of the forms accepted for
boolean values as described in section .
Specifies whether rules checking should be strict or relaxed for the
renaming of elements. The value may have any of the forms accepted for
boolean values as described in section .
Specifies whether rules checking should be strict or relaxed. The
value may have any of the forms accepted for boolean values as
described in section .
Specifies whether rules checking should be strict or relaxed for the
splitting of elements. The value may have any of the forms accepted for
boolean values as described in section .
Specifies the character to show where ignorable tab characters occur.
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 left , right , center , or numeric , which specifies how to justify text relative to the tab stop.
The default is left ; it causes the text following the tab character to be positioned with its left edge at the tab position. Right means that the right edge of the text following the tab character is positioned at the tab position, and center means that the text is centered at the tab position. Numeric 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, -tabs {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 -tabs option may be overridden by -tabs options in tags and elements. If no -tabs option is specified, or if it is specified as an empty list, then Tk uses default tabs spaced every eight (average size) characters.
Specifies background color to use when drawing sgml tags.
Specifies the width of the border to draw around sgml tags. If set to 0, no border will be drawn around the tags.
Specifies the font to use for drawing the contents of sgml tags.
Specifies the color to use for drawing the foreground text of a tag. This color is used when drawing all text in an sgml tag with the exception of invalid elements.
Specifies the foreground color to use for drawing the foreground text of an sgml tag for an incomplete or invalid element.
Specifies a non-negative value indicating how much additional internal
space to use for an sgml tag in the X-direction. The value specifies a
screen distance as described in section .
When computing how large the tag will be, the widget will add this amount to the width the tag would normally need (as determined by the width of the things displayed in the tag). The sgml tag will end up with extra internal space to the left and right of what it displays inside.
Specifies a non-negative value indicating how much additional internal space to use for an sgml tag in the Y-direction.
When computing how large the tag will be, the widget will add this amount to the height the tag would normally need (as determined by the height of the things displayed in the tag). The sgml tag will end up with extra internal space to the top and bottom of what it displays inside.
Specifies a non-negative value indicating how much additional external space to request for an sgml tag in the X-direction. The extra space is added to the left and right of each sgml tag.
Specifies a non-negative value indicating how much additional external space to request for an sgml tag in the Y-direction. The extra space is added above the top and below the bottom of each sgml tag.
Specifies the relief to use for drawing tags. Can be one of raised, sunken, flat, ridge, and groove.
Specifies the overall width of the document when the wrap mode has ben set to fixed. The value of this option includes the width of the left margin.
Specifies whether or not to draw an underline underneath characters.
The value may have any of the forms accepted for boolean values as
described in section .
Specifies a command to be executed whenever the status of an
element changes. See section for details.
Specifies the desired width for the window in units of characters in the font given by the -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.
Specifies how to handle lines in the text that are too long to be displayed in a single line of the window. The value must be none or char or word or fixed.
A wrap mode of none 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 char mode a screen line break may occur after any character; in word mode a line break will only be made at word boundaries. In fixed mode, line breaking will occur as in word mode with the exception that the maximum width of line is controlled by the setting of the textwidth configuration option instead of the window size.
Default values for configuration options that are not specified when an sgml widget is created are looked up in the option database. The following table contains the name of the command-line options and their corresponding widget and class names that are used for the database lookup.