 |
Index for Section 3X |
|
 |
Alphabetical listing for V |
|
 |
Bottom of page |
|
VendorShell(3X)
OSF/Motif
NAME
VendorShell - The VendorShell widget class
SYNOPSIS
#include <Xm/Xm.h>
#include <X11/Shell.h>
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, 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
XmNaudibleWarning
Class: XmCAudibleWarning
Default: XmBELL
Type: unsigned char
Access: CSG
XmNbuttonFontList
Class: XmCButtonFontList
Default: dynamic
Type: XmFontList
Access: CSG
XmNdefaultFontList
Class: XmCDefaultFontList
Default: dynamic
Type: XmFontList
Access: CG
XmNdeleteResponse
Class: XmCDeleteResponse
Default: XmDESTROY
Type: unsigned char
Access: CSG
XmNinputMethod
Class: XmCInputMethod
Default: NULL
Type: String
Access: CSG
XmNkeyboardFocusPolicy
Class: XmCKeyboardFocusPolicy
Default: XmEXPLICIT
Type: unsigned char
Access: CSG
XmNlabelFontList
Class: XmCLabelFontList
Default: dynamic
Type: XmFontList
Access: CSG
XmNmwmDecorations
Class: XmCMwmDecorations
Default: -1
Type: int
Access: CSG
XmNmwmFunctions
Class: XmCMwmFunctions
Default: -1
Type: int
Access: CSG
XmNmwmInputMode
Class: XmCMwmInputMode
Default: -1
Type: int
Access: CSG
XmNmwmMenu
Class: XmCMwmMenu
Default: NULL
Type: String
Access: CSG
XmNpreeditType
Class: XmCPreeditType
Default: dynamic
Type: String
Access: CSG
XmNshellUnitType
Class: XmCShellUnitType
Default: XmPIXELS
Type: unsigned char
Access: CSG
XmNtextFontList
Class: XmCTextFontList
Default: dynamic
Type: XmFontList
Access: CSG
XmNuseAsyncGeometry
Class: XmCUseAsyncGeometry
Default: False
Type: Boolean
Access: 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. 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
WM_DELETE_WINDOW message. The setting can be one of three values:
XmDESTROY, XmUNMAP, and XmDO_NOTHING. The resource is scanned, and the
appropriate action is taken, after the WM_DELETE_WINDOW 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, 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 _MOTIF_WM_HINTS property. If any
decoration flags are specified by the _MOTIF_WM_HINTS 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 _MOTIF_WM_HINTS 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 _MOTIF_WM_HINTS 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>:
· MWM_DECOR_ALL--All decorations except those specified by other
flag bits that are set
· MWM_DECOR_BORDER--Client window border
· MWM_DECOR_RESIZEH--Resize frame handles
· MWM_DECOR_TITLE--Title bar
· MWM_DECOR_MENU--Window menu button
· MWM_DECOR_MINIMIZE--Minimize window button
· MWM_DECOR_MAXIMIZE--Maximize window button
XmNmwmFunctions
Specifies the function flags (specific window manager functions to
apply or not apply to the client window) for the _MOTIF_WM_HINTS
property. If any function flags are specified by the _MOTIF_WM_HINTS
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 _MOTIF_WM_HINTS 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 _MOTIF_WM_HINTS 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>:
· MWM_FUNC_ALL--All functions except those specified by other flag
bits that are set
· MWM_FUNC_RESIZE--f.resize
· MWM_FUNC_MOVE--f.move
· MWM_FUNC_MINIMIZE--f.minimize
· MWM_FUNC_MAXIMIZE--f.maximize
· MWM_FUNC_CLOSE--f.kill
XmNmwmInputMode
Specifies the input mode flag (application modal or system modal input
constraints) for the _MOTIF_WM_HINTS property. If no input mode flag
is specified by the _MOTIF_WM_HINTS 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
_MOTIF_WM_HINTS 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>:
· MWM_INPUT_MODELESS--Input goes to any window
· MWM_INPUT_PRIMARY_APPLICATION_MODAL--Input does not go to
ancestors of this window
· MWM_INPUT_SYSTEM_MODAL--Input goes only to this window
· MWM_INPUT_FULL_APPLICATION_MODAL--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.
· Xm100TH_MILLIMETERS--all values provided to the widget are treated
as 1/100 millimeter.
· Xm1000TH_INCHES--all values provided to the widget are treated as
1/1000 inch.
· Xm100TH_POINTS--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.
· Xm100TH_FONT_UNITS--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 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
XmNbaseHeight
Class: XmCBaseHeight
Default: XtUnspecifiedShellInt
Type: int
Access: CSG
XmNbaseWidth
Class: XmCBaseWidth
Default: XtUnspecifiedShellInt
Type: int
Access: CSG
XmNheightInc
Class: XmCHeightInc
Default: XtUnspecifiedShellInt
Type: int
Access: CSG
XmNiconMask
Class: XmCIconMask
Default: NULL
Type: Pixmap
Access: CSG
XmNiconPixmap
Class: XmCIconPixmap
Default: NULL
Type: Pixmap
Access: CSG
XmNiconWindow
Class: XmCIconWindow
Default: NULL
Type: Window
Access: CSG
XmNiconX
Class: XmCIconX
Default: -1
Type: int
Access: CSG
XmNiconY
Class: XmCIconY
Default: -1
Type: int
Access: CSG
XmNinitialState
Class: XmCInitialState
Default: NormalState
Type: int
Access: CSG
XmNinput
Class: XmCInput
Default: True
Type: Boolean
Access: CSG
XmNmaxAspectX
Class: XmCMaxAspectX
Default: XtUnspecifiedShellInt
Type: int
Access: CSG
XmNmaxAspectY
Class: XmCMaxAspectY
Default: XtUnspecifiedShellInt
Type: int
Access: CSG
XmNmaxHeight
Class: XmCMaxHeight
Default: XtUnspecifiedShellInt
Type: int
Access: CSG
XmNmaxWidth
Class: XmCMaxWidth
Default: XtUnspecifiedShellInt
Type: int
Access: CSG
XmNminAspectX
Class: XmCMinAspectX
Default: XtUnspecifiedShellInt
Type: int
Access: CSG
XmNminAspectY
Class: XmCMinAspectY
Default: XtUnspecifiedShellInt
Type: int
Access: CSG
XmNminHeight
Class: XmCMinHeight
Default: XtUnspecifiedShellInt
Type: int
Access: CSG
XmNminWidth
Class: XmCMinWidth
Default: XtUnspecifiedShellInt
Type: int
Access: CSG
XmNtitle
Class: XmCTitle
Default: dynamic
Type: String
Access: CSG
XmNtitleEncoding
Class: XmCTitleEncoding
Default: dynamic
Type: Atom
Access: CSG
XmNtransient
Class: XmCTransient
Default: False
Type: Boolean
Access: CSG
XmNwaitForWm
Class: XmCWaitForWm
Default: True
Type: Boolean
Access: CSG
XmNwidthInc
Class: XmCWidthInc
Default: XtUnspecifiedShellInt
Type: int
Access: CSG
XmNwindowGroup
Class: XmCWindowGroup
Default: dynamic
Type: Window
Access: CSG
XmNwinGravity
Class: XmCWinGravity
Default: dynamic
Type: int
Access: CSG
XmNwmTimeout
Class: XmCWmTimeout
Default: 5000 ms
Type: int
Access: CSG
Shell Resource Set
XmNallowShellResize
Class: XmCAllowShellResize
Default: False
Type: Boolean
Access: CG
XmNcreatePopupChildProc
Class: XmCCreatePopupChildProc
Default: NULL
Type: XtCreatePopupChildProc
Access: CSG
XmNgeometry
Class: XmCGeometry
Default: NULL
Type: String
Access: CSG
XmNoverrideRedirect
Class: XmCOverrideRedirect
Default: False
Type: Boolean
Access: CSG
XmNpopdownCallback
Class: XmCCallback
Default: NULL
Type: XtCallbackList
Access: C
XmNpopupCallback
Class: XmCCallback
Default: NULL
Type: XtCallbackList
Access: C
XmNsaveUnder
Class: XmCSaveUnder
Default: False
Type: Boolean
Access: CSG
XmNvisual
Class: XmCVisual
Default: CopyFromParent
Type: Visual *
Access: CSG
Composite Resource Set
XmNchildren
Class: XmCReadOnly
Default: NULL
Type: WidgetList
Access: G
XmNinsertPosition
Class: XmCInsertPosition
Default: NULL
Type: XtOrderProc
Access: CSG
XmNnumChildren
Class: XmCReadOnly
Default: 0
Type: Cardinal
Access: G
Core Resource Set
XmNaccelerators
Class: XmCAccelerators
Default: dynamic
Type: XtAccelerators
Access: CSG
XmNancestorSensitive
Class: XmCSensitive
Default: dynamic
Type: Boolean
Access: G
XmNbackground
Class: XmCBackground
Default: dynamic
Type: Pixel
Access: CSG
XmNbackgroundPixmap
Class: XmCPixmap
Default: XmUNSPECIFIED_PIXMAP
Type: Pixmap
Access: CSG
XmNborderColor
Class: XmCBorderColor
Default: XtDefaultForeground
Type: Pixel
Access: CSG
XmNborderPixmap
Class: XmCPixmap
Default: XmUNSPECIFIED_PIXMAP
Type: Pixmap
Access: CSG
XmNborderWidth
Class: XmCBorderWidth
Default: 1
Type: Dimension
Access: CSG
XmNcolormap
Class: XmCColormap
Default: dynamic
Type: Colormap
Access: CG
XmNdepth
Class: XmCDepth
Default: dynamic
Type: int
Access: CG
XmNdestroyCallback
Class: XmCCallback
Default: NULL
Type: XtCallbackList
Access: C
XmNheight
Class: XmCHeight
Default: dynamic
Type: Dimension
Access: CSG
XmNinitialResourcesPersistent
Class: XmCInitialResourcesPersistent
Default: True
Type: Boolean
Access: C
XmNmappedWhenManaged
Class: XmCMappedWhenManaged
Default: True
Type: Boolean
Access: CSG
XmNscreen
Class: XmCScreen
Default: dynamic
Type: Screen *
Access: CG
XmNsensitive
Class: XmCSensitive
Default: True
Type: Boolean
Access: CSG
XmNtranslations
Class: XmCTranslations
Default: dynamic
Type: XtTranslations
Access: CSG
XmNwidth
Class: XmCWidth
Default: dynamic
Type: Dimension
Access: CSG
XmNx
Class: XmCPosition
Default: 0
Type: Position
Access: CSG
XmNy
Class: XmCPosition
Default: 0
Type: Position
Access: CSG
Translations
There are no translations for VendorShell.
SEE ALSO
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), XmSetWMProtocolHooks(3X)
 |
Index for Section 3X |
|
 |
Alphabetical listing for V |
|
 |
Top of page |
|