diff options
Diffstat (limited to 'tk/doc/listbox.n')
| -rw-r--r-- | tk/doc/listbox.n | 51 |
1 files changed, 33 insertions, 18 deletions
diff --git a/tk/doc/listbox.n b/tk/doc/listbox.n index 424e8d473d9..ad86edf567c 100644 --- a/tk/doc/listbox.n +++ b/tk/doc/listbox.n @@ -8,7 +8,7 @@ '\" RCS: @(#) $Id$ '\" .so man.macros -.TH listbox n 8.0 Tk "Tk Built-In Commands" +.TH listbox n 8.4 Tk "Tk Built-In Commands" .BS '\" Note: do not modify the .SH NAME line immediately below! .SH NAME @@ -16,29 +16,45 @@ listbox \- Create and manipulate listbox widgets .SH SYNOPSIS \fBlistbox\fR \fIpathName \fR?\fIoptions\fR? .SO -\-background \-foreground \-relief \-takefocus -\-borderwidth \-height \-listvar \-selectbackground \-width -\-cursor \-highlightbackground \-selectborderwidth \-xscrollcommand -\-exportselection \-highlightcolor \-selectforeground \-yscrollcommand -\-font \-highlightthickness \-setgrid +\-activestyle \-height \-selectforeground +\-background \-highlightbackground \-setgrid +\-borderwidth \-highlightcolor \-state +\-cursor \-highlightthickness \-takefocus +\-disabledforeground \-relief \-width +\-exportselection \-selectbackground \-xscrollcommand +\-font \-selectborderwidth \-yscrollcommand +\-foreground .SE .SH "WIDGET-SPECIFIC OPTIONS" +.VS 8.4 +.OP \-activestyle activeStyle ActiveStyle +Specifies the style in which to draw the active element. This must be +one of \fBdotbox\fR (show a focus ring around the active element), +\fBnone\fR (nospecial indication of active element) or +\fBunderline\fR (underline the active element). +The default is \fBunderline\fR. +.VS 8.4 .OP \-height height Height Specifies the desired height for the window, in lines. If zero or less, then the desired height for the window is made just large enough to hold all the elements in the listbox. -.OP \-listvar listVariable Variable -Specifies the name of a variable. The value of the variable is a list -to be displayed inside the widget; if the variable value changes -then the widget will automatically update itself to reflect the new value. -Attempts to assign a bad list value to a variable in use as a listvar -will cause an error. Attempts to unset a variable in use as a listvar -will fail but will not generate an error. +.OP \-listvariable listVariable Variable +Specifies the name of a variable. The value of the variable is a list to +be displayed inside the widget; if the variable value changes then the +widget will automatically update itself to reflect the new value. Attempts +to assign a variable with an invalid list value to \fB\-listvariable\fR +will cause an error. Attempts to unset a variable in use as a +\fB\-listvariable\fR will fail but will not generate an error. .OP \-selectmode selectMode SelectMode Specifies one of several styles for manipulating the selection. The value of the option may be arbitrary, but the default bindings expect it to be either \fBsingle\fR, \fBbrowse\fR, \fBmultiple\fR, or \fBextended\fR; the default value is \fBbrowse\fR. +.OP \-state state State +Specifies one of two states for the listbox: \fBnormal\fR or \fBdisabled\fR. +If the listbox is disabled then items may not be inserted or deleted, +items are drawn in the \fB-disabledforeground\fR color, and selection +cannot be modified and is not shown (though selection information is retained). .OP \-width width Width Specifies the desired width for the window in characters. If the font doesn't have a uniform width then the width of the @@ -93,8 +109,8 @@ to the first element in the listbox. .TP 12 \fBactive\fR Indicates the element that has the location cursor. This element -will be displayed with an underline when the listbox has the -keyboard focus, and it is specified with the \fBactivate\fR +will be displayed as specified by \fB\-activestyle\fR when the listbox +has the keyboard focus, and it is specified with the \fBactivate\fR widget command. .TP 12 \fBanchor\fR @@ -138,8 +154,8 @@ Sets the active element to the one indicated by \fIindex\fR. If \fIindex\fR is outside the range of elements in the listbox then the closest element is activated. .VE -The active element is drawn with an underline when the widget -has the input focus, and its index may be retrieved with the +The active element is drawn as specified by \fB\-activestyle\fR when the +widget has the input focus, and its index may be retrieved with the index \fBactive\fR. .TP \fIpathName \fBbbox\fR \fIindex\fR @@ -538,4 +554,3 @@ individual widgets or by redefining the class bindings. .SH KEYWORDS listbox, widget - |