VendorShell(3X) UNIX System V VendorShell(3X)
NAME
VendorShell - The VendorShell widget class
SYNOPSIS
#include <Xm/Xm.h>
#include <X11/Shell.h>
VERSION
This page documents version 1.2 of the Motif library.
DESCRIPTION
VendorShell is a Motif widget class used as a supporting
superclass for all shell classes that are visible to the
window manager and that are not override redirect. It
contains resources that describe the MWM-specific look and
feel. It also manages the MWM-specific communication needed
by all VendorShell subclasses. See the mwm(1X) man page for
more information.
If an application uses the XmNmwmDecorations,
XmNmwmFunctions, or XmNmwmInputMode resource, it should
include the file <Xm/MwmUtil.h>.
Setting XmNheight, XmNwidth, or XmNborderWidth for either a
VendorShell or its managed child usually sets that resource
to the same value in both the parent and the child. When an
off-the-spot input method exists, the height and width of
the shell may be greater than those of the managed child in
order to accommodate the input method. In this case setting
XmNheight or XmNwidth for the shell does not necessarily set
that resource to the same value in the managed child, and
setting XmNheight or XmNwidth for the child does not
necessarily set that resource to the same value in the
shell.
For the managed child of a VendorShell, regardless of the
value of the shell's XmNallowShellResize, setting XmNx or
XmNy sets the corresponding resource of the parent but does
not change the child's position relative to the parent.
XtGetValues for the child's XmNx or XmNy yields the value of
the corresponding resource in the parent. The x and y
coordinates of the child's upper left outside corner
relative to the parent's upper left inside corner are both
zero minus the value of XmNborderWidth.
Note that the Inter-Client Communication Conventions Manual
allows a window manager to change or control the border
width of a reparented top-level window.
Classes
VendorShell inherits behavior and resources from Core,
Page 1 (printed 4/30/98)
VendorShell(3X) UNIX System V VendorShell(3X)
Composite, Shell, and WMShell classes.
The class pointer is vendorShellWidgetClass.
The class name is VendorShell.
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 subresource 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 subresource 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 subresource can be set at creation time (C), set
by using XtSetValues (S), retrieved by using XtGetValues
(G), or is not applicable (N/A).
VendorShell Resource Set
Name Class Type Default Access
_____________________________________________________________________________________
XmNaudibleWarning XmCAudibleWarning unsigned char XmBELL CSG
XmNbuttonFontList XmCButtonFontList XmFontList dynamic CSG
XmNdefaultFontList XmCDefaultFontList XmFontList dynamic CG
XmNdeleteResponse XmCDeleteResponse unsigned char XmDESTROY CSG
XmNinputMethod XmCInputMethod String NULL CSG
XmNkeyboardFocusPolicy XmCKeyboardFocusPolicy unsigned char XmEXPLICIT CSG
XmNlabelFontList XmCLabelFontList XmFontList dynamic CSG
XmNmwmDecorations XmCMwmDecorations int -1 CSG
XmNmwmFunctions XmCMwmFunctions int -1 CSG
XmNmwmInputMode XmCMwmInputMode int -1 CSG
XmNmwmMenu XmCMwmMenu String NULL CSG
XmNpreeditType XmCPreeditType String dynamic CSG
XmNshellUnitType XmCShellUnitType unsigned char XmPIXELS CSG
XmNtextFontList XmCTextFontList XmFontList dynamic CSG
XmNuseAsyncGeometry XmCUseAsyncGeometry Boolean False CSG
XmNaudibleWarning
Determines whether an action activates its
associated audible cue. The possible values are:
XmBELL and XmNONE.
XmNbuttonFontList
Specifies the font list used for VendorShell's
button descendants. If this value is NULL at
initialization and if the value of
XmNdefaultFontList is not NULL, XmNbuttonFontList
is initialized to the value of XmNdefaultFontList.
Page 2 (printed 4/30/98)
VendorShell(3X) UNIX System V VendorShell(3X)
If the value of XmNdefaultFontList is NULL,
XmNbuttonFontList is initialized by looking up the
parent hierarchy of the widget for an ancestor
that is a subclass of the XmBulletinBoard,
VendorShell, or XmMenuShell widget class. If such
an ancestor is found, XmNbuttonFontList is
initialized to the XmNbuttonFontList of the
ancestor widget. If no such ancestor is found,
the default is implementation dependent.
XmNdefaultFontList
Specifies a default font list for VendorShell's
descendants. This resource is obsolete and exists
for compatibility with earlier releases. It has
been replaced by XmNbuttonFontList,
XmNlabelFontList, and XmNtextFontList.
XmNdeleteResponse
Determines what action the shell takes in response
to a WMDELETEWINDOW message. The setting can be
one of three values: XmDESTROY, XmUNMAP, and
XmDONOTHING. The resource is scanned, and the
appropriate action is taken, after the
WMDELETEWINDOW callback list (if any) that is
registered with the Protocol manager has been
called.
XmNinputMethod
Specifies the string that sets the locale modifier
for the input method.
XmNkeyboardFocusPolicy
Determines allocation of keyboard focus within the
widget hierarchy rooted at this shell. The X
keyboard focus must be directed to somewhere in
the hierarchy for this client-side focus
management to take effect. Possible values are
XmEXPLICIT, specifying a click-to-type policy, and
XmPOINTER, specifying a pointer-driven policy.
XmNlabelFontList
Specifies the font list used for VendorShell's
label descendants (Labels and LabelGadgets). If
this value is NULL at initialization and if the
value of XmNdefaultFontList is not NULL,
XmNlabelFontList is initialized to the value of
XmNdefaultFontList. If the value of
XmNdefaultFontList is NULL, XmNlabelFontList is
initialized by looking up the parent hierarchy of
the widget for an ancestor that is a subclass of
the XmBulletinBoard, VendorShell, or XmMenuShell
widget class. If such an ancestor is found,
Page 3 (printed 4/30/98)
VendorShell(3X) UNIX System V VendorShell(3X)
XmNlabelFontList is initialized to the
XmNlabelFontList of the ancestor widget. If no
such ancestor is found, the default is
implementation dependent.
XmNmwmDecorations
Specifies the decoration flags (specific
decorations to add or remove from the window
manager frame) for the MOTIFWMHINTS property.
If any decoration flags are specified by the
MOTIFWMHINTS property, only decorations
indicated by both that property and the MWM
clientDecoration and transientDecoration resources
are displayed. If no decoration flags are
specified by the MOTIFWMHINTS property,
decorations indicated by the MWM clientDecoration
and transientDecoration resources are displayed.
The default for the XmNmwmDecorations resource is
not to specify any decoration flags for the
MOTIFWMHINTS property.
The value of this resource is the bitwise
inclusive OR of one or more flag bits. Following
are the possible flag bit constants, defined in
the include file <Xm/MwmUtil.h>:
⊕ MWMDECORALL-All decorations except those
specified by other flag bits that are set
⊕ MWMDECORBORDER-Client window border
⊕ MWMDECORRESIZEH-Resize frame handles
⊕ MWMDECORTITLE-Title bar
⊕ MWMDECORMENU-Window menu button
⊕ MWMDECORMINIMIZE-Minimize window button
⊕ MWMDECORMAXIMIZE-Maximize window button
XmNmwmFunctions
Specifies the function flags (specific window
manager functions to apply or not apply to the
client window) for the MOTIFWMHINTS property.
If any function flags are specified by the
MOTIFWMHINTS property, only functions indicated
by both that property and the MWM clientFunctions
and transientFunctions resources are applied. If
no function flags are specified by the
Page 4 (printed 4/30/98)
VendorShell(3X) UNIX System V VendorShell(3X)
MOTIFWMHINTS property, functions indicated by
the MWM clientFunctions and transientFunctions
resources are applied. The default for the
XmNmwmFunctions resource is not to specify any
function flags for the MOTIFWMHINTS property.
The value of this resource is the bitwise
inclusive OR of one or more flag bits. Following
are the possible flag bit constants, defined in
the include file <Xm/MwmUtil.h>:
⊕ MWMFUNCALL-All functions except those
specified by other flag bits that are set
⊕ MWMFUNCRESIZE-f.resize
⊕ MWMFUNCMOVE-f.move
⊕ MWMFUNCMINIMIZE-f.minimize
⊕ MWMFUNCMAXIMIZE-f.maximize
⊕ MWMFUNCCLOSE-f.kill
XmNmwmInputMode
Specifies the input mode flag (application modal
or system modal input constraints) for the
MOTIFWMHINTS property. If no input mode flag
is specified by the MOTIFWMHINTS property, no
input constraints are applied, and input goes to
any window. The default for the XmNmwmInputMode
resource is not to specify any input mode flag for
the MOTIFWMHINTS property.
An application that sets input constraints on a
dialog usually uses the BulletinBoard's
XmNdialogStyle resource rather than the parent
DialogShell's XmNmwmInputMode resource.
Following are the possible values for this
resource, defined in the include file
<Xm/MwmUtil.h>:
⊕ MWMINPUTMODELESS-Input goes to any window
⊕ MWMINPUTPRIMARYAPPLICATIONMODAL-Input
does not go to ancestors of this window
⊕ MWMINPUTSYSTEMMODAL-Input goes only to
Page 5 (printed 4/30/98)
VendorShell(3X) UNIX System V VendorShell(3X)
this window
⊕ MWMINPUTFULLAPPLICATIONMODAL-Input does
not go to other windows in this application
XmNmwmMenu
Specifies the menu items that the Motif window
manager should add to the end of the window menu.
The string contains a list of items separated by
\n with the following format:
label [mnemonic] [accelerator] function
If more than one item is specified, the items
should be separated by a newline character.
XmNpreeditType
Specifies the input method style or styles
available to the input manager. The syntax,
possible values, and default value are
implementation dependent.
XmNshellUnitType
Determines geometric resource interpretation. The
following values are allowed:
⊕ XmPIXELS-all values provided to the widget
are treated as normal pixel values.
⊕ Xm100THMILLIMETERS-all values provided to
the widget are treated as 1/100 millimeter.
⊕ Xm1000THINCHES-all values provided to the
widget are treated as 1/1000 inch.
⊕ Xm100THPOINTS-all values provided to the
widget are treated as 1/100 point. A point
is a unit used in text processing
applications and is defined as 1/72 inch.
⊕ Xm100THFONTUNITS-all values provided to the
widget are treated as 1/100 of a font unit.
A font unit has horizontal and vertical
components. These are the values of the
XmScreen resources XmNhorizontalFontUnit and
XmNverticalFontUnit.
XmNtextFontList
Specifies the font list used for VendorShell's
Page 6 (printed 4/30/98)
VendorShell(3X) UNIX System V VendorShell(3X)
Text and List descendants. If this value is NULL
at initialization and if the value of
XmNdefaultFontList is not NULL, XmNtextFontList is
initialized to the value of XmNdefaultFontList.
If the value of XmNdefaultFontList is NULL,
XmNtextFontList is initialized by looking up the
parent hierarchy of the widget for an ancestor
that is a subclass of the XmBulletinBoard or
VendorShell widget class. If such an ancestor is
found, XmNtextFontList is initialized to the
XmNtextFontList of the ancestor widget. If no
such ancestor is found, the default is
implementation dependent.
XmNuseAsyncGeometry
Specifies whether the geometry manager should wait
for confirmation of a geometry request to the
window manager. When the value of this resource
is True, the geometry manager forces XmNwaitForWm
to False and XmNwmTimeout to 0, and it relies on
asynchronous notification. When the value of this
resource is False, XmNwaitForWm and XmNwmTimeout
are unaffected. The default is False.
Inherited Resources
VendorShell inherits behavior and resources from the
following superclasses. For a complete description of each
resource, refer to the man page for that superclass.
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 True 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
Page 7 (printed 4/30/98)
VendorShell(3X) UNIX System V VendorShell(3X)
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
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
Page 8 (printed 4/30/98)
VendorShell(3X) UNIX System V VendorShell(3X)
XmNy XmCPosition Position 0 CSG
Translations
There are no translations for VendorShell.
RELATED INFORMATION
Composite(3X), Core(3X), mwm(1X), Shell(3X), WMShell(3X),
XmActivateProtocol(3X), XmActivateWMProtocol(3X),
XmAddProtocolCallback(3X), XmAddWMProtocolCallback(3X),
XmAddProtocols(3X), XmAddWMProtocols(3X),
XmDeactivateProtocol(3X), XmDeactivateWMProtocol(3X),
XmGetAtomName(3X), XmInternAtom(3X), XmIsMotifWMRunning(3X),
XmRemoveProtocolCallback(3X),
XmRemoveWMProtocolCallback(3X), XmRemoveProtocols(3X),
XmRemoveWMProtocols(3X), XmScreen(3X),
XmSetProtocolHooks(3X), and XmSetWMProtocolHooks(3X).
Page 9 (printed 4/30/98)