545 lines
26 KiB
Plaintext
545 lines
26 KiB
Plaintext
'\"
|
|
'\" Copyright (c) 1991-1994 The Regents of the University of California.
|
|
'\" Copyright (c) 1994-1995 Sun Microsystems, Inc.
|
|
'\"
|
|
'\" See the file "license.terms" for information on usage and redistribution
|
|
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
|
'\"
|
|
'\" @(#) wm.n 1.30 95/08/12 17:34:53
|
|
'\"
|
|
.so STk-man.macros
|
|
.TH wm n 3.2 STk "Tk Built-In Commands"
|
|
.BS
|
|
'\" Note: do not modify the .SH NAME line immediately below!
|
|
.SH NAME
|
|
wm \- Communicate with window manager
|
|
.SH SYNOPSIS
|
|
(\fBwm\fR \fIoption window \fR?\fIargs\fR?)
|
|
.BE
|
|
|
|
.SH DESCRIPTION
|
|
.PP
|
|
The \fBwm\fR procedure is used to interact with window managers in
|
|
order to control such things as the title for a window, its geometry,
|
|
or the increments in terms of which it may be resized. The \fBwm\fR
|
|
procedure can take any of a number of different forms, depending on
|
|
the \fIoption\fR argument. All of the forms expect at least one
|
|
additional argument, \fIwindow\fR, which must be the path name of a
|
|
top-level window.
|
|
.PP
|
|
The legal forms for the \fBwm\fR procedure are:
|
|
.TP
|
|
(\fBwm 'aspect \fIwindow\fR ?\fIminNumer minDenom maxNumer maxDenom\fR?)
|
|
If \fIminNumer\fR, \fIminDenom\fR, \fImaxNumer\fR, and \fImaxDenom\fR
|
|
are all specified, then they will be passed to the window manager
|
|
and the window manager should use them to enforce a range of
|
|
acceptable aspect ratios for \fIwindow\fR. The aspect ratio of
|
|
\fIwindow\fR (width/length) will be constrained to lie
|
|
between \fIminNumer\fR/\fIminDenom\fR and \fImaxNumer\fR/\fImaxDenom\fR.
|
|
If \fIminNumer\fR etc. are all specified as empty strings, then
|
|
any existing aspect ratio restrictions are removed.
|
|
If \fIminNumer\fR etc. are specified, then the procedure returns an
|
|
empty list. Otherwise, it returns
|
|
a STk list containing four elements, which are the current values
|
|
of \fIminNumer\fR, \fIminDenom\fR, \fImaxNumer\fR, and \fImaxDenom\fR
|
|
(if no aspect restrictions are in effect, then an empty list is
|
|
returned).
|
|
.TP
|
|
(\fBwm 'client \fIwindow\fR)
|
|
.TP
|
|
(\fBwm 'client \fIwindow\fR \fIname\fR)
|
|
If \fIname\fR is specified, this procedure stores \fIname\fR (which
|
|
should be the name of
|
|
the host on which the application is executing) in \fIwindow\fR's
|
|
\fBWM_CLIENT_MACHINE\fR property for use by the window manager or
|
|
session manager.
|
|
The procedure returns an empty list in this case.
|
|
If \fIname\fR isn't specified, the procedure returns the last name
|
|
set in a \fBwm client\fR procedure for \fIwindow\fR.
|
|
If \fIname\fR is specified as an empty string, the procedure deletes the
|
|
\fBWM_CLIENT_MACHINE\fR property from \fIwindow\fR.
|
|
.TP
|
|
(\fBwm 'colormapwindows \fIwindow\fR)
|
|
.TP
|
|
(\fBwm 'colormapwindows \fIwindow\fR \fIwindowList\fR)
|
|
This procedure is used to manipulate the \fBWM_COLORMAP_WINDOWS\fR
|
|
property, which provides information to the window managers about
|
|
windows that have private colormaps.
|
|
If \fIwindowList\fR isn't specified, the procedure returns a list
|
|
whose elements are the names of the windows in the \fBWM_COLORMAP_WINDOWS\fR
|
|
property.
|
|
If \fIwindowList\fR is specified, it consists of a list of window
|
|
path names; the procedure overwrites the \fBWM_COLORMAP_WINDOWS\fR
|
|
property with the given windows and returns an empty list.
|
|
The \fBWM_COLORMAP_WINDOWS\fR property should normally contain a
|
|
list of the internal windows within \fIwindow\fR whose colormaps differ
|
|
from their parents.
|
|
The order of the windows in the property indicates a priority order:
|
|
the window manager will attempt to install as many colormaps as possible
|
|
from the head of this list when \fIwindow\fR gets the colormap focus.
|
|
If \fIwindow\fR is not included among the windows in \fIwindowList\fR,
|
|
Tk implicitly adds it at the end of the \fBWM_COLORMAP_WINDOWS\fR
|
|
property, so that its colormap is lowest in priority.
|
|
If \fBwm colormapwindows\fR is not invoked, Tk will automatically set
|
|
the property for each top-level window to all the internal windows
|
|
whose colormaps differ from their parents, followed by the top-level
|
|
itself; the order of the internal windows is undefined.
|
|
See the ICCCM documentation for more information on the
|
|
\fBWM_COLORMAP_WINDOWS\fR property.
|
|
.TP
|
|
(\fBwm 'command \fIwindow\fR)
|
|
.TP
|
|
(\fBwm 'command \fIwindow\fR \fIvalue\fR)
|
|
If \fIvalue\fR is specified, this procedure stores \fIvalue\fR in \fIwindow\fR's
|
|
\fBWM_COMMAND\fR property for use by the window manager or
|
|
session manager and returns an empty list.
|
|
\fIValue\fR must have proper list structure; the elements should
|
|
contain the words of the procedure used to invoke the application.
|
|
If \fIvalue\fR isn't specified then the procedure returns the last value
|
|
set in a \fBwm procedure\fR command for \fIwindow\fR.
|
|
If \fIvalue\fR is specified as an empty string, the procedure
|
|
deletes the \fBWM_COMMAND\fR property from \fIwindow\fR.
|
|
.TP
|
|
(\fBwm 'deiconify \fIwindow\fR)
|
|
Arrange for \fIwindow\fR to be displayed in normal (non-iconified) form.
|
|
This is done by mapping the window. If the window has never been
|
|
mapped then this procedure will not map the window, but it will ensure
|
|
that when the window is first mapped it will be displayed
|
|
in de-iconified form. Returns an empty list.
|
|
.TP
|
|
(\fBwm 'focusmodel \fIwindow\fR)
|
|
.TP
|
|
(\fBwm 'focusmodel \fIwindow\fR '\fBactive\fR)
|
|
.TP
|
|
(\fBwm 'focusmodel \fIwindow\fR '\fBpassive\fR)
|
|
If \fBactive\fR or \fBpassive\fR is supplied as an optional argument
|
|
to the procedure, then it specifies the focus model for \fIwindow\fR.
|
|
In this case the procedure returns an empty list. If no additional
|
|
argument is supplied, then the procedure returns the current focus
|
|
model for \fIwindow\fR.
|
|
An \fBactive\fR focus model means that \fIwindow\fR will claim the
|
|
input focus for itself or its descendants, even at times when
|
|
the focus is currently in some other application. \fBPassive\fR means that
|
|
\fIwindow\fR will never claim the focus for itself: the window manager
|
|
should give the focus to \fIwindow\fR at appropriate times. However,
|
|
once the focus has been given to \fIwindow\fR or one of its descendants,
|
|
the application may re-assign the focus among \fIwindow\fR's descendants.
|
|
The focus model defaults to \fBpassive\fR, and Tk's \fBfocus\fR procedure
|
|
assumes a passive model of focusing.
|
|
.TP
|
|
(\fBwm 'frame \fIwindow\fR)
|
|
If \fIwindow\fR has been reparented by the window manager into a
|
|
decorative frame, the procedure returns the X window identifier for
|
|
the outermost frame that contains \fIwindow\fR (the window whose
|
|
parent is the root or virtual root). If \fIwindow\fR hasn't been
|
|
reparented by the window manager then the procedure returns the
|
|
X window identifier for \fIwindow\fR.
|
|
.TP
|
|
(\fBwm 'geometry \fIwindow\fR)
|
|
.TP
|
|
(\fBwm 'geometry \fIwindow\fR \fInewGeometry\fR)
|
|
If \fInewGeometry\fR is specified, then the geometry of \fIwindow\fR
|
|
is changed and an empty list is returned. Otherwise the current
|
|
geometry for \fIwindow\fR is returned (this is the most recent
|
|
geometry specified either by manual resizing or
|
|
in a \fBwm geometry\fR procedure). \fINewGeometry\fR has
|
|
the form "\fB=\fIwidth\fBx\fIheight\fB\(+-\fIx\fB\(+-\fIy\fR", where
|
|
any of \fB=\fR, \fIwidth\fBx\fIheight\fR, or \fB\(+-\fIx\fB\(+-\fIy\fR
|
|
may be omitted. \fIWidth\fR and \fIheight\fR are positive integers
|
|
specifying the desired dimensions of \fIwindow\fR. If \fIwindow\fR
|
|
is gridded (see GRIDDED GEOMETRY MANAGEMENT below) then the dimensions
|
|
are specified in grid units; otherwise they are specified in pixel
|
|
units. \fIX\fR and \fIy\fR specify the desired location of
|
|
\fIwindow\fR on the screen, in pixels.
|
|
If \fIx\fR is preceded by \fB+\fR, it specifies
|
|
the number of pixels between the left edge of the screen and the left
|
|
edge of \fIwindow\fR's border; if preceded by \fB:\fR then
|
|
\fIx\fR specifies the number of pixels
|
|
between the right edge of the screen and the right edge of \fIwindow\fR's
|
|
border. If \fIy\fR is preceded by \fB+\fR then it specifies the
|
|
number of pixels between the top of the screen and the top
|
|
of \fIwindow\fR's border; if \fIy\fR is preceded by \fB:\fR then
|
|
it specifies the number of pixels between the bottom of \fIwindow\fR's
|
|
border and the bottom of the screen.
|
|
If \fInewGeometry\fR is specified as an empty string then any
|
|
existing user-specified geometry for \fIwindow\fR is cancelled, and
|
|
the window will revert to the size requested internally by its
|
|
widgets.
|
|
.TP
|
|
(\fBwm 'grid \fIwindow\fR)
|
|
.TP
|
|
(\fBwm 'grid \fIwindow\fR \fIbaseWidth baseHeight widthInc heightInc\fR)
|
|
This procedure indicates that \fIwindow\fR is to be managed as a
|
|
gridded window.
|
|
It also specifies the relationship between grid units and pixel units.
|
|
\fIBaseWidth\fR and \fIbaseHeight\fR specify the number of grid
|
|
units corresponding to the pixel dimensions requested internally
|
|
by \fIwindow\fR using \fBTk_GeometryRequest\fR. \fIWidthInc\fR
|
|
and \fIheightInc\fR specify the number of pixels in each horizontal
|
|
and vertical grid unit.
|
|
These four values determine a range of acceptable sizes for
|
|
\fIwindow\fR, corresponding to grid-based widths and heights
|
|
that are non-negative integers.
|
|
Tk will pass this information to the window manager; during
|
|
manual resizing, the window manager will restrict the window's size
|
|
to one of these acceptable sizes.
|
|
Furthermore, during manual resizing the window manager will display
|
|
the window's current size in terms of grid units rather than pixels.
|
|
If \fIbaseWidth\fR etc. are all specified as empty strings, then
|
|
\fIwindow\fR will no longer be managed as a gridded window. If
|
|
\fIbaseWidth\fR etc. are specified then the return value is an
|
|
empty list.
|
|
Otherwise the return value is a STk list containing
|
|
four elements corresponding to the current \fIbaseWidth\fR,
|
|
\fIbaseHeight\fR, \fIwidthInc\fR, and \fIheightInc\fR; if
|
|
\fIwindow\fR is not currently gridded, then \fB#f\fR
|
|
is returned.
|
|
Note: this procedure should not be needed very often, since the
|
|
\fBTk_SetGrid\fR library procedure and the \fBsetGrid\fR option
|
|
provide easier access to the same functionality.
|
|
.TP
|
|
(\fBwm 'group \fIwindow\fR)
|
|
.TP
|
|
(\fBwm 'group \fIwindow\fR \fIwidget\-name\fR)
|
|
If \fIwidget\-name\fR is specified, it gives the path name for the leader of
|
|
a group of related windows. The window manager may use this information,
|
|
for example, to unmap all of the windows in a group when the group's
|
|
leader is iconified. \fIPathName\fR may be specified as \fB#f\fR to
|
|
remove \fIwindow\fR from any group association. If \fIwidget\-name\fR is
|
|
specified then the procedure returns an empty list; otherwise it
|
|
returns the path name of \fIwindow\fR's current group leader, or \fB#f\fR
|
|
if \fIwindow\fR isn't part of any group.
|
|
.TP
|
|
(\fBwm 'iconbitmap \fIwindow\fR)
|
|
.TP
|
|
(\fBwm 'iconbitmap \fIwindow\fR \fIbitmap\fR)
|
|
If \fIbitmap\fR is specified, then it names a bitmap in the standard
|
|
forms accepted by Tk (see the \fBTk_GetBitmap\fR manual entry for details).
|
|
This bitmap is passed to the window manager to be displayed in
|
|
\fIwindow\fR's icon, and the procedure returns an empty list. If
|
|
\fB#f\fR is specified for \fIbitmap\fR, then any current icon
|
|
bitmap is cancelled for \fIwindow\fR.
|
|
If \fIbitmap\fR is specified then the procedure returns an empty list.
|
|
Otherwise it returns the name of
|
|
the current icon bitmap associated with \fIwindow\fR, or \fB#f\fR
|
|
string if \fIwindow\fR has no icon bitmap.
|
|
.TP
|
|
(\fBwm 'iconify \fIwindow\fR)
|
|
Arrange for \fIwindow\fR to be iconified. It \fIwindow\fR hasn't
|
|
yet been mapped for the first time, this procedure will arrange for
|
|
it to appear in the iconified state when it is eventually mapped.
|
|
.TP
|
|
(\fBwm 'iconmask \fIwindow\fR)
|
|
.TP
|
|
(\fBwm 'iconmask \fIwindow\fR \fIbitmap\fR)
|
|
If \fIbitmap\fR is specified, then it names a bitmap in the standard
|
|
forms accepted by Tk (see the \fBTk_GetBitmap\fR manual entry for details).
|
|
This bitmap is passed to the window manager to be used as a mask
|
|
in conjunction with the \fBiconbitmap\fR option: where the mask
|
|
has zeroes no icon will be displayed; where it has ones, the bits
|
|
from the icon bitmap will be displayed. If
|
|
\fB#f\fR is specified for \fIbitmap\fR then any current icon
|
|
mask is cancelled for \fIwindow\fR (this is equivalent to specifying
|
|
a bitmap of all ones). If \fIbitmap\fR is specified
|
|
then the procedure returns an empty string. Otherwise it
|
|
returns the name of the current icon mask associated with
|
|
\fIwindow\fR, or \fB#f\fR if no mask is in effect.
|
|
.TP
|
|
(\fBwm 'iconname \fIwindow\fR)
|
|
.TP
|
|
(\fBwm 'iconname \fIwindow\fR \fInewName\fR)
|
|
If \fInewName\fR is specified, then it is passed to the window
|
|
manager; the window manager should display \fInewName\fR inside
|
|
the icon associated with \fIwindow\fR. In this case an empty
|
|
list is returned as result. If \fInewName\fR isn't specified
|
|
then the procedure returns the current icon name for \fIwindow\fR,
|
|
or an empty string if no icon name has been specified (in this
|
|
case the window manager will normally display the window's title,
|
|
as specified with the \fBwm title\fR procedure).
|
|
.TP
|
|
(\fBwm 'iconposition \fIwindow\fR)
|
|
.TP
|
|
(\fBwm 'iconposition \fIwindow\fR \fIx y\fR)
|
|
If \fIx\fR and \fIy\fR are specified, they are passed to the window
|
|
manager as a hint about where to position the icon for \fIwindow\fR.
|
|
In this case an empty list is returned. If \fIx\fR and \fIy\fR are
|
|
specified as \fB#f\fR then any existing icon position hint is cancelled.
|
|
If neither \fIx\fR nor \fIy\fR is specified, then the procedure returns
|
|
a list containing two values, which are the current icon position
|
|
hints (if no hints are in effect then \fB#f\fR list is returned).
|
|
.TP
|
|
(\fBwm 'iconwindow \fIwindow\fR)
|
|
.TP
|
|
(\fBwm 'iconwindow \fIwindow\fR \fIwidget\-name\fR)
|
|
If \fIwidget\-name\fR is specified, it is the path name for a window to
|
|
use as icon for \fIwindow\fR: when \fIwindow\fR is iconified then
|
|
\fIwidget\-name\fR will be mapped to serve as icon, and when \fIwindow\fR
|
|
is de-iconified then \fIwidget\-name\fR will be unmapped again. If
|
|
\fIwidget\-name\fR is specified as \fB#f\fR then any existing
|
|
icon window association for \fIwindow\fR will be cancelled. If
|
|
the \fIwidget\-name\fR argument is specified then an empty list is
|
|
returned. Otherwise the procedure returns the path name of the
|
|
current icon window for \fIwindow\fR, or \fB#f\fR if there
|
|
is no icon window currently specified for \fIwindow\fR.
|
|
Button press events are disabled for \fIwindow\fR as long as it is
|
|
an icon window; this is needed in order to allow window managers
|
|
to ``own'' those events.
|
|
Note: not all window managers support the notion of an icon window.
|
|
.TP
|
|
(\fBwm 'maxsize \fIwindow\fR)
|
|
.TP
|
|
(\fBwm 'maxsize \fIwindow\fR \fIwidth height\fR)
|
|
If \fIwidth\fR and \fIheight\fR are specified, they give
|
|
the maximum permissible dimensions for \fIwindow\fR.
|
|
For gridded windows the dimensions are specified in
|
|
grid units; otherwise they are specified in pixel units.
|
|
The window manager will restrict the window's dimensions to be
|
|
less than or equal to \fIwidth\fR and \fIheight\fR.
|
|
If \fIwidth\fR and \fIheight\fR are
|
|
specified, then the procedure returns an empty string. Otherwise
|
|
it returns a list with two elements, which are the
|
|
maximum width and height currently in effect.
|
|
The maximum size defaults to the size of the screen.
|
|
If resizing has been disabled with the \fBwm resizable\fR procedure,
|
|
then this procedure has no effect.
|
|
See the sections on geometry management below for more information.
|
|
.TP
|
|
(\fBwm 'minsize \fIwindow\fR)
|
|
.TP
|
|
(\fBwm 'minsize \fIwindow\fR \fIwidth height\fR)
|
|
If \fIwidth\fR and \fIheight\fR are specified, they give the
|
|
minimum permissible dimensions for \fIwindow\fR.
|
|
For gridded windows the dimensions are specified in
|
|
grid units; otherwise they are specified in pixel units.
|
|
The window manager will restrict the window's dimensions to be
|
|
greater than or equal to \fIwidth\fR and \fIheight\fR.
|
|
If \fIwidth\fR and \fIheight\fR are
|
|
specified, then the procedure returns an empty string. Otherwise
|
|
it returns a list with two elements, which are the
|
|
minimum width and height currently in effect.
|
|
The minimum size defaults to one pixel in each dimension.
|
|
If resizing has been disabled with the \fBwm resizable\fR procedure,
|
|
then this procedure has no effect.
|
|
See the sections on geometry management below for more information.
|
|
.TP
|
|
(\fBwm 'overrideredirect \fIwindow\fR)
|
|
.TP
|
|
(\fBwm 'overrideredirect \fIwindow\fR \fIboolean\fR)
|
|
If \fIboolean\fR is specified, it must have a proper boolean form and
|
|
the override-redirect flag for \fIwindow\fR is set to that value.
|
|
If \fIboolean\fR is not specified then \fB#t\fR or \fB#f\fR is
|
|
returned to indicate whether or not the override-redirect flag
|
|
is currently set for \fIwindow\fR.
|
|
Setting the override-redirect flag for a window causes
|
|
it to be ignored by the window manager; among other things, this means
|
|
that the window will not be reparented from the root window into a
|
|
decorative frame and the user will not be able to manipulate the
|
|
window using the normal window manager mechanisms.
|
|
.TP
|
|
(\fBwm 'positionfrom \fIwindow\fR)
|
|
.TP
|
|
(\fBwm 'positionfrom \fIwindow\fR \fIwho\fR)
|
|
If \fIwho\fR is specified, it must be \fBprogram\fR,
|
|
\fBuser\fR (or an abbreviation of one of these two), or \fB#f\fR.
|
|
It indicates
|
|
whether \fIwindow\fR's current position was requested by the
|
|
program or by the user. Many window managers ignore program-requested
|
|
initial positions and ask the user to manually position the window; if
|
|
\fBuser\fR is specified then the window manager should position the
|
|
window at the given place without asking the user for assistance.
|
|
If \fIwho\fR is specified as \fB#f\fR, then the current position
|
|
source is cancelled.
|
|
If \fIwho\fR is specified, then the procedure returns an empty list.
|
|
Otherwise it returns \fBuser\fR or \fBwindow\fR to indicate the
|
|
source of the window's current position, or \fB#F\fR if
|
|
no source has been specified yet. Most window managers interpret
|
|
``no source'' as equivalent to \fBprogram\fR.
|
|
Tk will automatically set the position source to \fBuser\fR
|
|
when a \fBwm geometry\fR procedure is invoked, unless the source has
|
|
been set explicitly to \fBprogram\fR.
|
|
.TP
|
|
(\fBwm 'protocol \fIwindow\fR ?\fIname\fR? ?\fIprocedure\fR?)
|
|
This procedure is used to manage window manager protocols such as
|
|
\fBWM_DELETE_WINDOW\fR.
|
|
\fIName\fR is the name of an atom corresponding to a window manager
|
|
protocol, such as \fBWM_DELETE_WINDOW\fR or \fBWM_SAVE_YOURSELF\fR
|
|
or \fBWM_TAKE_FOCUS\fR.
|
|
If both \fIname\fR and \fIprocedure\fR are specified, then \fIprocedure\fR
|
|
is associated with the protocol specified by \fIname\fR.
|
|
\fIName\fR will be added to \fIwindow\fR's \fBWM_PROTOCOLS\fR
|
|
property to tell the window manager that the application has a
|
|
protocol handler for \fIname\fR, and \fIprocedure\fR will
|
|
be invoked in the future whenever the window manager sends a
|
|
message to the client for that protocol.
|
|
In this case the procedure returns an empty list.
|
|
If \fIname\fR is specified but \fIprocedure\fR isn't, then the current
|
|
procedure for \fIname\fR is returned, or an empty list if there
|
|
is no handler defined for \fIname\fR.
|
|
If \fIprocedure\fR is specified as an empty string then the current
|
|
handler for \fIname\fR is deleted and it is removed from the
|
|
\fBWM_PROTOCOLS\fR property on \fIwindow\fR; an empty string is
|
|
returned.
|
|
Lastly, if neither \fIname\fR nor \fIprocedure\fR is specified, the
|
|
procedure returns a list of all the protocols for which handlers
|
|
are currently defined for \fIwindow\fR.
|
|
.RS
|
|
.PP
|
|
Tk always defines a protocol handler for \fBWM_DELETE_WINDOW\fR, even if
|
|
you haven't asked for one with \fBwm protocol\fR.
|
|
If a \fBWM_DELETE_WINDOW\fR message arrives when you haven't defined
|
|
a handler, then Tk handles the message by destroying the window for
|
|
which it was received.
|
|
.RE
|
|
.TP
|
|
(\fBwm 'resizable \fIwindow\fR)
|
|
.TP
|
|
(\fBwm 'resizable \fIwindow\fR \fIwidth height\fR)
|
|
This procedure controls whether or not the user may interactively
|
|
resize a top-level window. If \fIwidth\fR and \fIheight\fR are
|
|
specified, they are boolean values that determine whether the
|
|
width and height of \fIwindow\fR may be modified by the user.
|
|
In this case the procedure returns an empty string.
|
|
If \fIwidth\fR and \fIheight\fR are omitted then the procedure
|
|
returns a list with two boolean elements that indicate whether the
|
|
width and height of \fIwindow\fR are currently resizable.
|
|
By default, windows are resizable in both dimensions.
|
|
If resizing is disabled, then the window's size will be the size
|
|
from the most recent interactive resize or \fBwm geometry\fR
|
|
procedure. If there has been no such operation then
|
|
the window's natural size will be used.
|
|
.TP
|
|
(\fBwm 'sizefrom \fIwindow\fR)
|
|
.TP
|
|
(\fBwm 'sizefrom \fIwindow\fR \fIwho\fR)
|
|
If \fIwho\fR is specified, it must be \fBprogram\fR
|
|
\fBuser\fR (or an abbreviation of one of these two) or \fB#f\fR . It indicates
|
|
whether \fIwindow\fR's current size was requested by the
|
|
program or by the user. Some window managers ignore program-requested
|
|
sizes and ask the user to manually size the window; if
|
|
\fBuser\fR is specified then the window manager should give the
|
|
window its specified size without asking the user for assistance.
|
|
If \fIwho\fR is specified as \fB#f\fR, then the current size
|
|
source is cancelled.
|
|
If \fIwho\fR is specified, then the procedure returns an empty string.
|
|
Otherwise it returns \fBuser\fR or \fBwindow\fR to indicate the
|
|
source of the window's current size, or \fB#f\fR if
|
|
no source has been specified yet. Most window managers interpret
|
|
``no source'' as equivalent to \fBprogram\fR.
|
|
.TP
|
|
(\fBwm 'state \fIwindow\fR)
|
|
Returns the current state of \fIwindow\fR: either "\fBnormal\fR",
|
|
"\fBiconic\fR", "\fBwithdrawn\fR", or "\fBicon\fR". The difference
|
|
between "\fBiconic\fR" and "\fBicon\fR" is that "\fBiconic\fR" refers
|
|
to a window that has been iconified (e.g., with the \fBwm iconify\fR
|
|
command) while "\fBicon\fR" refers to a window whose only purpose is
|
|
to serve as the icon for some other window (via the \fBwm iconwindow\fR
|
|
command).
|
|
.TP
|
|
(\fBwm 'title \fIwindow\fR)
|
|
.TP
|
|
(\fBwm 'title \fIwindow\fR \fIstring\fR)
|
|
If \fIstring\fR is specified, then it will be passed to the window
|
|
manager for use as the title for \fIwindow\fR (the window manager
|
|
should display this string in \fIwindow\fR's title bar). In this
|
|
case the procedure returns an empty list. If \fIstring\fR isn't
|
|
specified then the procedure returns the current title for the
|
|
\fIwindow\fR. The title for a window defaults to its name.
|
|
.TP
|
|
(\fBwm 'transient \fIwindow\fR)
|
|
.TP
|
|
(\fBwm 'transient \fIwindow\fR \fImaster\fR)
|
|
If \fImaster\fR is specified, then the window manager is informed
|
|
that \fIwindow\fR is a transient window (e.g. pull-down menu) working
|
|
on behalf of \fImaster\fR (where \fImaster\fR is the
|
|
path name for a top-level window). Some window managers will use
|
|
this information to manage \fIwindow\fR specially. If \fImaster\fR
|
|
is specified as \fB#f\fR then \fIwindow\fR is marked as not
|
|
being a transient window any more. If \fImaster\fR is specified,
|
|
then the procedure returns an empty list. Otherwise the procedure
|
|
returns the path name of \fIwindow\fR's current master, or
|
|
\fB#f\fR if \fIwindow\fR isn't currently a transient window.
|
|
.TP
|
|
(\fBwm 'withdraw \fIwindow\fR)
|
|
Arranges for \fIwindow\fR to be withdrawn from the screen. This
|
|
causes the window to be unmapped and forgotten about by the window
|
|
manager. If the window
|
|
has never been mapped, then this procedure
|
|
causes the window to be mapped in the withdrawn state. Not all
|
|
window managers appear to know how to handle windows that are
|
|
mapped in the withdrawn state.
|
|
Note: it sometimes seems to be necessary to withdraw a
|
|
window and then re-map it (e.g. with \fBwm deiconify\fR) to get some
|
|
window managers to pay attention to changes in window attributes
|
|
such as group.
|
|
|
|
.SH "GEOMETRY MANAGEMENT"
|
|
.PP
|
|
By default a top-level window appears on the screen in its
|
|
\fInatural size\fR, which is the one determined internally by its
|
|
widgets and geometry managers.
|
|
If the natural size of a top-level window changes, then the window's size
|
|
changes to match.
|
|
A top-level window can be given a size other than its natural size in two ways.
|
|
First, the user can resize the window manually using the facilities
|
|
of the window manager, such as resize handles.
|
|
Second, the application can request a particular size for a
|
|
top-level window using the \fBwm geometry\fR procedure.
|
|
These two cases are handled identically by Tk; in either case,
|
|
the requested size overrides the natural size.
|
|
You can return the window to its natural by invoking \fBwm geometry\fR
|
|
with an empty \fIgeometry\fR string.
|
|
.PP
|
|
Normally a top-level window can have any size from one pixel in each
|
|
dimension up to the size of its screen.
|
|
However, you can use the \fBwm minsize\fR and \fBwm maxsize\fR procedures
|
|
to limit the range of allowable sizes.
|
|
The range set by \fBwm minsize\fR and \fBwm maxsize\fR applies to
|
|
all forms of resizing, including the window's natural size as
|
|
well as manual resizes and the \fBwm geometry\fR procedure.
|
|
You can also use the procedure \fBwm resizable\fR to completely
|
|
disable interactive resizing in one or both dimensions.
|
|
|
|
.SH "GRIDDED GEOMETRY MANAGEMENT"
|
|
.PP
|
|
Gridded geometry management occurs when one of the widgets of an
|
|
application supports a range of useful sizes.
|
|
This occurs, for example, in a text editor where the scrollbars,
|
|
menus, and other adornments are fixed in size but the edit widget
|
|
can support any number of lines of text or characters per line.
|
|
In this case, it is usually desirable to let the user specify the
|
|
number of lines or characters-per-line, either with the
|
|
\fBwm geometry\fR procedure or by interactively resizing the window.
|
|
In the case of text, and in other interesting cases also, only
|
|
discrete sizes of the window make sense, such as integral numbers
|
|
of lines and characters-per-line; arbitrary pixel sizes are not useful.
|
|
.PP
|
|
Gridded geometry management provides support for this kind of
|
|
application.
|
|
Tk (and the window manager) assume that there is a grid of some
|
|
sort within the application and that the application should be
|
|
resized in terms of \fIgrid units\fR rather than pixels.
|
|
Gridded geometry management is typically invoked by turning on
|
|
the \fBsetGrid\fR option for a widget; it can also be invoked
|
|
with the \fBwm grid\fR procedure or by calling \fBTk_SetGrid\fR.
|
|
In each of these approaches the particular widget (or sometimes
|
|
code in the application as a whole) specifies the relationship between
|
|
integral grid sizes for the window and pixel sizes.
|
|
To return to non-gridded geometry management, invoke
|
|
\fBwm grid\fR with empty argument strings.
|
|
.PP
|
|
When gridded geometry management is enabled then all the dimensions specified
|
|
in \fBwm minsize\fR, \fBwm maxsize\fR, and \fBwm geometry\fR procedures
|
|
are treated as grid units rather than pixel units.
|
|
Interactive resizing is also carried out in even numbers of grid units
|
|
rather than pixels.
|
|
|
|
.SH BUGS
|
|
.PP
|
|
Most existing window managers appear to have bugs that affect the
|
|
operation of the \fBwm\fR procedure. For example, some changes won't
|
|
take effect if the window is already active: the window will have
|
|
to be withdrawn and de-iconified in order to make the change happen.
|
|
|
|
.SH SEE ALSO
|
|
toplevel
|