diff options
| -rw-r--r-- | doc/canvas.n | 21 | ||||
| -rw-r--r-- | doc/getOpenFile.n | 5 | ||||
| -rw-r--r-- | doc/text.n | 6 | ||||
| -rw-r--r-- | doc/ttk_button.n | 32 | ||||
| -rw-r--r-- | doc/ttk_checkbutton.n | 32 | ||||
| -rw-r--r-- | doc/ttk_combobox.n | 9 | ||||
| -rw-r--r-- | doc/ttk_entry.n | 56 | ||||
| -rw-r--r-- | doc/ttk_frame.n | 22 | ||||
| -rw-r--r-- | doc/ttk_image.n | 7 | ||||
| -rw-r--r-- | doc/ttk_intro.n | 43 | ||||
| -rw-r--r-- | doc/ttk_label.n | 18 | ||||
| -rw-r--r-- | doc/ttk_labelframe.n | 40 | ||||
| -rw-r--r-- | doc/ttk_menubutton.n | 13 | ||||
| -rw-r--r-- | doc/ttk_notebook.n | 179 | ||||
| -rw-r--r-- | doc/ttk_panedwindow.n | 11 | ||||
| -rw-r--r-- | doc/ttk_progressbar.n | 8 | ||||
| -rw-r--r-- | doc/ttk_radiobutton.n | 28 | ||||
| -rw-r--r-- | doc/ttk_scrollbar.n | 26 | ||||
| -rw-r--r-- | doc/ttk_separator.n | 10 | ||||
| -rw-r--r-- | doc/ttk_sizegrip.n | 16 | ||||
| -rw-r--r-- | doc/ttk_style.n | 12 | ||||
| -rw-r--r-- | doc/ttk_treeview.n | 40 | ||||
| -rw-r--r-- | doc/ttk_widget.n | 23 | ||||
| -rw-r--r-- | doc/wm.n | 21 |
24 files changed, 317 insertions, 361 deletions
diff --git a/doc/canvas.n b/doc/canvas.n index 7a6666b..b9b2320 100644 --- a/doc/canvas.n +++ b/doc/canvas.n @@ -6,7 +6,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: canvas.n,v 1.25 2007/05/25 22:15:42 dkf Exp $ +'\" RCS: @(#) $Id: canvas.n,v 1.26 2007/10/23 15:44:35 dkf Exp $ '\" .so man.macros .TH canvas n 8.3 Tk "Tk Built-In Commands" @@ -1026,7 +1026,6 @@ the coordinates of the item. .PP Many items share a common set of options. These options are explained here, and then referred to be each widget type for brevity. -.PP .TP \fB\-dash \fIpattern\fR .TP @@ -1157,7 +1156,7 @@ pairs, each of which sets one of the configuration options for the item. These same \fIoption\fR\-\fIvalue\fR pairs may be used in \fBitemconfigure\fR widget commands to change the item's configuration. -.br +.PP The following standard options are supported by arcs: .CS \-dash @@ -1227,7 +1226,7 @@ pairs, each of which sets one of the configuration options for the item. These same \fIoption\fR\-\fIvalue\fR pairs may be used in \fBitemconfigure\fR widget commands to change the item's configuration. -.br +.PP The following standard options are supported by bitmaps: .CS \-state @@ -1291,7 +1290,7 @@ pairs, each of which sets one of the configuration options for the item. These same \fIoption\fR\-\fIvalue\fR pairs may be used in \fBitemconfigure\fR widget commands to change the item's configuration. -.br +.PP The following standard options are supported by images: .CS \-state @@ -1336,7 +1335,7 @@ pairs, each of which sets one of the configuration options for the item. These same \fIoption\fR\-\fIvalue\fR pairs may be used in \fBitemconfigure\fR widget commands to change the item's configuration. -.br +.PP The following standard options are supported by lines: .CS \-dash @@ -1446,7 +1445,7 @@ pairs, each of which sets one of the configuration options for the item. These same \fIoption\fR\-\fIvalue\fR pairs may be used in \fBitemconfigure\fR widget commands to change the item's configuration. -.br +.PP The following standard options are supported by ovals: .CS \-dash @@ -1493,7 +1492,7 @@ pairs, each of which sets one of the configuration options for the item. These same \fIoption\fR\-\fIvalue\fR pairs may be used in \fBitemconfigure\fR widget commands to change the item's configuration. -.br +.PP The following standard options are supported by polygons: .CS \-dash @@ -1585,7 +1584,7 @@ pairs, each of which sets one of the configuration options for the item. These same \fIoption\fR\-\fIvalue\fR pairs may be used in \fBitemconfigure\fR widget commands to change the item's configuration. -.br +.PP The following standard options are supported by rectangles: .CS \-dash @@ -1633,7 +1632,7 @@ pairs, each of which sets one of the configuration options for the item. These same \fIoption\fR\-\fIvalue\fR pairs may be used in \fBitemconfigure\fR widget commands to change the item's configuration. -.br +.PP The following standard options are supported by text items: .CS \-fill @@ -1714,7 +1713,7 @@ pairs, each of which sets one of the configuration options for the item. These same \fIoption\fR\-\fIvalue\fR pairs may be used in \fBitemconfigure\fR widget commands to change the item's configuration. -.br +.PP The following standard options are supported by window items: .CS \-state diff --git a/doc/getOpenFile.n b/doc/getOpenFile.n index 7e8469a..0c07e5f 100644 --- a/doc/getOpenFile.n +++ b/doc/getOpenFile.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: getOpenFile.n,v 1.15 2005/07/06 22:17:06 hobbs Exp $ +'\" RCS: @(#) $Id: getOpenFile.n,v 1.16 2007/10/23 15:44:35 dkf Exp $ '\" .so man.macros .TH tk_getOpenFile n 4.2 Tk "Tk Built-In Commands" @@ -13,9 +13,10 @@ .SH NAME tk_getOpenFile, tk_getSaveFile \- pop up a dialog box for the user to select a file to open or save. .SH SYNOPSIS +.nf \fBtk_getOpenFile \fR?\fIoption value ...\fR? -.br \fBtk_getSaveFile \fR?\fIoption value ...\fR? +.fi .BE .SH DESCRIPTION @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: text.n,v 1.44 2007/10/16 15:13:18 dkf Exp $ +'\" RCS: @(#) $Id: text.n,v 1.45 2007/10/23 15:44:35 dkf Exp $ '\" .so man.macros .TH text n 8.5 Tk "Tk Built-In Commands" @@ -1458,11 +1458,13 @@ arguments, and the section on \fIpathName \fBdelete\fR for an explanation of the handling of the indices. If \fIindex2\fR corresponds to an index earlier in the text than \fIindex1\fR, an error will be generated. -.br +.RS +.PP The deletion and insertion are arranged so that no unnecessary scrolling of the window or movement of insertion cursor occurs. In addition the undo/redo stack are correctly modified, if undo operations are active in the text widget. The command returns an empty string. +.RE .VE 8.5 .TP \fIpathName \fBscan\fR \fIoption args\fR diff --git a/doc/ttk_button.n b/doc/ttk_button.n index ce1771b..df926c9 100644 --- a/doc/ttk_button.n +++ b/doc/ttk_button.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_button.n,v 1.3 2006/12/13 23:04:32 hobbs Exp $ +'\" RCS: @(#) $Id: ttk_button.n,v 1.4 2007/10/23 15:44:35 dkf Exp $ '\" .so man.macros .TH ttk_button n 8.5 Tk "Tk Themed Widget" @@ -20,11 +20,11 @@ ttk_button \- Widget that issues a command when pressed A \fBttk::button\fR widget displays a textual label and/or image, and evaluates a command when pressed. .SO -\-class \-compound \-cursor \-image -\-state \-style \-takefocus \-text -\-textvariable \-underline \-width +\-class \-compound \-cursor +\-image \-state \-style +\-takefocus \-text \-textvariable +\-underline \-width .SE - .SH "WIDGET-SPECIFIC OPTIONS" .OP \-command command Command A script to evaluate when the widget is invoked. @@ -36,9 +36,11 @@ In a dialog box, one button may be designated the "default" button \fBnormal\fR means that it may become the default button, and \fBdisabled\fR means that it is not defaultable. The default is \fBnormal\fR. -.br +.RS +.PP Depending on the theme, the default button may be displayed with an extra highlight ring, or with a different border color. +.RE .OP \-width width Width If greater than zero, specifies how much space, in character widths, to allocate for the text label. @@ -46,14 +48,13 @@ If less than zero, specifies a minimum width. If zero or unspecified, the natural width of the text label is used. Note that some themes may specify a non-zero \fB-width\fR in the style. -'\" Not documented -- may go away -'\" .OP \-padding padding Padding -'\" .OP \-foreground foreground Foreground -'\" .OP \-font font Font -'\" .OP \-anchor anchor Anchor -'\" .OP \-padding padding Padding -'\" .OP \-relief relief Relief - +.\" Not documented -- may go away +.\" .OP \-padding padding Padding +.\" .OP \-foreground foreground Foreground +.\" .OP \-font font Font +.\" .OP \-anchor anchor Anchor +.\" .OP \-padding padding Padding +.\" .OP \-relief relief Relief .SH "WIDGET COMMAND" .TP \fIpathName \fBinvoke\fR @@ -67,7 +68,6 @@ Invokes the command associated with the button. .TP \fIpathName \fBstate\fR ?\fIstateSpec\fR? See \fIttk_widget(n)\fR - .SH "COMPATIBILITY OPTIONS" .OP \-state state State May be set to \fBnormal\fR or \fBdisabled\fR @@ -75,9 +75,7 @@ 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. - .SH "SEE ALSO" ttk_widget(n), button(n) - .SH "KEYWORDS" widget, button, default, command diff --git a/doc/ttk_checkbutton.n b/doc/ttk_checkbutton.n index cd48748..018187c 100644 --- a/doc/ttk_checkbutton.n +++ b/doc/ttk_checkbutton.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_checkbutton.n,v 1.4 2007/05/03 23:55:29 dkf Exp $ +'\" RCS: @(#) $Id: ttk_checkbutton.n,v 1.5 2007/10/23 15:44:35 dkf Exp $ '\" .so man.macros .TH ttk_checkbutton n 8.5 Tk "Tk Themed Widget" @@ -21,24 +21,23 @@ A \fBttk::checkbutton\fR widget is used to show or change a setting. It has two states, selected and deselected. The state of the checkbutton may be linked to a Tcl variable. .SO -\-class \-compound \-cursor \-image -\-state \-style \-takefocus \-text -\-textvariable \-underline \-width +\-class \-compound \-cursor +\-image \-state \-style +\-takefocus \-text \-textvariable +\-underline \-width .SE - .SH "WIDGET-SPECIFIC OPTIONS" .OP \-command command Command A Tcl script to execute whenever the widget is invoked. .OP \-offvalue offValue OffValue -The value to store in the associated \fI-variable\fR +The value to store in the associated \fB\-variable\fR when the widget is deselected. Defaults to \fB0\fR. .OP \-onvalue onValue OnValue -The value to store in the associated \fI-variable\fR +The value to store in the associated \fB\-variable\fR when the widget is selected. Defaults to \fB1\fR. .OP \-variable variable Variable The name of a global variable whose value is linked to the widget. Defaults to the widget pathname if not specified. - .SH "WIDGET COMMAND" In addition to the standard \fBcget\fR, \fBconfigure\fR, \fBinstate\fR, and \fBstate\fR @@ -47,27 +46,24 @@ widget commands: .TP \fIpathname\fR invoke Toggles between the selected and deselected states -and evaluates the associated \fI-command\fR. -If the widget is currently selected, sets the \fI-variable\fR -to the \fI-offvalue\fR and deselects the widget; -otherwise, sets the \fI-variable\fR to the \fI-onvalue\fR -Returns the result of the \fI-command\fR. +and evaluates the associated \fB\-command\fR. +If the widget is currently selected, sets the \fB\-variable\fR +to the \fB\-offvalue\fR and deselects the widget; +otherwise, sets the \fB\-variable\fR to the \fB\-onvalue\fR +Returns the result of the \fB\-command\fR. .\" Missing: select, deselect, toggle .\" Are these useful? They don't invoke the -command .\" Missing: flash. This is definitely not useful. - .SH "WIDGET STATES" The widget does not respond to user input if the \fBdisabled\fR state is set. The widget sets the \fBselected\fR state whenever -the linked \fB-variable\fR is set to the widget's \fB-onvalue\fR, +the linked \fB\-variable\fR is set to the widget's \fB\-onvalue\fR, and clears it otherwise. The widget sets the \fBalternate\fR state whenever the -linked \fB-variable\fR is unset. +linked \fB\-variable\fR is unset. (The \fBalternate\fR state may be used to indicate a ``tri-state'' or ``indeterminate'' selection.) - .SH "SEE ALSO" ttk_widget(n), ttk_radiobutton(n), checkbutton(n) - .SH "KEYWORDS" widget, button, toggle, check, option diff --git a/doc/ttk_combobox.n b/doc/ttk_combobox.n index 598ea0f..d6baf8d 100644 --- a/doc/ttk_combobox.n +++ b/doc/ttk_combobox.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_combobox.n,v 1.6 2007/10/22 14:33:13 dkf Exp $ +'\" RCS: @(#) $Id: ttk_combobox.n,v 1.7 2007/10/23 15:44:35 dkf Exp $ '\" .so man.macros .TH ttk_combobox n 8.5 Tk "Tk Themed Widget" @@ -21,10 +21,10 @@ A \fBttk::combobox\fR combines a text field with a pop-down list of values; the user may select the value of the text field from among the values in the list. .SO -\-class \-cursor \-takefocus \-style +\-class \-cursor \-takefocus +\-style .SE .\" ALSO: Other entry widget options - .SH "WIDGET-SPECIFIC OPTIONS" .OP \-exportselection exportSelection ExportSelection Boolean value. If set, the widget selection is linked to the X selection. @@ -52,7 +52,6 @@ Specifies the list of values to display in the drop-down listbox. Specifies an integer value indicating the desired width of the entry window, in average-size characters of the widget's font. .BE - .SH "WIDGET COMMAND" .TP \fIpathName \fBcget\fR \fIoption\fR @@ -100,12 +99,10 @@ bbox delete icursor index insert selection xview .DE - .SH "VIRTUAL EVENTS" The combobox widget generates a \fB<<ComboboxSelected>>\fR virtual event when the user selects an element from the list of values. This event is generated after the listbox is unposted. - .SH "SEE ALSO" ttk_widget(n), ttk_entry(n) .SH KEYWORDS diff --git a/doc/ttk_entry.n b/doc/ttk_entry.n index 66a3651..5275004 100644 --- a/doc/ttk_entry.n +++ b/doc/ttk_entry.n @@ -7,7 +7,7 @@ '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" '\" SOURCE: entry.n, r1.12 -'\" RCS: @(#) $Id: ttk_entry.n,v 1.3 2006/12/13 23:04:33 hobbs Exp $ +'\" RCS: @(#) $Id: ttk_entry.n,v 1.4 2007/10/23 15:44:35 dkf Exp $ '\" .so man.macros .TH ttk_entry n 8.5 Tk "Tk Themed Widget" @@ -24,14 +24,13 @@ ttk_entry \- Editable text field widget An \fBttk::entry\fR widget displays a one-line text string and allows that string to be edited by the user. The value of the string may be linked to a Tcl variable -with the \fB-textvariable\fR option. +with the \fB\-textvariable\fR option. Entry widgets support horizontal scrolling with the -standard \fB-xscrollcommand\fR option and \fBxview\fR widget command. +standard \fB\-xscrollcommand\fR option and \fBxview\fR widget command. .SO -\-class \-cursor \-style \-takefocus -\-xscrollcommand +\-class \-cursor \-style +\-takefocus \-xscrollcommand .SE - .SH "WIDGET-SPECIFIC OPTIONS" .OP \-exportselection exportSelection ExportSelection A boolean value specifying whether or not @@ -88,8 +87,6 @@ Specifies an integer value indicating the desired width of the entry window, in average-size characters of the widget's font. .\" Not in ttk: If the value is less than or equal to zero, the widget picks a .\" Not in ttk: size just large enough to hold its current text. -.BE - .SH NOTES A portion of the entry may be selected as described below. If an entry is exporting its selection (see the \fBexportSelection\fR @@ -107,7 +104,6 @@ may be used to change the view in the window. Entries use the standard \fBxScrollCommand\fR mechanism for interacting with scrollbars (see the description of the \fBxScrollCommand\fR option for details). - .SH "INDICES" Many of the \fBentry\fR widget commands take one or more indices as arguments. An index specifies a particular character in the entry's @@ -138,7 +134,6 @@ entry window. Abbreviations may be used for any of the forms above, e.g. ``\fBe\fR'' or ``\fBsel.f\fR''. In general, out-of-range indices are automatically rounded to the nearest legal value. - .SH "WIDGET COMMAND" .PP The following commands are possible for entry widgets: @@ -220,7 +215,7 @@ See \fIttk_widget(n)\fR. .TP \fIpathName \fBvalidate\fR Force revalidation, independent of the conditions specified -by the \fB-validate\fR option. +by the \fB\-validate\fR option. Returns 0 if validation fails, 1 if it succeeds. Sets or clears the \fBinvalid\fR state accordingly. .TP @@ -262,19 +257,18 @@ If \fInumber\fR is negative then characters farther to the left become visible; if it is positive then characters farther to the right become visible. .RE - .SH VALIDATION -The \fB-validate\fR, \fB-validatecommand\fR, and \fB-invalidcommand\fR +The \fB\-validate\fR, \fB\-validatecommand\fR, and \fB\-invalidcommand\fR options are used to enable entry widget validation. .SS "VALIDATION MODES" There are two main validation modes: \fIprevalidation\fR, -in which the \fB-validatecommand\fR is evaluated prior to each edit +in which the \fB\-validatecommand\fR is evaluated prior to each edit and the return value is used to determine whether to accept or reject the change; -and \fIrevalidation\fR, in which the \fB-validatecommand\fR is +and \fIrevalidation\fR, in which the \fB\-validatecommand\fR is evaluated to determine whether the current value is valid. .PP -The \fB-validate\fR option determines when validation occurs; +The \fB\-validate\fR option determines when validation occurs; it may be set to any of the following values: .IP \fBnone\fR Default. This means validation will only occur when @@ -293,22 +287,22 @@ The entry is revalidated when the entry loses focus. .IP \fBall\fR Validation is performed for all above conditions. .PP -The \fB-invalidcommand\fR is evaluated whenever -the \fB-validatecommand\fR returns a false value. +The \fB\-invalidcommand\fR is evaluated whenever +the \fB\-validatecommand\fR returns a false value. .PP -The \fB-validatecommand\fR and \fB-invalidcommand\fR +The \fB\-validatecommand\fR and \fB\-invalidcommand\fR may modify the entry widget's value via the widget \fBinsert\fR or \fBdelete\fR commands, -or by setting the linked \fB-textvariable\fR. +or by setting the linked \fB\-textvariable\fR. If either does so during prevalidation, then the edit is rejected -regardless of the value returned by the \fB-validatecommand\fR. +regardless of the value returned by the \fB\-validatecommand\fR. .PP -If \fB-validatecommand\fR is empty (the default), +If \fB\-validatecommand\fR is empty (the default), validation always succeeds. .SS "VALIDATION SCRIPT SUBSTITUTIONS" It is possible to perform percent substitutions on the -\fB-validatecommand\fR and \fBinvalidCommand\fR, +\fB\-validatecommand\fR and \fBinvalidCommand\fR, just as in a \fBbind\fR script. The following substitutions are recognized: .IP \fB%d\fR @@ -325,7 +319,7 @@ The current value of entry prior to editing. .IP \fB%S\fR The text string being inserted/deleted, if any, {} otherwise. .IP \fB%v\fR -The current value of the \fB-validate\fR option. +The current value of the \fB\-validate\fR option. .IP \fB%V\fR The validation condition that triggered the callback (\fBkey\fR, \fBfocusin\fR, \fBfocusout\fR, or \fBforced\fR). @@ -334,18 +328,17 @@ The name of the entry widget. .SS "DIFFERENCES FROM TK ENTRY WIDGET VALIDATION" .IP \(bu The standard Tk entry widget automatically disables validation -(by setting \fB-validate\fR to \fBnone\fR) -if the \fB-validatecommand\fR or \fB-invalidcommand\fR modifies +(by setting \fB\-validate\fR to \fBnone\fR) +if the \fB\-validatecommand\fR or \fB\-invalidcommand\fR modifies the entry's value. The Tk themed entry widget only disables validation if one -of the validation scripts raises an error, or if \fB-validatecommand\fR +of the validation scripts raises an error, or if \fB\-validatecommand\fR does not return a valid boolean value. (Thus, it is not necessary to reenable validation after modifying the entry value in a validation script). .IP \(bu The standard entry widget invokes validation whenever the linked -\fB-textvariable\fR is modified; the Tk themed entry widget does not. - +\fB\-textvariable\fR is modified; the Tk themed entry widget does not. .SH "DEFAULT BINDINGS" The entry widget's default bindings enable the following behavior. In the descriptions below, ``word'' refers to a contiguous group @@ -425,7 +418,6 @@ Control-d deletes the character to the right of the insert cursor. .IP \(bu Control-k deletes all the characters to the right of the insertion cursor. - .SH "WIDGET STATES" In the \fBdisabled\fR state, the entry cannot be edited and the text cannot be selected. @@ -436,7 +428,7 @@ the entry cannot be edited The \fBdisabled\fR state is the same as \fBreadonly\fR, and in addition text cannot be selected. .PP -Note that changes to the linked \fB-textvariable\fR will +Note that changes to the linked \fB\-textvariable\fR will still be reflected in the entry, even if it is disabled or readonly. .PP Typically, the text is "grayed-out" in the \fBdisabled\fR state, @@ -444,9 +436,7 @@ and a different background is used in the \fBreadonly\fR state. .PP The entry widget sets the \fBinvalid\fR state if revalidation fails, and clears it whenever validation succeeds. - .SH "SEE ALSO" ttk_widget(n), entry(n) - .SH KEYWORDS entry, widget, text field diff --git a/doc/ttk_frame.n b/doc/ttk_frame.n index 5c33aba..32be4d5 100644 --- a/doc/ttk_frame.n +++ b/doc/ttk_frame.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_frame.n,v 1.3 2006/12/13 23:04:33 hobbs Exp $ +'\" RCS: @(#) $Id: ttk_frame.n,v 1.4 2007/10/23 15:44:35 dkf Exp $ '\" .so man.macros .TH ttk_frame n 8.5 Tk "Tk Themed Widget" @@ -20,39 +20,35 @@ ttk_frame \- Simple container widget A \fBttk::frame\fR widget is a container, used to group other widgets together. .SO -\-class \-cursor \-takefocus \-style +\-class \-cursor \-takefocus +\-style .SE - .SH "WIDGET-SPECIFIC OPTIONS" -.OP -borderwidth borderWidth BorderWidth +.OP \-borderwidth borderWidth BorderWidth The desired width of the widget border. Defaults to 0. -.OP -relief relief Relief +.OP \-relief relief Relief One of the standard Tk border styles: \fBflat\fR, \fBgroove\fR, \fBraised\fR, \fBridge\fR, \fBsolid\fR, or \fBsunken\fR. Defaults to \fBflat\fR. -.OP -padding padding Padding +.OP \-padding padding Padding Additional padding to include inside the border. -.OP -width width Width +.OP \-width width Width If specified, the widget's requested width in pixels. -.OP -height height Height +.OP \-height height Height If specified, the widget's requested height in pixels. - .SH "WIDGET COMMAND" Supports the standard widget commands \fBconfigure\fR, \fBcget\fR, \fBinstate\fR, and \fBstate\fR; see \fIttk_widget(n)\fR. - .SH "NOTES" Note that if the \fBpack\fR, \fBgrid\fR, or other geometry managers are used to manage the children of the \fBframe\fR, by the GM's requested size will normally take precedence -over the \fBframe\fR widget's \fB-width\fR and \fB-height\fR options. +over the \fBframe\fR widget's \fB\-width\fR and \fB\-height\fR options. [\fBpack propagate\fR] and [\fBgrid propagate\fR] can be used to change this. - .SH "SEE ALSO" ttk_widget(n), ttk_labelframe(n), frame(n) - .SH "KEYWORDS" widget, frame, container diff --git a/doc/ttk_image.n b/doc/ttk_image.n index c308533..6eebf64 100644 --- a/doc/ttk_image.n +++ b/doc/ttk_image.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_image.n,v 1.7 2007/10/22 14:33:13 dkf Exp $ +'\" RCS: @(#) $Id: ttk_image.n,v 1.8 2007/10/23 15:44:36 dkf Exp $ '\" .so man.macros .TH ttk_image n 8.5 Tk "Tk Themed Widget" @@ -22,7 +22,6 @@ of one or more elements. The first element is the default image name. The rest of the list is a sequence of \fIstatespec / value\fR pairs specifying other images to use when the element is in a particular state or combination of states. - .SH OPTIONS Valid \fIoptions\fR are: .TP @@ -50,7 +49,6 @@ zero or more characters "n", "s", "w", or "e". . Specifies a minimum width for the element. If less than zero, the base image's width is used as a default. - .SH "IMAGE STRETCHING" If the element's allocated parcel is larger than the image, the image will be placed in the parcel based on the \fB\-sticky\fR option. If the image needs to @@ -60,7 +58,6 @@ ns\fR), subregions of the image are replicated to fill the parcel based on the four fixed corners, top and left edges (which may be tiled horizontally), left and right edges (which may be tiled vertically), and the central area (which may be tiled in both directions). - .SH "EXAMPLE" .CS set img1 [image create photo -file button.png] @@ -70,9 +67,7 @@ style element create Button.button image \e [list $img1 pressed $img2 active $img3] \e -border {2 4} -sticky we .CE - .SH "SEE ALSO" image(n), photo(n) - .SH KEYWORDS pixmap theme, image diff --git a/doc/ttk_intro.n b/doc/ttk_intro.n index 38afd18..4a96e66 100644 --- a/doc/ttk_intro.n +++ b/doc/ttk_intro.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_intro.n,v 1.4 2007/10/22 14:33:13 dkf Exp $ +'\" RCS: @(#) $Id: ttk_intro.n,v 1.5 2007/10/23 15:44:36 dkf Exp $ '\" .so man.macros .TH ttk_intro n 8.5 Tk "Tk Themed Widget" @@ -20,7 +20,6 @@ below. The basic idea is to separate, to the extent possible, the code implementing a widget's behavior from the code implementing its appearance. Widget class bindings are primarily responsible for maintaining the widget state and invoking callbacks; all aspects of the widgets appearance is - .SH "THEMES" A \fItheme\fR is a collection of elements and styles that determine the look and feel of the widget set. Themes can be used to: @@ -36,7 +35,6 @@ Application suite "branding" Blend in with the rest of the desktop (Gnome, KDE, Java) .IP \(bu And, of course: eye candy. - .SH "ELEMENTS" An \fIelement\fR displays an individual part of a widget. For example, a vertical scrollbar widget contains \fBuparrow\fR, \fBdownarrow\fR, @@ -72,16 +70,15 @@ the \fB\-side\fR option, and placed within the parcel according to the .CS style layout Horizontal.TScrollbar { Scrollbar.trough -children { - Scrollbar.leftarrow -side left -sticky w - Scrollbar.rightarrow -side right -sticky e - Scrollbar.thumb -side left -expand true -sticky ew + Scrollbar.leftarrow -side left -sticky w + Scrollbar.rightarrow -side right -sticky e + Scrollbar.thumb -side left -expand true -sticky ew } } .CE By default, the layout for a widget is the same as its class name. Some widgets may override this (for example, the \fBscrollbar\fR widget chooses -different layouts based on the \fB-orient\fR option). - +different layouts based on the \fB\-orient\fR option). .SH "STATES" In standard Tk, many widgets have a \fB\-state\fR option which (in most cases) is either \fBnormal\fR or \fBdisabled\fR. Some widgets support additional @@ -101,12 +98,12 @@ cleared instead. .PP For example, the class bindings for the \fBttk::button\fR widget are: .CS -bind TButton <Enter> { %W state active } -bind TButton <Leave> { %W state !active } -bind TButton <ButtonPress-1> { %W state pressed } -bind TButton <Button1-Leave> { %W state !pressed } -bind TButton <Button1-Enter> { %W state pressed } -bind TButton <ButtonRelease-1> \e +bind TButton <Enter> { %W state active } +bind TButton <Leave> { %W state !active } +bind TButton <ButtonPress-1> { %W state pressed } +bind TButton <Button1-Leave> { %W state !pressed } +bind TButton <Button1-Enter> { %W state pressed } +bind TButton <ButtonRelease-1> \e { %W instate {pressed} { %W state !pressed ; %W invoke } } .CE This specifies that the widget becomes \fBactive\fR when the pointer enters @@ -120,7 +117,6 @@ actual bindings are a little more complicated than the above, but not by much). .PP \fINote to self: rewrite that paragraph. It's horrible.\fR - .SH "STYLES" Each widget is associated with a \fIstyle\fR, which specifies values for element resources. Style names use a recursive dotted notation like layouts @@ -128,10 +124,10 @@ and elements; by default, widgets use the class name to look up a style in the current theme. For example: .CS style default TButton \e - -background #d9d9d9 \e - -foreground black \e - -relief raised \e - ; + -background #d9d9d9 \e + -foreground black \e + -relief raised \e + ; .CE Many elements are displayed differently depending on the widget state. For example, buttons have a different background when they are active, a different @@ -139,11 +135,10 @@ foreground when disabled, and a different relief when pressed. The \fBstyle map\fR command specifies dynamic resources for a particular style: .CS style map TButton \e - -background [list disabled #d9d9d9 active #ececec] \e - -foreground [list disabled #a3a3a3] \e - -relief [list {pressed !disabled} sunken] \e - ; + -background [list disabled #d9d9d9 active #ececec] \e + -foreground [list disabled #a3a3a3] \e + -relief [list {pressed !disabled} sunken] \e + ; .CE - .SH "SEE ALSO" ttk_widget(n), ttk_style(n) diff --git a/doc/ttk_label.n b/doc/ttk_label.n index 7a647bd..8acb3b2 100644 --- a/doc/ttk_label.n +++ b/doc/ttk_label.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_label.n,v 1.3 2006/12/13 23:04:33 hobbs Exp $ +'\" RCS: @(#) $Id: ttk_label.n,v 1.4 2007/10/23 15:44:36 dkf Exp $ '\" .so man.macros .TH ttk_label n 8.5 Tk "Tk Themed Widget" @@ -21,18 +21,18 @@ A \fBttk::label\fR widget displays a textual label and/or image. The label may be linked to a Tcl variable to automatically change the displayed text. .SO -\-class \-compound \-cursor \-image -\-style \-takefocus \-text \-textvariable -\-underline \-width +\-class \-compound \-cursor +\-image \-style \-takefocus +\-text \-textvariable \-underline +\-width .SE - .SH "WIDGET-SPECIFIC OPTIONS" .OP \-anchor anchor Anchor Specifies how the information in the widget is positioned relative to the inner margins. Legal values are \fBn\fR, \fBne\fR, \fBe\fR, \fBse\fR, \fBs\fR, \fBsw\fR, \fBw\fR, \fBnw\fR, and \fBcenter\fR. -See also \fB-justify\fR. +See also \fB\-justify\fR. .OP \-background frameColor FrameColor The widget's background color. If unspecified, the theme default is used. @@ -45,7 +45,7 @@ If unspecified, the theme default is used. If there are multiple lines of text, specifies how the lines are laid out relative to one another. One of \fBleft\fR, \fBcenter\fR, or \fBright\fR. -See also \fB-anchor\fR. +See also \fB\-anchor\fR. .OP \-padding padding Padding Specifies the amount of extra space to allocate for the widget. The padding is a list of up to four length specifications @@ -62,14 +62,13 @@ Valid values are and \fBsunken\fR. .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 \-wraplength wrapLength WrapLength Specifies the maximum line length (in pixels). If this option is less than or equal to zero, then automatic wrapping is not performed; otherwise the text is split into lines such that no line is longer than the specified value. - .SH "WIDGET COMMAND" .TP \fIpathName \fBcget\fR \fIoption\fR @@ -80,6 +79,5 @@ than the specified value. .TP \fIpathName \fBstate\fR ?\fIstateSpec\fR? See \fIttk_widget(n)\fR - .SH "SEE ALSO" ttk_widget(n), label(n) diff --git a/doc/ttk_labelframe.n b/doc/ttk_labelframe.n index 7e13941..531d9c8 100644 --- a/doc/ttk_labelframe.n +++ b/doc/ttk_labelframe.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_labelframe.n,v 1.3 2006/12/13 23:04:33 hobbs Exp $ +'\" RCS: @(#) $Id: ttk_labelframe.n,v 1.4 2007/10/23 15:44:36 dkf Exp $ '\" .so man.macros .TH ttk_labelframe n 8.5 Tk "Tk Themed Widget" @@ -21,28 +21,28 @@ A \fBttk::labelframe\fR widget is a container used to group other widgets together. It has an optional label, which may be a plain text string or another widget. .SO -\-class \-cursor \-takefocus \-style +\-class \-cursor \-takefocus +\-style .SE - .SH "WIDGET-SPECIFIC OPTIONS" -'\" XXX: Currently included, but may go away: -'\" XXX: .OP -borderwidth borderWidth BorderWidth -'\" XXX: The desired width of the widget border. Default is theme-dependent. -'\" XXX: .OP -relief relief Relief -'\" XXX: One of the standard Tk border styles: -'\" XXX: \fBflat\fR, \fBgroove\fR, \fBraised\fR, \fBridge\fR, -'\" XXX: \fBsolid\fR, or \fBsunken\fR. -'\" XXX: Default is theme-dependent. +.\" XXX: Currently included, but may go away: +.\" XXX: .OP -borderwidth borderWidth BorderWidth +.\" XXX: The desired width of the widget border. Default is theme-dependent. +.\" XXX: .OP -relief relief Relief +.\" XXX: One of the standard Tk border styles: +.\" XXX: \fBflat\fR, \fBgroove\fR, \fBraised\fR, \fBridge\fR, +.\" XXX: \fBsolid\fR, or \fBsunken\fR. +.\" XXX: Default is theme-dependent. .OP -labelanchor labelAnchor LabelAnchor Specifies where to place the label. Allowed values are (clockwise from the top upper left corner): \fBnw\fR, \fBn\fR, \fBne\fR, \fBen\fR, \fBe\fR, \fBes\fR, \fBse\fR, \fBs\fR,\fBsw\fR, \fBws\fR, \fBw\fR and \fBwn\fR. The default value is theme-dependent. -'\" Alternate explanation: The first character must be one of n, s, e, or w -'\" and specifies which side the label should be placed on; -'\" the remaining characters specify how the label is aligned on that side. -'\" NOTE: Now allows other values as well; leave this undocumented for now +.\" Alternate explanation: The first character must be one of n, s, e, or w +.\" and specifies which side the label should be placed on; +.\" the remaining characters specify how the label is aligned on that side. +.\" NOTE: Now allows other values as well; leave this undocumented for now .OP -text text Text Specifies the text of the label. .OP -underline underline Underline @@ -55,23 +55,21 @@ sets the keyboard focus to the first child of the \fBttk::labelframe\fR widget. Additional padding to include inside the border. .OP -labelwidget labelWidget LabelWidget The name of a widget to use for the label. -If set, overrides the \fB-text\fR option. -The \fB-labelwidget\fR must be a child of the \fBlabelframe\fR widget +If set, overrides the \fB\-text\fR option. +The \fB\-labelwidget\fR must be a child of the \fBlabelframe\fR widget or one of the \fBlabelframe\fR's ancestors, and must belong to the same top-level widget as the \fBlabelframe\fR. .OP -width width Width If specified, the widget's requested width in pixels. .OP -height height Height If specified, the widget's requested height in pixels. -(See \fIttk_frame(n)\fR for further notes on \fB-width\fR and \fB-height\fR). - +(See \fIttk_frame(n)\fR for further notes on \fB\-width\fR and +\fB\-height\fR). .SH "WIDGET COMMAND" Supports the standard widget commands \fBconfigure\fR, \fBcget\fR, \fBinstate\fR, and \fBstate\fR; see \fIttk_widget(n)\fR. - .SH "SEE ALSO" ttk_widget(n), ttk_frame(n), labelframe(n) - .SH "KEYWORDS" widget, frame, container, label, groupbox diff --git a/doc/ttk_menubutton.n b/doc/ttk_menubutton.n index 11bc820..bc57388 100644 --- a/doc/ttk_menubutton.n +++ b/doc/ttk_menubutton.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_menubutton.n,v 1.3 2006/12/13 23:04:33 hobbs Exp $ +'\" RCS: @(#) $Id: ttk_menubutton.n,v 1.4 2007/10/23 15:44:36 dkf Exp $ '\" .so man.macros .TH ttk_menubutton n 8.5 Tk "Tk Themed Widget" @@ -20,11 +20,11 @@ ttk_menubutton \- Widget that pops down a menu when pressed A \fBttk::menubutton\fR widget displays a textual label and/or image, and displays a menu when pressed. .SO -\-class \-compound \-cursor \-image -\-state \-style \-takefocus \-text -\-textvariable \-underline \-width +\-class \-compound \-cursor +\-image \-state \-style +\-takefocus \-text \-textvariable +\-underline \-width .SE - .SH "WIDGET-SPECIFIC OPTIONS" .OP \-direction direction Direction Specifies where the menu is to be popped up relative @@ -39,14 +39,11 @@ menubutton. .\" not documented: may go away: .\" .OP \-anchor anchor Anchor .\" .OP \-padding padding Pad - .SH "WIDGET COMMAND" Menubutton widgets support the standard \fBcget\fR, \fBconfigure\fR, \fBinstate\fR, and \fBstate\fR methods. No other widget methods are used. - .SH "SEE ALSO" ttk_widget(n), menu(n), menubutton(n) - .SH "KEYWORDS" widget, button, menu diff --git a/doc/ttk_notebook.n b/doc/ttk_notebook.n index 18459d4..a677443 100644 --- a/doc/ttk_notebook.n +++ b/doc/ttk_notebook.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_notebook.n,v 1.3 2006/12/13 23:04:33 hobbs Exp $ +'\" RCS: @(#) $Id: ttk_notebook.n,v 1.4 2007/10/23 15:44:36 dkf Exp $ '\" .so man.macros .TH ttk_notebook n 8.5 Tk "Tk Themed Widget" @@ -13,170 +13,161 @@ .SH NAME ttk_notebook \- Multi-paned container widget .SH SYNOPSIS +.nf \fBttk::notebook\fR \fIpathName \fR?\fIoptions\fR? -.br + \fIpathName \fBadd\fR \fIpathName\fR.\fIsubwindow\fR ?\fIoptions...\fR? \fIpathName \fBinsert\fR \fIindex\fR \fIpathName\fR.\fIsubwindow\fR ?\fIoptions...\fR? +.fi .BE .SH DESCRIPTION -A \fBttk::notebook\fR widget manages a collection of subpanes -and displays a single one at a time. -Each pane is associated with a tab, which the user -may select to change the currently-displayed pane. +A \fBttk::notebook\fR widget manages a collection of subpanes and displays a +single one at a time. Each pane is associated with a tab, which the user may +select to change the currently-displayed pane. .SO -\-class \-cursor \-takefocus \-style +\-class \-cursor \-style +\-takefocus .SE - .SH "WIDGET-SPECIFIC OPTIONS" .OP \-height height Height -If present and greater than zero, -specifies the desired height of the pane area -(not including internal padding or tabs). -Otherwise, the maximum height of all panes is used. +If present and greater than zero, specifies the desired height of the pane +area (not including internal padding or tabs). Otherwise, the maximum height +of all panes is used. .OP \-padding padding Padding -Specifies the amount of extra space to add around the outside -of the notebook. -The padding is a list of up to four length specifications -\fIleft top right bottom\fR. -If fewer than four elements are specified, -\fIbottom\fR defaults to \fItop\fR, -\fIright\fR defaults to \fIleft\fR, and -\fItop\fR defaults to \fIleft\fR. +Specifies the amount of extra space to add around the outside of the notebook. +The padding is a list of up to four length specifications \fIleft top right +bottom\fR. If fewer than four elements are specified, \fIbottom\fR defaults to +\fItop\fR, \fIright\fR defaults to \fIleft\fR, and \fItop\fR defaults to +\fIleft\fR. .OP \-width width Width -If present and greater than zero, -specifies the desired width of the pane area -(not including internal padding). -Otherwise, the maximum width of all panes is used. +If present and greater than zero, specifies the desired width of the pane area +(not including internal padding). Otherwise, the maximum width of all panes is +used. .SH "TAB OPTIONS" The following options may be specified for individual notebook panes: .OP \-state state State -Either \fBnormal\fR, \fBdisabled\fR or \fBhidden\fR. -If \fBdisabled\fR, then the tab is not selectable. If \fBhidden\fR, -then the tab is not shown. +Either \fBnormal\fR, \fBdisabled\fR or \fBhidden\fR. If \fBdisabled\fR, then +the tab is not selectable. If \fBhidden\fR, then the tab is not shown. .OP \-sticky sticky Sticky -Specifies how the child pane is positioned within the pane area. -Value is a string containing zero or more of the characters -\fBn, s, e,\fR or \fBw\fR. -Each letter refers to a side (north, south, east, or west) -that the child window will "stick" to, -as per the \fBgrid\fR geometry manager. +Specifies how the child pane is positioned within the pane area. Value is a +string containing zero or more of the characters \fBn, s, e,\fR or \fBw\fR. +Each letter refers to a side (north, south, east, or west) that the child +window will "stick" to, as per the \fBgrid\fR geometry manager. .OP \-padding padding Padding Specifies the amount of extra space to add between the notebook and this pane. -Syntax is the same as for the widget \fB-padding\fR option. +Syntax is the same as for the widget \fB\-padding\fR option. .OP \-text text Text Specifies a string to be displayed in the tab. .OP \-image image Image -Specifies an image to display in the tab, -which must have been created with the \fBimage create\fR command. +Specifies an image to display in the tab, which must have been created with +the \fBimage create\fR command. .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. -See \fIlabel(n)\fR for legal values. +Specifies how to display the image relative to the text, in the case both +\fB\-text\fR and \fB\-image\fR are present. See \fIlabel(n)\fR for legal +values. .OP \-underline underline Underline -Specifies the integer index (0-based) of a character to underline -in the text string. -The underlined character is used for mnemonic activation -if \fBttk::notebook::enableTraversal\fR is called. - +Specifies the integer index (0-based) of a character to underline in the text +string. The underlined character is used for mnemonic activation if +\fBttk::notebook::enableTraversal\fR is called. .SH "WIDGET COMMAND" .TP \fIpathname \fBadd \fIchild\fR ?\fIoptions...\fR? -Adds a new tab to the notebook. -When the tab is selected, the \fIchild\fR window -will be displayed. -\fIchild\fR must be a direct child of the notebook window. -See \fBTAB OPTIONS\fR for the list of available \fIoptions\fR. +. +Adds a new tab to the notebook. When the tab is selected, the \fIchild\fR +window will be displayed. \fIchild\fR must be a direct child of the notebook +window. See \fBTAB OPTIONS\fR for the list of available \fIoptions\fR. .TP \fIpathname \fBconfigure\fR ?\fIoptions\fR? +. See \fIttk_widget(n)\fR. .TP \fIpathname \fBcget\fR \fIoption\fR +. See \fIttk_widget(n)\fR. .TP \fIpathname \fBforget\fR \fItabid\fR -Removes the tab specified by \fItabid\fR, -unmaps and unmanages the associated child window. +. +Removes the tab specified by \fItabid\fR, unmaps and unmanages the associated +child window. .TP \fIpathname \fBindex\fR \fItabid\fR -Returns the numeric index of the tab specified by \fItabid\fR, -or the total number of tabs if \fItabid\fR is the string "\fBend\fR". +. +Returns the numeric index of the tab specified by \fItabid\fR, or the total +number of tabs if \fItabid\fR is the string "\fBend\fR". .TP \fIpathname \fBinsert\fR \fIpos\fR \fIsubwindow\fR \fIoptions...\fR -Inserts a pane at the specified position. -\fIpos\fR is either the string \fBend\fR, an integer index, -or the name of a managed subwindow. -If \fIsubwindow\fR is already managed by the notebook, -moves it to the specified position. -See \fBTAB OPTIONS\fR for the list of available options. +. +Inserts a pane at the specified position. \fIpos\fR is either the string +\fBend\fR, an integer index, or the name of a managed subwindow. If +\fIsubwindow\fR is already managed by the notebook, moves it to the specified +position. See \fBTAB OPTIONS\fR for the list of available options. .TP \fIpathname \fBinstate\fR \fIstatespec \fR?\fIscript...\fR? +. See \fIttk_widget(n)\fR. .TP \fIpathname \fBselect\fR ?\fItabid\fR? -Selects the specified tab. The associated child pane will be displayed, -and the previously-selected pane (if different) is unmapped. -If \fItabid\fR is omitted, returns the widget name of the -currently selected pane. +. +Selects the specified tab. The associated child pane will be displayed, and +the previously-selected pane (if different) is unmapped. If \fItabid\fR is +omitted, returns the widget name of the currently selected pane. .TP \fIpathname \fBstate\fR ?\fIstatespec\fR? +. See \fIttk_widget(n)\fR. .TP -\fIpathname \fBtab\fR \fItabid\fR ?\fI-options \fR?\fIvalue ...\fR -Query or modify the options of the specific tab. -If no \fI-option\fR is specified, returns a dictionary of the tab option values. -If one \fI-option\fR is specified, returns the value of that \fIoption\fR. -Otherwise, sets the \fI-option\fRs to the corresponding \fIvalue\fRs. -See \fBTAB OPTIONS\fR for the available options. +\fIpathname \fBtab\fR \fItabid\fR ?\fI\-options \fR?\fIvalue ...\fR +. +Query or modify the options of the specific tab. If no \fI\-option\fR is +specified, returns a dictionary of the tab option values. If one +\fI\-option\fR is specified, returns the value of that \fIoption\fR. +Otherwise, sets the \fI\-option\fRs to the corresponding \fIvalue\fRs. See +\fBTAB OPTIONS\fR for the available options. .TP \fIpathname \fBtabs\fR +. Returns a list of all windows managed by the widget. .\" Perhaps "panes" is a better name for this command? - .SH "KEYBOARD TRAVERSAL" -To enable keyboard traversal for a toplevel window -containing a notebook widget \fI$nb\fR, call: +To enable keyboard traversal for a toplevel window containing a notebook +widget \fI$nb\fR, call: .CS ttk::notebook::enableTraversal $nb .CE .PP -This will extend the bindings for the toplevel widget -containing the notebook as follows: +This will extend the bindings for the toplevel widget containing the notebook +as follows: .IP \(bu \fBControl-Tab\fR selects the tab following the currently selected one. .IP \(bu \fBShift-Control-Tab\fR selects the tab preceding the currently selected one. .IP \(bu -\fBAlt-K\fR, where \fBK\fR is the mnemonic (underlined) character -of any tab, will select that tab. +\fBAlt-K\fR, where \fBK\fR is the mnemonic (underlined) character of any tab, +will select that tab. .PP Multiple notebooks in a single toplevel may be enabled for traversal, -including nested notebooks. -However, notebook traversal only works properly if all panes -are direct children of the notebook. - +including nested notebooks. However, notebook traversal only works properly if +all panes are direct children of the notebook. .SH "TAB IDENTIFIERS" -The \fItabid\fR argument to the above commands may take -any of the following forms: +The \fItabid\fR argument to the above commands may take any of the following +forms: .IP \(bu An integer between zero and the number of tabs; .IP \(bu The name of a child pane window; .IP \(bu -A positional specification of the form "@\fIx\fR,\fIy\fR", -which identifies the tab +A positional specification of the form "@\fIx\fR,\fIy\fR", which identifies +the tab .IP \(bu -The literal string "\fBcurrent\fR", -which identifies the currently-selected tab; or: +The literal string "\fBcurrent\fR", which identifies the currently-selected +tab; or: .IP \(bu -The literal string "\fBend\fR", -which returns the number of tabs -(only valid for "\fIpathname \fBindex\fR"). - +The literal string "\fBend\fR", which returns the number of tabs (only valid +for "\fIpathname \fBindex\fR"). .SH "VIRTUAL EVENTS" -The notebook widget generates a \fB<<NotebookTabChanged>>\fR -virtual event after a new tab is selected. - +The notebook widget generates a \fB<<NotebookTabChanged>>\fR virtual event +after a new tab is selected. .SH "EXAMPLE" .CS notebook .nb @@ -185,9 +176,7 @@ notebook .nb \.nb select .nb.f2 ttk::notebook::enableTraversal .nb .CE - .SH "SEE ALSO" ttk_widget(n), grid(n) - .SH "KEYWORDS" pane, tab diff --git a/doc/ttk_panedwindow.n b/doc/ttk_panedwindow.n index ff88473..e9befb6 100644 --- a/doc/ttk_panedwindow.n +++ b/doc/ttk_panedwindow.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_panedwindow.n,v 1.7 2007/10/22 14:33:13 dkf Exp $ +'\" RCS: @(#) $Id: ttk_panedwindow.n,v 1.8 2007/10/23 15:44:36 dkf Exp $ '\" .so man.macros .TH ttk_panedwindow n 8.5 Tk "Tk Themed Widget" @@ -15,7 +15,7 @@ ttk_panedwindow \- Multi-pane container window .SH SYNOPSIS .nf \fBttk::panedwindow\fR \fIpathName \fR?\fIoptions\fR? -.br + \fIpathName \fBadd\fR \fIpathName.subwindow\fR ?\fIoptions...\fR? \fIpathName \fBinsert\fR \fIindex\fR \fIpathName.subwindow\fR ?\fIoptions...\fR? .fi @@ -26,9 +26,9 @@ A \fBttk::panedwindow\fR widget displays a number of subwindows, stacked either vertically or horizontally. The user may adjust the relative sizes of the subwindows by dragging the sash between panes. .SO -\-class \-cursor \-takefocus \-style +\-class \-cursor \-style +\-takefocus .SE - .SH "WIDGET-SPECIFIC OPTIONS" .OP \-orient orient Orient Specifies the orientation of the window. If \fBvertical\fR, subpanes are @@ -42,14 +42,12 @@ managed windows. If present and greater than zero, specifies the desired height of the widget in pixels. Otherwise, the requested height is determined by the height of the managed windows. - .SH "PANE OPTIONS" The following options may be specified for each pane: .OP \-weight weight Weight An integer specifying the relative stretchability of the pane. When the paned window is resized, the extra space is added or subtracted to each pane proportionally to its \fB\-weight\fR. - .SH "WIDGET COMMAND" Supports the standard \fBconfigure\fR, \fBcget\fR, \fBstate\fR, and \fBinstate\fR commands; see \fIttk_widget(n)\fR for details. Additional @@ -99,6 +97,5 @@ Returns the new position of sash number \fIindex\fR. . Returns the index of the sash at point \fIx,y\fR, or the empty string if \fIx,y\fR is not over a sash. - .SH "SEE ALSO" ttk_widget(n), ttk_notebook(n), panedwindow(n) diff --git a/doc/ttk_progressbar.n b/doc/ttk_progressbar.n index ae353c4..d5baec6 100644 --- a/doc/ttk_progressbar.n +++ b/doc/ttk_progressbar.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_progressbar.n,v 1.4 2007/10/22 14:33:13 dkf Exp $ +'\" RCS: @(#) $Id: ttk_progressbar.n,v 1.5 2007/10/23 15:44:36 dkf Exp $ '\" .so man.macros .TH ttk_progressbar n 8.5 Tk "Tk Themed Widget" @@ -23,9 +23,9 @@ completed relative to the total amount of work to be done, and \fIindeterminate\fR mode provides an animated display to let the user know that something is happening. .SO -\-class \-cursor \-takefocus \-style +\-class \-cursor \-style +\-takefocus .SE - .SH "WIDGET-SPECIFIC OPTIONS" .OP \-orient orient Orient One of \fBhorizontal\fR or \fBvertical\fR. Specifies the orientation of the @@ -51,7 +51,6 @@ Read-only option. The widget periodically increments the value of this option whenever the \fB\-value\fR is greater than 0 and, in \fIdeterminate\fR mode, less than \fB\-maximum\fR. This option may be used by the current theme to provide additional animation effects. - .SH "WIDGET COMMAND" .TP \fIpathName \fBcget\fR \fIoption\fR @@ -86,6 +85,5 @@ omitted. . Stop autoincrement mode: cancels any recurring timer event initiated by \fIpathName \fBstart\fR. - .SH "SEE ALSO" ttk_widget(n) diff --git a/doc/ttk_radiobutton.n b/doc/ttk_radiobutton.n index e9e93a6..2b4a424 100644 --- a/doc/ttk_radiobutton.n +++ b/doc/ttk_radiobutton.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_radiobutton.n,v 1.3 2006/12/13 23:04:33 hobbs Exp $ +'\" RCS: @(#) $Id: ttk_radiobutton.n,v 1.4 2007/10/23 15:44:36 dkf Exp $ '\" .so man.macros .TH ttk_radiobutton n 8.5 Tk "Tk Themed Widget" @@ -23,21 +23,20 @@ Radiobuttons are linked to a Tcl variable, and have an associated value; when a radiobutton is clicked, it sets the variable to its associated value. .SO -\-class \-compound \-cursor \-image -\-state \-style \-takefocus \-text -\-textvariable \-underline \-width +\-class \-compound \-cursor +\-image \-state \-style +\-takefocus \-text \-textvariable +\-underline \-width .SE - .SH "WIDGET-SPECIFIC OPTIONS" .OP \-command command Command A Tcl script to evaluate whenever the widget is invoked. .OP \-value Value Value -The value to store in the associated \fI-variable\fR +The value to store in the associated \fB\-variable\fR when the widget is selected. .OP \-variable variable Variable The name of a global variable whose value is linked to the widget. Default value is \fB::selectedButton\fR. - .SH "WIDGET COMMAND" In addition to the standard \fBcget\fR, \fBconfigure\fR, \fBinstate\fR, and \fBstate\fR @@ -45,25 +44,22 @@ commands, radiobuttons support the following additional widget commands: .TP \fIpathname\fR invoke -Sets the \fI-variable\fR to the \fI-value\fR, selects the widget, -and evaluates the associated \fI-command\fR. -Returns the result of the \fI-command\fR, or the empty -string if no \fI-command\fR is specified. +Sets the \fB\-variable\fR to the \fB\-value\fR, selects the widget, +and evaluates the associated \fB\-command\fR. +Returns the result of the \fB\-command\fR, or the empty +string if no \fB\-command\fR is specified. .\" Missing: select, deselect. Useful? .\" Missing: flash. This is definitely not useful. - .SH "WIDGET STATES" The widget does not respond to user input if the \fBdisabled\fR state is set. The widget sets the \fBselected\fR state whenever -the linked \fB-variable\fR is set to the widget's \fB-value\fR, +the linked \fB\-variable\fR is set to the widget's \fB\-value\fR, and clears it otherwise. The widget sets the \fBalternate\fR state whenever the -linked \fB-variable\fR is unset. +linked \fB\-variable\fR is unset. (The \fBalternate\fR state may be used to indicate a ``tri-state'' or ``indeterminate'' selection.) - .SH "SEE ALSO" ttk_widget(n), ttk_checkbutton(n), radiobutton(n) - .SH "KEYWORDS" widget, button, option diff --git a/doc/ttk_scrollbar.n b/doc/ttk_scrollbar.n index 6c1efeb..6de1d66 100644 --- a/doc/ttk_scrollbar.n +++ b/doc/ttk_scrollbar.n @@ -6,7 +6,7 @@ '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" '\" SOURCE: tk/doc/scrollbar.n, r1.4 -'\" RCS: @(#) $Id: ttk_scrollbar.n,v 1.4 2007/10/22 14:33:13 dkf Exp $ +'\" RCS: @(#) $Id: ttk_scrollbar.n,v 1.5 2007/10/23 15:44:36 dkf Exp $ '\" .so man.macros .TH ttk_scrollbar n 8.5 Tk "Tk Themed Widget" @@ -28,24 +28,25 @@ control the visible region. Depending on the theme, two or more arrow buttons may also be present; these are used to scroll the visible region in discrete units. .SO -\-class \-cursor \-style \-takefocus +\-class \-cursor \-style +\-takefocus .SE - .SH "WIDGET-SPECIFIC OPTIONS" .OP \-command command Command A Tcl script prefix to evaluate to change the view in the widget associated with the scrollbar. Additional arguments are appended to the value of this option, as described in \fBSCROLLING COMMANDS\fR below, whenever the user requests a view change by manipulating the scrollbar. -.br +.RS +.PP This option typically consists of a two-element list, containing the name of a scrollable widget followed by either \fBxview\fR (for horizontal scrollbars) or \fByview\fR (for vertical scrollbars). +.RE .OP \-orient orient Orient One of \fBhorizontal\fR or \fBvertical\fR. Specifies the orientation of the scrollbar. .BE - .SH "WIDGET COMMAND" .TP \fIpathName \fBcget\fR \fIoption\fR @@ -76,7 +77,6 @@ between 0 and 1. \fIpathName \fBstate\fR ?\fIstateSpec\fR? . Modify or query the widget state; see \fIttk_widget(n)\fR. - .SH "INTERNAL COMMANDS" The following widget commands are used internally by the TScrollbar widget class bindings. @@ -106,7 +106,6 @@ closest point in the trough is used. Returns the name of the element under the point given by \fIx\fR and \fIy\fR, or an empty string if the point does not lie in any element of the scrollbar. \fIX\fR and \fIy\fR are pixel coordinates relative to the scrollbar widget. - .SH "SCROLLING COMMANDS" When the user interacts with the scrollbar, for example by dragging the thumb, the scrollbar notifies the associated widget that it must change its view. @@ -138,28 +137,27 @@ widget to define the meaning of a page; typically it is slightly less than what fits in the window, so that there is a slight overlap between the old and new views. \fINumber\fR is either 1, which means the next page should become visible, or \-1, which means that the previous page should become visible. - .SH "WIDGET STATES" The scrollbar automatically sets the \fBdisabled\fR state bit when the entire range is visible (range is 0.0 to 1.0), and clears it otherwise. It also sets the \fBactive\fR and \fBpressed\fR state flags of individual elements, based on the position and state of the mouse pointer. - .SH EXAMPLE .CS set f [frame .f] -ttk::scrollbar $f.hsb -orient horizontal -command [list $f.t xview] -ttk::scrollbar $f.vsb -orient vertical -command [list $f.t yview] -text $f.t -xscrollcommand [list $f.hsb set] -yscrollcommand [list $f.vsb set] +ttk::scrollbar $f.hsb -orient horizontal \e + -command [list $f.t xview] +ttk::scrollbar $f.vsb -orient vertical \e + -command [list $f.t yview] +text $f.t -xscrollcommand [list $f.hsb set] \e + -yscrollcommand [list $f.vsb set] grid $f.t -row 0 -column 0 -sticky nsew grid $f.vsb -row 0 -column 1 -sticky nsew grid $f.hsb -row 1 -column 0 -sticky nsew grid columnconfigure $f 0 -weight 1 grid rowconfigure $f 0 -weight 1 .CE - .SH "SEE ALSO" ttk_widget(n), scrollbar(n) - .SH KEYWORDS scrollbar, widget diff --git a/doc/ttk_separator.n b/doc/ttk_separator.n index 9e4ccbf..6c6f7fc 100644 --- a/doc/ttk_separator.n +++ b/doc/ttk_separator.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_separator.n,v 1.3 2006/12/13 23:04:33 hobbs Exp $ +'\" RCS: @(#) $Id: ttk_separator.n,v 1.4 2007/10/23 15:44:36 dkf Exp $ '\" .so man.macros .TH ttk_separator n 8.5 Tk "Tk Themed Widget" @@ -20,22 +20,18 @@ ttk_separator \- Separator bar A \fBttk::separator\fR widget displays a horizontal or vertical separator bar. .SO -\-class \-cursor \-state \-style -\-takefocus +\-class \-cursor \-state +\-style \-takefocus .SE - .SH "WIDGET-SPECIFIC OPTIONS" .OP \-orient orient Orient One of \fBhorizontal\fR or \fBvertical\fR. Specifies the orientation of the separator. - .SH "WIDGET COMMAND" Separator widgets support the standard \fBcget\fR, \fBconfigure\fR, \fBinstate\fR, and \fBstate\fR methods. No other widget methods are used. - .SH "SEE ALSO" ttk_widget(n) - .SH "KEYWORDS" widget, separator diff --git a/doc/ttk_sizegrip.n b/doc/ttk_sizegrip.n index ad293f4..708674f 100644 --- a/doc/ttk_sizegrip.n +++ b/doc/ttk_sizegrip.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_sizegrip.n,v 1.6 2007/10/22 14:33:13 dkf Exp $ +'\" RCS: @(#) $Id: ttk_sizegrip.n,v 1.7 2007/10/23 15:44:36 dkf Exp $ '\" .so man.macros .TH ttk_sizegrip n 8.5 Tk "Tk Themed Widget" @@ -24,30 +24,30 @@ by pressing and dragging the grip. \-class \-cursor \-state \-style \-takefocus .SE - .SH "WIDGET COMMAND" Sizegrip widgets support the standard \fBcget\fR, \fBconfigure\fR, \fBinstate\fR, and \fBstate\fR methods. No other widget methods are used. - .SH "PLATFORM-SPECIFIC NOTES" On Mac OSX, toplevel windows automatically include a built-in size grip by default. Adding an \fBttk::sizegrip\fR there is harmless, since the built-in grip will just mask the widget. .SH EXAMPLES +.PP +Using \fBpack\fR: .CS -# Using pack: pack [ttk::frame $top.statusbar] -side bottom -fill x pack [ttk::sizegrip $top.statusbar.grip] -side right -anchor se - -# Using grid: +.CE +.PP +Using \fBgrid\fR: +.CS grid [ttk::sizegrip $top.statusbar.grip] \e -row $lastRow -column $lastColumn -sticky se # ... optional: add vertical scrollbar in $lastColumn, # ... optional: add horizontal scrollbar in $lastRow .CE - .SH "BUGS" If the containing toplevel's position was specified relative to the right or bottom of the screen @@ -56,9 +56,7 @@ instead of \fB[wm geometry ... \fIw\fBx\fIh\fB+\fIx\fB+\fIy\fB]\fR), the sizegrip widget will not resize the window. .PP ttk::sizegrip widgets only support "southeast" resizing. - .SH "SEE ALSO" ttk_widget(n) - .SH "KEYWORDS" widget, sizegrip, grow box diff --git a/doc/ttk_style.n b/doc/ttk_style.n index 52322c3..7f4237d 100644 --- a/doc/ttk_style.n +++ b/doc/ttk_style.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_style.n,v 1.3 2006/12/13 23:04:33 hobbs Exp $ +'\" RCS: @(#) $Id: ttk_style.n,v 1.4 2007/10/23 15:44:36 dkf Exp $ '\" .so man.macros .TH ttk_style n 8.5 Tk "Tk Themed Widget" @@ -15,11 +15,13 @@ ttk_style \- Control overall look and feel of widgets \fBttk::style\fR \fIoption\fR ?\fIargs\fR? .BE +.BS .SH NOTES .PP This manpage has not been written yet. Please see the Tcl'2004 conference presentation, available at http://tktable.sourceforge.net/tile/tile-tcl2004.pdf +.BE .SH DEFINITIONS .PP @@ -89,7 +91,6 @@ Returns a list of the available themes. .TP \fBttk::style theme use\fR \fIthemeName\fR Sets the current theme to \fIthemeName\fR, and refreshes all widgets. - .SH LAYOUTS A \fIlayout\fR specifies a list of elements, each followed by one or more options specifying how to arrange the element. @@ -109,10 +110,9 @@ Specifies where the element is placed inside its allocated parcel. \fB-children \fI{ sublayout... }\fR Specifies a list of elements to place inside the element. .\" Also: -border, -unit, -expand: may go away. -.PP -For example: +.SH EXAMPLE .CS -ttk::style layout Horizontal.TScrollbar { +\fBttk::style\fR layout Horizontal.TScrollbar { Scrollbar.trough -children { Scrollbar.leftarrow -side left Scrollbar.rightarrow -side right @@ -120,9 +120,7 @@ ttk::style layout Horizontal.TScrollbar { } } .CE - .SH "SEE ALSO" ttk_intro(n), ttk_widget(n), photo(n) - .SH KEYWORDS style, theme, appearance diff --git a/doc/ttk_treeview.n b/doc/ttk_treeview.n index f724fe7..e1b207a 100644 --- a/doc/ttk_treeview.n +++ b/doc/ttk_treeview.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_treeview.n,v 1.6 2007/10/22 14:33:13 dkf Exp $ +'\" RCS: @(#) $Id: ttk_treeview.n,v 1.7 2007/10/23 15:44:36 dkf Exp $ '\" .so man.macros .TH ttk_treeview n 8.5 Tk "Tk Themed Widget" @@ -53,8 +53,10 @@ names. A list of column identifiers (either symbolic names or integer indices) specifying which data columns are displayed and the order in which they appear, or the string \fB#all\fP. -.br +.RS +.PP If set to \fB#all\fP (the default), all columns are shown in the order given. +.RE .OP \-height height Height Specifies the number of rows which should be visible. Note: the requested width is determined from the sum of the column widths. @@ -64,13 +66,15 @@ four length specifications; see \fBTtk_GetPaddingFromObj()\fR for details. .OP \-selectmode selectMode SelectMode Controls how the built-in class bindings manage the selection. One of \fBextended\fR, \fBbrowse\fR, or \fBnone\fR. -.br +.RS +.PP If set to \fBextended\fR (the default), multiple items may be selected. If \fBbrowse\fR, only a single item will be selected at a time. If \fBnone\fR, the selection will not be changed. -.br +.PP Note that application code and tag bindings can set the selection however they wish, regardless of the value of \fB\-selectmode\fR. +.RE .OP \-show show Show A list containing zero or more of the following values, specifying which elements of the tree to display. @@ -105,11 +109,13 @@ Returns the current value of the specified \fIoption\fR; see . If \fInewchildren\fR is not specified, returns the list of children belonging to \fIitem\fR. -.br +.RS +.PP If \fInewchildren\fR is specified, replaces \fIitem\fR's child list with \fInewchildren\fR. Items in the old child list not present in the new child list are detached from the tree. None of the items in \fInewchildren\fR may be an ancestor of \fIitem\fR. +.RE .TP \fIpathname \fBcolumn\fR \fIcolumn\fR ?\fI\-option \fR?\fIvalue \-option value...\fR? . @@ -238,9 +244,11 @@ greater than or equal to the current number of children, it is inserted at the end. If \fB\-id\fR is specified, it is used as the item identifier; \fIid\fR must not already exist in the tree. Otherwise, a new unique identifier is generated. -.br +.RS +.PP \fIpathname \fBinsert\fR returns the item identifier of the newly created item. See \fBITEM OPTIONS\fR for the list of available options. +.RE .TP \fIpathname \fBinstate \fIstatespec\fR ?\fIscript\fR? . @@ -258,10 +266,12 @@ for the list of available options. . Moves \fIitem\fR to position \fIindex\fR in \fIparent\fR's list of children. It is illegal to move an item under one of its descendants. -.br +.RS +.PP If \fIindex\fR is less than or equal to zero, \fIitem\fR is moved to the beginning; if greater than or equal to the number of children, it's moved to the end. +.RE .TP \fIpathname \fBnext \fIitem\fR . @@ -329,14 +339,16 @@ Add a Tk binding script for the event sequence \fIsequence\fR to the tag \fItagName\fR. When an X event is delivered to an item, binding scripts for each of the item's \fB\-tags\fR are evaluated in order as per \fIbindtags(n)\fR. -.br +.RS +.PP \fB<KeyPress>\fR, \fB<KeyRelease>\fR, and virtual events are sent to the focus item. \fB<ButtonPress>\fR, \fB<ButtonRelease>\fR, and \fB<Motion>\fR events are sent to the item under the mouse pointer. No other event types are supported. -.br +.PP The binding \fIscript\fR undergoes \fB%\fR-substitutions before evaluation; see \fBbind(n)\fR for details. +.RE .TP \fIpathName \fBtag configure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR? . @@ -366,11 +378,13 @@ The textual label to display for the item. A Tk image, displayed to the left of the label. .OP \-values values Values The list of values associated with the item. -.br +.RS +.PP Each item should have the same number of values as the \fB\-columns\fR widget option. If there are fewer values than columns, the remaining values are assumed empty. If there are more values than columns, the extra values are ignored. +.RE .OP \-open open Open A boolean value indicating whether the item's children should be displayed (\fB\-open true\fR) or hidden (\fB\-open false\fR). @@ -415,11 +429,11 @@ display column \fB#\fIn+1\fR. Again, \fBcolumn #0 always refers to the tree column\fR. .SH "VIRTUAL EVENTS" The treeview widget generates the following virtual events. -.IP <<TreeviewSelect>> +.IP \fB<<TreeviewSelect>>\fR Generated whenever the selection changes. -.IP <<TreeviewOpen>> +.IP \fB<<TreeviewOpen>>\fR Generated just before setting the focus item to \fB\-open true\fR. -.IP <<TreeviewClose>> +.IP \fB<<TreeviewClose>>\fR Generated just after setting the focus item to \fB\-open false\fR. .PP The \fBfocus\fR and \fBselection\fR widget commands can be used to determine diff --git a/doc/ttk_widget.n b/doc/ttk_widget.n index b9599ad..3ba3111 100644 --- a/doc/ttk_widget.n +++ b/doc/ttk_widget.n @@ -4,7 +4,7 @@ '\" 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.4 2007/10/22 14:33:13 dkf Exp $ +'\" RCS: @(#) $Id: ttk_widget.n,v 1.5 2007/10/23 15:44:36 dkf Exp $ '\" .so man.macros .TH ttk_widget n 8.5 Tk "Tk Themed Widget" @@ -43,7 +43,8 @@ The following options are supported by widgets that 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. Each of the numbers is a fraction between 0 and 1 indicating a position in the document; 0 @@ -51,14 +52,15 @@ indicates the beginning, 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''. 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. @@ -85,18 +87,15 @@ states. All images in the list should have the same size. Specifies how to display the image relative to the text, in the case both \fB\-text\fR and \fB\-image\fR are present. Valid values are: .RS -.IP text +.IP \fBtext\fR Display text only. -.IP image +.IP \fBimage\fR Display image only. -.IP center +.IP \fBcenter\fR Display text centered on top of image. -.IP top -.IP bottom -.IP left -.IP right +.IP \fBtop\fR, \fBbottom\fR, \fBleft\fR, \fBright\fR Display image above, below, left of, or right of the text, respectively. -.IP none +.IP \fBnone\fR The default; display the image if present, otherwise the text. .RE .OP \-width width Width @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: wm.n,v 1.31 2007/10/15 20:54:43 hobbs Exp $ +'\" RCS: @(#) $Id: wm.n,v 1.32 2007/10/23 15:44:36 dkf Exp $ '\" .so man.macros .TH wm n 8.5 Tk "Tk Built-In Commands" @@ -220,11 +220,14 @@ The focus model defaults to \fBpassive\fR, and Tk's \fBfocus\fR command assumes a passive model of focusing. .TP \fBwm forget \fIwindow\fR +.VS 8.5 The \fIwindow\fR will be unmapped from the screen and will no longer be managed by \fBwm\fR. Windows created with the \fBtoplevel\fR command will be treated like \fBframe\fR windows once they are no -longer managed by \fBwm\fR, however, the -menu configuration will be -remembered and the menus will return once the widget is managed again. +longer managed by \fBwm\fR, however, the \-menu configuration will be +remembered and the menus will return once the widget is managed again. See +\fBGEOMETRY MANAGEMENT\fR below for more details. +.VE 8.5 .TP \fBwm frame \fIwindow\fR If \fIwindow\fR has been reparented by the window manager into a @@ -244,7 +247,7 @@ the form \fB=\fIwidth\fBx\fIheight\fB\(+-\fIx\fB\(+-\fIy\fR, where any of \fB=\fR, \fIwidth\fBx\fIheight\fR, or \fB\(+-\fIx\fB\(+-\fIy\fR may be omitted. \fIWidth\fR and \fIheight\fR are positive integers specifying the desired dimensions of \fIwindow\fR. If \fIwindow\fR -is gridded (see GRIDDED GEOMETRY MANAGEMENT below) then the dimensions +is gridded (see \fBGRIDDED GEOMETRY MANAGEMENT\fR below) then the dimensions are specified in grid units; otherwise they are specified in pixel units. \fIX\fR and \fIy\fR specify the desired location of \fIwindow\fR on the screen, in pixels. @@ -403,11 +406,17 @@ is no icon window currently specified for \fIwindow\fR. Button press events are disabled for \fIwindow\fR as long as it is an icon window; this is needed in order to allow window managers to ``own'' those events. +.RS +.PP Note: not all window managers support the notion of an icon window. +.RE .TP \fBwm manage \fIwidget\fR +.VS 8.5 The \fIwidget\fR specified will become a stand alone top-level window. The -window will be decorated with the window managers title bar, etc. +window will be decorated with the window managers title bar, etc. See +\fBGEOMETRY MANAGEMENT\fR below for more details. +.VE 8.5 .TP \fBwm maxsize \fIwindow\fR ?\fIwidth height\fR? If \fIwidth\fR and \fIheight\fR are specified, they give @@ -616,6 +625,7 @@ well as manual resizes and the \fBwm geometry\fR command. You can also use the command \fBwm resizable\fR to completely disable interactive resizing in one or both dimensions. .PP +.VS 8.5 The \fBwm manage\fR and \fBwm forget\fR commands may be used to perform undocking and docking of windows. After a widget is managed by \fBwm manage\fR command, all other \fBwm\fR subcommands may be used @@ -630,6 +640,7 @@ that have their top-level widget changed via a \fBwm manage\fR or \fBwm forget\fR command, must be redone to adjust any top-level widget path in the bindtags. Bindtags that have not been customized do not have to be redone. +.VE 8.5 .SH "GRIDDED GEOMETRY MANAGEMENT" .PP Gridded geometry management occurs when one of the widgets of an |