'\" .UL arg1 arg2
'\" Print arg1 underlined, then print arg2 normally.
'\"
-'\" RCS: @(#) $Id: man.macros,v 1.3 2001/02/17 07:46:19 ghowlett Exp $
+'\" RCS: @(#) $Id: man.macros,v 1.1.1.1 2009/05/09 16:27:42 pcmacdon Exp $
'\"
'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
.if t .wh -1.3i ^B
.de UL
\\$1\l'|0\(ul'\\$2
..
-.TH tabset n 2.4 BLT "BLT Built-In Commands"
+.TH tabset n 2.5 BLT "BLT Built-In Commands"
.BS
'\" Note: do not modify the .SH NAME line immediately below!
.SH NAME
arguments. An index may take several forms:
.TP 12
\fInumber\fR
-Unique node id of the tab.
+Unique index offset of the tab.
.TP 12
\fB@\fIx\fB,\fIy\fR
Tab that covers the point in the tabset window
If there is no tab located under the mouse pointer, the index
is ignored.
.TP 12
+\fBbegin\fR
+First tab in the tabset. If there are no tabs in the tabset then the
+index is ignored.
+.TP 12
+\fBcurrent\fR
+Tab that is currently being operated upon. Used within bindings.
+.TP 12
\fBfocus\fR
Tab that currently has the widget's focus.
This tab is displayed with a dashed line around its label. You can
if there is one. If there is no tab to the left, the current
tab is returned.
.TP 12
+\fBnext\fR
+The next tab. Wraps to the first tab if at end.
+.TP 12
+\fBprev\fR
+The previous tab. Wraps to the last tab if at start.
+.TP 12
\fBright\fR
Tab immediately to the right the tab that currently has focus, if
there is one. If there is no tab to the right, the current tab is
event sequence given by \fIsequence\fR occurs for a tab with this
tag, \fIcommand\fR will be invoked. The syntax is similar to the
\fBbind\fR command except that it operates on tabs, rather
-than widgets. See the \fBbind\fR manual entry for
+than widgets. The tagName is one of \fBall\fR, \fBPerforation\fR,
+\fBImage\fR, \fBLeftimage\fR, \fBStartimage\fR, \fBEndimage\fR,
+or the name label used to create a Tab.
+See the \fBbind\fR manual entry for
complete details on \fIsequence\fR and the substitutions performed on
\fIcommand\fR.
.sp
If all arguments are specified then a new binding is created, replacing
any existing binding for the same \fIsequence\fR and \fItagName\fR.
-If the first character of \fIcommand\fR is \f(CW+\fR then \fIcommand\fR
+If the first character of \fIcommand\fR is \fB+\fR then \fIcommand\fR
augments an existing binding rather than replacing it.
If no \fIcommand\fR argument is provided then the command currently
associated with \fItagName\fR and \fIsequence\fR (it's an error occurs
.SB "WIDGET OPTIONS"
below.
.TP
+\fIpathName \fBcoords\fR \fIelement\fR ?\fIindex\fR?
+Returns the screen coordinates for the given \fIelement\fR,
+which is one of: \fBtext\fR,
+\fBimage\fR, \fBleftimage\fR, \fBstartimage\fR, \fBendimage\fR, or
+\fBperforation\fR.
+All except \fBstartimage\fR and \fBendimage\fR must also
+provide a tab \fIindex\fR.
+.TP
\fIpathName \fBdelete \fIfirst \fR?\fIlast\fR?
Deletes one or more tabs from the tabset. \fIFirst\fR and \fIlast\fR
are the first and last indices, defining a range of tabs to be deleted.
be in any form described in the section
.SB "INDICES".
.TP
+\fIpathName \fBhightlight\fR \fIindex\fR
+Highlight a tab.
+.TP
\fIpathName \fBindex\fR ?\fIflag\fR? \fIstring\fR
-Returns the node id of the tab specified by \fIstring\fR. If
+Returns the index offset of the tab specified by \fIstring\fR. If
\fIflag\fR is \fB\-name\fR, then \fIstring\fR is the name of a tab.
If \fIflag\fR is \fB\-index\fR, \fIstring\fR is an index such as
-"active" or "focus". If \fIflag\fR isn't specified, it defaults to
+"active" or "focus".
+If \fIflag\fR is \fB\-both\fR, \fIstring\fR is either.
+If \fIflag\fR isn't specified, it defaults to
\fB\-index\fR.
.TP
-\fIpathName \fBinsert\fR \fIposition \fIname\fR ?\fIoption value\fR?...
+\fIpathName \fBinsert\fR \fIposition ?\fIname ...\fR? ?\fIoption value\fR?...
Inserts new tabs into the tabset. Tabs are inserted just before the
tab given by \fIposition\fR. \fIPosition\fR may be either a number,
indicating where in the list the new tab should be added, or \fBend\fR,
indicating that the new tab is to be added the end of the list.
\fIName\fR is the symbolic name of the tab. \fIBe careful not to use
a number. Otherwise the tabset will confuse it with tab indices\fR. Returns
-a list of indices for all the new tabs.
+a list of indices for all the new tabs. If tab name is an empty
+string, or ends in #auto, it is
+generated using the given prefix. The list
+of created tab names is returned.
.TP
\fIpathName \fBinvoke \fIindex\fR
Selects the tab given by \fIindex\fR, maps the tab's embedded widget, and
\fIpathName \fBmove\fR \fIindex\fR \fBbefore\fR|\fBafter\fR \fIindex\fR
Moves the tab \fIindex\fR to a new position in the tabset.
.TP
-\fIpathName \fBnearest\fR \fIx\fR \fIy\fR
+\fIpathName \fBnearest\fR \fIx\fR \fIy\fR ?\fIvarName\fR? ?\fIcoordsVar\fR?
Returns the name of the tab nearest to given X-Y screen coordinate.
+If the argument \fIvarName\fR is present,
+this is a Tcl variable that is set to either \fBtext\fR,
+\fBimage\fR, \fBleftimage\fR, \fBstartimage\fR, \fBendimage\fR,
+\fBperforation\fR or the empty string depending
+what part of the
+tab the coordinate is over.
+If the argument \fIcoordsVar\fR is present,
+return the bounding box coordinates coordinates for the matching item
+set in \fIvarName\fR.
.TP
\fIpathName \fBperforation \fIoperation\fR ?\fIargs\fR?
This operation controls the perforation on the tab label.
.RS
.TP
-\fIpathName \fBperforation highlight\fR \fIindex\fR \fIboolean\fR
+\fIpathName \fBperforation activate\fR \fIboolean\fR
+Set perforation active state to on or off.
.TP
-\fIpathName \fBperforation invoke\fR \fIindex\fR
+\fIpathName \fBperforation invoke\fR
Invokes the command specified for perforations (see the
\fB\-perforationcommand\fR widget option). Typically this command
places the page into a top level widget. The name of the toplevel
Scrolls the tabset so that the tab
\fIindex\fR is visible in the widget's window.
.TP
+\fIpathName \fBselect \fIindex\fR
+Select the tab.
+.TP
\fIpathName \fBsize\fR
Returns the number of tabs in the tabset.
.TP
.SB "TAB OPTIONS"
below.
.TP
+\fIpathName \fBtab dockall\fR
+Dock all tearoffs.
+.TP
\fIpathName \fBtab names\fR ?\fIpattern\fR?
Returns the names of all the tabs matching the given pattern. If
no \fIpattern\fR argument is provided, then all tab names are returned.
.TP
-\fIpathName \fBtab tearoff \fIindex\fR ?\fInewName\fR?
-Reparents the widget embedded into \fIindex\fR, placing
-it inside of \fInewName\fR. \fINewName\fR is either the name of
-an new widget that will contain the embedded widget or the name
-of the \fBtabset\fR widget. It the last case, the embedded widget
-is put back into the folder.
-.sp
-If no \fInewName\fR argument is provided, then the name of the current
-parent of the embedded widget is returned.
+\fIpathName \fBtab pageheight\fR
+.TP
+\fIpathName \fBtab pagewidth\fR
+.TP
+\fIpathName \fBtab select \fInameOrindex\fR
+Select a tab by name or index, and cause it to become visible, selected,
+activated, and receive focus. This is a shortform for using separate
+commands.
+.TP
+\fIpathName \fBtab tearoff\fR ?\fIindex\fR?
+With no ?\fIindex\fR?, returns list of all torn-off tabs.
+Otherwise, return the window for the given torn-off tab.
.RE
.TP
+\fIpathName \fBtab tearoff\fR ?\fIindex\fR?
+With no ?\fIindex\fR?, returns list of all torn-off tabs.
+Otherwise, toggles the torn-off state of the tab.
+.TP
\fIpathName \fBview \fIargs\fR
This command queries or changes the position of the
tabset in the widget's window. It can take any of the following
.SH "WIDGET OPTIONS"
Widget configuration options may be set either by the \fBconfigure\fR
operation or the Tk \fBoption\fR command. The resource class
-is \f(CWTabset\fR. The resource name is the name of the widget.
+is \fBTabset\fR. The resource name is the name of the widget.
.CS
option add *Tabset.Foreground white
option add *Tabset.Background blue
operation. Individual tabs may override this option by setting the
tab's \fB\-activeforeground\fR option.
.TP
+\fB\-anchor \fIanchor\fR
+Anchors the tab's text (and images) to a particular edge of the tab.
+The default value is \fBcenter\fR.
+.TP
\fB\-background \fIcolor\fR
Sets the background color of the tabset.
.TP
\fB\-borderwidth \fIpixels\fR
Sets the width of the 3\-D border around the outside edge of the widget. The
\fB\-relief\fR option determines how the border is to be drawn. The
-default is \f(CW2\fR.
+default is \fB2\fR.
.TP
\fB\-cursor \fIcursor\fR
-Specifies the widget's cursor. The default cursor is \f(CW""\fR.
+Specifies the widget's cursor. The default cursor is \fB""\fR.
.TP
\fB\-dashes \fIdashList\fR
Sets the dash style of the focus outline. When a tab has the widget's
\fIDashList\fR is a list of up
to 11 numbers that alternately represent the lengths of the dashes
and gaps on the cross hair lines. Each number must be between 1 and
-255. If \fIdashList\fR is \f(CW""\fR, the outline will be a solid
-line. The default value is \f(CW5 2\fR.
+255. If \fIdashList\fR is \fB""\fR, the outline will be a solid
+line. The default value is \fB5 2\fR.
+.TP
+\fB\-ellipsis \fIstring\fR
+String to append to displayed labels that have been truncated
+due to exceeding \fB-labelmax\fR. The default is \fB...\fR.
+.TP
+\fB\-endimage \fIimageName\fR
+Specify an image to be drawn after tabs (ie. on the right if -side = top).
+This is used by
+a binding looking for \fIendimage\fR from the \fBnearest\fR subcommand.
+.TP
+\fB\-fillwidth \fIboolean\fR
+Indicates if extra space should be allocated to tabs when multiple tiers
+are displayed. The default is \fByes\fR.
.TP
\fB\-font \fIfontName\fR
Sets the default font for the text in tab labels. Individual tabs may
override this by setting the tab's \fB\-font\fR option. The default value is
-\f(CW*-Helvetica-Bold-R-Normal-*-12-120-*\fR.
+\fB*-Helvetica-Bold-R-Normal-*-12-120-*\fR.
.TP
\fB\-foreground \fIcolor\fR
Sets the default color of tab labels. Individual tabs may
override this option by setting the tab's \fB\-foreground\fR option.
-The default value is \f(CWblack\fR.
+The default value is \fBblack\fR.
.TP
\fB\-gap \fIsize\fR
-Sets the gap (in pixels) between tabs. The default value is \f(CW2\fR.
+Sets the gap (in pixels) between tabs. The default value is \fB2\fR.
+.TP
+\fB\-gapleft \fIsize\fR
+Sets a gap (in pixels) to leave between the text and -leftimage.
+The default value is \fB2\fR.
.TP
\fB\-height \fIpixels\fR
Specifies the requested height of widget. If \fIpixels\fR is
0, then the height of the widget will be calculated based on
the size the tabs and their pages.
-The default is \f(CW0\fR.
+The default is \fB0\fR.
.TP
\fB\-highlightbackground \fIcolor\fR
Sets the color to display in the traversal highlight region when
\fB\-highlightcolor \fIcolor\fR
Sets the color to use for the traversal highlight rectangle that is
drawn around the widget when it has the input focus.
-The default is \f(CWblack\fR.
+The default is \fBblack\fR.
.TP
\fB\-highlightthickness \fIpixels\fR
Sets the width of the highlight rectangle to draw around the outside of
the widget when it has the input focus. \fIPixels\fR is a non-negative
value and may have any of the forms acceptable to \fBTk_GetPixels\fR.
If the value is zero, no focus highlight is drawn around the widget.
-The default is \f(CW2\fR.
+The default is \fB2\fR.
+.TP
+\fB\-labelbackground \fIcolor\fR
+Sets a background color for the label.
+The default is \f""\fR.
+.TP
+\fB\-labelmax \fIlength\fR
+Length at which to truncate displayed label text after
+appending value of \fB-ellipsis\fR.
+This enables a user implemention of truncating labels as the number
+of tabs increases.
+Default is \fB0\fR meaning do no truncation.
.TP
\fB\-outerpad \fIpixels\fR
Padding around the exterior of the tabset and folder.
.TP
\fB\-pageheight \fIpixels\fR
Sets the requested height of the page. The page is the area under the
-tab used to display the page contents. If \fIpixels\fR is \f(CW0\fR,
+tab used to display the page contents. If \fIpixels\fR is \fB0\fR,
the maximum height of all embedded tab windows is used. The default
-is \f(CW0\fR.
+is \fB0\fR.
.TP
\fB\-pagewidth \fIpixels\fR
Sets the requested width of the page. The page is the area under the
-tab used to display the page contents. If \fIpixels\fR is \f(CW0\fR,
+tab used to display the page contents. If \fIpixels\fR is \fB0\fR,
the maximum width of all embedded tab windows is used. The default
-is \f(CW0\fR.
+is \fB0\fR.
.TP
\fB\-perforationcommand\fR \fIstring\fR
Specifies a Tcl script to be invoked to tear off the current
\fB\-relief \fIrelief\fR
Specifies the 3-D effect for the tabset widget. \fIRelief\fR
specifies how the tabset should appear relative to widget that
-it is packed into; for example, \f(CWraised\fR means the tabset should
-appear to protrude. The default is \f(CWsunken\fR.
+it is packed into; for example, \fBraised\fR means the tabset should
+appear to protrude. The default is \fBsunken\fR.
.TP
\fB\-rotate \fItheta\fR
Specifies the degrees to rotate text in tab labels.
\fITheta\fR is a real value representing the number of degrees
-to rotate the tick labels. The default is \f(CW0.0\fR degrees.
+to rotate the tick labels. The default is \fB0.0\fR degrees.
.TP
\fB\-samewidth \fIboolean\fR
Indicates if each tab should be the same width. If true, each tab will
-be as wide as the widest tab. The default is \f(CWno\fR.
+be as wide as the widest tab. The default is \fBno\fR.
.TP
\fB\-scrollcommand \fIstring\fR
Specifies the prefix for a command for communicating with
'\" \fB\-selectborderwidth \fIpixels\fR
'\" Sets the width of the raised 3-D border to draw around the label of
'\" the selected tab. \fIPixels\fR must be a non-negative value.
-'\" The default value is \f(CW1\fR.
+'\" The default value is \fB1\fR.
.TP
\fB\-selectcommand \fIstring\fR
-Specifies a default Tcl script to be associated with tabs. This
-command is typically invoked when left mouse button is released over
+Specifies a default Tcl script to be invoked when tabs are selected. This
+command is typically invoked when left mouse button is pressed over
the tab. Individual tabs may override this with the tab's
-\fB\-command\fR option. The default value is \f(CW""\fR.
+\fB\-command\fR option. Alternatively, the \fB<<TabsetSelect>>\fR virtual
+event may be bound to instead.
+The default value is \fB""\fR.
.TP
\fB\-selectforeground \fIcolor\fB
Sets the default color of the selected tab's text label.
Individual tabs can override this option by setting the tab's
-\fB\-selectforeground\fR option. The default value is \f(CWblack\fR.
+\fB\-selectforeground\fR option. The default value is \fBblack\fR.
.TP
\fB\-selectpad \fIpixels\fB
Specifies extra padding to be displayed around the selected tab.
-The default value is \f(CW3\fR.
+The default value is \fB3\fR.
+.TP
+\fB\-shadow \fIcolorAndOffset\fR
+Sets the shadow color for the text in all tab labels.
+If an offset isn't given, it defaults to 1. Drop shadows
+are useful when both the foreground and background of the tab
+have similar color intensities.
+If \fIcolor\fR is the empty string, no shadow is drawn.
+The default value is \fB""\fR.
+.TP
+\fB\-shadowcolor \fIcolor\fR
+Sets the folder shadow color.
.TP
\fB\-side \fIside\fB
Specifies the side of the widget to place tabs. The following
-values are valid for \fIside\fR. The default value is \f(CWtop\fR.
+values are valid for \fIside\fR. The default value is \fBtop\fR.
.RS
.TP 1i
-\f(CWtop\fR
+\fBtop\fR
Tabs are drawn along the top.
.TP 1i
-\f(CWleft\fR
+\fBleft\fR
Tabs are drawn along the left side.
.TP 1i
-\f(CWright\fR
+\fBright\fR
Tabs are drawn along the right side.
.TP 1i
-\f(CWboth\fR
+\fBboth\fR
Tabs are drawn along the bottom side.
.RE
.TP
\fB\-slant \fIslant\fR
Specifies if the tabs should be slanted 45 degrees on the left and/or
right sides. The following values are valid for \fIslant\fR. The default
-is \f(CWnone\fR.
+is \fBnone\fR.
.RS
.TP 1i
-\f(CWnone\fR
+\fBnone\fR
Tabs are drawn as a rectangle.
.TP 1i
-\f(CWleft\fR
+\fBleft\fR
The left side of the tab is slanted.
.TP 1i
-\f(CWright\fR
+\fBright\fR
The right side of the tab is slanted.
.TP 1i
-\f(CWboth\fR
+\fBboth\fR
Boths sides of the tab are slanted.
.RE
+.TP
+\fB\-startimage \fIimageName\fR
+Specify an image to be drawn before tabs (ie. on the left if -side = top).
+This is used by
+a binding looking for \fIstartimage\fR from the \fBnearest\fR subcommand.
.TP
\fB\-tabbackground \fIcolor\fR
Sets the default background color of tabs.
\fB\-tabborderwidth \fIpixels\fR
Sets the width of the 3\-D border around the outside edge of the tab. The
\fB\-tabrelief\fR option determines how the border is to be drawn. The
-default is \f(CW2\fR.
+default is \fB2\fR.
.TP
\fB\-tabforeground \fIcolor\fR
Specifies the color to use when displaying a tab's label.
\fB\-tabrelief \fIrelief\fR
Specifies the 3-D effect for both tabs and folders. \fIRelief\fR
specifies how the tabs should appear relative to background of the
-widget; for example, \f(CWraised\fR means the tab should
-appear to protrude. The default is \f(CWraised\fR.
+widget; for example, \fBraised\fR means the tab should
+appear to protrude. The default is \fBraised\fR.
+.TP
+\fB\-tabtile \fIimage\fR
+Specifies tiled background for tabs. The default is \fB""\fR.
.TP
\fB\-takefocus\fR \fIfocus\fR
Provides information used when moving the focus from window to window
via keyboard traversal (e.g., Tab and Shift-Tab). If \fIfocus\fR is
-\f(CW0\fR, this means that this window should be skipped entirely during
-keyboard traversal. \f(CW1\fR means that the this window should always
+\fB0\fR, this means that this window should be skipped entirely during
+keyboard traversal. \fB1\fR means that the this window should always
receive the input focus. An empty value means that the traversal
scripts decide whether to focus on the window.
-The default is \f(CW1\fR.
+The default is \fB1\fR.
.TP
\fB\-tearoff \fIboolean\fR
+Display tearoff.
.TP
\fB\-textside \fIside\fB
If both images and text are specified for a tab, this option determines on
which side of the tab the text is to be displayed. The
-valid sides are \f(CWleft\fR, \f(CWright\fR, \f(CWtop\fR, and
-\f(CWbottom\fR. The default value is \f(CWleft\fR.
+valid sides are \fBleft\fR, \fBright\fR, \fBtop\fR, and
+\fBbottom\fR. The default value is \fBleft\fR.
.TP
\fB\-tiers \fInumber\fB
Specifies the maximum number of tiers to use to display the tabs.
-The default value is \f(CW1\fR.
+The default value is \fB1\fR.
.TP
\fB\-tile \fIimage\fR
-Specifies a tiled background for the widget. If \fIimage\fR isn't
-\f(CW""\fR, the background is tiled using \fIimage\fR.
+Specifies a tiled background for the widget background excluding
+the tabs. If \fIimage\fR isn't
+\fB""\fR, the background is tiled using \fIimage\fR.
Otherwise, the normal background color is drawn (see the
\fB\-background\fR option). \fIImage\fR must be an image created
-using the Tk \fBimage\fR command. The default is \f(CW""\fR.
+using the Tk \fBimage\fR command. The default is \fB""\fR.
+Specifies a tiled background image for the background of the widget.
+This does not include the tabs.
+.TP
+\fB\-transient \fIboolean\fR
+Tearoff window should be transient.
.TP
\fB\-width \fIpixels\fR
Specifies the requested width of the widget. If \fIpixels\fR is
0, then the width of the widget will be calculated based on
the size the tabs and their pages.
-The default is \f(CW0\fR.
+The default is \fB0\fR.
.SH "TAB OPTIONS"
In addition to the \fBconfigure\fR operation, widget configuration
options may also be set by the Tk \fBoption\fR command. The class
-resource name is \f(CWTab\fR.
+resource name is \fBTab\fR.
.CS
option add *Tabset.Tab.Foreground white
option add *Tabset.name.Background blue
This option has effect only if the space in the folder surrounding the
embedded widget is larger than the widget itself. \fIAnchor\fR specifies
how the widget will be positioned in the extra space. For example, if
-\fIanchor\fR is \f(CWcenter\fR then the window is centered in the folder
-; if \fIanchor\fR is \f(CWw\fR then the window will
+\fIanchor\fR is \fBcenter\fR then the window is centered in the folder
+; if \fIanchor\fR is \fBw\fR then the window will
be aligned with the leftmost edge of the folder. The default value is
-\f(CWcenter\fR.
+\fBcenter\fR.
.TP
\fB\-background \fIcolor\fR
Sets the background color for \fInameOrIndex\fR. Setting this option overides the
commands for events in tabs are invoked. Each tag in the list matching
the event sequence will have its Tcl command executed. Implicitly the
name of the tab is always the first tag in the list. The default value is
-\f(CWall\fR.
+\fBall\fR.
.TP
\fB\-command \fIstring\fR
Specifies a Tcl script to be associated with \fInameOrIndex\fR. This
-command is typically invoked when left mouse button is released over
+command is typically invoked when left mouse button is pressed over
the tab. Setting this option overrides the widget's
\fB\-selectcommand\fR option.
.TP
Specifies a string to be associated with \fInameOrIndex\fR.
This value isn't used in the widget code. It may be used in Tcl bindings
to associate extra data (other than the image or text) with the
-tab. The default value is \f(CW""\fR.
+tab. The default value is \fB""\fR.
.TP
\fB\-fill \fIfill\fR
If the space in the folder surrounding the tab's embedded widget is
larger than the widget, then \fIfill\fR indicates if the embedded widget
should be stretched to occupy the extra space. \fIFill\fR is either
-\f(CWnone\fR,
-\f(CWx\fR, \f(CWy\fR, \f(CWboth\fR. For example, if \fIfill\fR is \f(CWx\fR,
-then the widget is stretched horizontally. If \fIfill\fR is \f(CWy\fR,
-the widget is stretched vertically. The default is \f(CWnone\fR.
+\fBnone\fR,
+\fBx\fR, \fBy\fR, \fBboth\fR. For example, if \fIfill\fR is \fBx\fR,
+then the widget is stretched horizontally. If \fIfill\fR is \fBy\fR,
+the widget is stretched vertically. The default is \fBnone\fR.
.TP
\fB\-font \fIfontName\fR
Sets the font for the text in tab labels. If \fIfontName\fR is not
the empty string, this overrides the tabset's \fB\-font\fR option.
-The default value is \f(CW""\fR.
+The default value is \fB""\fR.
.TP
\fB\-foreground \fIcolor\fR
Sets the color of the label for \fInameOrIndex\fR. If \fIcolor\fR
is not the empty string, this overrides the widget's \fB\-tabforeground\fR
-option. The default value is \f(CW""\fR.
+option. The default value is \fB""\fR.
+.TP
+\fB\-hidden \fIbool\fR
+Hide the tab. The default is \fB0\fR. The tab should be changed to not
+be the selected tab before setting it to hidden.
.TP
\fB\-image \fIimageName\fR
Specifies the image to be drawn in label for \fInameOrIndex\fR.
-If \fIimage\fR is \f(CW""\fR, no image will be drawn. Both text and
+If \fIimage\fR is \fB""\fR, no image will be drawn. Both text and
images may be displayed at the same time in tab labels.
-The default value is \f(CW""\fR.
+The default value is \fB""\fR.
+.TP
+\fB\-leftimage \fIimageName\fR
+Specify a second image to be drawn to the left before text/image when
+the widgets -textside = right.
+This image might represent a close icon when used with
+a binding that looks for \fIleftimage\fR from the \fBnearest\fR subcommand.
.TP
\fB\-ipadx \fIpad\fR
Sets the padding to the left and right of the label.
has two elements, the left side of the label is padded by the first
distance and the right side by the second. If \fIpad\fR has just one
distance, both the left and right sides are padded evenly. The
-default value is \f(CW0\fR.
+default value is \fB0\fR.
.TP
\fB\-ipady \fIpad\fR
Sets the padding to the top and bottom of the label.
has two elements, the top of the label is padded by the first
distance and the bottom by the second. If \fIpad\fR has just one
distance, both the top and bottom sides are padded evenly. The
-default value is \f(CW0\fR.
+default value is \fB0\fR.
.TP
\fB\-padx \fIpad\fR
Sets the padding around the left and right of the embedded widget, if
has two elements, the left side of the widget is padded by the first
distance and the right side by the second. If \fIpad\fR has just one
distance, both the left and right sides are padded evenly. The
-default value is \f(CW0\fR.
+default value is \fB0\fR.
.TP
\fB\-pady \fIpad\fR
Sets the padding around the top and bottom of the embedded widget, if
has two elements, the top of the widget is padded by the first
distance and the bottom by the second. If \fIpad\fR has just one
distance, both the top and bottom sides are padded evenly. The
-default value is \f(CW0\fR.
+default value is \fB0\fR.
.TP
\fB\-selectbackground \fIcolor\fR
Sets the color to use when displaying background of the selected
tab. If \fIcolor\fR is not the empty string, this overrides the
widget's \fB\-selectbackground\fR option. The default value is
-\f(CW""\fR.
+\fB""\fR.
.TP
\fB\-shadow \fIcolor\fR
Sets the shadow color for the text in the tab's label. Drop shadows
are useful when both the foreground and background of the tab
have similar color intensities.
If \fIcolor\fR is the empty string, no shadow is drawn.
-The default value is \f(CW""\fR.
+The default value is \fB""\fR.
.TP
\fB\-state \fIstate\fR
-Sets the state of the tab. If \fIstate\fR is \f(CWdisable\fR the
+Sets the state of the tab. If \fIstate\fR is \fBdisable\fR the
text of the tab is drawn as engraved and operations on the tab
(such as \fBinvoke\fR and \fBtab tearoff\fR) are ignored.
-The default is \f(CWnormal\fR.
+The default is \fBnormal\fR.
.TP
\fB\-stipple \fIbitmap\fR
Specifies a stipple pattern to use for the background of the folder
when the window is torn off.
\fIBitmap\fR specifies a bitmap to use as the stipple
-pattern. The default is \f(CWBLT\fR.
+pattern. The default is \fBBLT\fR.
.TP
\fB\-text \fItext\fR
Specifies the text of the tab's label. The exact way the text is
drawn may be affected by other options such as \fB\-state\fR or
\fB\-rotate\fR.
.TP
+\fB\-tornwindow \fItext\fR
+Name of window that was torn off.
+.TP
+\fB\-underline \fInum\fR
+Character to underline in text. Default is -1.
+.TP
\fB\-window \fIpathName\fR
Specifies the widget to be embedded into the tab. \fIPathName\fR must
be a child of the \fBtabset\fR widget. The tabset will "pack" and
-manage the size and placement of \fIpathName\fR. The default value
-is \f(CW""\fR.
+manage the size and placement of \fIpathName\fR.
+The default value is \fB""\fR.
.TP
\fB\-windowheight \fIpixels\fR
Sets the requested height of the page. The page is the area under the
-tab used to display the page contents. If \fIpixels\fR is \f(CW0\fR,
+tab used to display the page contents. If \fIpixels\fR is \fB0\fR,
the maximum height of all embedded tab windows is used. The default
-is \f(CW0\fR.
+is \fB0\fR.
.TP
\fB\-windowwidth \fIpixels\fR
Sets the requested width of the page. The page is the area under the
-tab used to display the page contents. If \fIpixels\fR is \f(CW0\fR,
+tab used to display the page contents. If \fIpixels\fR is \fB0\fR,
the maximum width of all embedded tab windows is used. The default
-is \f(CW0\fR.
+is \fB0\fR.
.SH "DEFAULT BINDINGS"
.PP
BLT automatically generates class bindings that supply tabsets their
default behaviors. The following event sequences are set by default
-for tabsets (via the class bind tag \f(CWTabset\fR):
+for tabsets (via the class bind tag \fBTabset\fR):
.IP \fB<ButtonPress-2>\fR
.IP \fB<B2-Motion>\fR
.IP \fB<ButtonRelease-2>\fR
embedded widget is mapped.
.PP
Each tab, by default, also has a set of bindings (via the tag
-\f(CWall\fR). These bindings may be reset using the tabset's
+\fBall\fR). These bindings may be reset using the tabset's
\fBbind\fR operation.
.IP \fB<Enter>\fR
.IP \fB<Leave>\fR
The \fB\-bindtags\fR option for tabs controls addition tag names that
can be matched. Implicitly the first tag for each tab is its name.
Setting the value of the \fB\-bindtags\fR option doesn't change this.
+.PP
+Note that the <<TabsetTearoff>> virtual event is generated on tearoff.
+and the <<TabsetSelect>> virtual event is generated on selection.
.SH EXAMPLE
You create a tabset widget with the \fBtabset\fR command.
.CS
# Create a new tabset
tabset .ts -relief sunken -borderwidth 2
.CE
-A new Tcl command \f(CW.ts\fR is also created. This command can be
+A new Tcl command \fB.ts\fR is also created. This command can be
used to query and modify the tabset. For example, to change the
default font used by all the tab labels, you use the new command and
the tabset's \fBconfigure\fR operation.
\&.ts insert 0 "f1"
.CE
This inserts the new tab named "f1" into the tabset. The index
-\f(CW0\fR indicates location to insert the new tab. You can also use
-the index \f(CWend\fR to append a tab to the end of the tabset. By
+\fB0\fR indicates location to insert the new tab. You can also use
+the index \fBend\fR to append a tab to the end of the tabset. By
default, the text of the tab is the name of the tab. You can change
this by configuring the \fB\-text\fR option.
.CS
OSDN Git Service
