VendorShell(Xm) 6 January 1993 VendorShell(Xm) Name VendorShell - the VendorShell widget class Syntax #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(Xm) man page for more informa- tion. If an application uses the XmNmwmDecorations, XmNmwmFunctions, or XmNmwmInputMode resource, it should include the file <Xm/MwmUtil.F>. 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 win- dow 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 pro- grammer 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 XmNkeyboard- XmCKeyboard- unsigned char XmEXPLICIT FocusPolicy FocusPolicy 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 XmNuseAsync- XmCUseAsync- Boolean False CSG Geometry Geometry 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 descen- dants. If this value is NULL at initialization and if the value of XmNdefaultFontList is not NULL, XmNbuttonFontList is initial- ized to the value of XmNdefaultFontList. If the value of XmNde- faultFontList is NULL, XmNbuttonFontList is initialized by look- ing 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 depen- dent. XmNdefaultFontList Specifies a default font list for VendorShell's descendants. This resource is obsolete and exists for compatibility with ear- lier releases. It has been replaced by XmNbuttonFontList, XmNla- belFontList, 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 hierar- chy rooted at this shell. The X keyboard focus must be directed to somewhere in the hierarchy for this client-side focus manage- ment 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 initializa- tion and if the value of XmNdefaultFontList is not NULL, XmNla- belFontList is initialized to the value of XmNdefaultFontList. If the value of XmNdefaultFontList is NULL, XmNlabelFontList is ini- tialized 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, XmNla- belFontList is initialized to the XmNlabelFontList of the ances- tor widget. If no such ancestor is found, the default is imple- mentation 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 theMWM clientFunctions and transientFunctions resources are applied. If no function flags are specified by the 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 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 -- 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: OverTheSpot The pre-edit window is located over the point of inser- tion. OffTheSpot The 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. Root The 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 informa- tion that describes the requirements for a given input method style. The three styles identified by XmNpreedit- Type are related to the preedit settings in an XIMStyles structure. The input styles, OverTheSpot, OffTheSpot and Root, correspond respectively to the settings XIMPreEdit- Position, 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. + 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 pro- cessing 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 Text and List des- cendants. If this value is NULL at initialization and if the value of XmNdefaultFontList is not NULL, XmNtextFontList is ini- tialized 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 initial- ized 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 confirma- tion of a geometry request to the window manager. When the value of this resource is True, the geometry manager forces XmNwait- ForWm to False and XmNwmTimeout to 0, and it relies on asynchro- nous 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 superc- lasses. 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 XtUnspecified- CSG ShellInt XmNbaseWidth XmCBaseWidth int XtUnspecified- CSG ShellInt XmNheightInc XmCHeightInc int XtUnspecified- CSG ShellInt 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 XtUnspecified- CSG ShellInt XmNmaxAspectY XmCMaxAspectY int XtUnspecified- CSG ShellInt XmNmaxHeight XmCMaxHeight int XtUnspecified- CSG ShellInt XmNmaxWidth XmCMaxWidth int XtUnspecified- CSG ShellInt XmNminAspectX XmCMinAspectX int XtUnspecified- CSG ShellInt XmNminAspectY XmCMinAspectY int XtUnspecified- CSG ShellInt XmNminHeight XmCMinHeight int XtUnspecified- CSG ShellInt XmNminWidth XmCMinWidth int XtUnspecified- CSG ShellInt XmNtitle XmCTitle String dynamic CSG XmNtitleEncoding XmCTitleEncoding Atom dynamic CSG XmNtransient XmCTransient Boolean False CSG XmNwaitForWm XmCWaitForWm Boolean True CSG XmNwidthInc XmCWidthInc int XtUnspecified- CSG ShellInt XmNwindowGroup XmCWindowGroup Window dynamic CSG XmNwinGravity XmCWinGravity int dynamic CSG XmNwmTimeout XmCWmTimeout int 5000 ms CSG Shell resource set ____________________________________________________________________________ Name Class Type Default Access ____________________________________________________________________________ XmNallowShell- XmCAllowShell- Boolean False CG Resize Resize XmNcreatePopup- XmCCreatePopup- XtCreatePopup- NULL CSG ChildProc ChildProc ChildProc XmNgeometry XmCGeometry String NULL CSG XmNoverride- XmCOverride- Boolean False CSG Redirect Redirect 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 XmNancestor- XmCSensitive Boolean dynamic G Sensitive XmNbackground XmCBackground Pixel dynamic CSG XmNbackground- XmCPixmap Pixmap XmUNSPEC- CSG Pixmap IFIED_PIXMAP XmNborderColor XmCBorderColor Pixel XtDefault- CSG Foreground XmNborderPixmap XmCPixmap Pixmap XmUNSPEC- CSG IFIED_PIXMAP 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 XmNinitial- XmCInitial- Boolean True C Resources- Resources- Persistent Persistent XmNmapped- XmCMapped- Boolean True CSG WhenManaged WhenManaged 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 There are no translations for VendorShell. See also Composite(Xm), Core(Xm), mwm(Xm), Shell(Xm), WMShell(Xm), XmActivateProtocol(Xm), XmActivateWMProtocol(Xm), XmAddProtocolCallback(Xm), XmAddWMProtocolCallback(Xm), XmAddProtocols(Xm), XmAddWMProtocols(Xm), XmDeactivateProtocol(Xm), XmDeactivateWMProtocol(Xm), XmGetAtomName(Xm), XmInternAtom(Xm), XmIsMotifWMRunning(Xm), XmRemoveProtocolCallback(Xm), XmRemoveWMProtocolCallback(Xm), XmRemoveProtocols(Xm), XmRemoveWMProtocols(Xm), XmScreen(Xm), XmSetProtocolHooks(Xm) and XmSetWMProtocolHooks(Xm).