head	1.19;
access;
symbols
	core-8-5-9:1.13.2.3
	core-8-5-8:1.13.2.2
	macosx-cocoa-merge:1.17
	macosx-cocoa-premerge:1.17
	macosx-carbon-freeze:1.17
	core-8-5-7:1.13.2.1
	core-8-5-6:1.13.2.1
	core-8-6-b1:1.17
	core-8-6-a3:1.16
	core-8-5-5:1.13.2.1
	core-8-6-a2:1.15
	core-8-5-4:1.13.2.1
	core-8-5-3:1.13.2.1
	core-8-6-a1:1.14
	core-8-5-branch:1.13.0.2
	core-8-5-2:1.13
	core-8-5-1:1.13
	core-8-5-0:1.13
	core-8-5-b3:1.11
	core-8-5-b2:1.8
	core-8-5-b1:1.3
	core-stablilizer-merge:1.3
	core-stabilizer-branch:1.3.0.2
	core-stabilizer-merge:1.13.2.1
	core-8-5-a6:1.3;
locks; strict;
comment	@# @;


1.19
date	2010.07.03.17.25.51;	author jenglish;	state Exp;
branches;
next	1.18;

1.18
date	2009.11.01.18.12.44;	author jenglish;	state Exp;
branches;
next	1.17;

1.17
date	2008.12.03.18.44.49;	author jenglish;	state Exp;
branches;
next	1.16;

1.16
date	2008.09.23.13.36.58;	author dkf;	state Exp;
branches;
next	1.15;

1.15
date	2008.06.30.22.57.03;	author dkf;	state Exp;
branches;
next	1.14;

1.14
date	2008.05.09.18.35.00;	author patthoyts;	state Exp;
branches;
next	1.13;

1.13
date	2007.12.13.15.23.44;	author dgp;	state Exp;
branches
	1.13.2.1;
next	1.12;

1.12
date	2007.12.12.15.51.22;	author jenglish;	state Exp;
branches;
next	1.11;

1.11
date	2007.11.01.10.59.44;	author dkf;	state Exp;
branches;
next	1.10;

1.10
date	2007.10.30.21.29.59;	author dkf;	state Exp;
branches;
next	1.9;

1.9
date	2007.10.29.16.04.14;	author dkf;	state Exp;
branches;
next	1.8;

1.8
date	2007.10.26.20.13.23;	author dgp;	state Exp;
branches;
next	1.7;

1.7
date	2007.10.26.12.25.38;	author dkf;	state Exp;
branches;
next	1.6;

1.6
date	2007.10.24.14.32.59;	author dkf;	state Exp;
branches;
next	1.5;

1.5
date	2007.10.23.15.44.36;	author dkf;	state Exp;
branches;
next	1.4;

1.4
date	2007.10.22.14.33.13;	author dkf;	state Exp;
branches;
next	1.3;

1.3
date	2006.12.13.23.04.33;	author hobbs;	state Exp;
branches
	1.3.2.1;
next	1.2;

1.2
date	2006.11.15.13.29.17;	author dkf;	state Exp;
branches;
next	1.1;

1.1
date	2006.10.31.01.42.25;	author hobbs;	state Exp;
branches;
next	;

1.3.2.1
date	2007.10.24.12.59.32;	author dgp;	state Exp;
branches;
next	1.3.2.2;

1.3.2.2
date	2007.10.27.04.23.15;	author dgp;	state Exp;
branches;
next	1.3.2.3;

1.3.2.3
date	2007.11.01.16.37.16;	author dgp;	state Exp;
branches;
next	1.3.2.4;

1.3.2.4
date	2007.12.13.06.28.47;	author dgp;	state Exp;
branches;
next	1.3.2.5;

1.3.2.5
date	2008.06.25.16.46.03;	author dgp;	state Exp;
branches;
next	;

1.13.2.1
date	2008.05.11.00.31.03;	author patthoyts;	state Exp;
branches;
next	1.13.2.2;

1.13.2.2
date	2009.05.14.00.53.04;	author patthoyts;	state Exp;
branches;
next	1.13.2.3;

1.13.2.3
date	2010.08.26.02.06.09;	author hobbs;	state Exp;
branches;
next	;


desc
@@


