XmFrame(library call)                                 XmFrame(library call)




 NAME    [Toc]    [Back]
      XmFrame - The Frame widget class

 SYNOPSIS    [Toc]    [Back]
      #include <Xm/Frame.h>

 DESCRIPTION    [Toc]    [Back]
      Frame is a very simple manager used to enclose a single work area
      child in a border drawn by Frame.  It uses the Manager class resources
      for border drawing and performs geometry management so that its size
      always matches its child's outer size plus the Frame's margins and
      shadow thickness.

      Frame is most often used to enclose other managers when the
      application developer wants the manager to have the same border
      appearance as the primitive widgets. Frame can also be used to enclose
      primitive widgets that do not support the same type of border drawing.
      This gives visual consistency when you develop applications using
      diverse widget sets.  Constraint resources are used to designate a
      child as the Frame title, align its text, and control its vertical
      alignment in relation to Frame's top shadow. The title appears only at
      the top of the Frame.

      If the Frame's parent is a Shell widget, the XmNshadowType resource
      defaults to XmSHADOW_OUT, and the Manager's XmNshadowThickness
      resource defaults to 1.

      If the Frame's parent is not a Shell widget, the XmNshadowType resouce
      defaults to XmSHADOW_ETCHED_IN, and the Manager's XmNshadowThickness
      resource defaults to 2.

    Classes    [Toc]    [Back]
      Frame inherits behavior and resources from the Core, Composite,
      Constraint, and XmManager classes.

      The class pointer is xmFrameWidgetClass.

      The class name is XmFrame.

    New Resources    [Toc]    [Back]
      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 resource 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 resource 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 resource can be set at
      creation time (C), set by using XtSetValues (S), retrieved by using
      XtGetValues (G), or is not applicable (N/A).



                                    - 1 -       Formatted:  January 24, 2005






 XmFrame(library call)                                 XmFrame(library call)




      ______________________________________________________________________
      |                        XmFrame Resource Set                         |
      |Name              Class             Type            Default   Access |
      |________________|_________________|_______________|_________|________|
      |XmNmarginWidth  | XmCMarginWidth  | Dimension     | 0       | CSG    |
      |________________|_________________|_______________|_________|________|
      |XmNmarginHeight | XmCMarginHeight | Dimension     | 0       | CSG    |
      |________________|_________________|_______________|_________|________|
      |XmNshadowType   | XmCShadowType   | unsigned char | dynamic | CSG    |
      |________________|_________________|_______________|_________|________|
      |________________|_________________|_______________|_________|________|

      XmNmarginWidth    [Toc]    [Back]
                Specifies the padding space on the left and right sides
                between Frame's child and Frame's shadow drawing.

      XmNmarginHeight    [Toc]    [Back]
                Specifies the padding space on the top and bottom sides
                between Frame's child and Frame's shadow drawing.  When a
                title is present, the top margin equals the value specified
                by this resource plus the distance (if any) that the title
                extends below the top shadow.

      XmNshadowType    [Toc]    [Back]
                Describes the drawing style for Frame. This resource can
                have the following values:

                XmSHADOW_IN    [Toc]    [Back]
                          Draws Frame so that it appears inset.  This means
                          that the bottom shadow visuals and top shadow
                          visuals are reversed.

                XmSHADOW_OUT    [Toc]    [Back]
                          Draws Frame so that it appears outset.  This is
                          the default if Frame's parent is a Shell widget.

                XmSHADOW_ETCHED_IN    [Toc]    [Back]
                          Draws Frame using a double line giving the effect
                          of a line etched into the window. The thickness of
                          the double line is equal to the value of
                          XmNshadowThickness.  This is the default when
                          Frame's parent is not a Shell widget.

                XmSHADOW_ETCHED_OUT    [Toc]    [Back]
                          Draws Frame using a double line giving the effect
                          of a line coming out of the window. The thickness
                          of the double line is equal to the value of
                          XmNshadowThickness.






                                    - 2 -       Formatted:  January 24, 2005






 XmFrame(library call)                                 XmFrame(library call)




      _____________________________________________________________________________________________________________
      |                                      XmFrame Constraint Resource Set                                       |
      |Name                          Class                         Type            Default                  Access |
      |____________________________|_____________________________|_______________|________________________|________|
      |XmNchildType                | XmCChildType                | unsigned char | XmFRAME_WORKAREA_CHILD | CSG    |
      |____________________________|_____________________________|_______________|________________________|________|
      |XmNchildHorizontalAlignment | XmCChildHorizontalAlignment | unsigned char | XmALIGNMENT_BEGINNING  | CSG    |
      |____________________________|_____________________________|_______________|________________________|________|
      |XmNchildHorizontalSpacing   | XmCChildHorizontalSpacing   | Dimension     | dynamic                | CSG    |
      |____________________________|_____________________________|_______________|________________________|________|
      |XmNchildVerticalAlignment   | XmCChildVerticalAlignment   | unsigned char | XmALIGNMENT_CENTER     | CSG    |
      |____________________________|_____________________________|_______________|________________________|________|
      |XmNframeChildType           | XmCFrameChildType           | unsigned char | XmFRAME_WORKAREA_CHILD | CSG    |
      |____________________________|_____________________________|_______________|________________________|________|
      |____________________________|_____________________________|_______________|________________________|________|

      XmNchildType    [Toc]    [Back]
                Refer to the XmNframeChildType resource description. The
                XmNchildType resource is obsoleted by XmNframeChildType, but
                is kept here for backward compatibility.

      XmNchildHorizontalAlignment    [Toc]    [Back]
                Specifies the alignment of the title. This resource has the
                following values:

                   +  XmALIGNMENT_BEGINNING

                   +  XmALIGNMENT_CENTER

                   +  XmALIGNMENT_END

                See the description of XmNalignment in the XmLabel reference
                page for an explanation of these values.

      XmNchildHorizontalSpacing    [Toc]    [Back]
                Specifies the minimum distance between either edge of the
                title text and the inner edge of the Frame shadow. Clipping
                of the title text occurs in order to maintain this spacing.
                The default value is the margin width of the Frame.

      XmNchildVerticalAlignment    [Toc]    [Back]
                Specifies the vertical alignment of the title text, or the
                title area in relation to the top shadow of the Frame.

                XmALIGNMENT_BASELINE_BOTTOM    [Toc]    [Back]
                          Causes the baseline of the title to align
                          vertically with the top shadow of the Frame. In
                          the case of a multi-line title, the baseline of
                          the last line of text aligns vertically with the
                          top shadow of the Frame.




                                    - 3 -       Formatted:  January 24, 2005






 XmFrame(library call)                                 XmFrame(library call)




                XmALIGNMENT_BASELINE_TOP    [Toc]    [Back]
                          Causes the baseline of the first line of the title
                          to align vertically with the top shadow of the
                          Frame.

                XmALIGNMENT_CHILD_TOP    [Toc]    [Back]
                          Causes the top edge of the title area to align
                          vertically with the top shadow of the Frame.

                XmALIGNMENT_CENTER    [Toc]    [Back]
                          Causes the center of the title area to align
                          vertically with the top shadow of the Frame.

                XmALIGNMENT_CHILD_BOTTOM    [Toc]    [Back]
                          Causes the bottom edge of the title area to align
                          vertically with the top shadow of the Frame.

      XmNframeChildType    [Toc]    [Back]
                Specifies whether a child is a title or work area. Frame
                supports a single title and/or work area child. The possible
                values are

                   +  XmFRAME_TITLE_CHILD

                   +  XmFRAME_WORKAREA_CHILD

                   +  XmFRAME_GENERIC_CHILD

                The Frame geometry manager ignores any child of type
                XmFRAME_GENERIC_CHILD.  This resource replaces XmNchildType.

    Inherited Resources    [Toc]    [Back]
      Frame inherits behavior and resources from the following superclasses.
      For a complete description of each resource, refer to the reference
      page for that superclass.



















                                    - 4 -       Formatted:  January 24, 2005






 XmFrame(library call)                                 XmFrame(library call)




      _____________________________________________________________________________________________________
      |                                      XmManager Resource Set                                        |
      |Name                      Class                   Type                Default                Access |
      |________________________|_______________________|___________________|______________________|________|
      |XmNbottomShadowColor    | XmCBottomShadowColor  | Pixel             | dynamic              | CSG    |
      |________________________|_______________________|___________________|______________________|________|
      |XmNbottomShadowPixmap   | XmCBottomShadowPixmap | Pixmap            | XmUNSPECIFIED_PIXMAP | CSG    |
      |________________________|_______________________|___________________|______________________|________|
      |XmNforeground           | XmCForeground         | Pixel             | dynamic              | CSG    |
      |________________________|_______________________|___________________|______________________|________|
      |XmNhelpCallback         | XmCCallback           | XtCallbackList    | NULL                 | C      |
      |________________________|_______________________|___________________|______________________|________|
      |XmNhighlightColor       | XmCHighlightColor     | Pixel             | dynamic              | CSG    |
      |________________________|_______________________|___________________|______________________|________|
      |XmNhighlightPixmap      | XmCHighlightPixmap    | Pixmap            | dynamic              | CSG    |
      |________________________|_______________________|___________________|______________________|________|
      |XmNinitialFocus         | XmCInitialFocus       | Widget            | NULL                 | CSG    |
      |________________________|_______________________|___________________|______________________|________|
      |XmNlayoutDirection      | XmCLayoutDirection    | XmDirection       | dynamic              | CG     |
      |________________________|_______________________|___________________|______________________|________|
      |XmNnavigationType       | XmCNavigationType     | XmNavigationType  | XmTAB_GROUP          | CSG    |
      |________________________|_______________________|___________________|______________________|________|
      |XmNpopupHandlerCallback | XmCCallback           | XtCallbackList    | NULL                 | C      |
      |________________________|_______________________|___________________|______________________|________|
      |XmNshadowThickness      | XmCShadowThickness    | Dimension         | dynamic              | CSG    |
      |________________________|_______________________|___________________|______________________|________|
      |XmNstringDirection      | XmCStringDirection    | XmStringDirection | dynamic              | CG     |
      |________________________|_______________________|___________________|______________________|________|
      |XmNtopShadowColor       | XmCTopShadowColor     | Pixel             | dynamic              | CSG    |
      |________________________|_______________________|___________________|______________________|________|
      |XmNtopShadowPixmap      | XmCTopShadowPixmap    | Pixmap            | dynamic              | CSG    |
      |________________________|_______________________|___________________|______________________|________|
      |XmNtraversalOn          | XmCTraversalOn        | Boolean           | True                 | CSG    |
      |________________________|_______________________|___________________|______________________|________|
      |XmNunitType             | XmCUnitType           | unsigned char     | dynamic              | CSG    |
      |________________________|_______________________|___________________|______________________|________|
      |XmNuserData             | XmCUserData           | XtPointer         | NULL                 | CSG    |
      |________________________|_______________________|___________________|______________________|________|
      |________________________|_______________________|___________________|______________________|________|

      ________________________________________________________________________
                               Composite Resource Set
       Name                Class               Type          Default   Access
      ________________________________________________________________________
       XmNchildren         XmCReadOnly         WidgetList    NULL      G
      ________________________________________________________________________
       XmNinsertPosition   XmCInsertPosition   XtOrderProc   NULL      CSG
      ________________________________________________________________________
       XmNnumChildren      XmCReadOnly         Cardinal      0         G
      ________________________________________________________________________
      ________________________________________________________________________



                                    - 5 -       Formatted:  January 24, 2005






 XmFrame(library call)                                 XmFrame(library call)





      |                  |                   |             |         |        |
      ________________________________________________________________________________________________________________
      |                  |                   |       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      | 0                    | 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    [Toc]    [Back]
      XmFrame inherits translations from XmManager.

 RELATED    [Toc]    [Back]




                                    - 6 -       Formatted:  January 24, 2005






 XmFrame(library call)                                 XmFrame(library call)




      Composite(3), Constraint(3), Core(3), XmCreateFrame(3), and
      XmManager(3).


                                    - 7 -       Formatted:  January 24, 2005