WMShell(3X)WMShell(3X)NAMEWMShell - The WMShell widget class
SYNOPSIS
#include <Xm/Xm.h> #include <X11/Shell.h>
DESCRIPTIONWMShell 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 pro‐
grammer to specify data. The programmer can also set the resource val‐
ues 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).
WMShell Resource Set
Class: XmCBaseHeight
Default: XtUnspecifiedShellInt
Type: int
Access: CSG
Class: XmCBaseWidth
Default: XtUnspecifiedShellInt
Type: int
Access: CSG
Class: XmCHeightInc
Default: XtUnspecifiedShellInt
Type: int
Access: CSG
Class: XmCIconMask
Default: NULL
Type: Pixmap
Access: CSG
Class: XmCIconPixmap
Default: NULL
Type: Pixmap
Access: CSG
Class: XmCIconWindow
Default: NULL
Type: Window
Access: CSG
Class: XmCIconX
Default: -1
Type: int
Access: CSG
Class: XmCIconY
Default: -1
Type: int
Access: CSG
Class: XmCInitialState
Default: NormalState
Type: int
Access: CSG
Class: XmCInput
Default: False
Type: Boolean
Access: CSG
Class: XmCMaxAspectX
Default: XtUnspecifiedShellInt
Type: int
Access: CSG
Class: XmCMaxAspectY
Default: XtUnspecifiedShellInt
Type: int
Access: CSG
Class: XmCMaxHeight
Default: XtUnspecifiedShellInt
Type: int
Access: CSG
Class: XmCMaxWidth
Default: XtUnspecifiedShellInt
Type: int
Access: CSG
Class: XmCMinAspectX
Default: XtUnspecifiedShellInt
Type: int
Access: CSG
Class: XmCMinAspectY
Default: XtUnspecifiedShellInt
Type: int
Access: CSG
Class: XmCMinHeight
Default: XtUnspecifiedShellInt
Type: int
Access: CSG
Class: XmCMinWidth
Default: XtUnspecifiedShellInt
Type: int
Access: CSG
Class: XmCTitle
Default: dynamic
Type: String
Access: CSG
Class: XmCTitleEncoding
Default: dynamic
Type: Atom
Access: CSG
Class: XmCTransient
Default: False
Type: Boolean
Access: CSG
Class: XmCWaitForWm
Default: True
Type: Boolean
Access: CSG
Class: XmCWidthInc
Default: XtUnspecifiedShellInt
Type: int
Access: CSG
Class: XmCWindowGroup
Default: dynamic
Type: Window
Access: CSG
Class: XmCWinGravity
Default: dynamic
Type: int
Access: CSG
Class: XmCWmTimeout
Default: 5000 ms
Type: int
Access: CSG
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 XmNheight‐
Inc, with a minimum of XmNminHeight and a maximum of XmNmax‐
Height. 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. 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 sup‐
plied for XmNbaseWidth but is supplied for XmNbaseHeight, the
value of XmNbaseWidth is set to 0 when the widget is realized.
Specifies the increment for a progression of preferred heights
for the window manager to use in sizing the widget. The pre‐
ferred heights are XmNbaseHeight plus integral multiples of XmN‐
heightInc, with a minimum of XmNminHeight and a maximum of XmN‐
maxHeight. 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. Specifies a bitmap that
could be used by the window manager to clip the XmNiconPixmap
bitmap to make the icon nonrectangular. Specifies a bitmap that
could be used by the window manager as the application's icon.
Specifies the ID of a window that could be used by the window
manager as the application's icon. Specifies a suitable place
to put the application's icon; this is a hint to the window man‐
ager in root window coordinates. Since the window manager con‐
trols icon placement policy, this may be ignored. If no initial
value is specified, the value is set to -1 when the widget is
realized. Specifies a suitable place to put the application's
icon; this is a hint to the window manager in root window coor‐
dinates. Since the window manager controls icon placement pol‐
icy, this may be ignored. If no initial value is specified, the
value is set to -1 when the widget is realized. Specifies the
state in which the application wishes the widget instance to
start. It must be one of the constants NormalState or Iconic‐
State. 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 WM_TAKE_FOCUS
───────────────────────────────────────────
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 Stan‐
dard Inter-Client Communication Conventions Manual. Specifies
the numerator of the maximum aspect ratio (X/Y) that the appli‐
cation wishes the widget instance to have. Specifies the denom‐
inator of the maximum aspect ratio (X/Y) that the application
wishes the widget instance to have. Specifies the maximum
height that the application wishes the widget instance to have.
If an initial value is not supplied for XmNmaxHeight but is sup‐
plied for XmNmaxWidth, the value of XmNmaxHeight is set to 32767
when the widget is realized. Specifies the maximum width that
the application wishes the widget instance to have. If an ini‐
tial value is not supplied for XmNmaxWidth but is supplied for
XmNmaxHeight, the value of XmNmaxWidth is set to 32767 when the
widget is realized. Specifies the numerator of the minimum
aspect ratio (X/Y) that the application wishes the widget
instance to have. Specifies the denominator of the minimum
aspect ratio (X/Y) that the application wishes the widget
instance to have. Specifies the minimum height that the appli‐
cation wishes the widget instance to have. If an initial value
is not supplied for XmNminHeight but is supplied for XmNmin‐
Width, the value of XmNminHeight is set to 1 when the widget is
realized. 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.
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. Specifies a property type that
represents the encoding of the XmNtitle string. If a language
procedure has been set, the default is None; otherwise, the
default is XA_STRING. When the widget is realized, if the value
is None, the corresponding name is assumed to be in the current
locale. The name is passed to XmbTextListToTextProperty with an
encoding style of XStdICCTextStyle. The resulting encoding is
“STRING” if the name is fully convertible to “STRING,” otherwise
“COMPOUND_TEXT.” The values of the encoding resources are not
changed; they remain None. 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 tran‐
sient widget's window differently from other windows. For exam‐
ple, a window manager may not iconify a transient window sepa‐
rately from its associated application. Applications and users
should not normally alter this resource. When True, specifies
that the Intrinsics waits the length of time given by the XmNwm‐
Timeout 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. 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 min‐
imum of XmNminWidth and a maximum of XmNmaxWidth. If an initial
value is not supplied for XmNwidthInc but is supplied for XmN‐
heightInc, the value of XmNwidthInc is set to 1 when the widget
is realized. Specifies the ID of a window with which this wid‐
get 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 XtUnspecifiedWindow‐
Group is specified, no window group is set. Specifies the win‐
dow 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, XmNwinGrav‐
ity is set to the window gravity returned by XWMGeometry. Other‐
wise, XmNwinGravity is set to NorthWestGravity. 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 super‐
classes. For a complete description of each resource, refer to the man
page for that superclass.
Shell Resource Set
Class: XmCAllowShellResize
Default: False
Type: Boolean
Access: CG
Class: XmCCreatePopupChildProc
Default: NULL
Type: XtCreatePopupChildProc
Access: CSG
Class: XmCGeometry
Default: NULL
Type: String
Access: CSG
Class: XmCOverrideRedirect
Default: False
Type: Boolean
Access: CSG
Class: XmCCallback
Default: NULL
Type: XtCallbackList
Access: C
Class: XmCCallback
Default: NULL
Type: XtCallbackList
Access: C
Class: XmCSaveUnder
Default: False
Type: Boolean
Access: CSG
Class: XmCVisual
Default: CopyFromParent
Type: Visual *
Access: CSG
Composite Resource Set
Class: XmCReadOnly
Default: NULL
Type: WidgetList
Access: G
Class: XmCInsertPosition
Default: NULL
Type: XtOrderProc
Access: CSG
Class: XmCReadOnly
Default: 0
Type: Cardinal
Access: G
Core Resource Set
Class: XmCAccelerators
Default: dynamic
Type: XtAccelerators
Access: CSG
Class: XmCSensitive
Default: dynamic
Type: Boolean
Access: G
Class: XmCBackground
Default: dynamic
Type: Pixel
Access: CSG
Class: XmCPixmap
Default: XmUNSPECIFIED_PIXMAP
Type: Pixmap
Access: CSG
Class: XmCBorderColor
Default: XtDefaultForeground
Type: Pixel
Access: CSG
Class: XmCPixmap
Default: XmUNSPECIFIED_PIXMAP
Type: Pixmap
Access: CSG
Class: XmCBorderWidth
Default: 1
Type: Dimension
Access: CSG
Class: XmCColormap
Default: dynamic
Type: Colormap
Access: CG
Class: XmCDepth
Default: dynamic
Type: int
Access: CG
Class: XmCCallback
Default: NULL
Type: XtCallbackList
Access: C
Class: XmCHeight
Default: dynamic
Type: Dimension
Access: CSG
Class: XmCInitialResourcesPersistent
Default: True
Type: Boolean
Access: C
Class: XmCMappedWhenManaged
Default: True
Type: Boolean
Access: CSG
Class: XmCScreen
Default: dynamic
Type: Screen *
Access: CG
Class: XmCSensitive
Default: True
Type: Boolean
Access: CSG
Class: XmCTranslations
Default: dynamic
Type: XtTranslations
Access: CSG
Class: XmCWidth
Default: dynamic
Type: Dimension
Access: CSG
Class: XmCPosition
Default: 0
Type: Position
Access: CSG
Class: XmCPosition
Default: 0
Type: Position
Access: CSG
Translations
There are no translations for WMShell.
SEE ALSOComposite(3X), Core(3X), Shell(3X)WMShell(3X)