VendorShell(3X)

VendorShell --The VendorShell widget class

As shipped in IRIX 6.5.7. Unchanged since IRIX 6.5.

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 over-
     ride  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 XmNmwmIn-
     putMode 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  in-
     side 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 program-
     mer 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 under-
     scores  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 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
               WM_DELETE_WINDOW  message.   The setting can be one of three val-
               ues: 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 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-dri-
               ven 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
               initialized  by looking up the parent hierarchy of the widget for
               an ancestor that is a subclass of  the  XmBulletinBoard,  Vendor-
               Shell,  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 _MO-
               TIF_WM_HINTS property, only decorations indicated  by  both  that
               property and the MWM clientDecoration and transientDecoration re-
               sources  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 in-
     clude 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  _MO-
               TIF_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  client-
               Functions  and transientFunctions resources are applied.  The de-
               fault 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  in-
     clude 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  de-
               fault  for the XmNmwmInputMode resource is not to specify any in-
               put 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  Di-
     alogShell'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 an-
                    cestors 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


     XmNmwmMenuSpecifies 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  im-
               plementation dependent.

     XmNshellUnitType
               Determines geometric resource interpretation.  The following val-
               ues 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  Xm-
                    Screen resources XmNhorizontalFontUnit and XmNverticalFontU-
                    nit.


     XmNtextFontList
               Specifies  the font list used for VendorShell's Text and List de-
               scendants.  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 Xm-
               NdefaultFontList is NULL, XmNtextFontList is initialized by look-
               ing 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 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, Xm-
               NwaitForWm and  XmNwmTimeout  are  unaffected.   The  default  is
               False.


   Inherited Resources
     VendorShell  inherits  behavior  and  resources  from  the following super-
     classes.  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
   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
XmNy                            XmCPosition                     Position         0                      CSG

   Translations
     There are no translations for VendorShell.

RELATED INFORMATION
     Composite(3X), Core(3X), mwm(1X), Shell(3X), WMShell(3X), XmActivateProto-
     col(3X), XmActivateWMProtocol(3X), XmAddProtocolCallback(3X), XmAddWMProto-
     colCallback(3X), XmAddProtocols(3X), XmAddWMProtocols(3X), XmDeactivatePro-
     tocol(3X), XmDeactivateWMProtocol(3X), XmGetAtomName(3X), XmInternAtom(3X),
     XmIsMotifWMRunning(3X), XmRemoveProtocolCallback(3X), XmRemoveWMProtocol-
     Callback(3X), XmRemoveProtocols(3X), XmRemoveWMProtocols(3X), XmScreen(3X),
     XmSetProtocolHooks(3X), and XmSetWMProtocolHooks(3X).

                                                                 VendorShell(3X)