scrollutil::scrollarea andscrollutil::getscrollarea Commandsscrollutil::scrollarea
Command – Quick Referencescrollutil::scrollarea
Command – Detailed Referencescrollutil::getscrollarea Commandscrollutil::scrollarea Command
– Quick Referencescrollutil::scrollarea – Create and manipulate
scrollarea widgetsscrollutil::scrollarea pathName ?options?
-background -highlightbackground -relief -borderwidth -highlightcolor -cursor -highlightthickness
-autohidescrollbars
boolean-lockinterval
milliseconds-respectheader
boolean-respecttitlecolumns
boolean-takefocus
0|1|""|command-xscrollbarmode
static|dynamic|none-yscrollbarmode
static|dynamic|nonepathName cget
optionpathName configure
?option? ?value option value ...?pathName setwidget
widgetpathName widgetscrollutil::scrollarea
Command – Detailed Referencescrollutil::scrollarea – Create and manipulate
scrollarea widgetsscrollutil::scrollarea pathName ?options?
scrollutil::scrollarea command creates a new
window named pathName and of the class
Scrollarea, and makes it into a scrollarea
widget. Additional options, described below, may be specified on the
command line or in the option database to configure aspects of the
scrollarea such as its borderwidth, relief, and display mode to be used for
the scrollbars. The scrollutil::scrollarea
command returns its pathName argument. At the
time this command is invoked, there must not exist a window named
pathName, but pathName's parent
must exist.setwidget subcommand of the associated Tcl
command as well as two scrollbars connected with that widget. These
components are managed within the scrollarea using
grid. The scrollbars, named
hsb (with -orient
horizontal) and vsb (with
-orient vertical) are direct children of the
scrollarea. The display mode of each scrollbar can be
static, dynamic, or
none (see the -xscrollbarmode and -yscrollbarmode configuration
options). The -takefocus option of both
scrollbars is set to 0. In the Scrollutil_tile package
the scrollbars are created as ttk::scrollbar widgets, except on Mac OS X
when using a Tk release earlier than 8.6.10, where the native
ttk::scrollbar widget of the aqua theme didn't yet look
as expected.setwidget is a tablelist and Tablelist version 6.5
or later is being used then the scrollarea can also contain siblings of the
tablelist widget above the vertical scrollbar and/or to the left of the
horizontal one, causing the vertical scrollbar to be displayed below the
tablelist's header and/or the horizontal scrollbar to appear to the right
of the tablelist's title column area, depending on the values of the
-respectheader and -respecttitlecolumns configuration
options.set sa [scrollutil::scrollarea ...] set lb [listbox $sa.lb ...] $sa setwidget $lb pack $sa -expand yes -fill both
-background -highlightbackground -relief -borderwidth -highlightcolor -cursor -highlightthickness
-background,
-highlightbackground,
-highlightcolor, and
-highlightthickness options are only supported by the
Scrollutil package, but not by Scrollutil_tile. They have the same
default values as the options of the same names for Tk frame widgets.
The default values of the remaining standard options are:-borderwidth 1 -cursor "" -relief sunken
-borderwidth or -relief option, if
as a result of this action the scrollarea has a positive
-borderwidth value (e.g., the default 1)
and a -relief value other than flat
(e.g., the default sunken), then the
-borderwidth option of the widget embedded into the
scrollarea via the setwidget
subcommand of the associated Tcl command will automatically be set to
0, provided that the embedded widget supports this
option.| Command-Line Name: | -autohidescrollbars |
| Database Name: | autoHideScrollbars |
| Database Class: | AutoHideScrollbars |
Specifies a boolean value indicating whether the scrollbars should be obscured if the focus is outside the toplevel window containing the scrollarea or the mouse pointer is outside the scrollarea widget. The default is
0.REMARK 1: The easiest way to override the default value for all scrollarea instances of your application is to insert the line
option add *Scrollarea.autoHideScrollbars 1somewhere at the top of your script (before creating any scrollarea widgets).
REMARK 2: To obscure a scrollbar, Scrollutil just lays a frame over it, thus keeping the area occupied by it reserved (if it was previously mapped). This is different from unmapping a dynamic scrollbar when there is nothing to scroll in the widget embedded into the scrollarea. Obscuring or unobscuring a scrollbar doesn't change its mapped/unmapped state.
REMARK 3: Regardless of the focus and the value of this option, if the mouse pointer is inside the scrollarea and the widget embedded into it via
setwidgetgets scrolled (e.g., with the aid of the mouse wheel), then the scrollbars will be unobscured.
| Command-Line Name: | -lockinterval |
| Database Name: | lockInterval |
| Database Class: | LockInterval |
Specifies the time interval in milliseconds for which the scrollbars having the display mode
dynamic(see the-xscrollbarmodeand-yscrollbarmodeoptions) will be protected from being unmapped after being mapped, in order to avoid any shimmering effects. This is also the time interval for which the dynamic scrollbars will mutually protect each other from being mapped after one of them got mapped. Without this locking mechanism, under some rare circumstances a dynamic scrollbar could get mapped and unmapped in an endless loop, thus giving rise to an annoying and often dangerous flickering effect. The same problem can arise due to a too small-lockintervalvalue. The default is1, which works as expected in the vast majority of cases. Should you experience any shimmering in one of your scrollarea widgets, just set this option for that scrollarea to a sufficiently large value (e.g.,100). Note, however, that this value should not be greater than300, because, for implementation-specific reasons, a-lockintervalvalue greater than300can prevent a dynamic scrollbar that should be hidden from being unmapped, or one that should be shown from being mapped.
| Command-Line Name: | -respectheader |
| Database Name: | respectHeader |
| Database Class: | RespectHeader |
This option is only relevant if the widget embedded into the scrollarea with the aid of the
setwidgetsubcommand of the associated Tcl command is a tablelist and the Tablelist version being used is 6.5 or later. Its value must be a boolean specifying whether the vertical scrollbar should appear below the tablelist widget's header, thus respecting the native look & feel on Mac OS X Aqua and on many modern Linux systems. The default is1on the windowing systemsaquaandx11, and0onwin32.
| Command-Line Name: | -respecttitlecolumns |
| Database Name: | respectTitleColumns |
| Database Class: | RespectTitleColumns |
This option is only relevant if the widget embedded into the scrollarea with the aid of the
setwidgetsubcommand of the associated Tcl command is a tablelist and the Tablelist version being used is 6.5 or later. Its value must be a boolean specifying whether the horizontal scrollbar should start to the right of the tablelist widget's non-scrollable title column area if the value of the-titlecolumnstablelist option is positive. The default is1.
| Command-Line Name: | -takefocus |
| Database Name: | takeFocus |
| Database Class: | TakeFocus |
This option determines whether the scrollarea accepts the focus during keyboard traversal. It is almost identical to the standard option of the same name (see the options manual entry for details). The only difference is that not the scrollarea itself but the widget embedded into it via the
setwidgetsubcommand of the associated Tcl command will receive the focus during keyboard traversal with the standard keys (TabandShift-Tab). The default is0, being that a scrollarea is esentially a frame containing the above-mentioned widget and two scrollbars.
| Command-Line Name: | -xscrollbarmode |
| Database Name: | xScrollbarMode |
| Database Class: | ScrollbarMode |
Specifies the display mode to be used for the horizontal scrollbar. The allowed values are
static,dynamic, andnone. Instaticmode the scrollbar is displayed at all times. Indynamicmode (which is the default) the scrollbar is mapped and unmapped as needed. The display modenonedisables the scrollbar display.
| Command-Line Name: | -yscrollbarmode |
| Database Name: | yScrollbarMode |
| Database Class: | ScrollbarMode |
Specifies the display mode to be used for the vertical scrollbar. The allowed values are
static,dynamic, andnone. Instaticmode the scrollbar is displayed at all times. Indynamicmode (which is the default) the scrollbar is mapped and unmapped as needed. The display modenonedisables the scrollbar display.
scrollutil::scrollarea command creates a new Tcl
command whose name is pathName. This command
may be used to invoke various operations on the widget. It has the
following general form:
pathName option ?arg arg ...?
option and the args determine
the exact behavior of the command. The following commands are
possible for scrollarea widgets:pathName cget
optionoption, which may have any of the values accepted
by the scrollutil::scrollarea command.pathName configure
?option? ?value option value
...?option is specified, the command returns a
list describing all of the available options for
pathName (see Tk_ConfigureInfo
for information on the format of this list). If
option is specified with no
value, then the command returns a list describing
the one named option (this list will be identical to the corresponding
sublist of the value returned if no option is
specified). 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 return value is an empty
string. option may have any of the values
accepted by the scrollutil::scrollarea
command.pathName setwidget
widgetwidget argument must be the path name of an
existing widget or an empty string. In the first case, the
command manages the widget to fill the top-left part of the scrollarea
and connects it with the scrollbars by setting its
-xscrollcommand and
-yscrollcommand options to appropriate wrappers for
the set command of the two scrollbars and setting
the -command option of the scrollbars to
[list widget xview] and
[list widget yview],
respectively. If widget is an empty string
then the widget passed to the most recent setwidget
invocation (if any) is unmanaged and unconnected from the
scrollbars. The return value is the argument passed to the
previous successful invocation of this subcommand, or an empty string
if there was no successful setwidget invocation
before.widget is
nonempty and the value of the -xscrollbarmode option is different
from none then widget must be a
horizontally scrollable widget, meaning that it must support the
-xscrollcommand configuration option and the
associated Tcl command must have the xview
subcommand. Similarly, if widget is nonempty
and the value of the -yscrollbarmode option is different
from none then widget must be a
vertically scrollable widget, meaning that it must support the
-yscrollcommand configuration option and the
associated Tcl command must have the yview
subcommand. Consequently, if widget is an
entry or ttk::entry then this subcommand will only be successful if the
-yscrollbarmode option was previously set to
none.widget argument must be a child of the scrollarea
or of one of the latter's ascendants. This minor restriction is
imposed by the grid geometry manager.setwidget gets destroyed, this
subcommand is automatically invoked with an empty string as
argument.-highlightthickness option of
widget to 0 if
widget supports this configuration option. In
addition, if the scrollarea has a positive
-borderwidth value (e.g., the default
1) and a -relief value other than
flat (e.g., the default sunken)
then this subcommand sets the -borderwidth option
of widget to 0, provided that
widget supports this option.pathName
widgetsetwidget subcommand, or an empty string if
there was no successful invocation of that subcommand yet.scrollutil::getscrollarea
Commandscrollutil::getscrollarea – Query the scrollarea
containing a given widgetscrollutil::gescrollarea widget
widget argument is embedded via the scrollarea's
setwidget subcommand, or an
empty string if there is no such scrollarea widget.