XmSeparator(3) Library Functions Manual XmSeparator(3) NAME XmSeparator -- The Separator widget class SYNOPSIS #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 verti- cal 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 XmNsepa- ratorType resizes the widget to its minimal height (for horizontal orienta- tion) 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 re- source XmNshadowThickness is used for the Separator's thickness when XmNseparatorType is XmSHADOW_ETCHED_IN, XmSHADOW_ETCHED_IN_DASH, XmSHADOW_ETCHED_OUT, or XmSHADOW_ETCHED_OUT_DASH. Separator does not highlight and allows no traversing. The primitive re- source XmNtraversalOn is forced to False. The XmNseparatorType of XmNO_LINE 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 building an argument list using the XmNbackgroundPixmap argument type as defined by Core. Whenever the widget is redrawn, its background is displayed contain- ing the desired separator drawing. Separator holds the XmQTmenuSavvy trait. Classes Separator inherits behavior, resources, and traits from Core and XmPrimi- tive. The class pointer is xmSeparatorWidgetClass. The class name is XmSeparator. 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 re- source by name or by class in a .Xdefaults file, remove the XmN or XmC pre- fix and use the remaining letters. To specify one of the defined values for a resource in a .Xdefaults file, remove the Xm prefix anduse the remaining letters (in either lowercase or uppercase, but include any underscores be- tween words). The codes in the access column indicate if the given re- source can be set at creation time (C), set by using XtSetValues (S), re- trieved 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_ETCHED_IN | CSG | +------------------+------------------+---------------+--------------------+--------+ +------------------+------------------+---------------+--------------------+--------+ 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. XmSINGLE_LINE Single line XmDOUBLE_LINE Double line XmSINGLE_DASHED_LINE Single-dashed line XmDOUBLE_DASHED_LINE Double-dashed line XmNO_LINE No line XmSHADOW_ETCHED_IN 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 orien- tation, the top shadow is drawn in XmNtopShadowColor and the bottom shadow is drawn in XmNbottomShadowColor. For vertical orientation, the left edge is drawn in Xm- NtopShadowColor and the right edge is drawn in XmNbot- tomShadowColor. XmSHADOW_ETCHED_OUT 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 XmNbot- tomShadowColor and the bottom shadow is drawn in XmN- topShadowColor. For vertical orientation, the left edge is drawn in XmNbottomShadowColor and the right edge is drawn in XmNtopShadowColor. XmSHADOW_ETCHED_IN_DASH Identical to XmSHADOW_ETCHED_IN except a series of lines creates a dashed line. XmSHADOW_ETCHED_OUT_DASH Identical to XmSHADOW_ETCHED_OUT except a series of lines creates a dashed line. Inherited Resources Separator inherits behavior and resources from the superclasses in the fol- lowing table. For a complete description of each resource, refer to the reference page for that superclass. +----------------------------------------------------------------------------------------------------+ | | XmPrimitive|Resource Set | | | | Name | Class | Type | Default | Access | +-------------------------+-----------------------+------------------+----------------------+--------+ | XmNbottomShadowColor | XmCBottomShadowColor | Pixel | dynamic | CSG | +-------------------------+-----------------------+------------------+----------------------+--------+ | XmNbottomShadowPixmap | XmCBottomShadowPixmap | Pixmap | XmUNSPECIFIED_PIXMAP | CSG | +-------------------------+-----------------------+------------------+----------------------+--------+ | XmNconvertCallback | XmCCallback | XtCallbackList | NULL | C | +-------------------------+-----------------------+------------------+----------------------+--------+ | XmNforeground | XmCForeground | Pixel | dynamic | CSG | +-------------------------+-----------------------+------------------+----------------------+--------+ | XmNhelpCallback | XmCCallback | XtCallbackList | NULL | C | +-------------------------+-----------------------+------------------+----------------------+--------+ | XmNhighlightColor | XmCHighlightColor | Pixel | dynamic | CSG | +-------------------------+-----------------------+------------------+----------------------+--------+ | XmNhighlightOnEnter | XmCHighlightOnEnter | Boolean | False | CSG | +-------------------------+-----------------------+------------------+----------------------+--------+ | XmNhighlightPixmap | XmCHighlightPixmap | Pixmap | dynamic | CSG | +-------------------------+-----------------------+------------------+----------------------+--------+ | XmNhighlightThickness | XmCHighlightThickness | Dimension | 0 | CSG | +-------------------------+-----------------------+------------------+----------------------+--------+ | XmNlayoutDirection | XmCLayoutDirection | XmDirection | dynamic | CG | +-------------------------+-----------------------+------------------+----------------------+--------+ | XmNnavigationType | XmCNavigationType | XmNavigationType | XmNONE | CSG | +-------------------------+-----------------------+------------------+----------------------+--------+ | XmNpopupHandlerCallback | XmCCallback | XtCallbackList | NULL | C | +-------------------------+-----------------------+------------------+----------------------+--------+ | XmNshadowThickness | XmCShadowThickness | Dimension | 2 | CSG | +-------------------------+-----------------------+------------------+----------------------+--------+ | XmNtopShadowColor | XmCTopShadowColor | Pixel | dynamic | CSG | +-------------------------+-----------------------+------------------+----------------------+--------+ | XmNtopShadowPixmap | XmCTopShadowPixmap | Pixmap | 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 | +-------------------------------+-------------------------------+----------------+----------------------+--------+ | 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 There are no translations for XmSeparator. RELATED Core(3), XmCreateSeparator(3), XmVaCreateSeparator(3), and XmVaCreateMan- agedSeparator(3). XmSeparator(3)
NAME | SYNOPSIS | DESCRIPTION | RELATED
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=XmSeparator&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>