From 983fb168919502aae8279e5596bfaa149d17ff8f Mon Sep 17 00:00:00 2001 From: hobbs Date: Wed, 13 Dec 2006 23:04:32 +0000 Subject: * unix/Makefile.in (install-doc): intentionally skip ttk_dialog.n installation (not for public consumption) * doc/scrollbar.n, doc/button.n, doc/checkbutton.n: * doc/entry.n, doc/frame.n, doc/label.n, doc/labelframe.n: * doc/menu.n, doc/menubutton.n, doc/panedwindow.n: * doc/radiobutton.n, doc/scrollbar.n, doc/ttk_*: revamp ttk docs to use consist nroff format (not 100% consistent with classic widget docs). Add more man page cross-linking "SEE ALSO". --- ChangeLog | 10 ++++++++++ doc/button.n | 5 ++++- doc/checkbutton.n | 4 ++-- doc/entry.n | 5 ++++- doc/frame.n | 5 ++--- doc/label.n | 4 ++-- doc/labelframe.n | 7 ++++--- doc/menu.n | 8 +++++--- doc/menubutton.n | 5 ++++- doc/panedwindow.n | 6 +++++- doc/radiobutton.n | 4 ++-- doc/scrollbar.n | 5 ++++- doc/ttk_button.n | 20 ++++++++++++++------ doc/ttk_checkbutton.n | 18 +++++++++++++++--- doc/ttk_combobox.n | 38 +++++++++++++++++++++++++------------- doc/ttk_dialog.n | 22 ++++++++++++++++++---- doc/ttk_entry.n | 34 ++++++++++++++++++++++++---------- doc/ttk_frame.n | 23 +++++++++++++++++++---- doc/ttk_image.n | 13 +++++++++++-- doc/ttk_intro.n | 13 +++++++++++-- doc/ttk_label.n | 20 +++++++++++++++----- doc/ttk_labelframe.n | 29 +++++++++++++++++++++-------- doc/ttk_menubutton.n | 17 ++++++++++++++--- doc/ttk_notebook.n | 30 ++++++++++++++++++++++-------- doc/ttk_panedwindow.n | 34 +++++++++++++++++++++++----------- doc/ttk_progressbar.n | 36 +++++++++++++++++++++++------------- doc/ttk_radiobutton.n | 18 +++++++++++++++--- doc/ttk_scrollbar.n | 51 +++++++++++++++++++++++++++++---------------------- doc/ttk_separator.n | 19 +++++++++++++++---- doc/ttk_sizegrip.n | 19 +++++++++++++++---- doc/ttk_style.n | 13 ++++++++++--- doc/ttk_treeview.n | 32 ++++++++++++++++++++++---------- doc/ttk_widget.n | 18 ++++++++++++++---- unix/Makefile.in | 3 ++- 34 files changed, 425 insertions(+), 163 deletions(-) diff --git a/ChangeLog b/ChangeLog index aa28cae..2405c63 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,15 @@ 2006-12-13 Jeff Hobbs + * unix/Makefile.in (install-doc): intentionally skip ttk_dialog.n + installation (not for public consumption) + + * doc/scrollbar.n, doc/button.n, doc/checkbutton.n: + * doc/entry.n, doc/frame.n, doc/label.n, doc/labelframe.n: + * doc/menu.n, doc/menubutton.n, doc/panedwindow.n: + * doc/radiobutton.n, doc/scrollbar.n, doc/ttk_*: revamp ttk docs + to use consist nroff format (not 100% consistent with classic + widget docs). Add more man page cross-linking "SEE ALSO". + * generic/ttk/ttkInit.c: * generic/ttk/ttkTreeview.c: make treeview exist by default * generic/ttk/ttkPanedwindow.c: s/TtkPaned_Init/TtkPanedwindow_Init/ diff --git a/doc/button.n b/doc/button.n index dcb85f5..333ff61 100644 --- a/doc/button.n +++ b/doc/button.n @@ -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: button.n,v 1.10 2005/04/06 21:11:54 dkf Exp $ +'\" RCS: @(#) $Id: button.n,v 1.11 2006/12/13 23:04:32 hobbs Exp $ '\" .so man.macros .TH button n 4.4 Tk "Tk Built-In Commands" @@ -177,5 +177,8 @@ actions occur: the button is completely non-responsive. The behavior of buttons can be changed by defining new bindings for individual widgets or by redefining the class bindings. +.SH "SEE ALSO" +ttk_button(n) + .SH KEYWORDS button, widget diff --git a/doc/checkbutton.n b/doc/checkbutton.n index 6efcca9..c22bbcb 100644 --- a/doc/checkbutton.n +++ b/doc/checkbutton.n @@ -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: checkbutton.n,v 1.11 2005/12/01 03:54:06 hobbs Exp $ +'\" RCS: @(#) $Id: checkbutton.n,v 1.12 2006/12/13 23:04:32 hobbs Exp $ '\" .so man.macros .TH checkbutton n 4.4 Tk "Tk Built-In Commands" @@ -263,7 +263,7 @@ The behavior of checkbuttons can be changed by defining new bindings for individual widgets or by redefining the class bindings. .SH "SEE ALSO" -button(n), options(n), radiobutton(n) +button(n), options(n), radiobutton(n), ttk_checkbutton(n) .SH KEYWORDS checkbutton, widget diff --git a/doc/entry.n b/doc/entry.n index aaf5b09..8f7c4ed 100644 --- a/doc/entry.n +++ b/doc/entry.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: entry.n,v 1.15 2005/04/06 21:11:54 dkf Exp $ +'\" RCS: @(#) $Id: entry.n,v 1.16 2006/12/13 23:04:32 hobbs Exp $ '\" .so man.macros .TH entry n 8.3 Tk "Tk Built-In Commands" @@ -526,5 +526,8 @@ entry whatever the value of its \fB\-state\fR option. The behavior of entries can be changed by defining new bindings for individual widgets or by redefining the class bindings. +.SH "SEE ALSO" +ttk_entry(n) + .SH KEYWORDS entry, widget diff --git a/doc/frame.n b/doc/frame.n index 5ab53f8..8d362a1 100644 --- a/doc/frame.n +++ b/doc/frame.n @@ -5,8 +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: frame.n,v 1.5 2004/11/07 22:21:13 pspjuth Exp $ +'\" RCS: @(#) $Id: frame.n,v 1.6 2006/12/13 23:04:32 hobbs Exp $ '\" .so man.macros .TH frame n 8.4 Tk "Tk Built-In Commands" @@ -136,7 +135,7 @@ When a new frame is created, it has no default event bindings: frames are not intended to be interactive. .SH "SEE ALSO" -labelframe(n), toplevel(n) +labelframe(n), toplevel(n), ttk_frame(n) .SH KEYWORDS frame, widget diff --git a/doc/label.n b/doc/label.n index 593e561..93710e5 100644 --- a/doc/label.n +++ b/doc/label.n @@ -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: label.n,v 1.8 2006/11/15 16:31:23 dkf Exp $ +'\" RCS: @(#) $Id: label.n,v 1.9 2006/12/13 23:04:32 hobbs Exp $ '\" .so man.macros .TH label n 4.0 Tk "Tk Built-In Commands" @@ -125,7 +125,7 @@ pack .mid \-expand 1 \-fill both .CE .SH "SEE ALSO" -labelframe(n), button(n) +labelframe(n), button(n), ttk_label(n) .SH KEYWORDS label, widget diff --git a/doc/labelframe.n b/doc/labelframe.n index fb3ea2f..2937893 100644 --- a/doc/labelframe.n +++ b/doc/labelframe.n @@ -4,9 +4,8 @@ '\" '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. -'\" '\" -'\" RCS: @(#) $Id: labelframe.n,v 1.2 2006/11/16 11:22:32 dkf Exp $ +'\" RCS: @(#) $Id: labelframe.n,v 1.3 2006/12/13 23:04:32 hobbs Exp $ '\" .so man.macros .TH labelframe n 8.4 Tk "Tk Built-In Commands" @@ -178,7 +177,9 @@ set bun white set cheese none set pickle none .CE + .SH "SEE ALSO" -frame(n), label(n) +frame(n), label(n), ttk_labelframe(n) + .SH KEYWORDS labelframe, widget diff --git a/doc/menu.n b/doc/menu.n index ea6ecb0..4b5d2a3 100644 --- a/doc/menu.n +++ b/doc/menu.n @@ -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: menu.n,v 1.13 2006/12/04 15:16:31 dkf Exp $ +'\" RCS: @(#) $Id: menu.n,v 1.14 2006/12/13 23:04:32 hobbs Exp $ '\" .so man.macros .TH menu n 4.1 Tk "Tk Built-In Commands" @@ -744,7 +744,9 @@ individual widgets or by redefining the class bindings. At present it isn't possible to use the option database to specify values for the options to individual entries. + +.SH "SEE ALSO" +bind(n), menubutton(n), ttk_menubutton(n), toplevel(n) + .SH KEYWORDS menu, widget -.SH "SEE ALSO" -bind(n), menubutton(n), toplevel(n) diff --git a/doc/menubutton.n b/doc/menubutton.n index 2f0bef8..b3b42f7 100644 --- a/doc/menubutton.n +++ b/doc/menubutton.n @@ -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: menubutton.n,v 1.6 2004/08/16 14:01:10 dkf Exp $ +'\" RCS: @(#) $Id: menubutton.n,v 1.7 2006/12/13 23:04:32 hobbs Exp $ '\" .so man.macros .TH menubutton n 4.0 Tk "Tk Built-In Commands" @@ -191,5 +191,8 @@ actions occur: the menubutton is completely non-responsive. The behavior of menubuttons can be changed by defining new bindings for individual widgets or by redefining the class bindings. +.SH "SEE ALSO" +ttk_menubutton(n), menu(n) + .SH KEYWORDS menubutton, widget diff --git a/doc/panedwindow.n b/doc/panedwindow.n index 5f51675..b9f6e03 100644 --- a/doc/panedwindow.n +++ b/doc/panedwindow.n @@ -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: panedwindow.n,v 1.9 2006/11/15 13:29:17 dkf Exp $ +'\" RCS: @(#) $Id: panedwindow.n,v 1.10 2006/12/13 23:04:32 hobbs Exp $ '\" .so man.macros .TH panedwindow n 8.4 Tk "Tk Built-In Commands" @@ -267,6 +267,7 @@ panedwindow. \fISize\fR may be any value accepted by \fBTk_GetPixels\fR. .TP \fIpathName \fBpanes\fR Returns an ordered list of the widgets managed by \fIpathName\fR. + .SH "RESIZING PANES" A pane is resized by grabbing the sash (or sash handle if present) and dragging with the mouse. This is accomplished via mouse motion @@ -278,5 +279,8 @@ When a pane is resized from outside (e.g. it is packed to expand and fill, and the containing toplevel is resized), space is added to the final (rightmost or bottommost) pane in the window. +.SH "SEE ALSO" +ttk_panedwindow(n) + .SH KEYWORDS panedwindow, widget, geometry management diff --git a/doc/radiobutton.n b/doc/radiobutton.n index 549e62c..54307c0 100644 --- a/doc/radiobutton.n +++ b/doc/radiobutton.n @@ -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: radiobutton.n,v 1.10 2005/04/06 21:11:54 dkf Exp $ +'\" RCS: @(#) $Id: radiobutton.n,v 1.11 2006/12/13 23:04:32 hobbs Exp $ '\" .so man.macros .TH radiobutton n 4.4 Tk "Tk Built-In Commands" @@ -257,7 +257,7 @@ The behavior of radiobuttons can be changed by defining new bindings for individual widgets or by redefining the class bindings. .SH "SEE ALSO" -checkbutton(n), labelframe(n), listbox(n), options(n), scale(n) +checkbutton(n), labelframe(n), listbox(n), options(n), scale(n), ttk_radiobutton(n) .SH KEYWORDS radiobutton, widget diff --git a/doc/scrollbar.n b/doc/scrollbar.n index 8cc35fc..f370ac6 100644 --- a/doc/scrollbar.n +++ b/doc/scrollbar.n @@ -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: scrollbar.n,v 1.6 2004/10/28 12:25:53 dkf Exp $ +'\" RCS: @(#) $Id: scrollbar.n,v 1.7 2006/12/13 23:04:32 hobbs Exp $ '\" .so man.macros .TH scrollbar n 4.1 Tk "Tk Built-In Commands" @@ -341,5 +341,8 @@ grid columnconfigure .tl 0 -weight 1 grid rowconfigure .tl 0 -weight 1 .CE +.SH "SEE ALSO" +ttk_scrollbar(n) + .SH KEYWORDS scrollbar, widget diff --git a/doc/ttk_button.n b/doc/ttk_button.n index 396360c..ce1771b 100644 --- a/doc/ttk_button.n +++ b/doc/ttk_button.n @@ -1,22 +1,30 @@ '\" '\" Copyright (c) 2004 Joe English '\" +'\" 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 $ +'\" .so man.macros .TH ttk_button n 8.5 Tk "Tk Themed Widget" .BS +.\" Use _ instead of :: as the name becomes a filename on install .SH NAME -ttk::button \- Widget that issues a command when pressed +ttk_button \- Widget that issues a command when pressed .SH SYNOPSIS \fBttk::button\fR \fIpathName \fR?\fIoptions\fR? .BE + .SH DESCRIPTION -A \fBbutton\fR widget displays a textual label and/or image, +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 .SE + .SH "WIDGET-SPECIFIC OPTIONS" .OP \-command command Command A script to evaluate when the widget is invoked. @@ -31,7 +39,6 @@ The default is \fBnormal\fR. .br Depending on the theme, the default button may be displayed with an extra highlight ring, or with a different border color. -See also: \fIkeynav(n)\fR. .OP \-width width Width If greater than zero, specifies how much space, in character widths, to allocate for the text label. @@ -56,10 +63,10 @@ Invokes the command associated with the button. .TP \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR? .TP -\fIpathName \fBinstate \fIstatespec\fR ?\fIscript\fR? +\fIpathName \fBinstate \fIstateSpec\fR ?\fIscript\fR? .TP \fIpathName \fBstate\fR ?\fIstateSpec\fR? -See \fIwidget(n)\fR +See \fIttk_widget(n)\fR .SH "COMPATIBILITY OPTIONS" .OP \-state state State @@ -70,6 +77,7 @@ widget state, but the \fBstate\fR widget command does not affect the state option. .SH "SEE ALSO" -widget(n), keynav(n) +ttk_widget(n), button(n) + .SH "KEYWORDS" widget, button, default, command diff --git a/doc/ttk_checkbutton.n b/doc/ttk_checkbutton.n index e74b7b2..d38d731 100644 --- a/doc/ttk_checkbutton.n +++ b/doc/ttk_checkbutton.n @@ -1,16 +1,23 @@ '\" '\" Copyright (c) 2004 Joe English '\" +'\" 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.3 2006/12/13 23:04:32 hobbs Exp $ +'\" .so man.macros .TH ttk_checkbutton n 8.5 Tk "Tk Themed Widget" .BS +.\" Use _ instead of :: as the name becomes a filename on install .SH NAME -ttk::checkbutton \- On/off widget +ttk_checkbutton \- On/off widget .SH SYNOPSIS \fBttk::checkbutton\fR \fIpathName \fR?\fIoptions\fR? .BE + .SH DESCRIPTION -A \fBcheckbutton\fR widget is used to show or change a setting. +A \fBttk::checkbutton\fR widget is used to show or change a setting. It has two states, selected and deselected. The state of the checkbuton may be linked to a Tcl variable. .SO @@ -18,6 +25,7 @@ The state of the checkbuton may be linked to a Tcl variable. \-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. @@ -30,6 +38,7 @@ 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 @@ -46,6 +55,7 @@ Returns the result of the \fI-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 @@ -55,7 +65,9 @@ The widget sets the \fBalternate\fR state whenever the linked \fB-variable\fR is unset. (The \fBalternate\fR state may be used to indicate a ``tri-state'' or ``indeterminate'' selection.) + .SH "SEE ALSO" -widget(n), keynav(n), radiobutton(n) +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 3e2fe23..5f08b04 100644 --- a/doc/ttk_combobox.n +++ b/doc/ttk_combobox.n @@ -1,17 +1,30 @@ '\" '\" Copyright (c) 2004 Joe English '\" +'\" 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.3 2006/12/13 23:04:32 hobbs Exp $ +'\" .so man.macros .TH ttk_combobox n 8.5 Tk "Tk Themed Widget" .BS +.\" Use _ instead of :: as the name becomes a filename on install .SH NAME -ttk::combobox \- text field with popdown selection list +ttk_combobox \- text field with popdown selection list .SH SYNOPSIS \fBttk::combobox\fR \fIpathName \fR?\fIoptions\fR? +.BE + +.SH DESCRIPTION +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 .SE .\" ALSO: Other entry widget options + .SH "WIDGET-SPECIFIC OPTIONS" .OP \-exportselection exportSelection ExportSelection Boolean value. @@ -42,19 +55,16 @@ 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 DESCRIPTION -A combobox 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. + .SH "WIDGET COMMAND" .TP \fIpathName \fBcget\fR \fIoption\fR Returns the current value of the specified \fIoption\fR. -See \fIwidget(n)\fR. +See \fIttk_widget(n)\fR. .TP \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR? Modify or query widget options. -See \fIwidget(n)\fR. +See \fIttk_widget(n)\fR. .TP \fIpathName \fBcurrent\fR ?\fInewIndex\fR? If \fInewIndex\fR is supplied, sets the combobox value @@ -69,28 +79,30 @@ Returns the current value of the combobox. Returns the name of the element at position \fIx\fR, \fIy\fR, or the empty string if the coordinates are outside the window. .TP -\fIpathName \fBinstate \fIstatespec\fR ?\fIscript\fR? +\fIpathName \fBinstate \fIstateSpec\fR ?\fIscript\fR? Test the widget state. -See \fIwidget(n)\fR. +See \fIttk_widget(n)\fR. .TP \fIpathName \fBset\fR \fIvalue\fR Sets the value of the combobox to \fIvalue\fR. .TP \fIpathName \fBstate\fR ?\fIstateSpec\fR? Modify or query the widget state. -See \fIwidget(n)\fR. +See \fIttk_widget(n)\fR. .PP -The combobox widget also supports the following \fIentry\fR -widget commands (see \fIentry(n)\fR for details): +The combobox widget also supports the following \fIttk::entry\fR +widget commands (see \fIttk_entry(n)\fR for details): .DS .ta 5.5c 11c bbox delete icursor index insert selection xview .DE + .SH "VIRTUAL EVENTS" The combobox widget generates a \fB<>\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" -widget(n), entry(n) +ttk_widget(n), ttk_entry(n) diff --git a/doc/ttk_dialog.n b/doc/ttk_dialog.n index 8bcea18..41a30c6 100644 --- a/doc/ttk_dialog.n +++ b/doc/ttk_dialog.n @@ -1,14 +1,23 @@ '\" '\" Copyright (c) 2005 Joe English '\" +'\" See the file "license.terms" for information on usage and redistribution +'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. +'\" +'\" RCS: @(#) $Id: ttk_dialog.n,v 1.3 2006/12/13 23:04:33 hobbs Exp $ +'\" .so man.macros .TH ttk_dialog n 8.5 Tk "Tk Themed Widget" -.SH "NAME" -ttk::dialog \- create a dialog box +.BS +.\" Use _ instead of :: as the name becomes a filename on install +.SH NAME +ttk_dialog \- create a dialog box .SH "SYNOPSIS" \fBttk::dialog\fR \fIpathname\fR ?\fIoptions...\fR? \fBttk::dialog::define\fR \fIdialogType\fR ?\fIoptions...\fR? -.SH "DESCRIPTION" +.BE + +.SH DESCRIPTION A dialog box is a transient top-level window containing an icon, a short message, an optional, longer, detail message, and a row of command buttons. @@ -17,6 +26,7 @@ a callback function is invoked and then the dialog is destroyed. .PP Additional widgets may be added in the dialog \fIclient frame\fR. + .SH "WIDGET-SPECIFIC OPTIONS" .OP \-title undefined undefined Specifies a string to use as the window manager title. @@ -55,12 +65,14 @@ The cancel button is invoked if the user presses the Escape key and when the dialog is closed from the window manager. If \fB-cancel\fR is not specified, the dialog ignores window manager close commands (WM_DELETE_WINDOW). + .SH "WIDGET COMMANDS" .TP \fBttk::dialog::clientframe \fIdlg\fR Returns the widget path of the client frame. Other widgets may be added to the client frame. The client frame appears between the detail message and the command buttons. + .SH "PREDEFINED DIALOG TYPES" The \fB-type\fR option, if present, specifies default values for other options. \fBttk::dialog::define \fItype options...\fR @@ -78,6 +90,7 @@ ttk::dialog::define yesnocancel \e ttk::dialog::define retrycancel \e -icon question -buttons {retry cancel} -cancel cancel .CE + .SH "STOCK BUTTONS" The following ``stock'' symbolic button names have predefined labels: \fByes\fR, \fBno\fR, \fBok\fR, \fBcancel\fR, and \fBretry\fR. @@ -116,5 +129,6 @@ ttk::dialog .saveFileDialog \e -command saveFileComplete \e ; .CE + .SH "SEE ALSO" -\fBtk_messageBox(n)\fR, \fBwm(n)\fR, \fBtoplevel(n)\fR +tk_messageBox(n), wm(n), toplevel(n) diff --git a/doc/ttk_entry.n b/doc/ttk_entry.n index 1a55452..66a3651 100644 --- a/doc/ttk_entry.n +++ b/doc/ttk_entry.n @@ -1,7 +1,4 @@ '\" -'\" SOURCE: entry.n, r1.12 -'\" -'\" Copyright (c) 1990-1994 The Regents of the University of California. '\" Copyright (c) 1994-1996 Sun Microsystems, Inc. '\" Copyright (c) 1998-2000 Scriptics Corporation. '\" Copyright (c) 2004 Joe English @@ -9,16 +6,22 @@ '\" See the file "license.terms" for information on usage and redistribution '\" 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 $ +'\" .so man.macros .TH ttk_entry n 8.5 Tk "Tk Themed Widget" .BS +.\" Use _ instead of :: as the name becomes a filename on install .SH NAME -ttk::entry \- Editable text field widget +ttk_entry \- Editable text field widget .SH SYNOPSIS \fBttk::entry\fR \fIpathName \fR?\fIoptions\fR? +.BE + .SH DESCRIPTION .PP -An \fBentry\fR widget displays a one-line text string and +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. @@ -28,6 +31,7 @@ standard \fB-xscrollcommand\fR option and \fBxview\fR widget command. \-class \-cursor \-style \-takefocus \-xscrollcommand .SE + .SH "WIDGET-SPECIFIC OPTIONS" .OP \-exportselection exportSelection ExportSelection A boolean value specifying whether or not @@ -60,7 +64,7 @@ If characters in the entry are selected and copied elsewhere, the information copied will be what is displayed, not the true contents of the entry. .OP \-state state State -Compatibility option; see \fBwidget(n)\fR for details. +Compatibility option; see \fIttk_widget(n)\fR for details. Specifies one of three states for the entry, \fBnormal\fR, \fBdisabled\fR, or \fBreadonly\fR. See \fBWIDGET STATES\fR, below. @@ -85,6 +89,7 @@ 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 @@ -102,6 +107,7 @@ 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 @@ -132,6 +138,7 @@ 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: @@ -148,11 +155,11 @@ of the window. .TP \fIpathName \fBcget\fR \fIoption\fR Returns the current value of the specified \fIoption\fR. -See \fIwidget(n)\fR. +See \fIttk_widget(n)\fR. .TP \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR? Modify or query widget options. -See \fIwidget(n)\fR. +See \fIttk_widget(n)\fR. .TP \fIpathName \fBdelete \fIfirst \fR?\fIlast\fR? Delete one or more elements of the entry. @@ -183,7 +190,7 @@ indicated by \fIindex\fR. Returns the empty string. .TP \fIpathName \fBinstate \fIstatespec\fR ?\fIscript\fR? Test the widget state. -See \fIwidget(n)\fR. +See \fIttk_widget(n)\fR. .TP \fIpathName \fBselection \fIoption arg\fR This command is used to adjust the selection within an entry. It @@ -209,7 +216,7 @@ earlier one, then the entry's selection is cleared. .TP \fIpathName \fBstate\fR ?\fIstateSpec\fR? Modify or query the widget state. -See \fIwidget(n)\fR. +See \fIttk_widget(n)\fR. .TP \fIpathName \fBvalidate\fR Force revalidation, independent of the conditions specified @@ -255,6 +262,7 @@ 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 options are used to enable entry widget validation. @@ -337,6 +345,7 @@ 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. + .SH "DEFAULT BINDINGS" The entry widget's default bindings enable the following behavior. In the descriptions below, ``word'' refers to a contiguous group @@ -416,6 +425,7 @@ 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. @@ -434,5 +444,9 @@ 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 efb6fa6..5c33aba 100644 --- a/doc/ttk_frame.n +++ b/doc/ttk_frame.n @@ -1,17 +1,28 @@ +'\" '\" Copyright (c) 2005 Joe English +'\" +'\" 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 $ +'\" .so man.macros .TH ttk_frame n 8.5 Tk "Tk Themed Widget" .BS +.\" Use _ instead of :: as the name becomes a filename on install .SH NAME -ttk::frame \- Simple container widget +ttk_frame \- Simple container widget .SH SYNOPSIS \fBttk::frame\fR \fIpathName \fR?\fIoptions\fR? .BE + .SH DESCRIPTION -A \fBframe\fR widget is a container, used to group other widgets together. +A \fBttk::frame\fR widget is a container, used to group other widgets +together. .SO \-class \-cursor \-takefocus \-style .SE + .SH "WIDGET-SPECIFIC OPTIONS" .OP -borderwidth borderWidth BorderWidth The desired width of the widget border. Defaults to 0. @@ -26,10 +37,12 @@ Additional padding to include inside the border. If specified, the widget's requested width in pixels. .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 \fIwidget(n)\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, @@ -37,7 +50,9 @@ by the GM's requested size will normally take precedence 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" -widget(n), labelframe(n) +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 30c6698..53a73f2 100644 --- a/doc/ttk_image.n +++ b/doc/ttk_image.n @@ -1,6 +1,10 @@ '\" '\" Copyright (c) 2004 Joe English -'\" $Id: ttk_image.n,v 1.4 2006/12/09 20:53:35 jenglish Exp $ +'\" +'\" 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.5 2006/12/13 23:04:33 hobbs Exp $ '\" .so man.macros .TH ttk_image n 8.5 Tk "Tk Themed Widget" @@ -10,6 +14,7 @@ ttk_image \- Define an element based on an image .SH SYNOPSIS \fBttk::style element create \fIname\fR \fBimage\fR \fIimageSpec\fR ?\fIoptions\fR? .BE + .SH DESCRIPTION The \fIimage\fR element factory creates a new element in the current theme whose visual appearance is determined @@ -19,8 +24,9 @@ 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: +Valid \fIoptions\fR are: .TP \fB-border\fR \fIpadding\fR \fIpadding\fR is a list of up to four integers, specifying @@ -55,6 +61,7 @@ The \fB-border\fR divides the image into 9 regions: 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] @@ -64,7 +71,9 @@ 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 1187c3f..2ee1944 100644 --- a/doc/ttk_intro.n +++ b/doc/ttk_intro.n @@ -1,12 +1,18 @@ '\" '\" Copyright (c) 2004 Joe English '\" +'\" 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.3 2006/12/13 23:04:33 hobbs Exp $ +'\" .so man.macros .TH ttk_intro n 8.5 Tk "Tk Themed Widget" .BS .SH NAME ttk_intro \- Introduction to the Tk theme engine .BE + .SH "OVERVIEW" The Tk themed widget set is based on a revised and enhanced version of TIP #48 (http://tip.tcl.tk/48) specified style engine. @@ -17,6 +23,7 @@ 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. @@ -97,7 +104,7 @@ The themed Tk widgets generalizes this idea: every widget has a bitmap of independent state flags. Widget state flags include \fBactive\fR, \fBdisabled\fR, \fBpressed\fR, \fBfocus\fR, etc., -(see \fIwidget(n)\fR for the full list of state flags). +(see \fIttk_widget(n)\fR for the full list of state flags). .PP Instead of a \fB-state\fR option, every widget now has a \fBstate\fR widget command which is used to set or query @@ -131,6 +138,7 @@ in the \fBpressed\fR state. 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. @@ -156,5 +164,6 @@ style map TButton \e -relief [list {pressed !disabled} sunken] \e ; .CE + .SH "SEE ALSO" -widget(n), style(n) +ttk_widget(n), ttk_style(n) diff --git a/doc/ttk_label.n b/doc/ttk_label.n index 02f21eb..7a647bd 100644 --- a/doc/ttk_label.n +++ b/doc/ttk_label.n @@ -1,16 +1,23 @@ '\" '\" Copyright (c) 2004 Joe English '\" +'\" 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 $ +'\" .so man.macros .TH ttk_label n 8.5 Tk "Tk Themed Widget" .BS +.\" Use _ instead of :: as the name becomes a filename on install .SH NAME -ttk::label \- Display a text string and/or image +ttk_label \- Display a text string and/or image .SH SYNOPSIS \fBttk::label\fR \fIpathName \fR?\fIoptions\fR? .BE + .SH DESCRIPTION -A \fBlabel\fR widget displays a textual label and/or image. +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 @@ -18,6 +25,7 @@ to automatically change the displayed text. \-style \-takefocus \-text \-textvariable \-underline \-width .SE + .SH "WIDGET-SPECIFIC OPTIONS" .OP \-anchor anchor Anchor Specifies how the information in the widget is positioned @@ -61,15 +69,17 @@ 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 .TP \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR? .TP -\fIpathName \fBinstate \fIstatespec\fR ?\fIscript\fR? +\fIpathName \fBinstate \fIstateSpec\fR ?\fIscript\fR? .TP \fIpathName \fBstate\fR ?\fIstateSpec\fR? -See \fIwidget(n)\fR +See \fIttk_widget(n)\fR + .SH "SEE ALSO" -widget(n) +ttk_widget(n), label(n) diff --git a/doc/ttk_labelframe.n b/doc/ttk_labelframe.n index 8771f19..7e13941 100644 --- a/doc/ttk_labelframe.n +++ b/doc/ttk_labelframe.n @@ -1,18 +1,29 @@ +'\" '\" Copyright (c) 2005 Joe English +'\" +'\" 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 $ +'\" .so man.macros .TH ttk_labelframe n 8.5 Tk "Tk Themed Widget" .BS +.\" Use _ instead of :: as the name becomes a filename on install .SH NAME -ttk::labelframe \- Container widget with optional label +ttk_labelframe \- Container widget with optional label .SH SYNOPSIS \fBttk::labelframe\fR \fIpathName \fR?\fIoptions\fR? .BE + .SH DESCRIPTION -A \fBlabelframe\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. +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 .SE + .SH "WIDGET-SPECIFIC OPTIONS" '\" XXX: Currently included, but may go away: '\" XXX: .OP -borderwidth borderWidth BorderWidth @@ -37,8 +48,7 @@ Specifies the text of the label. .OP -underline underline Underline If set, specifies the integer index (0-based) of a character to underline in the text string. -The underlined character is used for mnemonic activation -(see \fIkeynav(n)\fR). +The underlined character is used for mnemonic activation. Mnemonic activation for a \fBttk::labelframe\fR sets the keyboard focus to the first child of the \fBttk::labelframe\fR widget. .OP -padding padding Padding @@ -53,12 +63,15 @@ same top-level widget as the \fBlabelframe\fR. 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\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 \fIwidget(n)\fR. +see \fIttk_widget(n)\fR. + .SH "SEE ALSO" -widget(n), frame(n) +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 572a2ea..11bc820 100644 --- a/doc/ttk_menubutton.n +++ b/doc/ttk_menubutton.n @@ -1,22 +1,30 @@ '\" '\" Copyright (c) 2004 Joe English '\" +'\" 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 $ +'\" .so man.macros .TH ttk_menubutton n 8.5 Tk "Tk Themed Widget" .BS +.\" Use _ instead of :: as the name becomes a filename on install .SH NAME -ttk::menubutton \- Widget that pops down a menu when pressed +ttk_menubutton \- Widget that pops down a menu when pressed .SH SYNOPSIS \fBttk::menubutton\fR \fIpathName \fR?\fIoptions\fR? .BE + .SH DESCRIPTION -A \fBmenubutton\fR widget displays a textual label and/or image, +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 .SE + .SH "WIDGET-SPECIFIC OPTIONS" .OP \-direction direction Direction Specifies where the menu is to be popped up relative @@ -31,11 +39,14 @@ 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" -widget(n), keynav(n), menu(n) +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 8912666..18459d4 100644 --- a/doc/ttk_notebook.n +++ b/doc/ttk_notebook.n @@ -1,26 +1,34 @@ '\" '\" Copyright (c) 2004 Joe English '\" +'\" 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 $ +'\" .so man.macros .TH ttk_notebook n 8.5 Tk "Tk Themed Widget" .BS +.\" Use _ instead of :: as the name becomes a filename on install .SH NAME -ttk::notebook \- Multi-paned container widget +ttk_notebook \- Multi-paned container widget .SH SYNOPSIS \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? .BE + .SH DESCRIPTION -A \fBnotebook\fR widget manages a collection of subpanes +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 .SE -.SH "WIDGET OPTIONS" + +.SH "WIDGET-SPECIFIC OPTIONS" .OP \-height height Height If present and greater than zero, specifies the desired height of the pane area @@ -70,6 +78,7 @@ 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? @@ -80,10 +89,10 @@ will be displayed. See \fBTAB OPTIONS\fR for the list of available \fIoptions\fR. .TP \fIpathname \fBconfigure\fR ?\fIoptions\fR? -See \fIwidget(n)\fR. +See \fIttk_widget(n)\fR. .TP \fIpathname \fBcget\fR \fIoption\fR -See \fIwidget(n)\fR. +See \fIttk_widget(n)\fR. .TP \fIpathname \fBforget\fR \fItabid\fR Removes the tab specified by \fItabid\fR, @@ -102,7 +111,7 @@ 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 \fIwidget(n)\fR. +See \fIttk_widget(n)\fR. .TP \fIpathname \fBselect\fR ?\fItabid\fR? Selects the specified tab. The associated child pane will be displayed, @@ -111,7 +120,7 @@ If \fItabid\fR is omitted, returns the widget name of the currently selected pane. .TP \fIpathname \fBstate\fR ?\fIstatespec\fR? -See \fIwidget(n)\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. @@ -123,6 +132,7 @@ See \fBTAB OPTIONS\fR for the available options. \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: @@ -144,6 +154,7 @@ 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. + .SH "TAB IDENTIFIERS" The \fItabid\fR argument to the above commands may take any of the following forms: @@ -165,6 +176,7 @@ which returns the number of tabs .SH "VIRTUAL EVENTS" The notebook widget generates a \fB<>\fR virtual event after a new tab is selected. + .SH "EXAMPLE" .CS notebook .nb @@ -173,7 +185,9 @@ notebook .nb \.nb select .nb.f2 ttk::notebook::enableTraversal .nb .CE + .SH "SEE ALSO" -widget(n), grid(n) +ttk_widget(n), grid(n) + .SH "KEYWORDS" pane, tab diff --git a/doc/ttk_panedwindow.n b/doc/ttk_panedwindow.n index 1c7661e..43eea62 100644 --- a/doc/ttk_panedwindow.n +++ b/doc/ttk_panedwindow.n @@ -1,10 +1,17 @@ -'\" $Id: ttk_panedwindow.n,v 1.2 2006/11/15 13:29:17 dkf Exp $ +'\" '\" Copyright (c) 2005 Joe English +'\" +'\" 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.3 2006/12/13 23:04:33 hobbs Exp $ +'\" .so man.macros .TH ttk_panedwindow n 8.5 Tk "Tk Themed Widget" .BS -.SH "NAME" -ttk::panedwindow \- Multi-pane container window +.\" Use _ instead of :: as the name becomes a filename on install +.SH NAME +ttk_panedwindow \- Multi-pane container window .SH SYNOPSIS .nf \fBttk::panedwindow\fR \fIpathName \fR?\fIoptions\fR? @@ -13,28 +20,31 @@ ttk::panedwindow \- Multi-pane container window \fIpathName \fBinsert\fR \fIindex\fR \fIpathName.subwindow\fR ?\fIoptions...\fR? .fi .BE -.SH "DESCRIPTION" -A paned 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. + +.SH DESCRIPTION +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 .SE -.SH "WIDGET OPTIONS" + +.SH "WIDGET-SPECIFIC OPTIONS" .OP \-orient orient Orient Specifies the orientation of the window. If \fBvertical\fR, subpanes are stacked top-to-bottom; if \fBhorizontal\fR, subpanes are stacked left-to-right. + .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 subracted 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 \fIwidget(n)\fR for details. +and \fBinstate\fR commands; see \fIttk_widget(n)\fR for details. Additional commands: .TP \fIpathname \fBadd\fR \fIsubwindow\fR \fIoptions...\fR @@ -61,6 +71,7 @@ If no \fI-option\fR is specified, returns a dictionary of the pane 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. + .SH "INTERNAL ROUTINES" The following routines are used internally by the \fBpaned\fR widget binding code. @@ -74,5 +85,6 @@ Returns the position of sash number \fIindex\fR. Returns a list consisting of the sash index at point \fIx,y\fR and the name of the sash subelement at that point. Returns the empty list if \fIx,y\fR is not over a sash. + .SH "SEE ALSO" -\fIwidget(n)\fR, \fInotebook(n)\fR. +ttk_widget(n), ttk_notebook(n), panedwindow(n) diff --git a/doc/ttk_progressbar.n b/doc/ttk_progressbar.n index 2f5eedb..f94c12e 100644 --- a/doc/ttk_progressbar.n +++ b/doc/ttk_progressbar.n @@ -1,16 +1,31 @@ '\" '\" Copyright (c) 2005 Joe English '\" +'\" 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.3 2006/12/13 23:04:33 hobbs Exp $ +'\" .so man.macros .TH ttk_progressbar n 8.5 Tk "Tk Themed Widget" .BS +.\" Use _ instead of :: as the name becomes a filename on install .SH NAME -ttk::progressbar \- Provide progress feedback +ttk_progressbar \- Provide progress feedback .SH SYNOPSIS \fBttk::progressbar\fR \fIpathName \fR?\fIoptions\fR? +.BE + +.SH DESCRIPTION +A \fBttk::progressbar\fR widget shows the status of a long-running +operation. They can operate in two modes: \fIdeterminate\fR mode shows the +amount 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 .SE + .SH "WIDGET-SPECIFIC OPTIONS" .OP \-orient orient Orient One of \fBhorizontal\fR or \fBvertical\fR. @@ -41,23 +56,17 @@ 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. -.BE -.SH "DESCRIPTION" -A progress bar widget shows the status of a long-running operation. -They can operate in two modes: \fIdeterminate\fR mode shows the -amount 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. + .SH "WIDGET COMMAND" .TP \fIpathName \fBcget\fR \fIoption\fR -Returns the current value of the specified \fIoption\fR; see \fIwidget(n)\fR. +Returns the current value of the specified \fIoption\fR; see \fIttk_widget(n)\fR. .TP \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR? -Modify or query widget options; see \fIwidget(n)\fR. +Modify or query widget options; see \fIttk_widget(n)\fR. .TP \fIpathName \fBinstate \fIstatespec\fR ?\fIscript\fR? -Test the widget state; see \fIwidget(n)\fR. +Test the widget state; see \fIttk_widget(n)\fR. .TP \fIpathName \fBstart\fR ?\fIinterval\fR? Begin autoincrement mode: @@ -66,7 +75,7 @@ every \fIinterval\fR milliseconds. If omitted, \fIinterval\fR defaults to 50 milliseconds (20 steps/second). .TP \fIpathName \fBstate\fR ?\fIstateSpec\fR? -Modify or query the widget state; see \fIwidget(n)\fR. +Modify or query the widget state; see \fIttk_widget(n)\fR. .TP \fIpathName \fBstep\fR ?\fIamount\fR? Increments the \fB-value\fR by \fIamount\fR. @@ -75,5 +84,6 @@ Increments the \fB-value\fR by \fIamount\fR. \fIpathName \fBstop\fR Stop autoincrement mode: cancels any recurring timer event initiated by \fIpathName \fBstart\fR. + .SH "SEE ALSO" -widget(n) +ttk_widget(n) diff --git a/doc/ttk_radiobutton.n b/doc/ttk_radiobutton.n index 6d6d9db..e9e93a6 100644 --- a/doc/ttk_radiobutton.n +++ b/doc/ttk_radiobutton.n @@ -1,16 +1,23 @@ '\" '\" Copyright (c) 2004 Joe English '\" +'\" 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 $ +'\" .so man.macros .TH ttk_radiobutton n 8.5 Tk "Tk Themed Widget" .BS +.\" Use _ instead of :: as the name becomes a filename on install .SH NAME -ttk::radiobutton \- Mutually exclusive option widget +ttk_radiobutton \- Mutually exclusive option widget .SH SYNOPSIS \fBttk::radiobutton\fR \fIpathName \fR?\fIoptions\fR? .BE + .SH DESCRIPTION -\fBradiobutton\fR widgets are used in groups to show or change +\fBttk::radiobutton\fR widgets are used in groups to show or change a set of mutually-exclusive options. Radiobuttons are linked to a Tcl variable, and have an associated value; when a radiobutton is clicked, @@ -20,6 +27,7 @@ it sets the variable to its associated value. \-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. @@ -29,6 +37,7 @@ 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 @@ -42,6 +51,7 @@ Returns the result of the \fI-command\fR, or the empty string if no \fI-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 @@ -51,7 +61,9 @@ The widget sets the \fBalternate\fR state whenever the linked \fB-variable\fR is unset. (The \fBalternate\fR state may be used to indicate a ``tri-state'' or ``indeterminate'' selection.) + .SH "SEE ALSO" -widget(n), keynav(n), checkbutton(n) +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 090c964..de4a666 100644 --- a/doc/ttk_scrollbar.n +++ b/doc/ttk_scrollbar.n @@ -1,25 +1,37 @@ '\" -'\" SOURCE: tk/doc/scrollbar.n, r1.4 -'\" -'\" Copyright (c) 1990-1994 The Regents of the University of California. '\" Copyright (c) 1994-1996 Sun Microsystems, Inc. '\" Copyright (c) 2004 Joe English '\" '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" $Id: ttk_scrollbar.n,v 1.2 2006/11/15 13:29:17 dkf Exp $ +'\" SOURCE: tk/doc/scrollbar.n, r1.4 +'\" RCS: @(#) $Id: ttk_scrollbar.n,v 1.3 2006/12/13 23:04:33 hobbs Exp $ '\" .so man.macros .TH ttk_scrollbar n 8.5 Tk "Tk Themed Widget" .BS +.\" Use _ instead of :: as the name becomes a filename on install .SH NAME -ttk::scrollbar \- Control the viewport of a scrollable widget +ttk_scrollbar \- Control the viewport of a scrollable widget .SH SYNOPSIS \fBttk::scrollbar\fR \fIpathName \fR?\fIoptions...\fR? +.BE + +.SH DESCRIPTION +\fBttk::scrollbar\fR widgets are typically linked to an associated window +that displays a document of some sort, such as a file being edited or a +drawing. +A scrollbar displays a \fIthumb\fR in the middle portion of the scrollbar, +whose position and size provides information about the portion of the +document visible in the associated window. +The thumb may be dragged by the user to 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 .SE + .SH "WIDGET-SPECIFIC OPTIONS" .OP \-command command Command A Tcl script prefix to evaluate @@ -37,33 +49,20 @@ One of \fBhorizontal\fR or \fBvertical\fR. Specifies the orientation of the scrollbar. .BE -.SH DESCRIPTION -Scrollbar widgets are typically linked to an associated window -that displays a document of some sort, -such as a file being edited or a drawing. -A scrollbar displays a \fIthumb\fR in the -middle portion of the scrollbar, -whose position and size provides information -about the portion of the document visible in -the associated window. -The thumb may be dragged by the user to 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. .SH "WIDGET COMMAND" .TP \fIpathName \fBcget\fR \fIoption\fR -Returns the current value of the specified \fIoption\fR; see \fIwidget(n)\fR. +Returns the current value of the specified \fIoption\fR; see \fIttk_widget(n)\fR. .TP \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR? -Modify or query widget options; see \fIwidget(n)\fR. +Modify or query widget options; see \fIttk_widget(n)\fR. .TP \fIpathName \fBget\fR Returns the scrollbar settings in the form of a list whose elements are the arguments to the most recent \fBset\fR widget command. .TP \fIpathName \fBinstate \fIstatespec\fR ?\fIscript\fR? -Test the widget state; see \fIwidget(n)\fR. +Test the widget state; see \fIttk_widget(n)\fR. .TP \fIpathName \fBset\fR \fIfirst last\fR This command is normally invoked by the scrollbar's associated widget @@ -72,7 +71,8 @@ Specifies the visible range to be displayed. \fIfirst\fR and \fIlast\fR are real fractions between 0 and 1. .TP \fIpathName \fBstate\fR ?\fIstateSpec\fR? -Modify or query the widget state; see \fIwidget(n)\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. @@ -103,6 +103,7 @@ 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 @@ -138,12 +139,14 @@ 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] @@ -156,5 +159,9 @@ 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 50892e9..9e4ccbf 100644 --- a/doc/ttk_separator.n +++ b/doc/ttk_separator.n @@ -1,30 +1,41 @@ -'\" $Id: ttk_separator.n,v 1.2 2006/11/15 13:29:17 dkf Exp $ '\" '\" Copyright (c) 2004 Joe English '\" +'\" 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 $ +'\" .so man.macros .TH ttk_separator n 8.5 Tk "Tk Themed Widget" .BS +.\" Use _ instead of :: as the name becomes a filename on install .SH NAME -ttk::separator \- Separator bar +ttk_separator \- Separator bar .SH SYNOPSIS \fBttk::separator\fR \fIpathName \fR?\fIoptions\fR? .BE + .SH DESCRIPTION -A \fBseparator\fR widget displays a horizontal or vertical separator bar. +A \fBttk::separator\fR widget displays a horizontal or vertical separator +bar. .SO \-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" -widget(n) +ttk_widget(n) + .SH "KEYWORDS" widget, separator diff --git a/doc/ttk_sizegrip.n b/doc/ttk_sizegrip.n index 505013c..41e9565 100644 --- a/doc/ttk_sizegrip.n +++ b/doc/ttk_sizegrip.n @@ -1,27 +1,35 @@ -'\" $Id: ttk_sizegrip.n,v 1.2 2006/11/15 13:29:17 dkf Exp $ '\" '\" Copyright (c) 2006 Joe English '\" +'\" 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.3 2006/12/13 23:04:33 hobbs Exp $ +'\" .so man.macros .TH ttk_sizegrip n 8.5 Tk "Tk Themed Widget" .BS +.\" Use _ instead of :: as the name becomes a filename on install .SH NAME -ttk::sizegrip \- A silly widget +ttk_sizegrip \- Bottom-right corner resize widget .SH SYNOPSIS \fBttk::sizegrip\fR \fIpathName \fR?\fIoptions\fR? .BE + .SH DESCRIPTION -A \fBsizegrip\fR widget (also known as a \fIgrow box\fR) +A \fBttk::sizegrip\fR widget (also known as a \fIgrow box\fR) allows the user to resize the containing toplevel window by pressing and dragging the grip. .SO \-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. @@ -39,6 +47,7 @@ grid [ttk::sizegrip $top.statusbar.grip] \ # ... 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 sceen @@ -47,7 +56,9 @@ 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" -widget(n) +ttk_widget(n) + .SH "KEYWORDS" widget, sizegrip, grow box diff --git a/doc/ttk_style.n b/doc/ttk_style.n index cbdb165..52322c3 100644 --- a/doc/ttk_style.n +++ b/doc/ttk_style.n @@ -1,15 +1,20 @@ '\" '\" Copyright (c) 2004 Joe English -'\" $Id: ttk_style.n,v 1.2 2006/11/15 13:29:17 dkf Exp $ +'\" +'\" 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 $ '\" .so man.macros .TH ttk_style n 8.5 Tk "Tk Themed Widget" .BS .SH NAME -ttk::style \- Control overall look and feel of widgets +ttk_style \- Control overall look and feel of widgets .SH SYNOPSIS \fBttk::style\fR \fIoption\fR ?\fIargs\fR? .BE + .SH NOTES .PP This manpage has not been written yet. @@ -115,7 +120,9 @@ ttk::style layout Horizontal.TScrollbar { } } .CE + .SH "SEE ALSO" -ttk_intro(n), ttk_widget(n), pixmap +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 a15bfe9..0770c7c 100644 --- a/doc/ttk_treeview.n +++ b/doc/ttk_treeview.n @@ -1,14 +1,22 @@ '\" '\" Copyright (c) 2004 Joe English '\" +'\" 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.3 2006/12/13 23:04:33 hobbs Exp $ +'\" .so man.macros .TH ttk_treeview n 8.5 Tk "Tk Themed Widget" +.\" Use _ instead of :: as the name becomes a filename on install .SH NAME -ttk::treeview \- hierarchical multicolumn data display widget +ttk_treeview \- hierarchical multicolumn data display widget .SH SYNOPSIS \fBttk::treeview\fR \fIpathname \fR?\fIoptions\fR? -.SH "DESCRIPTION" -The treeview widget displays a hierarchical collection of items. +.BE + +.SH DESCRIPTION +The \fBttk::treeview\fR widget displays a hierarchical collection of items. Each item has a textual label, an optional image, and an optional list of data values. The data values are displayed in successive columns after @@ -40,7 +48,8 @@ They probably ought to support horizontal scrolling as well. \-class \-cursor \-takefocus \-style \-yscrollcommand .SE -.SH "WIDGET OPTIONS" + +.SH "WIDGET-SPECIFIC OPTIONS" .OP \-columns columns Columns A list of column identifiers, specifying the number of columns and their names. @@ -85,6 +94,7 @@ The default is \fBtree headings\fR, i.e., show all elements. \fBNOTE:\fR Column #0 always refers to the tree column, even if \fB-show tree\fR is not specified. .RE + .SH "WIDGET COMMAND" .TP \fIpathname \fBbbox\fR \fIitem\fR ?\fIcolumn\fR? @@ -97,7 +107,7 @@ If the \fIitem\fR is not visible returns the empty list. .TP \fIpathname \fBcget\fR \fIoption\fR -Returns the current value of the specified \fIoption\fR; see \fIwidget(n)\fR. +Returns the current value of the specified \fIoption\fR; see \fIttk_widget(n)\fR. .TP \fIpathname \fBchildren\fR \fIitem\fR ?\fInewchildren\fR? If \fInewchildren\fR is not specified, @@ -139,7 +149,7 @@ Use \fIpathname column #0\fR to configure the tree column. .RE .TP \fIpathname \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR? -Modify or query widget options; see \fIwidget(n)\fR. +Modify or query widget options; see \fIttk_widget(n)\fR. .TP \fIpathname \fBdelete\fR \fIitemList\fR Deletes each of the items in \fIitemList\fR and all of their descendants. @@ -225,7 +235,7 @@ newly created item. See \fBITEM OPTIONS\fR for the list of available options. .TP \fIpathname \fBinstate \fIstatespec\fR ?\fIscript\fR? -Test the widget state; see \fIwidget(n)\fR. +Test the widget state; see \fIttk_widget(n)\fR. .TP \fIpathname \fBitem\fR \fIitem\fR ?\fI-option \fR?\fIvalue -option value...\fR? Query or modify the options for the specified \fIitem\fR. @@ -289,7 +299,7 @@ in item \fIitem\fR to the specified \fIvalue\fR. See also \fBCOLUMN IDENTIFIERS\fR. .TP \fIpathname \fBstate\fR ?\fIstateSpec\fR? -Modify or query the widget state; see \fIwidget(n)\fR. +Modify or query the widget state; see \fIttk_widget(n)\fR. .TP \fIpathName \fBtag \fIargs...\fR .RS @@ -322,7 +332,7 @@ See \fBTAG OPTIONS\fR for the list of available options. .RE .TP \fIpathName \fByview \fIargs\fR -Standard command for vertical scrolling; see \fIwidget(n)\fR. +Standard command for vertical scrolling; see \fIttk_widget(n)\fR. .PP .SH "ITEM OPTIONS" @@ -361,6 +371,7 @@ Specifies the font to use when drawing text. Specifies the item image, in case the item's \fB-image\fR option is empty. .PP \fI(@@@ TODO: sort out order of precedence for options)\fR + .SH "COLUMN IDENTIFIERS" Column identifiers take any of the following forms: .IP \(bu @@ -398,5 +409,6 @@ 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. + .SH "SEE ALSO" -widget(n), listbox(n), image(n), bind(n) +ttk_widget(n), listbox(n), image(n), bind(n) diff --git a/doc/ttk_widget.n b/doc/ttk_widget.n index da22343..1c70d67 100644 --- a/doc/ttk_widget.n +++ b/doc/ttk_widget.n @@ -1,15 +1,21 @@ '\" '\" Copyright (c) 2004 Joe English -'\" $Id: ttk_widget.n,v 1.2 2006/11/15 13:29:17 dkf Exp $ +'\" +'\" 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 2006/12/13 23:04:33 hobbs Exp $ '\" .so man.macros .TH ttk_widget n 8.5 Tk "Tk Themed Widget" .BS .SH NAME -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 @@ -35,6 +41,7 @@ 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 @@ -63,6 +70,7 @@ then no command is be executed. .OP \-yscrollcommand yScrollCommand ScrollCommand A command prefix, used to communicate with vertical scrollbars. 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: @@ -75,8 +83,7 @@ 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. -The underlined character is used for mnemonic activation -(see \fIkeynav(n)\fR). +The underlined character is used for mnemonic activation. .OP \-image image Image Specifies an image to display. This is a list of 1 or more elements. @@ -205,6 +212,7 @@ 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] @@ -218,7 +226,9 @@ $b instate {pressed !disabled} { .b invoke } # Reenable widget: $b state !disabled .CE + .SH "SEE ALSO" ttk_intro(n), style(n) + .SH KEYWORDS state, configure, option diff --git a/unix/Makefile.in b/unix/Makefile.in index 5643302..177af09 100644 --- a/unix/Makefile.in +++ b/unix/Makefile.in @@ -5,7 +5,7 @@ # "autoconf" program (constructs like "@foo@" will get replaced in the # actual Makefile. # -# RCS: @(#) $Id: Makefile.in,v 1.119 2006/12/13 20:38:28 hobbs Exp $ +# RCS: @(#) $Id: Makefile.in,v 1.120 2006/12/13 23:04:33 hobbs Exp $ # Current Tk version; used in various names. @@ -834,6 +834,7 @@ install-doc: @echo "Installing and cross-linking command (.n) docs"; @for i in $(TOP_DIR)/doc/*.n; do \ + if [ "ttk_dialog.n" = `basename $$i` ] ; then continue ; fi ; \ $(UNIX_DIR)/installManPage $(MAN_FLAGS) $$i $(MANN_INSTALL_DIR); \ done -- cgit v0.12