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).

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 | dynamic | CSG
XmNtransient | XmCTransient | Boolean | False | CSG
XmNwaitForWm | XmCWaitForWm | Boolean | True | CSG
XmNwidthInc | XmCWidthInc | int | XtUnspecifiedShellInt | CSG
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.

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

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

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.

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 XWMGeometry. 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 | XtCreatePopupChildProc | 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
XmNvisual | XmCVisual | Visual * | CopyFromParent | CSG

Composite Resource Set
Name | Class | Type | Default | Access
XmNchildren | XmCReadOnly | WidgetList | NULL | G
XmNinsertPosition | XmCInsertPosition | XtOrderProc | 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
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).