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

NameClassTypeDefaultAccess


XmNaudibleWarningXmCAudibleWarningunsigned charXmBELLCSG

XmNbuttonFontListXmCButtonFontListXmFontListdynamicCSG

XmNdefaultFontListXmCDefaultFontListXmFontListdynamicCG

XmNdeleteResponseXmCDeleteResponseunsigned charXmDESTROYCSG

XmNinputMethodXmCInputMethodStringNULLCSG

XmNkeyboardFocusPolicyXmCKeyboardFocusPolicyunsigned charXmEXPLICITCSG

XmNlabelFontListXmCLabelFontListXmFontListdynamicCSG

XmNmwmDecorationsXmCMwmDecorationsint-1CSG

XmNmwmFunctionsXmCMwmFunctionsint-1CSG

XmNmwmInputModeXmCMwmInputModeint-1CSG

XmNmwmMenuXmCMwmMenuStringNULLCSG

XmNpreeditTypeXmCPreeditTypeStringdynamicCSG

XmNshellUnitTypeXmCShellUnitTypeunsigned charXmPIXELSCSG

XmNtextFontListXmCTextFontListXmFontListdynamicCSG

XmNuseAsyncGeometryXmCUseAsyncGeometryBooleanFalseCSG

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. If more than one style is specified, the list is in priority order. The input manager uses the first style if it is available; if not, it uses the second style, and so on. The supported input method styles are:

OverTheSpotThe pre-edit window is located over the point of insertion. 

OffTheSpotThe pre-edit window is not located over the point of insertion.  In this case, the pre-edit window is often located at the bottom of the application window. 

RootThe pre-edit window is a child of the root window. 

If no input method style in this list is available, the input manager can support another input style method, but only if it does not require geometry management or any additional supporting information. 
The Xlib XIMStyles data structure stores preedit information that describes the requirements for a given input method style. The three styles identified by XmNpreeditType are related to the preedit settings in an XIMStyles structure.  The input styles, "OverTheSpot", "OffTheSpot" and "Root", correspond respectively to the settings XIMPreEditPosition, XIMPreEditArea, and XIMPreEditNothing. 

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

NameClassTypeDefaultAccess


XmNbaseHeightXmCBaseHeightintXtUnspecifiedShellIntCSG

XmNbaseWidthXmCBaseWidthintXtUnspecifiedShellIntCSG

XmNheightIncXmCHeightIncintXtUnspecifiedShellIntCSG

XmNiconMaskXmCIconMaskPixmapNULLCSG

XmNiconPixmapXmCIconPixmapPixmapNULLCSG

XmNiconWindowXmCIconWindowWindowNULLCSG

XmNiconXXmCIconXint−1CSG

XmNiconYXmCIconYint−1CSG

XmNinitialStateXmCInitialStateintNormalStateCSG

XmNinputXmCInputBooleanTrueCSG

XmNmaxAspectXXmCMaxAspectXintXtUnspecifiedShellIntCSG

XmNmaxAspectYXmCMaxAspectYintXtUnspecifiedShellIntCSG

XmNmaxHeightXmCMaxHeightintXtUnspecifiedShellIntCSG

XmNmaxWidthXmCMaxWidthintXtUnspecifiedShellIntCSG

XmNminAspectXXmCMinAspectXintXtUnspecifiedShellIntCSG

XmNminAspectYXmCMinAspectYintXtUnspecifiedShellIntCSG

XmNminHeightXmCMinHeightintXtUnspecifiedShellIntCSG

XmNminWidthXmCMinWidthintXtUnspecifiedShellIntCSG

XmNtitleXmCTitleStringdynamicCSG

XmNtitleEncodingXmCTitleEncodingAtomdynamicCSG

XmNtransientXmCTransientBooleanFalseCSG

XmNwaitForWmXmCWaitForWmBooleanTrueCSG

XmNwidthIncXmCWidthIncintXtUnspecifiedShellIntCSG

XmNwindowGroupXmCWindowGroupWindowdynamicCSG

XmNwinGravityXmCWinGravityintdynamicCSG

XmNwmTimeoutXmCWmTimeoutint5000 msCSG

 

Shell Resource Set

NameClassTypeDefaultAccess


XmNallowShellResizeXmCAllowShellResizeBooleanFalseCG

XmNcreatePopupChildProcXmCCreatePopupChildProcXtCreatePopupChildProcNULLCSG

XmNgeometryXmCGeometryStringNULLCSG

XmNoverrideRedirectXmCOverrideRedirectBooleanFalseCSG

XmNpopdownCallbackXmCCallbackXtCallbackListNULLC

XmNpopupCallbackXmCCallbackXtCallbackListNULLC

XmNsaveUnderXmCSaveUnderBooleanFalseCSG

XmNvisualXmCVisualVisual ∗CopyFromParentCSG

 

Composite Resource Set

NameClassTypeDefaultAccess


XmNchildrenXmCReadOnlyWidgetListNULLG

XmNinsertPositionXmCInsertPositionXtOrderProcNULLCSG

XmNnumChildrenXmCReadOnlyCardinal0G

 

Core Resource Set

NameClassTypeDefaultAccess


XmNacceleratorsXmCAcceleratorsXtAcceleratorsdynamicCSG

XmNancestorSensitiveXmCSensitiveBooleandynamicG

XmNbackgroundXmCBackgroundPixeldynamicCSG

XmNbackgroundPixmapXmCPixmapPixmapXmUNSPECIFIED_PIXMAPCSG

XmNborderColorXmCBorderColorPixelXtDefaultForegroundCSG

XmNborderPixmapXmCPixmapPixmapXmUNSPECIFIED_PIXMAPCSG

XmNborderWidthXmCBorderWidthDimension1CSG

XmNcolormapXmCColormapColormapdynamicCG

XmNdepthXmCDepthintdynamicCG

XmNdestroyCallbackXmCCallbackXtCallbackListNULLC

XmNheightXmCHeightDimensiondynamicCSG

XmNinitialResourcesPersistentXmCInitialResourcesPersistentBooleanTrueC

XmNmappedWhenManagedXmCMappedWhenManagedBooleanTrueCSG

XmNscreenXmCScreenScreen ∗dynamicCG

XmNsensitiveXmCSensitiveBooleanTrueCSG

XmNtranslationsXmCTranslationsXtTranslationsdynamicCSG

XmNwidthXmCWidthDimensiondynamicCSG

XmNxXmCPositionPosition0CSG

XmNyXmCPositionPosition0CSG

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

Sun Release 4.0  —  Last change: