|
|
| |
WMShell(3) |
FreeBSD Library Functions Manual |
WMShell(3) |
WMShell — The WMShell widget class
#include <Xm/Xm.h>
#include <X11/Shell.h>
WMShell is a top-level widget that encapsulates the interaction with the window
manager.
WMShell inherits behavior and resources from the Core, Composite,
and Shell classes.
The class pointer is wmShellWidgetClass.
The class name is WMShell.
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 |
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 |
_ |
_ |
_ |
_ |
_ |
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
(zero) 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 (zero)
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. 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
- 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
- Specifies the numerator of the maximum aspect ratio (X/Y) that the
application wants the widget instance to have.
- XmNmaxAspectY
- Specifies the denominator of the maximum aspect ratio (X/Y) that the
application wants the widget instance to have.
- XmNmaxHeight
- Specifies the maximum height that the application wants the widget
instance to have.
- XmNmaxWidth
- Specifies the maximum width that the application wants the widget instance
to have.
- XmNminAspectX
- Specifies the numerator of the minimum aspect ratio (X/Y) that the
application wants the widget instance to have.
- XmNminAspectY
- Specifies the denominator of the minimum aspect ratio (X/Y) that the
application wants the widget instance to have.
- XmNminHeight
- Specifies the minimum height that the application wants the widget
instance to have.
- XmNminWidth
- 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
- 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
- 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.
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.
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 |
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 |
_ |
_ |
_ |
_ |
_ |
There are no translations for WMShell.
Composite(3), Core(3), and Shell(3).
Visit the GSP FreeBSD Man Page Interface. Output converted with ManDoc. |