1.19
log
@ttk_widget.n(SEE ALSO): s/style/ttk::style/
(patch from David Welton sent to tcl-core)
@
text
@'\"
'\" 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_widget.n,v 1.18 2009/11/01 18:12:44 jenglish Exp $
'\"
.so man.macros
.TH ttk::widget n 8.5 Tk "Tk Themed Widget"
.BS
.SH NAME
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
Specifies the window class.
The class is used when querying the option database
for the window's other options, to determine the default
bindtags for the window, and to select the widget's default
layout and style.
This is a read-only option:
it may only be specified when the window is created,
and may not be changed with the \fBconfigure\fR widget command.
.OP \-cursor cursor Cursor
Specifies the mouse cursor to be used for the widget.
See \fBTk_GetCursor\fR and \fIcursors(n)\fR in the Tk reference manual
for the legal values.
If set to the empty string (the default),
the cursor is inherited from the parent widget.
.OP \-takefocus takeFocus TakeFocus
Determines whether the window accepts the focus during keyboard traversal.
Either \fB0\fR, \fB1\fR, a command prefix (to which the widget path
is appended, and which should return \fB0\fR or \fB1\fR),
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"
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
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 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.
.PP
Typically the \fBxScrollCommand\fR option consists of the path name
of a \fBscrollbar\fR widget followed by
.QW set ,
e.g.
.QW ".x.scrollbar set" .
This will cause the scrollbar to be updated whenever the view in the
window changes.
.PP
If this option is set to the empty string (the default),
then no command will 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.
.SH "LABEL OPTIONS"
The following options are supported by labels, buttons,
and other button-like widgets:
.OP \-text text Text
Specifies a text string to be displayed inside the widget
(unless overridden by \fB\-textvariable\fR).
.OP \-textvariable textVariable Variable
Specifies the name of variable whose value will be used
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.
.OP \-image image Image
Specifies an image to display.
This is a list of 1 or more elements.
The first element is the default image name.
The rest of the list is a sequence of \fIstatespec / value\fR pairs
as per \fBstyle map\fR, specifying different images to use when
the widget is in a particular state or combination of states.
All images in the list should have the same size.
.OP \-compound compound Compound
Specifies how to display the image relative to the text,
in the case both \fB\-text\fR and \fB\-image\fR are present.
Valid values are:
.RS
.IP text
Display text only.
.IP image
Display image only.
.IP center
Display text centered on top of image.
.IP top
.IP bottom
.IP left
.IP right
Display image above, below, left of, or right of the text, respectively.
.IP none
The default; display the image if present, otherwise the text.
.RE
.OP \-width width Width
If greater than zero, specifies how much space, in character widths,
to allocate for the text label.
If less than zero, specifies a minimum width.
If zero or unspecified, the natural width of the text label is used.
.SH "COMPATIBILITY OPTIONS"
.OP \-state state State
May be set to \fBnormal\fR or \fBdisabled\fR
to control the \fBdisabled\fR state bit.
This is a write-only option:
setting it changes the widget state,
but the \fBstate\fR widget command
does not affect the \fB\-state\fR option.
.SH COMMANDS
.TP
\fIpathName \fBcget\fR \fIoption\fR
Returns the current value of the configuration option given
by \fIoption\fR.
.TP
\fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
Query or modify the configuration options of the widget.
If one or more \fIoption\-value\fR pairs are specified,
then the command modifies the given widget option(s)
to have the given value(s);
in this case the command returns an empty string.
If \fIoption\fR is specified with no \fIvalue\fR,
then the command returns a list describing the named option:
the elements of the list are the
option name, database name, database class, default value,
and current value.
.\" Note: Ttk widgets don't use TK_OPTION_SYNONYM.
If no \fIoption\fR is specified, returns a list describing all of
the available options for \fIpathName\fR.
.TP
\fIpathName \fBidentify\fR \fBelement\fR \fIx y\fR
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 within any element.
\fIx\fR and \fIy\fR are pixel coordinates relative to the widget.
Some widgets accept other \fBidentify\fR subcommands.
.TP
\fIpathName \fBinstate\fR \fIstatespec\fR ?\fIscript\fR?
Test the widget's state.
If \fIscript\fR is not specified, returns 1 if
the widget state matches \fIstatespec\fR and 0 otherwise.
If \fIscript\fR is specified, equivalent to
.CS
if {[\fIpathName\fR instate \fIstateSpec\fR]} \fIscript\fR
.CE
.TP
\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]
\fIpathName \fRstate $changes
.CE
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:
.TP
\fBactive\fR
The mouse cursor is over the widget
and pressing a mouse button will cause some action to occur. (aka
.QW prelight
(Gnome),
.QW hot
(Windows),
.QW hover ).
.TP
\fBdisabled\fR
Widget is disabled under program control (aka
.QW unavailable ,
.QW inactive )
.TP
\fBfocus\fR
Widget has keyboard focus
.TP
\fBpressed\fR
Widget is being pressed (aka
.QW armed
in Motif).
.TP
\fBselected\fR
.QW On ,
.QW true ,
or
.QW current
for things like checkbuttons and radiobuttons.
.TP
\fBbackground\fR
Windows and the Mac have a notion of an
.QW active
or foreground window.
The \fBbackground\fR state is set for widgets in a background window,
and cleared for those in the foreground window.
.TP
\fBreadonly\fR
Widget should not allow user modification.
.TP
\fBalternate\fR
A widget-specific alternate display format.
For example, used for checkbuttons and radiobuttons in the
.QW tristate
or
.QW mixed
state, and for buttons with \fB\-default active\fR.
.TP
\fBinvalid\fR
The widget's value is invalid.
(Potential uses: scale widget value out of bounds,
entry widget value failed validation.)
.TP
\fBhover\fR
The mouse cursor is within the widget.
This is similar to the \fBactive\fP state;
it is used in some themes for widgets that
provide distinct visual feedback for
the active widget in addition to the active element
within the widget.
.PP
A \fIstate specification\fR or \fIstateSpec\fR is a list
of state names, optionally prefixed with an exclamation point (!)
indicating that the bit is off.
.SH EXAMPLES
.CS
set b [ttk::button .b]

# Disable the widget:
$b state disabled

# Invoke the widget only if it is currently pressed and enabled:
$b instate {pressed !disabled} { .b invoke }

# Reenable widget:
$b state !disabled
.CE
.SH "SEE ALSO"
ttk::intro(n), ttk::style(n)
.SH KEYWORDS
state, configure, option
'\" Local Variables:
'\" mode: nroff
'\" End:
@


1.18
log
@Uniform, extensible syntax for [$w identify] methods:
[$w identify $component $x $y].
All ttk::* widgets support [$w identify element $x $y];
widgets with other identifiable parts may have additional subcommands.
Notebook widgets support [$nb identify tab],
Panedwindow widgets support [$w identify sash].
Older 2-argument form [$w identify $x $y] still supported,
though it does different things depending on the widget.
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: ttk_widget.n,v 1.17 2008/12/03 18:44:49 jenglish Exp $
d259 1
a259 1
ttk::intro(n), style(n)
@


