Museum

Home

Lab Overview

Retrotechnology Articles

Online Manuals

⇒ XmSeparaA(Xm) — OpenDesktop Software Development System 3.0.0

Media Vault

Software Library

Restoration Projects

Artifacts Sought


 XmSeparator(Xm)                6 January 1993                XmSeparator(Xm)


 Name

    XmSeparator - the Separator widget class

 Syntax


    #include <Xm/Separator.h>


 Description

    Separator is a primitive widget that separates items in a display.
    Several different line drawing styles are provided, as well as horizontal
    or vertical orientation.

    The Separator line drawing is automatically centered within the height of
    the widget for a horizontal orientation and centered within the width of
    the widget for a vertical orientation.  An XtSetValues with a new XmNsep-
    aratorType resizes the widget to its minimal height (for horizontal
    orientation) or its minimal width (for vertical orientation) unless
    height or width is explicitly set in the XtSetValues call.

    Separator does not draw shadows around the separator.  The Primitive
    resource XmNshadowThickness is used for the Separator's thickness when
    XmNseparatorType is XmSHADOWETCHEDIN, XmSHADOWETCHEDINDASH,
    XmSHADOWETCHEDOUT, or XmSHADOWETCHEDOUTDASH.

    Separator does not highlight and allows no traversing. The primitive
    resource XmNtraversalOn is forced to False.

    The XmNseparatorType of XmNOLINE provides an escape to the application
    programmer who needs a different style of drawing.  A pixmap the height
    of the widget can be created and used as the background pixmap by build-
    ing an argument list using the XmNbackgroundPixmap argument type as
    defined by Core.  Whenever the widget is redrawn, its background is dis-
    played containing the desired separator drawing.

    Classes

    Separator inherits behavior and resources from Core and XmPrimitive
    classes.

    The class pointer is xmSeparatorWidgetClass.

    The class name is XmSeparator.

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

 XmSeparator resource set

 ____________________________________________________________________________
 Name                Class              Type            Default        Access
 ____________________________________________________________________________
 XmNmargin           XmCMargin          Dimension       0              CSG
 XmNorientation      XmCOrientation     unsigned char   XmHORIZONTAL   CSG
 XmNseparatorType    XmCSeparatorType   unsigned char   XmSHADOW_-     CSG
                                                        ETCHED_IN


    XmNmargin
            For horizontal orientation, specifies the space on the left and
            right sides between the border of the Separator and the line
            drawn.  For vertical orientation, specifies the space on the top
            and bottom between the border of the Separator and the line
            drawn.

    XmNorientation
            Displays Separator vertically or horizontally. This resource can
            have values of XmVERTICAL and XmHORIZONTAL.

    XmNseparatorType
            Specifies the type of line drawing to be done in the Separator
            widget.

            +  XmSINGLELINE -- single line.

            +  XmDOUBLELINE -- double line.

            +  XmSINGLEDASHEDLINE -- single-dashed line.

            +  XmDOUBLEDASHEDLINE -- double-dashed line.

            +  XmNOLINE -- no line.

            +  XmSHADOWETCHEDIN -- a line whose shadows give the effect of
               a line etched into the window. The thickness of the line is
               equal to the value of XmNshadowThickness. For horizontal
               orientation, the top shadow is drawn in XmNtopShadowColor and
               the bottom shadow is drawn in XmNbottomShadowColor. For verti-
               cal orientation, the left edge is drawn in XmNtopShadowColor
               and the right edge is drawn in XmNbottomShadowColor.

            +  XmSHADOWETCHEDOUT -- a line whose shadows give the effect of
               an etched line coming out of the window. The thickness of the
               line is equal to the value of XmNshadowThickness. For horizon-
               tal orientation, the top shadow is drawn in XmNbottom-
               ShadowColor and the bottom shadow is drawn in XmNtopShadow-
               Color. For vertical orientation, the left edge is drawn in
               XmNbottomShadowColor and the right edge is drawn in
               XmNtopShadowColor.

            +  XmSHADOWETCHEDINDASH -- identical to XmSHADOWETCHEDIN
               except a series of lines creates a dashed line.

            +  XmSHADOWETCHEDOUTDASH -- identical to XmSHADOWETCHEDOUT
               except a series of lines creates a dashed line.

    Inherited resources

    Separator inherits behavior and resources from the following superc-
    lasses. For a complete description of each resource, refer to the man
    page for that superclass.

 XmPrimitive resource set

 ____________________________________________________________________________
 Name               Class             Type             Default         Access
 ____________________________________________________________________________
 XmNbottomSha-      XmCBottomShadow-  Pixel            dynamic         CSG
 dowColor           Color
 XmNbottomShadow-   XmCBottomShadow-  Pixmap           XmUNSPECIFIED_- CSG
 Pixmap             Pixmap                             PIXMAP
 XmNforeground      XmCForeground     Pixel            dynamic         CSG
 XmNhelpCallback    XmCCallback       XtCallbackList   NULL            C
 XmNhighlightColor  XmCHighlightColor Pixel            dynamic         CSG
 XmNhighlight-      XmCHighlight-     Boolean          False           CSG
 OnEnter            OnEnter
 XmNhighlightPixmap XmCHighlightPixmapPixmap           dynamic         CSG
 XmNhighlight-      XmCHighlight-     Dimension        0               CSG
 Thickness          Thickness
 XmNnavigationType  XmCNavigationType XmNavigationType XmNONE          CSG
 XmNshadowThickness XmCShadowThicknessDimension        2               CSG
 XmNtopShadowColor  XmCTopShadowColor Pixel            dynamic         CSG
 XmNtopShadowPixmap XmCTopShadowPixmapPixmap           dynamic         CSG
 XmNtraversalOn     XmCTraversalOn    Boolean          False           G
 XmNunitType        XmCUnitType       unsigned char    dynamic         CSG
 XmNuserData        XmCUserData       XtPointer        NULL            CSG


 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         XmUNSPECIFIED_-CSG
 Pixmap                                                 PIXMAP
 XmNborderColor      XmCBorderColor      Pixel          XtDefault-     CSG
                                                        Foreground
 XmNborderPixmap     XmCPixmap           Pixmap         XmUNSPECIFIED_-CSG
                                                        PIXMAP
 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
 XmNinitialResources-XmCInitialResources-Boolean        True           C
 Persistent          Persistent
 XmNmappedWhen-      XmCMappedWhen-      Boolean        True           CSG
 Managed             Managed
 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 XmSeparator.

 See also

    Core(Xm), XmCreateSeparator(Xm) and XmPrimitive(Xm).


Typewritten Software • bear@typewritten.org • Edmonds, WA 98026