scrollutil::pagesman
Commandscrollutil::pagesman
– Create and manipulate
pagesman widgetsscrollutil::pagesman pathName ?options?
-background -highlightbackground -relief -borderwidth -highlightcolor -cursor -highlightthickness
-forgetcommand
command
-height
screenDistance
-leavecommand
command
-takefocus
0|1|""|command
-width
screenDistance
pathName add window
?-padding padding? ?-sticky
stickyness?
pathName cget
option
pathName configure
?option? ?value option value ...?
pathName forget
pageIndex
pathName index
window
pathName pages
pathName select
?pageIndex?
pathName size
scrollutil::pagesman
– Create and manipulate
pagesman widgetsscrollutil::pagesman pathName ?options?
scrollutil::pagesman
command creates a new
window named pathName
and of the class
Pagesman
, and makes it into a pagesman
widget. Additional options, described below, may be specified on the
command line or in the option database to configure aspects of the
plainnotebook widget such as its width, height, borderwidth, and
relief. The scrollutil::pagesman
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.-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 0 -cursor "" -relief flat
Command-Line Name: | -forgetcommand |
Database Name: | forgetCommand |
Database Class: | ForgetCommand |
Specifies a command to be invoked when attempting to unmanage a window with the aid of the
forget
subcommand. If the option's value is a nonempty string then it is concatenated with the path name of the pagesman widget and that of the window to be unmanaged, and the resulting script, which must return a boolean, is evaluated in the global scope. If the return value of this script is false then theforget
subcommand is aborted, i.e., the window is not unmanaged. The default is an empty string.
Command-Line Name: | -height |
Database Name: | height |
Database Class: | Height |
If present and greater than zero, specifies the desired total height for the widget, including the border and highlight rectangle (if any) drawn around the outside of the widget, in any of the forms acceptable to
Tk_GetPixels
. Otherwise, the maximum height of all pages is used. The default is0
.
Command-Line Name: | -leavecommand |
Database Name: | leaveCommand |
Database Class: | LeaveCommand |
Specifies a command to be invoked when attempting to leave the currently selected window by selecting a different one with the aid of the
select
subcommand. If the option's value is a nonempty string then it is concatenated with the path name of the pagesman widget and that of the currently selected window, and the resulting script, which must return a boolean, is evaluated in the global scope. If the return value of this script is false then the operation of selecting a different window is aborted. The default is an empty string.
Command-Line Name: | -takefocus |
Database Name: | takeFocus |
Database Class: | TakeFocus |
This option determines whether the pagesman widget 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 pagesman widget itself but the currently selected window (if any) will receive the focus during keyboard traversal with the standard keys (
Tab
andShift-Tab
). The default is an empty string.
Command-Line Name: | -width |
Database Name: | width |
Database Class: | Width |
If present and greater than zero, specifies the desired total width for the widget, including the border and highlight rectangle (if any) drawn around the outside of the widget, in any of the forms acceptable to
Tk_GetPixels
. Otherwise, the maximum width of all pages is used. The default is0
.
scrollutil::pagesman
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 arg
s determine
the exact behavior of the command. The following commands are
possible for pagesman widgets:pathName add window
?-padding padding? ?-sticky
stickyness?
-padding
option specifies the
amount of extra space to add between the widget and this page.
padding
must be a list of up to four non-negative
screen distances {left top right
bottom}
. If fewer than four elements are specified,
bottom
defaults to top
,
right
defaults to left
, and
top
defaults to left
. A
padding value specified as an empty list is equivalent to
0
, which is the default. The
-sticky
option specifies how the page window will
be positioned within the widget. stickyness
must be a string containing zero or more of the characters
n
, s
, e
, or
w
. Each letter refers to a side (north,
south, east, or west) that the page window will “stick” to, as per the
grid
geometry manager. The default stickyness
is nsew
.pathName cget
option
option
, which may have any of the values accepted
by the scrollutil::pagesman
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::pagesman
command.pathName forget
pageIndex
pageIndex
. The subcommand returns
0
if it was aborted by the command specified as the value
of the -forgetcommand
option, and 1
otherwise.pathName index
window
add
subcommand.pathName
pages
add
subcommand.pathName select
?pageIndex?
pageIndex
is omitted, the subcommand returns
the path name of the currently selected window. Otherwise it
selects the specified page by mapping the corresponding window and
unmapping the previously-selected one (if different). In this
case, the return value is 0
if the operation of selecting
a different window was aborted by the command specified as the value of
the -leavecommand
option, and 1
otherwise.pathName size
<<PagesmanPageChanged>>
virtual event.