1.17
log
@Add new "hover" state
(patch from Pat Thoyts; needed to support proper visual feedback on Vista).
@
text
@d3 1
a3 1
'\" 
d6 3
a8 3
'\" 
'\" RCS: @@(#) $Id: ttk_widget.n,v 1.16 2008/09/23 13:36:58 dkf Exp $
'\" 
a15 1
.PP
d21 1
a21 1
The class is used when querying the option database 
d25 1
a25 1
This is a read-only option: 
d35 1
a35 1
Determines whether the window accepts the focus during keyboard traversal.  
d37 1
a37 1
is appended, and which should return \fB0\fR or \fB1\fR), 
a42 1
.PP
d44 1
a44 1
are controllable by a scrollbar.  
d59 1
a59 1
Typically the \fBxScrollCommand\fR option consists of the path name 
d64 1
a64 1
This will cause the scrollbar to be updated whenever the view in the 
a73 1
.PP
d83 1
a83 1
If set, specifies the integer index (0-based) of a character to underline 
d97 1
a97 1
Valid values are: 
d114 2
a115 2
If greater than zero, specifies how much space, in character widths, 
to allocate for the text label.  
d123 2
a124 2
setting it changes the widget state, 
but the \fBstate\fR widget command 
a126 1
.PP
d135 2
a136 2
then the command modifies the given widget option(s) 
to have the given value(s); 
d138 1
a138 1
If \fIoption\fR is specified with no \fIvalue\fR, 
d140 2
a141 2
the elements of the list are the 
option name, database name, database class, default value, 
d147 2
a148 2
\fIpathName \fBidentify\fR \fIx y\fR
Returns the name of the element under the point given 
d152 2
a153 1
.TP 
d156 1
a156 1
If \fIscript\fR is not specified, returns 1 if 
d162 1
a162 1
.TP 
d165 1
a165 1
If \fIstateSpec\fR is present, sets the widget state: 
d175 1
a175 1
If \fIstateSpec\fR is not specified, 
a178 1
.PP
d183 1
a183 1
The mouse cursor is over the widget 
d194 1
a194 1
.QW inactive ) 
d197 1
a197 1
Widget has keyboard focus 
d202 1
a202 1
in Motif). 
d209 1
a209 1
for things like checkbuttons and radiobuttons. 
d231 1
a231 1
(Potential uses: scale widget value out of bounds, 
a245 1
.PP
@


1.16
log
@Fix [Bug 2118116]
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: ttk_widget.n,v 1.15 2008/06/30 22:57:03 dkf Exp $
d237 8
@


1.15
log
@Minor doc updates (removing out of date changebars, improving typedef formatting,
 etc.)
@
text
@a0 1
'\" -*- nroff -*-
d7 1
a7 1
'\" RCS: @@(#) $Id: ttk_widget.n,v 1.14 2008/05/09 18:35:00 patthoyts Exp $
d259 3
@


1.14
log
@Document the identify command as present on all ttk widgets
@
text
@d1 1
d8 1
a8 1
'\" RCS: @@(#) $Id: ttk_widget.n,v 1.13 2007/12/13 15:23:44 dgp Exp $
d17 1
d45 1
d77 1
a129 1

d131 1
d183 1
d243 1
@


1.13
log
@merge stable branch onto HEAD
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: ttk_widget.n,v 1.3.2.4 2007/12/13 06:28:47 dgp Exp $
d147 6
@


1.13.2.1
log
@Backported documentation fixes from HEAD
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: ttk_widget.n,v 1.14 2008/05/09 18:35:00 patthoyts Exp $
a146 6
.TP
\fIpathName \fBidentify\fR \fIx y\fR
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 within any element.
\fIx\fR and \fIy\fR are pixel coordinates relative to the widget.
@


1.13.2.2
log
@Backported support for the Vista theme.
This requires the vsapi element engine, the hover state and the theme script definition.
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: ttk_widget.n,v 1.13.2.1 2008/05/11 00:31:03 patthoyts Exp $
a232 8
.TP
\fBhover\fR
The mouse cursor is within the widget.
This is similar to the \fBactive\fP state;
it is used in some themes for widgets that
provide distinct visual feedback for
the active widget in addition to the active element
within the widget.
@


1.13.2.3
log
@        Major backport of 8.6 Ttk for 8.5.9.  Most changes were only being
        committed to head (8.6), although they could apply for 8.5 as well.
        This re-sync makes future work easier to maintain and adds some
        useful work for 8.5 users. Notable changes:
        - Lots of code cleanup
        - Some bug fixes never backported
        - Addition of ttk::spinbox
        - minor color changes
        - Improved Vista/7 styling
        - Move to tile version 0.8.6 (pseudo-package)
        - ABI and API compatible (even $w identify)
        - minor new features (extended $w identify)
@
text
@d3 1
a3 1
'\"
d6 3
a8 3
'\"
'\" RCS: @@(#) $Id: ttk_widget.n,v 1.19 2010/07/03 17:25:51 jenglish Exp $
'\"
d10 1
a10 1
.TH ttk::widget n 8.5.9 Tk "Tk Themed Widget"
d21 1
a21 1
The class is used when querying the option database
d25 1
a25 1
This is a read-only option:
d35 1
a35 1
Determines whether the window accepts the focus during keyboard traversal.
d37 1
a37 1
is appended, and which should return \fB0\fR or \fB1\fR),
d44 1
a44 1
are controllable by a scrollbar.
d59 1
a59 1
Typically the \fBxScrollCommand\fR option consists of the path name
d64 1
a64 1
This will cause the scrollbar to be updated whenever the view in the
d83 1
a83 1
If set, specifies the integer index (0-based) of a character to underline
d97 1
a97 1
Valid values are:
d114 2
a115 2
If greater than zero, specifies how much space, in character widths,
to allocate for the text label.
d123 2
a124 2
setting it changes the widget state,
but the \fBstate\fR widget command
d126 1
d136 2
a137 2
then the command modifies the given widget option(s)
to have the given value(s);
d139 1
a139 1
If \fIoption\fR is specified with no \fIvalue\fR,
d141 2
a142 2
the elements of the list are the
option name, database name, database class, default value,
d148 2
a149 2
\fIpathName \fBidentify\fR \fBelement\fR \fIx y\fR
Returns the name of the element under the point given
d153 1
a153 2
Some widgets accept other \fBidentify\fR subcommands.
.TP
d156 1
a156 1
If \fIscript\fR is not specified, returns 1 if
d162 1
a162 1
.TP
d165 1
a165 1
If \fIstateSpec\fR is present, sets the widget state:
d175 1
a175 1
If \fIstateSpec\fR is not specified,
d183 1
a183 1
The mouse cursor is over the widget
d194 1
a194 1
.QW inactive )
d197 1
a197 1
Widget has keyboard focus
d202 1
a202 1
in Motif).
d209 1
a209 1
for things like checkbuttons and radiobuttons.
d231 1
a231 1
(Potential uses: scale widget value out of bounds,
d259 1
a259 1
ttk::intro(n), ttk::style(n)
a261 3
'\" Local Variables:
'\" mode: nroff
'\" End:
@


1.12
log
@Various minor updates to ttk_* manpages.
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: ttk_widget.n,v 1.11 2007/11/01 10:59:44 dkf Exp $
@


1.11
log
@Make documentation use the name that scripts use as much as possible.
[Bug 1640073]
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: ttk_widget.n,v 1.10 2007/10/30 21:29:59 dkf Exp $
a42 1
.PP
a48 1
.PP
d68 1
a68 1
then no command is be executed.
d122 5
a126 4
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.
d157 1
a157 1
\fIpathName \fBstate\fR ?\fIstateSpec\fR
d162 1
d171 1
@


1.10
log
@More documentation improvements
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: ttk_widget.n,v 1.9 2007/10/29 16:04:14 dkf Exp $
d10 1
a10 1
.TH ttk_widget n 8.5 Tk "Tk Themed Widget"
d13 1
a13 1
ttk_widget \- Standard options and commands supported by Tk themed widgets
d244 1
a244 1
ttk_intro(n), style(n)
@


1.9
log
@Lots more GOOBE stuff. Now works with 'make html'!
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: ttk_widget.n,v 1.8 2007/10/26 20:13:23 dgp Exp $
a14 1

a16 1

a41 1

d49 2
a50 1
.br
d60 1
a60 1
.br
d68 1
a68 1
.br
d71 1
a74 1

d235 1
a235 1
$b state disabled			
d238 1
a238 1
$b instate {pressed !disabled} { .b invoke }	
d241 1
a241 1
$b state !disabled			
@


1.8
log
@        * doc/*.1:              Revert doc changes that broke
        * doc/*.3:              `make html` so we can get the release
        * doc/*.n:              out the door.
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: ttk_widget.n,v 1.3 2006/12/13 23:04:33 hobbs Exp $
d64 4
a67 1
of a \fBscrollbar\fR widget followed by ``set'', e.g. ``.x.scrollbar set''.
d75 1
a75 1
See the description of \fB-xscrollcommand\fR above for details.
d82 1
a82 1
(unless overridden by \fB-textvariable\fR).
d85 1
a85 1
in place of the \fB-text\fR resource.
d100 1
a100 1
in the case both \fB-text\fR and \fB-image\fR are present.
a121 1

d126 4
a129 4
This is a ``write-only'' option: setting it changes the
widget state, but the \fBstate\fR widget command does
not affect the state option.

d179 6
a184 2
and pressing a mouse button will cause some action to occur.
(aka "prelight" (Gnome), "hot" (Windows), "hover").
d187 3
a189 2
Widget is disabled under program control 
(aka "unavailable", "inactive") 
d195 3
a197 1
Widget is being pressed (aka "armed" in Motif). 
d200 5
a204 1
"On", "true", or "current" for things like checkbuttons and radiobuttons. 
d207 3
a209 1
Windows and the Mac have a notion of an "active" or foreground window.
d218 5
a222 3
For example, used for checkbuttons and radiobuttons 
in the "tristate" or "mixed" state,
and for buttons with \fB-default active\fR.
a231 1

a244 1

a246 1

@


1.7
log
@Fix minor faults
@
text
@d3 1
a3 1
'\"
d6 3
a8 3
'\"
'\" RCS: @@(#) $Id: ttk_widget.n,v 1.6 2007/10/24 14:32:59 dkf Exp $
'\"
d18 1
d22 8
a29 5
Specifies the window class. The class is used when querying the option
database for the window's other options, to determine the default bindtags for
the window, and to select the widget's default layout and style. This is a
read-only option: it may only be specified when the window is created, and may
not be changed with the \fBconfigure\fR widget command.
d31 5
a35 4
Specifies the mouse cursor to be used for the widget. See \fBTk_GetCursor\fR
and \fIcursors(n)\fR in the Tk reference manual for the legal values. If set
to the empty string (the default), the cursor is inherited from the parent
widget.
d37 4
a40 3
Determines whether the window accepts the focus during keyboard traversal.
Either \fB0\fR, \fB1\fR, a command prefix (to which the widget path is
appended, and which should return \fB0\fR or \fB1\fR), or the empty string.
d44 1
d47 3
a49 2
The following options are supported by widgets that are controllable by a
scrollbar. See \fIscrollbar(n)\fR for more information
d52 18
a69 21
.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
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.
.PP
Typically the \fBxScrollCommand\fR option consists of the path name of a
\fBscrollbar\fR widget followed by
.QW set ,
e.g.
.QW ".x.scrollbar set" .
This will cause the scrollbar to be updated whenever the view in the window
changes.
.PP
If this option is set to the empty string (the default), then no command is be
executed.
.RE
d71 3
a73 2
A command prefix, used to communicate with vertical scrollbars. See the
description of \fB\-xscrollcommand\fR above for details.
d75 2
a76 2
The following options are supported by labels, buttons, and other button-like
widgets:
d78 2
a79 2
Specifies a text string to be displayed inside the widget (unless overridden
by \fB\-textvariable\fR).
d81 2
a82 2
Specifies the name of variable whose value will be used in place of the
\fB\-text\fR resource.
d84 3
a86 2
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.
d88 7
a94 5
Specifies an image to display. This is a list of 1 or more elements. The first
element is the default image name. The rest of the list is a sequence of
\fIstatespec / value\fR pairs as per \fBstyle map\fR, specifying different
images to use when the widget is in a particular state or combination of
states. All images in the list should have the same size.
d96 3
a98 2
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:
d100 1
a100 1
.IP \fBtext\fR
d102 1
a102 1
.IP \fBimage\fR
d104 1
a104 1
.IP \fBcenter\fR
d106 4
a109 1
.IP "\fBtop\fR, \fBbottom\fR, \fBleft\fR, \fBright\fR"
d111 1
a111 1
.IP \fBnone\fR
d115 5
a119 3
If greater than zero, specifies how much space, in character widths, to
allocate for the text label. If less than zero, specifies a minimum width. If
zero or unspecified, the natural width of the text label is used.
d122 6
a127 5
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.
d131 2
a132 2
.
Returns the current value of the configuration option given by \fIoption\fR.
d135 10
a144 8
.
Query or modify the configuration options of the widget. If one or more
\fIoption\-value\fR pairs are specified, then the command modifies the given
widget option(s) to have the given value(s); in this case the command returns
an empty string. If \fIoption\fR is specified with no \fIvalue\fR, then the
command returns a list describing the named option: the elements of the list
are the option name, database name, database class, default value, and current
value.
d146 3
a148 3
If no \fIoption\fR is specified, returns a list describing all of the
available options for \fIpathName\fR.
.TP
d150 4
a153 5
.
Test the widget's state. If \fIscript\fR is not specified, returns 1 if the
widget state matches \fIstatespec\fR and 0 otherwise.  If \fIscript\fR is
specified, equivalent to
.RS
d157 1
a157 2
.RE
.TP
d159 5
a163 6
.
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. Returns a new state spec indicating
which flags were changed:
.RS
d168 3
a170 3
will restore \fIpathName\fR to the original state. If \fIstateSpec\fR is not
specified, returns a list of the currently-enabled state flags.
.RE
d172 2
a173 2
The widget state is a bitmap of independent state flags. Widget state flags
include:
d176 3
a178 8
.
The mouse cursor is over the widget and pressing a mouse button will cause
some action to occur. (aka 
.QW "prelight"
(Gnome),
.QW "hot"
(Windows),
.QW "hover" ).
d181 2
a182 4
.
Widget is disabled under program control (aka
.QW "unavailable" ,
.QW "inactive" )
d185 1
a185 2
.
Widget has keyboard focus.
d188 1
a188 4
.
Widget is being pressed (aka
.QW "armed"
in Motif).
d191 1
a191 7
.
The widget is
.QW "On" ,
.QW "true" ,
or
.QW "current"
(for things like checkbuttons and radiobuttons).
d194 3
a196 5
.
Windows and the Mac have a notion of an
.QW "active"
or foreground window. The \fBbackground\fR state is set for widgets in a
background window, and cleared for those in the foreground window.
a198 1
.
d202 4
a205 7
.
A widget-specific alternate display format. For example, used for checkbuttons
and radiobuttons in the
.QW "tristate"
or
.QW "mixed"
state, and for buttons with \fB\-default active\fR.
d208 3
a210 3
.
The widget's value is invalid. (Potential uses: scale widget value out of
bounds, entry widget value failed validation.)
d212 4
a215 3
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.
d221 1
a221 1
$b state disabled
d224 1
a224 1
$b instate {pressed !disabled} { .b invoke }
d227 1
a227 1
$b state !disabled
d229 1
d232 1
@


1.6
log
@Lots of improvements to look and feel of manual pages
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: ttk_widget.n,v 1.5 2007/10/23 15:44:36 dkf Exp $
d96 1
a96 1
.IP \fBtop\fR, \fBbottom\fR, \fBleft\fR, \fBright\fR
@


1.5
log
@Rendering-with-groff GOOBE.
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: ttk_widget.n,v 1.4 2007/10/22 14:33:13 dkf Exp $
a17 1

a37 1

d55 5
a59 2
\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
a67 1

a104 1

d108 4
a111 3
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.

d163 6
a168 1
some action to occur. (aka "prelight" (Gnome), "hot" (Windows), "hover").
d172 3
a174 1
Widget is disabled under program control (aka "unavailable", "inactive")
d182 3
a184 1
Widget is being pressed (aka "armed" in Motif).
d188 6
a193 2
The widget is "On", "true", or "current" (for things like checkbuttons and
radiobuttons).
d197 4
a200 3
Windows and the Mac have a notion of an "active" or foreground window. The
\fBbackground\fR state is set for widgets in a background window, and cleared
for those in the foreground window.
d209 5
a213 2
and radiobuttons in the "tristate" or "mixed" state, and for buttons with
\fB\-default active\fR.
a222 1

a235 1

@


1.4
log
@Documentation improvements, all minor.
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: ttk_widget.n,v 1.3 2006/12/13 23:04:33 hobbs Exp $
d46 2
a47 1
.br
d55 1
a55 1
.br
d60 1
a60 1
.br
d63 1
d90 1
a90 1
.IP text
d92 1
a92 1
.IP image
d94 1
a94 1
.IP center
d96 1
a96 4
.IP top
.IP bottom
.IP left
.IP right
d98 1
a98 1
.IP none
@


1.3
log
@	* 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".
@
text
@d3 1
a3 1
'\" 
d6 3
a8 3
'\" 
'\" RCS: @@(#) $Id: popup.n,v 1.4 2004/06/21 20:59:29 dkf Exp $
'\" 
d22 5
a26 8
Specifies the window class.
The class is used when querying the option database 
for the window's other options, to determine the default
bindtags for the window, and to select the widget's default
layout and style.
This is a read-only option: 
it may only be specified when the window is created,
and may not be changed with the \fBconfigure\fR widget command.
d28 4
a31 5
Specifies the mouse cursor to be used for the widget.
See \fBTk_GetCursor\fR and \fIcursors(n)\fR in the Tk reference manual
for the legal values.
If set to the empty string (the default),
the cursor is inherited from the parent widget.
d33 3
a35 4
Determines whether the window accepts the focus during keyboard traversal.  
Either \fB0\fR, \fB1\fR, a command prefix (to which the widget path
is appended, and which should return \fB0\fR or \fB1\fR), 
or the empty string.
d42 2
a43 3
The following options are supported by widgets that
are controllable by a scrollbar.  
See \fIscrollbar(n)\fR for more information
d47 7
a53 9
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 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.
d55 4
a58 4
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.
d60 2
a61 2
If this option is set to the empty string (the default),
then no command is be executed.
d63 2
a64 2
A command prefix, used to communicate with vertical scrollbars.
See the description of \fB-xscrollcommand\fR above for details.
d67 2
a68 2
The following options are supported by labels, buttons,
and other button-like widgets:
d70 2
a71 2
Specifies a text string to be displayed inside the widget
(unless overridden by \fB-textvariable\fR).
d73 2
a74 2
Specifies the name of variable whose value will be used
in place of the \fB-text\fR resource.
d76 2
a77 3
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.
d79 5
a83 7
Specifies an image to display.
This is a list of 1 or more elements.
The first element is the default image name.
The rest of the list is a sequence of \fIstatespec / value\fR pairs
as per \fBstyle map\fR, specifying different images to use when
the widget is in a particular state or combination of states.
All images in the list should have the same size.
d85 2
a86 3
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: 
d103 3
a105 4
If greater than zero, specifies how much space, in character widths, 
to allocate for the text label.  
If less than zero, specifies a minimum width.
If zero or unspecified, the natural width of the text label is used.
d109 3
a111 5
May be set to \fBnormal\fR or \fBdisabled\fR
to control the \fBdisabled\fR state bit.
This is a ``write-only'' option: setting it changes the
widget state, but the \fBstate\fR widget command does
not affect the state option.
d116 2
a117 2
Returns the current value of the configuration option given
by \fIoption\fR.
d120 8
a127 10
Query or modify the configuration options of the widget.
If one or more \fIoption\-value\fR pairs are specified,
then the command modifies the given widget option(s) 
to have the given value(s); 
in this case the command returns an empty string.
If \fIoption\fR is specified with no \fIvalue\fR, 
then the command returns a list describing the named option:
the elements of the list are the 
option name, database name, database class, default value, 
and current value.
d129 3
a131 3
If no \fIoption\fR is specified, returns a list describing all of
the available options for \fIpathName\fR.
.TP 
d133 5
a137 4
Test the widget's state.
If \fIscript\fR is not specified, returns 1 if 
the widget state matches \fIstatespec\fR and 0 otherwise.
If \fIscript\fR is specified, equivalent to
d141 2
a142 1
.TP 
d144 6
a149 5
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.
Returns a new state spec indicating which flags were changed:
d154 3
a156 3
will restore \fIpathName\fR to the original state.
If \fIstateSpec\fR is not specified, 
returns a list of the currently-enabled state flags.
d158 2
a159 2
The widget state is a bitmap of independent state flags.
Widget state flags include:
d162 3
a164 3
The mouse cursor is over the widget 
and pressing a mouse button will cause some action to occur.
(aka "prelight" (Gnome), "hot" (Windows), "hover").
d167 2
a168 2
Widget is disabled under program control 
(aka "unavailable", "inactive") 
d171 2
a172 1
Widget has keyboard focus 
d175 2
a176 1
Widget is being pressed (aka "armed" in Motif). 
d179 3
a181 1
"On", "true", or "current" for things like checkbuttons and radiobuttons. 
d184 4
a187 3
Windows and the Mac have a notion of an "active" or foreground window.
The \fBbackground\fR state is set for widgets in a background window,
and cleared for those in the foreground window.
d190 1
d194 4
a197 4
A widget-specific alternate display format.
For example, used for checkbuttons and radiobuttons 
in the "tristate" or "mixed" state,
and for buttons with \fB-default active\fR.
d200 3
a202 3
The widget's value is invalid.
(Potential uses: scale widget value out of bounds, 
entry widget value failed validation.)
d204 3
a206 3
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.
d213 1
a213 1
$b state disabled			
d216 1
a216 1
$b instate {pressed !disabled} { .b invoke }	
d219 1
a219 1
$b state !disabled			
a223 1

@


1.3.2.1
log
@merge updates from HEAD
@
text
@d3 1
a3 1
'\"
d7 1
a7 1
'\" RCS: @@(#) $Id: ttk_widget.n,v 1.3 2006/12/13 23:04:33 hobbs Exp $
d22 8
a29 5
Specifies the window class. The class is used when querying the option
database for the window's other options, to determine the default bindtags for
the window, and to select the widget's default layout and style. This is a
read-only option: it may only be specified when the window is created, and may
not be changed with the \fBconfigure\fR widget command.
d31 5
a35 4
Specifies the mouse cursor to be used for the widget. See \fBTk_GetCursor\fR
and \fIcursors(n)\fR in the Tk reference manual for the legal values. If set
to the empty string (the default), the cursor is inherited from the parent
widget.
d37 4
a40 3
Determines whether the window accepts the focus during keyboard traversal.
Either \fB0\fR, \fB1\fR, a command prefix (to which the widget path is
appended, and which should return \fB0\fR or \fB1\fR), or the empty string.
d47 3
a49 2
The following options are supported by widgets that are controllable by a
scrollbar. See \fIscrollbar(n)\fR for more information
d52 18
a69 18
.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
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.
.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.
.PP
If this option is set to the empty string (the default), then no command is be
executed.
.RE
d71 2
a72 2
A command prefix, used to communicate with vertical scrollbars. See the
description of \fB\-xscrollcommand\fR above for details.
d75 2
a76 2
The following options are supported by labels, buttons, and other button-like
widgets:
d78 2
a79 2
Specifies a text string to be displayed inside the widget (unless overridden
by \fB\-textvariable\fR).
d81 2
a82 2
Specifies the name of variable whose value will be used in place of the
\fB\-text\fR resource.
d84 3
a86 2
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.
d88 7
a94 5
Specifies an image to display. This is a list of 1 or more elements. The first
element is the default image name. The rest of the list is a sequence of
\fIstatespec / value\fR pairs as per \fBstyle map\fR, specifying different
images to use when the widget is in a particular state or combination of
states. All images in the list should have the same size.
d96 3
a98 2
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:
d100 1
a100 1
.IP \fBtext\fR
d102 1
a102 1
.IP \fBimage\fR
d104 1
a104 1
.IP \fBcenter\fR
d106 4
a109 1
.IP \fBtop\fR, \fBbottom\fR, \fBleft\fR, \fBright\fR
d111 1
a111 1
.IP \fBnone\fR
d115 4
a118 3
If greater than zero, specifies how much space, in character widths, to
allocate for the text label. If less than zero, specifies a minimum width. If
zero or unspecified, the natural width of the text label is used.
d122 5
a126 3
May be set to \fBnormal\fR or \fBdisabled\fR to control the \fBdisabled\fR
state bit. This is a ``write-only'' option: setting it changes the widget
state, but the \fBstate\fR widget command does not affect the state option.
d131 2
a132 2
.
Returns the current value of the configuration option given by \fIoption\fR.
d135 10
a144 8
.
Query or modify the configuration options of the widget. If one or more
\fIoption\-value\fR pairs are specified, then the command modifies the given
widget option(s) to have the given value(s); in this case the command returns
an empty string. If \fIoption\fR is specified with no \fIvalue\fR, then the
command returns a list describing the named option: the elements of the list
are the option name, database name, database class, default value, and current
value.
d146 3
a148 3
If no \fIoption\fR is specified, returns a list describing all of the
available options for \fIpathName\fR.
.TP
d150 4
a153 5
.
Test the widget's state. If \fIscript\fR is not specified, returns 1 if the
widget state matches \fIstatespec\fR and 0 otherwise.  If \fIscript\fR is
specified, equivalent to
.RS
d157 1
a157 2
.RE
.TP
d159 5
a163 6
.
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. Returns a new state spec indicating
which flags were changed:
.RS
d168 3
a170 3
will restore \fIpathName\fR to the original state. If \fIstateSpec\fR is not
specified, returns a list of the currently-enabled state flags.
.RE
d172 2
a173 2
The widget state is a bitmap of independent state flags. Widget state flags
include:
d176 3
a178 3
.
The mouse cursor is over the widget and pressing a mouse button will cause
some action to occur. (aka "prelight" (Gnome), "hot" (Windows), "hover").
d181 2
a182 2
.
Widget is disabled under program control (aka "unavailable", "inactive")
d185 1
a185 2
.
Widget has keyboard focus.
d188 1
a188 2
.
Widget is being pressed (aka "armed" in Motif).
d191 1
a191 3
.
The widget is "On", "true", or "current" (for things like checkbuttons and
radiobuttons).
d194 3
a196 4
.
Windows and the Mac have a notion of an "active" or foreground window. The
\fBbackground\fR state is set for widgets in a background window, and cleared
for those in the foreground window.
a198 1
.
d202 4
a205 4
.
A widget-specific alternate display format. For example, used for checkbuttons
and radiobuttons in the "tristate" or "mixed" state, and for buttons with
\fB\-default active\fR.
d208 3
a210 3
.
The widget's value is invalid. (Potential uses: scale widget value out of
bounds, entry widget value failed validation.)
d212 3
a214 3
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.
d221 1
a221 1
$b state disabled
d224 1
a224 1
$b instate {pressed !disabled} { .b invoke }
d227 1
a227 1
$b state !disabled
d232 1
@


1.3.2.2
log
@merge updates from HEAD
@
text
@d3 1
a3 1
'\" 
d7 1
a7 1
'\" RCS: @@(#) $Id: ttk_widget.n,v 1.3.2.1 2007/10/24 12:59:32 dgp Exp $
d22 5
a26 8
Specifies the window class.
The class is used when querying the option database 
for the window's other options, to determine the default
bindtags for the window, and to select the widget's default
layout and style.
This is a read-only option: 
it may only be specified when the window is created,
and may not be changed with the \fBconfigure\fR widget command.
d28 4
a31 5
Specifies the mouse cursor to be used for the widget.
See \fBTk_GetCursor\fR and \fIcursors(n)\fR in the Tk reference manual
for the legal values.
If set to the empty string (the default),
the cursor is inherited from the parent widget.
d33 3
a35 4
Determines whether the window accepts the focus during keyboard traversal.  
Either \fB0\fR, \fB1\fR, a command prefix (to which the widget path
is appended, and which should return \fB0\fR or \fB1\fR), 
or the empty string.
d42 2
a43 3
The following options are supported by widgets that
are controllable by a scrollbar.  
See \fIscrollbar(n)\fR for more information
d46 18
a63 18
.br
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 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
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
If this option is set to the empty string (the default),
then no command is be executed.
d65 2
a66 2
A command prefix, used to communicate with vertical scrollbars.
See the description of \fB-xscrollcommand\fR above for details.
d69 2
a70 2
The following options are supported by labels, buttons,
and other button-like widgets:
d72 2
a73 2
Specifies a text string to be displayed inside the widget
(unless overridden by \fB-textvariable\fR).
d75 2
a76 2
Specifies the name of variable whose value will be used
in place of the \fB-text\fR resource.
d78 2
a79 3
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.
d81 5
a85 7
Specifies an image to display.
This is a list of 1 or more elements.
The first element is the default image name.
The rest of the list is a sequence of \fIstatespec / value\fR pairs
as per \fBstyle map\fR, specifying different images to use when
the widget is in a particular state or combination of states.
All images in the list should have the same size.
d87 2
a88 3
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: 
d90 1
a90 1
.IP text
d92 1
a92 1
.IP image
d94 1
a94 1
.IP center
d96 1
a96 4
.IP top
.IP bottom
.IP left
.IP right
d98 1
a98 1
.IP none
d102 3
a104 4
If greater than zero, specifies how much space, in character widths, 
to allocate for the text label.  
If less than zero, specifies a minimum width.
If zero or unspecified, the natural width of the text label is used.
d108 3
a110 5
May be set to \fBnormal\fR or \fBdisabled\fR
to control the \fBdisabled\fR state bit.
This is a ``write-only'' option: setting it changes the
widget state, but the \fBstate\fR widget command does
not affect the state option.
d115 2
a116 2
Returns the current value of the configuration option given
by \fIoption\fR.
d119 8
a126 10
Query or modify the configuration options of the widget.
If one or more \fIoption\-value\fR pairs are specified,
then the command modifies the given widget option(s) 
to have the given value(s); 
in this case the command returns an empty string.
If \fIoption\fR is specified with no \fIvalue\fR, 
then the command returns a list describing the named option:
the elements of the list are the 
option name, database name, database class, default value, 
and current value.
d128 3
a130 3
If no \fIoption\fR is specified, returns a list describing all of
the available options for \fIpathName\fR.
.TP 
d132 5
a136 4
Test the widget's state.
If \fIscript\fR is not specified, returns 1 if 
the widget state matches \fIstatespec\fR and 0 otherwise.
If \fIscript\fR is specified, equivalent to
d140 2
a141 1
.TP 
d143 6
a148 5
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.
Returns a new state spec indicating which flags were changed:
d153 3
a155 3
will restore \fIpathName\fR to the original state.
If \fIstateSpec\fR is not specified, 
returns a list of the currently-enabled state flags.
d157 2
a158 2
The widget state is a bitmap of independent state flags.
Widget state flags include:
d161 3
a163 3
The mouse cursor is over the widget 
and pressing a mouse button will cause some action to occur.
(aka "prelight" (Gnome), "hot" (Windows), "hover").
d166 2
a167 2
Widget is disabled under program control 
(aka "unavailable", "inactive") 
d170 2
a171 1
Widget has keyboard focus 
d174 2
a175 1
Widget is being pressed (aka "armed" in Motif). 
d178 3
a180 1
"On", "true", or "current" for things like checkbuttons and radiobuttons. 
d183 4
a186 3
Windows and the Mac have a notion of an "active" or foreground window.
The \fBbackground\fR state is set for widgets in a background window,
and cleared for those in the foreground window.
d189 1
d193 4
a196 4
A widget-specific alternate display format.
For example, used for checkbuttons and radiobuttons 
in the "tristate" or "mixed" state,
and for buttons with \fB-default active\fR.
d199 3
a201 3
The widget's value is invalid.
(Potential uses: scale widget value out of bounds, 
entry widget value failed validation.)
d203 3
a205 3
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.
d212 1
a212 1
$b state disabled			
d215 1
a215 1
$b instate {pressed !disabled} { .b invoke }	
d218 1
a218 1
$b state !disabled			
a222 1

@


1.3.2.3
log
@merge updates from HEAD
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id$
d10 1
a10 1
.TH ttk::widget n 8.5 Tk "Tk Themed Widget"
d13 1
a13 1
ttk::widget \- Standard options and commands supported by Tk themed widgets
d15 1
d18 1
d44 1
d52 1
a52 2
.RS
.PP
d62 1
a62 1
.PP
d64 1
a64 4
of a \fBscrollbar\fR widget followed by
.QW set ,
e.g.
.QW ".x.scrollbar set" .
d67 1
a67 1
.PP
a69 1
.RE
d72 2
a73 1
See the description of \fB\-xscrollcommand\fR above for details.
d79 1
a79 1
(unless overridden by \fB\-textvariable\fR).
d82 1
a82 1
in place of the \fB\-text\fR resource.
d97 1
a97 1
in the case both \fB\-text\fR and \fB\-image\fR are present.
d119 1
d124 4
a127 4
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.
d177 2
a178 6
and pressing a mouse button will cause some action to occur. (aka
.QW prelight
(Gnome),
.QW hot
(Windows),
.QW hover ).
d181 2
a182 3
Widget is disabled under program control (aka
.QW unavailable ,
.QW inactive ) 
d188 1
a188 3
Widget is being pressed (aka
.QW armed
in Motif). 
d191 1
a191 5
.QW On ,
.QW true ,
or
.QW current
for things like checkbuttons and radiobuttons. 
d194 1
a194 3
Windows and the Mac have a notion of an
.QW active
or foreground window.
d203 3
a205 5
For example, used for checkbuttons and radiobuttons in the
.QW tristate
or
.QW mixed
state, and for buttons with \fB\-default active\fR.
d215 1
d221 1
a221 1
$b state disabled
d224 1
a224 1
$b instate {pressed !disabled} { .b invoke }
d227 1
a227 1
$b state !disabled
d229 1
d231 2
a232 1
ttk::intro(n), style(n)
@


1.3.2.4
log
@merge updates from HEAD
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: ttk_widget.n,v 1.3.2.3 2007/11/01 16:37:16 dgp Exp $
d43 1
d50 1
d70 1
a70 1
then no command will be executed.
d124 4
a127 5
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.

d158 1
a158 1
\fIpathName \fBstate\fR ?\fIstateSpec\fR?
a162 1
.RS
a170 1
.RE
@


1.3.2.5
log
@merge updates from 8.5 branch
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: ttk_widget.n,v 1.3.2.4 2007/12/13 06:28:47 dgp Exp $
a146 6
.TP
\fIpathName \fBidentify\fR \fIx y\fR
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 within any element.
\fIx\fR and \fIy\fR are pixel coordinates relative to the widget.
@


1.2
log
@Convert \fP to \fR so that man-page scrapers have an easier time.
@
text
@d3 5
a7 1
'\" $Id: ttk_widget.n,v 1.1 2006/10/31 01:42:25 hobbs Exp $
d13 1
a13 1
widget \- Standard options and commands supported by Tk themed widgets
d15 1
d18 1
d44 1
d73 1
d86 1
a86 2
The underlined character is used for mnemonic activation
(see \fIkeynav(n)\fR).
d215 1
d229 1
d232 1
@


1.1
log
@	* doc/ttk_Geometry.3, doc/ttk_Theme.3, doc/ttk_button.n:
	* doc/ttk_checkbutton.n, doc/ttk_combobox.n, doc/ttk_dialog.n:
	* doc/ttk_entry.n, doc/ttk_frame.n, doc/ttk_image.n:
	* doc/ttk_intro.n, doc/ttk_label.n, doc/ttk_labelframe.n:
	* doc/ttk_menubutton.n, doc/ttk_notebook.n, doc/ttk_panedwindow.n:
	* doc/ttk_progressbar.n, doc/ttk_radiobutton.n, doc/ttk_scrollbar.n:
	* doc/ttk_separator.n, doc/ttk_sizegrip.n, doc/ttk_style.n:
	* doc/ttk_treeview.n, doc/ttk_widget.n,:
	* generic/ttk/ttk.decls, generic/ttk/ttkBlink.c:
	* generic/ttk/ttkButton.c, generic/ttk/ttkCache.c:
	* generic/ttk/ttkClamTheme.c, generic/ttk/ttkClassicTheme.c:
	* generic/ttk/ttkDecls.h, generic/ttk/ttkDefaultTheme.c:
	* generic/ttk/ttkElements.c, generic/ttk/ttkEntry.c:
	* generic/ttk/ttkFrame.c, generic/ttk/ttkImage.c:
	* generic/ttk/ttkInit.c, generic/ttk/ttkLabel.c:
	* generic/ttk/ttkLayout.c, generic/ttk/ttkManager.c:
	* generic/ttk/ttkManager.h, generic/ttk/ttkNotebook.c:
	* generic/ttk/ttkPanedwindow.c, generic/ttk/ttkProgress.c:
	* generic/ttk/ttkScale.c, generic/ttk/ttkScroll.c:
	* generic/ttk/ttkScrollbar.c, generic/ttk/ttkSeparator.c:
	* generic/ttk/ttkSquare.c, generic/ttk/ttkState.c:
	* generic/ttk/ttkStubInit.c, generic/ttk/ttkStubLib.c:
	* generic/ttk/ttkTagSet.c, generic/ttk/ttkTheme.c:
	* generic/ttk/ttkTheme.h, generic/ttk/ttkThemeInt.h:
	* generic/ttk/ttkTrace.c, generic/ttk/ttkTrack.c:
	* generic/ttk/ttkTreeview.c, generic/ttk/ttkWidget.c:
	* generic/ttk/ttkWidget.h:
	* library/demos/ttk_demo.tcl, library/demos/ttk_iconlib.tcl:
	* library/demos/ttk_repeater.tcl:
	* library/ttk/altTheme.tcl, library/ttk/aquaTheme.tcl:
	* library/ttk/button.tcl, library/ttk/clamTheme.tcl:
	* library/ttk/classicTheme.tcl, library/ttk/combobox.tcl:
	* library/ttk/cursors.tcl, library/ttk/defaults.tcl:
	* library/ttk/dialog.tcl, library/ttk/entry.tcl:
	* library/ttk/fonts.tcl, library/ttk/icons.tcl:
	* library/ttk/keynav.tcl, library/ttk/menubutton.tcl:
	* library/ttk/notebook.tcl, library/ttk/panedwindow.tcl:
	* library/ttk/progress.tcl, library/ttk/scale.tcl:
	* library/ttk/scrollbar.tcl, library/ttk/sizegrip.tcl:
	* library/ttk/treeview.tcl, library/ttk/ttk.tcl:
	* library/ttk/utils.tcl, library/ttk/winTheme.tcl:
	* library/ttk/xpTheme.tcl:
	* macosx/ttkMacOSXTheme.c:
	* tests/ttk/all.tcl, tests/ttk/bwidget.test, tests/ttk/combobox.test:
	* tests/ttk/entry.test, tests/ttk/image.test:
	* tests/ttk/labelframe.test, tests/ttk/layout.test:
	* tests/ttk/misc.test, tests/ttk/notebook.test:
	* tests/ttk/panedwindow.test, tests/ttk/progressbar.test:
	* tests/ttk/scrollbar.test, tests/ttk/treetags.test:
	* tests/ttk/treeview.test, tests/ttk/ttk.test, tests/ttk/validate.test:
	* win/ttkWinMonitor.c, win/ttkWinTheme.c, win/ttkWinXPTheme.c:
	First import of Ttk themed Tk widgets as branched from tile 0.7.8

	* generic/tkInt.h, generic/tkWindow.c: add Ttk_Init call, copy
	tk classic widgets to ::tk namespace.
	* library/tk.tcl: add source of ttk/ttk.tcl, define $::ttk::library.
	* unix/Makefile.in, win/Makefile.in: add Ttk build bits
	* win/configure, win/configure.in: check for uxtheme.h (XP theme).
@
text
@d3 1
a3 1
'\" $Id: widget.n,v 1.13 2006/09/20 15:04:05 jenglish Exp $
d42 1
a42 1
See \fIscrollbar(n)\fP for more information
d57 1
a57 1
of a \fBscrollbar\fP widget followed by ``set'', e.g. ``.x.scrollbar set''.
d65 1
a65 1
See the description of \fB-xscrollcommand\fP above for details.
d74 1
a74 1
in place of the \fB-text\fP resource.
d115 2
a116 2
May be set to \fBnormal\fP or \fBdisabled\fP
to control the \fBdisabled\fP state bit.
d118 1
a118 1
widget state, but the \fBstate\fP widget command does
d188 1
a188 1
The \fBbackground\fP state is set for widgets in a background window,
d198 1
a198 1
and for buttons with \fB-default active\fP.
d200 1
a200 1
\fBinvalid\fP
d205 1
a205 1
A \fIstate specification\fP or \fIstateSpec\fP is a list
@

