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$
.so man.macros
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.
Typically the xScrollCommand option consists of the path name of a scrollbar 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.
If this option is set to the empty string (the default), then no command will be executed.
pathName cget option Returns the current value of the configuration option given by option.
pathName configure ?option? ?value option value ...?
Query or modify the configuration options of the widget.
If one or more option-value 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 option is specified with no value,
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 option is specified, returns a list describing all of
the available options for pathName.
pathName identify element x y Returns the name of the element under the point given by x and y, or an empty string if the point does not lie within any element. x and y are pixel coordinates relative to the widget. Some widgets accept other identify subcommands.
pathName instate statespec ?script? Test the widget's state. If script is not specified, returns 1 if the widget state matches statespec and 0 otherwise. If script is specified, equivalent to .CS if {[pathName instate stateSpec]} script .CE
pathName state ?stateSpec? Modify or inquire widget state. If stateSpec is present, sets the widget state: for each flag in stateSpec, sets the corresponding flag or clears it if prefixed by an exclamation point.
Returns a new state spec indicating which flags were changed: .CS set changes [pathName state spec] pathName state $changes .CE will restore pathName to the original state. If stateSpec is not specified, returns a list of the currently-enabled state flags.
active 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 ).
disabled Widget is disabled under program control (aka .QW unavailable , .QW inactive )
focus Widget has keyboard focus
pressed Widget is being pressed (aka .QW armed in Motif).
selected .QW On , .QW true , or .QW current for things like checkbuttons and radiobuttons.
background Windows and the Mac have a notion of an .QW active or foreground window. The background state is set for widgets in a background window, and cleared for those in the foreground window.
readonly Widget should not allow user modification.
alternate 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 -default active.
invalid The widget's value is invalid. (Potential uses: scale widget value out of bounds, entry widget value failed validation.)
hover The mouse cursor is within the widget. This is similar to the active 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.
A state specification or stateSpec is a list of state names, optionally prefixed with an exclamation point (!) indicating that the bit is off.
mode: nroff
End: