diff options
| -rw-r--r-- | ChangeLog | 5 | ||||
| -rw-r--r-- | doc/ttk_intro.n | 31 | ||||
| -rw-r--r-- | doc/ttk_panedwindow.n | 6 | ||||
| -rw-r--r-- | doc/ttk_style.n | 14 | ||||
| -rw-r--r-- | doc/ttk_treeview.n | 7 | ||||
| -rw-r--r-- | doc/ttk_widget.n | 19 |
6 files changed, 44 insertions, 38 deletions
@@ -1,3 +1,8 @@ +2007-12-12 Joe English <jenglish@users.sourceforge.net> + + * doc/ttk_intro.n, doc/ttk_style.n, doc/ttk_widget.n: + Various minor updates. + 2007-12-12 Don Porter <dgp@users.sourceforge.net> * changes: Updated for 8.5.0 release. diff --git a/doc/ttk_intro.n b/doc/ttk_intro.n index fef7428..f0628eb 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.8 2007/11/01 10:59:43 dkf Exp $ +'\" RCS: @(#) $Id: ttk_intro.n,v 1.9 2007/12/12 15:51:21 jenglish Exp $ '\" .so man.macros .TH ttk::intro n 8.5 Tk "Tk Themed Widget" @@ -33,8 +33,7 @@ Adapt to display limitations (low-color, grayscale, monochrome, tiny screens) .IP \(bu Accessibility (high contrast, large type) .IP \(bu -Application suite -.QW branding +Application suite branding .IP \(bu Blend in with the rest of the desktop (Gnome, KDE, Java) .IP \(bu @@ -46,7 +45,7 @@ For example, a vertical scrollbar widget contains \fBuparrow\fR, .PP Element names use a recursive dotted notation. For example, \fBuparrow\fR identifies a generic arrow element, -and \fBScrollbar.arrow\fR and \fBCombobox.uparrow\fR identify +and \fBScrollbar.uparrow\fR and \fBCombobox.uparrow\fR identify widget-specific elements. When looking for an element, the style engine looks for the specific name first, and if an element of that name is @@ -59,15 +58,15 @@ For example, the \fBtext\fR element (which displays a text string) has \fB\-text\fR, \fB\-font\fR, \fB\-foreground\fR, \fB\-background\fR, \fB\-underline\fR, and \fB\-width\fR options. -The value of an element resource is taken from: -.IP \(bu -A dynamic setting specified by \fBstyle map\fR and the current state; +The value of an element option is taken from: .IP \(bu An option of the same name and type in the widget containing the element; .IP \(bu -The default setting specified by \fBstyle default\fR; or +A dynamic setting specified by \fBstyle map\fR and the current state; +.IP \(bu +The default setting specified by \fBstyle configure\fR; or .IP \(bu -The element's built-in default value for the resource. +The element's built-in default value for the option. .SH "LAYOUTS" A \fIlayout\fR specifies which elements make up a widget and how they are arranged. @@ -79,7 +78,7 @@ and placed within the parcel according to the \fB\-sticky\fR option. For example, the layout for a horizontal scrollbar .CS -style layout Horizontal.TScrollbar { +ttk::style layout Horizontal.TScrollbar { Scrollbar.trough \-children { Scrollbar.leftarrow \-side left \-sticky w Scrollbar.rightarrow \-side right \-sticky e @@ -88,7 +87,7 @@ style layout Horizontal.TScrollbar { } .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 +Some widgets may override this (for example, the \fBttk::scrollbar\fR widget chooses different layouts based on the \fB\-orient\fR option). .SH "STATES" In standard Tk, many widgets have a \fB\-state\fR option @@ -110,7 +109,7 @@ A \fIstate specification\fR is a list of symbolic state names indicating which bits are set, each optionally prefixed with an exclamation point indicating that the bit is cleared instead. .PP -For example, the class bindings for the \fBtbutton\fR +For example, the class bindings for the \fBttk::button\fR widget are: .CS bind TButton <Enter> { %W state active } @@ -137,12 +136,12 @@ but not by much). \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. +which specifies values for element options. Style names use a recursive dotted notation like layouts 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 +ttk::style configure TButton \e \-background #d9d9d9 \e \-foreground black \e \-relief raised \e @@ -151,10 +150,10 @@ style default TButton \e Many elements are displayed differently depending on the widget state. For example, buttons have a different background when they are active, a different foreground when disabled, and a different relief when pressed. -The \fBstyle map\fR command specifies dynamic resources +The \fBstyle map\fR command specifies dynamic option settings for a particular style: .CS -style map TButton \e +ttk::style map TButton \e \-background [list disabled #d9d9d9 active #ececec] \e \-foreground [list disabled #a3a3a3] \e \-relief [list {pressed !disabled} sunken] \e diff --git a/doc/ttk_panedwindow.n b/doc/ttk_panedwindow.n index 8e66c9b..23c11ee 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.12 2007/11/01 10:59:43 dkf Exp $ +'\" RCS: @(#) $Id: ttk_panedwindow.n,v 1.13 2007/12/12 15:51:22 jenglish Exp $ '\" .so man.macros .TH ttk::panedwindow n 8.5 Tk "Tk Themed Widget" @@ -15,8 +15,8 @@ ttk::panedwindow \- Multi-pane container window .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? +\fIpathName \fBadd\fR \fIwindow\fR ?\fIoptions...\fR? +\fIpathName \fBinsert\fR \fIindex\fR \fIwindow\fR ?\fIoptions...\fR? .fi .BE .SH DESCRIPTION diff --git a/doc/ttk_style.n b/doc/ttk_style.n index fe06af9..a2a7a4f 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.10 2007/12/05 16:38:15 jenglish Exp $ +'\" RCS: @(#) $Id: ttk_style.n,v 1.11 2007/12/12 15:51:22 jenglish Exp $ '\" .so man.macros .TH ttk::style n 8.5 Tk "Tk Themed Widget" @@ -21,7 +21,7 @@ available at http://tktable.sourceforge.net/tile/tile-tcl2004.pdf Each widget is assigned a \fIstyle\fR, which specifies the set of elements making up the widget and how they are arranged, along with dynamic and default -settings for element resources. +settings for element options. By default, the style name is the same as the widget's class; this may be overridden by the \fB\-style\fR option. .PP @@ -30,10 +30,10 @@ which controls the overall look and feel of an application. .SH DESCRIPTION The \fBttk::style\fR command takes the following arguments: .TP -\fBttk::style configure \fIstyle\fR ?\fI\-option\fR? ?\fIvalue option value...\fR? +\fBttk::style configure \fIstyle\fR ?\fI\-option\fR ?\fIvalue option value...\fR? ? Sets the default value of the specified option(s) in \fIstyle\fR. .TP -\fBttk::style map \fIstyle\fR ?\fI\-option\fB { \fIstatespec value\fB }\fR ... ? +\fBttk::style map \fIstyle\fR ?\fI\-option\fB { \fIstatespec value...\fB }\fR? Sets dynamic values of the specified option(s) in \fIstyle\fR. Each \fIstatespec / value\fR pair is examined in order; the value corresponding to the first matching \fIstatespec\fR @@ -82,7 +82,7 @@ Typically \fIscript\fR simply defines styles and elements, though arbitrary Tcl code may appear. .TP \fBttk::style theme names\fR -Returns a list of the available themes. +Returns a list of all known themes. .TP \fBttk::style theme use\fR \fIthemeName\fR Sets the current theme to \fIthemeName\fR, and refreshes all widgets. @@ -99,10 +99,10 @@ Specifies which side of the cavity to place the element; one of \fBleft\fR, \fBright\fR, \fBtop\fR, or \fBbottom\fR. If omitted, the element occupies the entire cavity. .TP -\fB\-sticky [\fInswe\fB]\fR +\fB\-sticky\fR \fB[\fInswe\fB]\fR Specifies where the element is placed inside its allocated parcel. .TP -\fB\-children {\fIsublayout... \fB}\fR +\fB\-children { \fIsublayout... \fB}\fR Specifies a list of elements to place inside the element. .\" Also: -border, -unit, -expand: may go away. .PP diff --git a/doc/ttk_treeview.n b/doc/ttk_treeview.n index 249aef1..ec2e1ce 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.13 2007/12/10 16:21:01 jenglish Exp $ +'\" RCS: @(#) $Id: ttk_treeview.n,v 1.14 2007/12/12 15:51:22 jenglish Exp $ '\" .so man.macros .TH ttk::treeview n 8.5 Tk "Tk Themed Widget" @@ -429,7 +429,8 @@ 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 the affected item or items. -In Tk 8.5, the affected item is also passed as the \fB\-detail\fR field -of the virtual event. +'\" Not yet: +'\" In Tk 8.5, the affected item is also passed as the \fB\-detail\fR field +'\" of the virtual event. .SH "SEE ALSO" ttk::widget(n), listbox(n), image(n), bind(n) diff --git a/doc/ttk_widget.n b/doc/ttk_widget.n index d2979b8..26f7db0 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.11 2007/11/01 10:59:44 dkf Exp $ +'\" RCS: @(#) $Id: ttk_widget.n,v 1.12 2007/12/12 15:51:22 jenglish Exp $ '\" .so man.macros .TH ttk::widget n 8.5 Tk "Tk Themed Widget" @@ -40,14 +40,12 @@ 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 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. .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. @@ -67,7 +65,7 @@ This will cause the scrollbar to be updated whenever the view in the window changes. .PP If this option is set to the empty string (the default), -then no command is be executed. +then no command will be executed. .RE .OP \-yscrollcommand yScrollCommand ScrollCommand A command prefix, used to communicate with vertical scrollbars. @@ -121,10 +119,11 @@ If zero or unspecified, the natural width of the text label is used. .OP \-state state State May be set to \fBnormal\fR or \fBdisabled\fR to control the \fBdisabled\fR state bit. -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. +This is a write-only option: +setting it changes the widget state, +but the \fBstate\fR widget command +does not affect the \fB\-state\fR option. + .SH COMMANDS .TP \fIpathName \fBcget\fR \fIoption\fR @@ -155,11 +154,12 @@ If \fIscript\fR is specified, equivalent to if {[\fIpathName\fR instate \fIstateSpec\fR]} \fIscript\fR .CE .TP -\fIpathName \fBstate\fR ?\fIstateSpec\fR +\fIpathName \fBstate\fR ?\fIstateSpec\fR? Modify or inquire widget state. If \fIstateSpec\fR is present, sets the widget state: for each flag in \fIstateSpec\fR, sets the corresponding flag or clears it if prefixed by an exclamation point. +.RS Returns a new state spec indicating which flags were changed: .CS set changes [\fIpathName \fRstate \fIspec\fR] @@ -168,6 +168,7 @@ set changes [\fIpathName \fRstate \fIspec\fR] will restore \fIpathName\fR to the original state. If \fIstateSpec\fR is not specified, returns a list of the currently-enabled state flags. +.RE .SH "WIDGET STATES" The widget state is a bitmap of independent state flags. Widget state flags include: |