diff options
Diffstat (limited to 'doc/ttk_widget.n')
| -rw-r--r-- | doc/ttk_widget.n | 86 |
1 files changed, 49 insertions, 37 deletions
diff --git a/doc/ttk_widget.n b/doc/ttk_widget.n index 3d93e74..ffc5979 100644 --- a/doc/ttk_widget.n +++ b/doc/ttk_widget.n @@ -4,18 +4,16 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_widget.n,v 1.3.2.2 2007/10/27 04:23:15 dgp Exp $ +'\" RCS: @(#) $Id: ttk_widget.n,v 1.3.2.3 2007/11/01 16:37:16 dgp Exp $ '\" .so man.macros -.TH ttk_widget n 8.5 Tk "Tk Themed Widget" +.TH ttk::widget n 8.5 Tk "Tk Themed Widget" .BS .SH NAME -ttk_widget \- Standard options and commands supported by Tk themed widgets +ttk::widget \- Standard options and commands supported by Tk themed widgets .BE - .SH DESCRIPTION This manual describes common widget options and commands. - .SH "STANDARD OPTIONS" The following options are supported by all Tk themed widgets: .OP \-class undefined undefined @@ -41,7 +39,6 @@ or the empty string. See \fIoptions(n)\fR in the Tk reference manual for the full description. .OP \-style style Style May be used to specify a custom widget style. - .SH "SCROLLABLE WIDGET OPTIONS" .PP The following options are supported by widgets that @@ -49,7 +46,8 @@ are controllable by a scrollbar. See \fIscrollbar(n)\fR for more information .OP \-xscrollcommand xScrollCommand ScrollCommand A command prefix, used to communicate with horizontal scrollbars. -.br +.RS +.PP When the view in the widget's window changes, the widget will generate a Tcl command by concatenating the scroll command and two numbers. @@ -59,27 +57,30 @@ and 1 indicates the end. The first fraction indicates the first information in the widget that is visible in the window, and the second fraction indicates the information just after the last portion that is visible. -.br +.PP Typically the \fBxScrollCommand\fR option consists of the path name -of a \fBscrollbar\fR widget followed by ``set'', e.g. ``.x.scrollbar set''. +of a \fBscrollbar\fR widget followed by +.QW set , +e.g. +.QW ".x.scrollbar set" . This will cause the scrollbar to be updated whenever the view in the window changes. -.br +.PP If this option is set to the empty string (the default), then no command is be executed. +.RE .OP \-yscrollcommand yScrollCommand ScrollCommand A command prefix, used to communicate with vertical scrollbars. -See the description of \fB-xscrollcommand\fR above for details. - +See the description of \fB\-xscrollcommand\fR above for details. .SH "LABEL OPTIONS" The following options are supported by labels, buttons, and other button-like widgets: .OP \-text text Text Specifies a text string to be displayed inside the widget -(unless overridden by \fB-textvariable\fR). +(unless overridden by \fB\-textvariable\fR). .OP \-textvariable textVariable Variable Specifies the name of variable whose value will be used -in place of the \fB-text\fR resource. +in place of the \fB\-text\fR resource. .OP \-underline underline Underline If set, specifies the integer index (0-based) of a character to underline in the text string. @@ -94,7 +95,7 @@ the widget is in a particular state or combination of states. All images in the list should have the same size. .OP \-compound compound Compound Specifies how to display the image relative to the text, -in the case both \fB-text\fR and \fB-image\fR are present. +in the case both \fB\-text\fR and \fB\-image\fR are present. Valid values are: .RS .IP text @@ -116,15 +117,14 @@ If greater than zero, specifies how much space, in character widths, to allocate for the text label. If less than zero, specifies a minimum width. If zero or unspecified, the natural width of the text label is used. - .SH "COMPATIBILITY OPTIONS" .OP \-state state State May be set to \fBnormal\fR or \fBdisabled\fR to control the \fBdisabled\fR state bit. -This is a ``write-only'' option: setting it changes the -widget state, but the \fBstate\fR widget command does -not affect the state option. - +This is a +.QW write-only +option: setting it changes the widget state, but the \fBstate\fR +widget command does not affect the state option. .SH COMMANDS .TP \fIpathName \fBcget\fR \fIoption\fR @@ -174,24 +174,37 @@ Widget state flags include: .TP \fBactive\fR The mouse cursor is over the widget -and pressing a mouse button will cause some action to occur. -(aka "prelight" (Gnome), "hot" (Windows), "hover"). +and pressing a mouse button will cause some action to occur. (aka +.QW prelight +(Gnome), +.QW hot +(Windows), +.QW hover ). .TP \fBdisabled\fR -Widget is disabled under program control -(aka "unavailable", "inactive") +Widget is disabled under program control (aka +.QW unavailable , +.QW inactive ) .TP \fBfocus\fR Widget has keyboard focus .TP \fBpressed\fR -Widget is being pressed (aka "armed" in Motif). +Widget is being pressed (aka +.QW armed +in Motif). .TP \fBselected\fR -"On", "true", or "current" for things like checkbuttons and radiobuttons. +.QW On , +.QW true , +or +.QW current +for things like checkbuttons and radiobuttons. .TP \fBbackground\fR -Windows and the Mac have a notion of an "active" or foreground window. +Windows and the Mac have a notion of an +.QW active +or foreground window. The \fBbackground\fR state is set for widgets in a background window, and cleared for those in the foreground window. .TP @@ -200,9 +213,11 @@ Widget should not allow user modification. .TP \fBalternate\fR A widget-specific alternate display format. -For example, used for checkbuttons and radiobuttons -in the "tristate" or "mixed" state, -and for buttons with \fB-default active\fR. +For example, used for checkbuttons and radiobuttons in the +.QW tristate +or +.QW mixed +state, and for buttons with \fB\-default active\fR. .TP \fBinvalid\fR The widget's value is invalid. @@ -212,23 +227,20 @@ entry widget value failed validation.) A \fIstate specification\fR or \fIstateSpec\fR is a list of state names, optionally prefixed with an exclamation point (!) indicating that the bit is off. - .SH EXAMPLES .CS set b [ttk::button .b] # Disable the widget: -$b state disabled +$b state disabled # Invoke the widget only if it is currently pressed and enabled: -$b instate {pressed !disabled} { .b invoke } +$b instate {pressed !disabled} { .b invoke } # Reenable widget: -$b state !disabled +$b state !disabled .CE - .SH "SEE ALSO" -ttk_intro(n), style(n) - +ttk::intro(n), style(n) .SH KEYWORDS state, configure, option |