WMShell(3X) UNIX System V WMShell(3X)
NAME
WMShell - The WMShell widget class.
SYNOPSIS
#include <Xm/Xm.h>
#include <X11/Shell.h>
DESCRIPTION
WMShell is a top-level widget that encapsulates the interaction with the
window manager.
Classes
WMShell inherits behavior and resources from Core, Composite, and Shell
classes.
The class pointer is wmShellWidgetClass.
The class name is WMShell.
New Resources
The following table defines a set of widget resources used by the
programmer to specify data. The programmer can also set the resource
values for the inherited classes to set attributes for this widget. To
reference a resource by name or by class in a .Xdefaults file, remove the
XmN or XmC prefix and use the remaining letters. To specify one of the
defined values for a resource in a .Xdefaults file, remove the Xm prefix
and use the remaining letters (in either lowercase or uppercase, but
include any underscores between words). The codes in the access column
indicate if the given resource can be set at creation time (C), set by
using XtSetValues (S), retrieved by using XtGetValues (G), or is not
applicable (N/A).
10/89 Page 1
WMShell(3X) UNIX System V WMShell(3X)
________________________________________________________________________________
WMShell Resource Set
________________________________________________________________________________
Name Class Type Default Access
________________________________________________________________________________
________________________________________________________________________________
XmNbaseHeight XmCBaseHeight int XtUnspecifiedShellInt CSG
________________________________________________________________________________
XmNbaseWidth XmCBaseWidth int XtUnspecifiedShellInt CSG
________________________________________________________________________________
XmNheightInc XmCHeightInc int XtUnspecifiedShellInt CSG
________________________________________________________________________________
XmNiconMask XmCIconMask Pixmap NULL CSG
________________________________________________________________________________
XmNiconPixmap XmCIconPixmap Pixmap NULL CSG
________________________________________________________________________________
XmNiconWindow XmCIconWindow Window NULL CSG
________________________________________________________________________________
XmNiconX XmCIconX int -1 CSG
________________________________________________________________________________
XmNiconY XmCIconY int -1 CSG
________________________________________________________________________________
XmNinitialState XmCInitialState int NormalState CSG
________________________________________________________________________________
XmNinput XmCInput Boolean False CSG
________________________________________________________________________________
XmNmaxAspectX XmCMaxAspectX int XtUnspecifiedShellInt CSG
________________________________________________________________________________
XmNmaxAspectY XmCMaxAspectY int XtUnspecifiedShellInt CSG
________________________________________________________________________________
XmNmaxHeight XmCMaxHeight int XtUnspecifiedShellInt CSG
________________________________________________________________________________
XmNmaxWidth XmCMaxWidth int XtUnspecifiedShellInt CSG
________________________________________________________________________________
XmNminAspectX XmCMinAspectX int XtUnspecifiedShellInt CSG
________________________________________________________________________________
XmNminAspectY XmCMinAspectY int XtUnspecifiedShellInt CSG
________________________________________________________________________________
XmNminHeight XmCMinHeight int XtUnspecifiedShellInt CSG
________________________________________________________________________________
XmNminWidth XmCMinWidth int XtUnspecifiedShellInt CSG
________________________________________________________________________________
XmNtitle XmCTitle String dynamic CSG
________________________________________________________________________________
XmNtitleEncoding XmCTitleEncoding Atom XA_STRING CSG
________________________________________________________________________________
XmNtransient XmCTransient Boolean False CSG
________________________________________________________________________________
XmNwaitForWm XmCWaitForWm Boolean True CSG
________________________________________________________________________________
XmNwidthInc XmCWidthInc int XtUnspecifiedShellInt CSG
________________________________________________________________________________
Page 2 10/89
WMShell(3X) UNIX System V WMShell(3X)
| XmNwindowGroup | XmCWindowGroup | Window | dynamic | CSG |
|_________________|__________________|_________|_______________________|________|
| XmNwinGravity | XmCWinGravity | int | dynamic | CSG |
|_________________|__________________|_________|_______________________|________|
| XmNwmTimeout | XmCWmTimeout | int | 5000 ms | CSG |
|_________________|__________________|_________|_______________________|________|
XmNbaseHeight
Specifies the base for a progression of preferred heights for the
window manager to use in sizing the widget. The preferred heights
are XmNbaseHeight plus integral multiples of XmNheightInc, with a
minimum of XmNminHeight and a maximum of XmNmaxHeight. If an
initial value is not supplied for XmNbaseHeight but is supplied for
XmNbaseWidth, the value of XmNbaseHeight is set to 0 when the
widget is realized.
XmNbaseWidth
Specifies the base for a progression of preferred widths for the
window manager to use in sizing the widget. The preferred widths
are XmNbaseWidth plus integral multiples of XmNwidthInc, with a
minimum of XmNminWidth and a maximum of XmNmaxWidth. If an initial
value is not supplied for XmNbaseWidth but is supplied for
XmNbaseHeight, the value of XmNbaseWidth is set to 0 when the
widget is realized.
XmNheightInc
Specifies the increment for a progression of preferred heights for
the window manager to use in sizing the widget. The preferred
heights are XmNbaseHeight plus integral multiples of XmNheightInc,
with a minimum of XmNminHeight and a maximum of XmNmaxHeight. If
an initial value is not supplied for XmNheightInc but is supplied
for XmNwidthInc, the value of XmNheightInc is set to 1 when the
widget is realized.
XmNiconMask
Specifies a bitmap that could be used by the window manager to clip
the XmNiconPixmap bitmap to make the icon nonrectangular.
XmNiconPixmap
Specifies a bitmap that could be used by the window manager as the
application's icon.
XmNiconWindow
Specifies the ID of a window that could be used by the window
manager as the application's icon.
XmNiconX
Specifies a suitable place to put the application's icon; this is a
hint to the window manager in root window coordinates. Since the
window manager controls icon placement policy, this may be ignored.
If no initial value is specified, the value is set to -1 when the
widget is realized.
10/89 Page 3
WMShell(3X) UNIX System V WMShell(3X)
XmNiconY
Specifies a suitable place to put the application's icon; this is a
hint to the window manager in root window coordinates. Since the
window manager controls icon placement policy, this may be ignored.
If no initial value is specified, the value is set to -1 when the
widget is realized.
XmNinitialState
Specifies the state in which the application wishes the widget
instance to start. It must be one of the constants NormalState or
IconicState.
XmNinput
Specifies the application's input model for this widget and its
descendants. The meaning of a True or False value for this
resource depends on the presence or absence of a WM_TAKE_FOCUS atom
in the WM_PROTOCOLS property:
____________________________________________
| Input Model | XmNinput| WMTAKEFOCUS|
|________________|__________|_______________|
|________________|__________|_______________|
| No input | False | Absent |
|________________|__________|_______________|
| Passive | True | Absent |
|________________|__________|_______________|
| Locally active | True | Present |
|________________|__________|_______________|
| Globally active| False | Present |
|________________|__________|_______________|
For more information on input models, see the X Consortium Standard
Inter-Client Communication Conventions Manual.
XmNmaxAspectX
Specifies the numerator of the maximum aspect ratio (X/Y) that the
application wishes the widget instance to have.
XmNmaxAspectY
Specifies the denominator of the maximum aspect ratio (X/Y) that
the application wishes the widget instance to have.
XmNmaxHeight
Specifies the maximum height that the application wishes the widget
instance to have. If an initial value is not supplied for
XmNmaxHeight but is supplied for XmNmaxWidth, the value of
XmNmaxHeight is set to 32767 when the widget is realized.
Page 4 10/89
WMShell(3X) UNIX System V WMShell(3X)
XmNmaxWidth
Specifies the maximum width that the application wishes the widget
instance to have. If an initial value is not supplied for
XmNmaxWidth but is supplied for XmNmaxHeight, the value of
XmNmaxWidth is set to 32767 when the widget is realized.
XmNminAspectX
Specifies the numerator of the minimum aspect ratio (X/Y) that the
application wishes the widget instance to have.
XmNminAspectY
Specifies the denominator of the minimum aspect ratio (X/Y) that
the application wishes the widget instance to have.
XmNminHeight
Specifies the minimum height that the application wishes the widget
instance to have. If an initial value is not supplied for
XmNminHeight but is supplied for XmNminWidth, the value of
XmNminHeight is set to 1 when the widget is realized.
XmNminWidth
Specifies the minimum width that the application wishes the widget
instance to have. If an initial value is not supplied for
XmNminWidth but is supplied for XmNminHeight, the value of
XmNminWidth is set to 1 when the widget is realized.
XmNtitle
Specifies the application name to be displayed by the window
manager. The default is the icon name if specified, otherwise the
name of the application.
XmNtitleEncoding
Specifies a property type that represents the encoding of the
XmNtitle string.
XmNtransient
Specifies a Boolean value that is True if the widget instance is
transient, typically a popup on behalf of another widget. The
window manager may treat a transient widget's window differently
from other windows. For example, a window manager may not iconify
a transient window separately from its associated application.
Applications and users should not normally alter this resource.
XmNwaitForWm
When True, specifies that the Intrinsics waits the length of time
given by the XmNwmTimeout resource for the window manager to
respond to certain actions before assuming that there is no window
manager present. This resource is altered by the Intrinsics as it
receives, or fails to receive, responses from the window manager.
10/89 Page 5
WMShell(3X) UNIX System V WMShell(3X)
XmNwidthInc
Specifies the base for a progression of preferred widths for the
window manager to use in sizing the widget. The preferred widths
are XmNbaseWidth plus integral multiples of XmNwidthInc, with a
minimum of XmNminWidth and a maximum of XmNmaxWidth. If an initial
value is not supplied for XmNwidthInc but is supplied for
XmNheightInc, the value of XmNwidthInc is set to 1 when the widget
is realized.
XmNwindowGroup
Specifies the ID of a window with which this widget instance is
associated. By convention, this window is the "leader" of a group
of windows. A window manager may treat all windows in a group in
some way; for example, it may always move or iconify them together.
If no initial value is specified, the value is set to the window of
the first realized ancestor widget in the parent hierarchy when the
widget is realized. If a value of XtUnspecifiedWindowGroup is
specified, no window group is set.
XmNwinGravity
Specifies the window gravity for use by the window manager in
positioning the widget. If no initial value is specified, the
value is set when the widget is realized. If XmNgeometry is not
NULL, XmNwinGravity is set to the window gravity returned by
XmWMGeometry. Otherwise, XmNwinGravity is set to NorthWestGravity.
XmNwmTimeout
Specifies the length of time that the Intrinsics waits for the
window manager to respond to certain actions before assuming that
there is no window manager present. The value is in milliseconds
and must not be negative.
Inherited Resources
WMShell inherits behavior and resources from the following superclasses.
For a complete description of each resource, refer to the man page for
that superclass.
______________________________________________________________________________________________
Shell Resource Set
______________________________________________________________________________________________
Name Class Type Default Access
______________________________________________________________________________________________
______________________________________________________________________________________________
XmNallowShellResize XmCAllowShellResize Boolean False CG
______________________________________________________________________________________________
XmNcreatePopupChildProc XmCCreatePopupChildProc (*)() NULL CSG
______________________________________________________________________________________________
XmNgeometry XmCGeometry String NULL CSG
______________________________________________________________________________________________
XmNoverrideRedirect XmCOverrideRedirect Boolean False CSG
Page 6 10/89
WMShell(3X) UNIX System V WMShell(3X)
|_______________________|_________________________|________________|________________|________|
|XmNpopdownCallback | XmCCallback | XtCallbackList| NULL | C |
|_______________________|_________________________|________________|________________|________|
|XmNpopupCallback | XmCCallback | XtCallbackList| NULL | C |
|_______________________|_________________________|________________|________________|________|
|XmNsaveUnder | XmCSaveUnder | Boolean | False | CSG |
|_______________________|_________________________|________________|________________|________|
|XmNvisual | XmCVisual | Visual * | CopyFromParent| CSG |
|_______________________|_________________________|________________|________________|________|
_______________________________________________________________________
| Composite Resource Set |
|__________________|___________________|____________|_________|________|
| Name | Class | Type | Default| Access|
|__________________|___________________|____________|_________|________|
|__________________|___________________|____________|_________|________|
| XmNchildren | XmCReadOnly | WidgetList| NULL | G |
|__________________|___________________|____________|_________|________|
| XmNinsertPosition| XmCInsertPosition| (*)() | NULL | CSG |
|__________________|___________________|____________|_________|________|
| XmNnumChildren | XmCReadOnly | Cardinal | 0 | G |
|__________________|___________________|____________|_________|________|
________________________________________________________________________________________________________________
Core Resource Set
________________________________________________________________________________________________________________
Name Class Type Default Access
________________________________________________________________________________________________________________
________________________________________________________________________________________________________________
XmNaccelerators XmCAccelerators XtAccelerators dynamic CSG
________________________________________________________________________________________________________________
XmNancestorSensitive XmCSensitive Boolean dynamic G
________________________________________________________________________________________________________________
XmNbackground XmCBackground Pixel dynamic CSG
________________________________________________________________________________________________________________
XmNbackgroundPixmap XmCPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG
________________________________________________________________________________________________________________
XmNborderColor XmCBorderColor Pixel XtDefaultForeground CSG
________________________________________________________________________________________________________________
XmNborderPixmap XmCPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG
________________________________________________________________________________________________________________
XmNborderWidth XmCBorderWidth Dimension 1 CSG
________________________________________________________________________________________________________________
XmNcolormap XmCColormap Colormap dynamic CG
________________________________________________________________________________________________________________
XmNdepth XmCDepth int dynamic CG
________________________________________________________________________________________________________________
XmNdestroyCallback XmCCallback XtCallbackList NULL C
________________________________________________________________________________________________________________
XmNheight XmCHeight Dimension dynamic CSG
________________________________________________________________________________________________________________
XmNinitialResourcesPersistent XmCInitialResourcesPersistent Boolean True C
10/89 Page 7
WMShell(3X) UNIX System V WMShell(3X)
|_____________________________|_______________________________|________________|______________________|________|
|XmNmappedWhenManaged | XmCMappedWhenManaged | Boolean | True | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNscreen | XmCScreen | Screen * | dynamic | CG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNsensitive | XmCSensitive | Boolean | True | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNtranslations | XmCTranslations | XtTranslations| dynamic | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNwidth | XmCWidth | Dimension | dynamic | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNx | XmCPosition | Position | 0 | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNy | XmCPosition | Position | 0 | CSG |
|_____________________________|_______________________________|________________|______________________|________|
Translations
There are no translations for WMShell.
RELATED INFORMATION
Composite(3X), Core(3X), and Shell(3X).
Page 8 10/89