WMShell(3Xm)

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 lower case or upper case, 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
Name | Class | Type | Default | Access
XmNheightInc | XmCHeightInc | int | -1 | 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 | 1 | CSG
XmNinput | XmCInput | Boolean | True | CSG
XmNmaxAspectX | XmCMaxAspectX | int | -1 | CSG
XmNmaxAspectY | XmCMaxAspectY | int | -1 | CSG
XmNmaxHeight | XmCMaxHeight | int | -1 | CSG
XmNmaxWidth | XmCMaxWidth | int | -1 | CSG
XmNminAspectX | XmCMinAspectX | int | -1 | CSG
XmNminAspectY | XmCMinAspectY | int | -1 | CSG
XmNminHeight | XmCMinHeight | int | -1 | CSG
XmNminWidth | XmCMinWidth | int | -1 | CSG
XmNtitle | XmCTitle | char * | NULL | CSG
XmNtransient | XmCTransient | Boolean | False | CSG
XmNwaitForWm | XmCWaitForWm | Boolean | True | CSG
XmNwidthInc | XmCWidthInc | int | -1 | CSG
XmNwindowGroup | XmCWindowGroup | XID | None | CSG
XmNwmTimeout | XmCWmTimeout | int | fivesecond | CSG

XmNheightInc
    Specifies allowable height for the widget instance by the window manager if this resource is defined. The sizes are XmNminimumHeight plus an integral multiple of XmNheightInc, subject to the XmNmaximumHeight resource.

XmNiconMask
    Specifies a bitmap which could be used by the window manager to clip the XmNiconPixmap bitmap to make the icon nonrectangular.

XmNiconPixmap
    Specifies a bitmap which could be used by the window manager as the application's icon.

XmNiconWindow
    Specifies the ID of a window which 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.

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.

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
    Gives the application's input model for this widget and its descendants.

XmNmaxAspectX
    Gives the maximum aspect ratio (X/Y) that the application wishes the widget instance to have.

XmNmaxAspectY
    Gives the maximum aspect ratio (X/Y) that the application wishes the widget instance to have.

XmNmaxHeight
    Gives the maximum height that the application wishes the widget instance to have.

XmNmaxWidth
    Gives the maximum width that the application wishes the widget instance to have.

XmNminAspectX
    Gives the minimum aspect ratio (X/Y) that the application wishes the widget instance to have.

XmNminAspectY
    Gives 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.

XmNminWidth
    Specifies the minimum width that the application wishes the widget instance to have.

XmNtitle
    Specifies the application name to be displayed by the window manager.

XmNtransient
    Specifies a Boolean value that is True if the widget instance is a transient window which should be treated more lightly by the window manager. Applications and users should not normally alter this resource.

XmNwaitForWm
    Specifies that the Intrinsics will wait the length of time given by the XmNwmTimeout resource for the window manager to respond to certain actions when True, before assuming that there is no window manager present. This resource will be altered by the Intrinsics as it receives, or fails to receive, responses from the window manager.

XmNwidthInc
    Specifies allowable width for the widget instance by the window manager if this resource is defined. The sizes are XmNminimumWidth plus an integral multiple of XmNwidthInc, subject to the XmNmaximumWidth resource.

XmNwindowGroup
    Specifies the ID of a window for which this widget instance is associated; a window manager may treat all windows in a group in some way, for example, by always moving or iconifying them together.

    If this is set on a Shell widget instance that has no parent but has popup children, this resource is set to the same value on all popup children of the widget instance, all popup children of these children, and so on. See also the XmNtransient resource.

XmNwmTimeout
    Specifies the length of time that the Intrinsics will wait for the window manager to respond to certain actions before assuming that there is no window manager present.

  Inherited Resources
WMShell inherits behavior and resources from the following superclasses. For a complete description of these resources, refer to the man page for that superclass.

Shell Resource Set
Name | Class | Type | Default | Access
XmNallowShellResize | XmCAllowShellResize | Boolean | False | CSG
XmNcreatePopupChildProc | XmCCreatePopupChildProc | XmCreatePopupChildProc | NULL | CSG
XmNgeometry | XmCGeometry | String | NULL | CSG
XmNoverrideRedirect | XmCOverrideRedirect | Boolean | False | CSG
XmNpopdownCallback | XmCCallback | XtCallbackList | NULL | C
XmNpopupCallback | XmCCallback | XtCallbackList | NULL | C
XmNsaveUnder | XmCSaveUnder | Boolean | False | CSG

Composite Resource Set
Name | Class | Type | Default | Access
XmNinsertPosition | XmCInsertPosition | XmRFunction | NULL | CSG

Core Resource Set
Name | Class | Type | Default | Access
XmNaccelerators | XmCAccelerators | XtTranslations | NULL | CSG
XmNancestorSensitive | XmCSensitive | Boolean | ShellAncestorSensitive | G
XmNbackground | XmCBackground | Pixel | White | CSG
XmNbackgroundPixmap | XmCPixmap | Pixmap | XmUNSPECIFIED_PIXMAP | CSG
XmNborderColor | XmCBorderColor | Pixel | Black | CSG
XmNborderPixmap | XmCPixmap | Pixmap | XmUNSPECIFIED_PIXMAP | CSG
XmNborderWidth | XmCBorderWidth | Dimension | 1 | CSG
XmNcolormap | XmCColormap | Colormap | ShellColormap | CG
XmNdepth | XmCDepth | int | ShellDepth | CG
XmNdestroyCallback | XmCCallback | XtCallbackList | NULL | C
XmNheight | XmCHeight | Dimension | 0 | CSG
XmNmappedWhenManaged | XmCMappedWhenManaged | Boolean | True | CSG
XmNscreen | XmCScreen | Pointer | XtCopyScreen | CG
XmNsensitive | XmCSensitive | Boolean | True | CSG
XmNtranslations | XmCTranslations | XtTranslations | NULL | CSG
XmNwidth | XmCWidth | Dimension | 0 | CSG
XmNx | XmCPosition | Position | 0 | CSG
XmNy | XmCPosition | Position | 0 | CSG

RELATED INFORMATION
Composite(3Xm), Core(3Xm), and Shell(3Xm).