WMShell(library call) WMShell(library call)
NAME [Toc] [Back]
WMShell - The WMShell widget class
SYNOPSIS [Toc] [Back]
#include <Xm/Xm.h>
#include <X11/Shell.h>
DESCRIPTION [Toc] [Back]
WMShell is a top-level widget that encapsulates the interaction with
the window manager.
Classes [Toc] [Back]
WMShell inherits behavior and resources from the Core, Composite, and
Shell classes.
The class pointer is wmShellWidgetClass.
The class name is WMShell.
New Resources [Toc] [Back]
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).
- 1 - Formatted: January 24, 2005
WMShell(library call) WMShell(library call)
________________________________________________________________________________
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 XtUnspecifiedShellInt CSG
________________________________________________________________________________
XmNiconY XmCIconY int XtUnspecifiedShellInt 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
- 2 - Formatted: January 24, 2005
WMShell(library call) WMShell(library call)
________________________________________________________________________________
|XmNwinGravity XmCWinGravity int dynamic CSG |
|_______________________________________________________________________________|
|XmNwmTimeout | XmCWmTimeout | int | 5000 ms | CSG |
|_________________|__________________|_________|_______________________|________|
|_________________|__________________|_________|_______________________|________|
XmNbaseHeight [Toc] [Back]
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 (zero) when the
widget is realized.
XmNbaseWidth [Toc] [Back]
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 (zero) when the widget is realized.
XmNheightInc [Toc] [Back]
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 [Toc] [Back]
Specifies a bitmap that could be used by the window manager
to clip the XmNiconPixmap bitmap to make the icon
nonrectangular.
XmNiconPixmap [Toc] [Back]
Specifies a bitmap that could be used by the window manager
as the application's icon.
XmNiconWindow [Toc] [Back]
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
- 3 - Formatted: January 24, 2005
WMShell(library call) WMShell(library call)
coordinates. Because the window manager controls icon
placement policy, this resource 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. Because the window manager controls icon
placement policy, this resource may be ignored.
XmNinitialState [Toc] [Back]
Specifies the state the application wants the widget
instance to start in. 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
(ICCCM).
XmNmaxAspectX [Toc] [Back]
Specifies the numerator of the maximum aspect ratio (X/Y)
that the application wants the widget instance to have.
XmNmaxAspectY [Toc] [Back]
Specifies the denominator of the maximum aspect ratio (X/Y)
that the application wants the widget instance to have.
XmNmaxHeight [Toc] [Back]
Specifies the maximum height that the application wants the
widget instance to have.
XmNmaxWidth [Toc] [Back]
Specifies the maximum width that the application wants the
widget instance to have.
- 4 - Formatted: January 24, 2005
WMShell(library call) WMShell(library call)
XmNminAspectX [Toc] [Back]
Specifies the numerator of the minimum aspect ratio (X/Y)
that the application wants the widget instance to have.
XmNminAspectY [Toc] [Back]
Specifies the denominator of the minimum aspect ratio (X/Y)
that the application wants the widget instance to have.
XmNminHeight [Toc] [Back]
Specifies the minimum height that the application wants the
widget instance to have.
XmNminWidth [Toc] [Back]
Specifies the minimum width that the application wants the
widget instance to have.
XmNtitle Specifies the application name to be displayed by the window
manager. The default is the icon name, if specified;
otherwise, it is the name of the application. When
XtGetValues is called on this resource, the returned value
is a pointer to the actual resource value and should not be
freed.
XmNtitleEncoding [Toc] [Back]
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 it is COMPOUND_TEXT. The values of the encoding
resources are not changed; they remain None.
XmNtransient [Toc] [Back]
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 [Toc] [Back]
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.
- 5 - Formatted: January 24, 2005
WMShell(library call) WMShell(library call)
XmNwidthInc [Toc] [Back]
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 [Toc] [Back]
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 [Toc] [Back]
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 [Toc] [Back]
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 [Toc] [Back]
WMShell inherits behavior and resources from the superclasses
described in the following tables. For a complete description of each
resource, refer to the reference page for that superclass.
- 6 - Formatted: January 24, 2005
WMShell(library call) WMShell(library call)
______________________________________________________________________________________________________
| 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 |
|__________________|___________________|_____________|_________|________|
|__________________|___________________|_____________|_________|________|
- 7 - Formatted: January 24, 2005
WMShell(library call) WMShell(library call)
________________________________________________________________________________________________________________
| 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 | 0 | 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 [Toc] [Back]
There are no translations for WMShell.
RELATED [Toc] [Back]
Composite(3), Core(3), and Shell(3).
- 8 - Formatted: January 24, 2005 [ Back ] |
