1XmSeparator(library call) XmSeparator(library call)
2
6 XmSeparator — The Separator widget class
7
9 #include <Xm/Separator.h>
10
12 Separator is a primitive widget that separates items in a display. Sev‐
13 eral different line drawing styles are provided, as well as horizontal
14 or vertical orientation.
15 The Separator line drawing is automatically centered within the height
17 of the widget for a horizontal orientation and centered within the
18 width of the widget for a vertical orientation. An XtSetValues with a
19 new XmNseparatorType resizes the widget to its minimal height (for hor‐
20 izontal orientation) or its minimal width (for vertical orientation)
21 unless height or width is explicitly set in the XtSetValues call.
22 Separator does not draw shadows around the separator. The Primitive
24 resource XmNshadowThickness is used for the Separator's thickness when
25 XmNseparatorType is XmSHADOW_ETCHED_IN, XmSHADOW_ETCHED_IN_DASH,
26 XmSHADOW_ETCHED_OUT, or XmSHADOW_ETCHED_OUT_DASH.
27 Separator does not highlight and allows no traversing. The primitive
29 resource XmNtraversalOn is forced to False.
30 The XmNseparatorType of XmNO_LINE provides an escape to the application
32 programmer who needs a different style of drawing. A pixmap the height
33 of the widget can be created and used as the background pixmap by
34 building an argument list using the XmNbackgroundPixmap argument type
35 as defined by Core. Whenever the widget is redrawn, its background is
36 displayed containing the desired separator drawing. Separator holds
37 the XmQTmenuSavvy trait.
38 Classes
40 Separator inherits behavior, resources, and traits from Core and
41 XmPrimitive.
42 The class pointer is xmSeparatorWidgetClass.
44 The class name is XmSeparator.
46 New Resources
48 The following table defines a set of widget resources used by the pro‐
49 grammer to specify data. The programmer can also set the resource val‐
50 ues for the inherited classes to set attributes for this widget. To
51 reference a resource by name or by class in a .Xdefaults file, remove
52 the XmN or XmC prefix and use the remaining letters. To specify one of
53 the defined values for a resource in a .Xdefaults file, remove the Xm
54 prefix anduse the remaining letters (in either lowercase or uppercase,
55 but include any underscores between words). The codes in the access
56 column indicate if the given resource can be set at creation time (C),
57 set by using XtSetValues (S), retrieved by using XtGetValues (G), or is
58 not applicable (N/A).
59 ┌──────────────────────────────────────────────────────────────────────────────────┐
61 │ │ XmSepara│tor Resource Set│ │ │
62 │Name │ Class │ Type │ Default │ Access │
63 ├─────────────────┼──────────────────┼───────────────┼────────────────────┼────────┤
64 │XmNmargin │ XmCMargin │ Dimension │ 0 │ CSG │
65 ├─────────────────┼──────────────────┼───────────────┼────────────────────┼────────┤
66 │XmNorientation │ XmCOrientation │ unsigned char │ XmHORIZONTAL │ CSG │
67 ├─────────────────┼──────────────────┼───────────────┼────────────────────┼────────┤
68 │XmNseparatorType │ XmCSeparatorType │ unsigned char │ XmSHADOW_ETCHED_IN │ CSG │
69 ├─────────────────┼──────────────────┼───────────────┼────────────────────┼────────┤
70 └─────────────────┴──────────────────┴───────────────┴────────────────────┴────────┘
71 XmNmargin For horizontal orientation, specifies the space on the left
72 and right sides between the border of the Separator and the
73 line drawn. For vertical orientation, specifies the space on
74 the top and bottom between the border of the Separator and
75 the line drawn.
76 XmNorientation
78 Displays Separator vertically or horizontally. This resource
79 can have values of XmVERTICAL and XmHORIZONTAL.
80 XmNseparatorType
82 Specifies the type of line drawing to be done in the Separa‐
83 tor widget.
84 XmSINGLE_LINE
86 Single line
87 XmDOUBLE_LINE
89 Double line
90 XmSINGLE_DASHED_LINE
92 Single-dashed line
93 XmDOUBLE_DASHED_LINE
95 Double-dashed line
96 XmNO_LINE No line
98 XmSHADOW_ETCHED_IN
100 A line whose shadows give the effect of a line
101 etched into the window. The thickness of the line
102 is equal to the value of XmNshadowThickness. For
103 horizontal orientation, the top shadow is drawn in
104 XmNtopShadowColor and the bottom shadow is drawn in
105 XmNbottomShadowColor. For vertical orientation, the
106 left edge is drawn in XmNtopShadowColor and the
107 right edge is drawn in XmNbottomShadowColor.
108 XmSHADOW_ETCHED_OUT
110 A line whose shadows give the effect of an etched
111 line coming out of the window. The thickness of the
112 line is equal to the value of XmNshadowThickness.
113 For horizontal orientation, the top shadow is drawn
114 in XmNbottomShadowColor and the bottom shadow is
115 drawn in XmNtopShadowColor. For vertical orienta‐
116 tion, the left edge is drawn in XmNbottomShadow‐
117 Color and the right edge is drawn in XmNtopShadow‐
118 Color.
119 XmSHADOW_ETCHED_IN_DASH
121 Identical to XmSHADOW_ETCHED_IN except a series of
122 lines creates a dashed line.
123 XmSHADOW_ETCHED_OUT_DASH
125 Identical to XmSHADOW_ETCHED_OUT except a series of
126 lines creates a dashed line.
127 Inherited Resources
129 Separator inherits behavior and resources from the superclasses in the
130 following table. For a complete description of each resource, refer to
131 the reference page for that superclass.
132 ┌───────────────────────────────────────────────────────────────────────────────────────────────────┐
134 │ │ XmPrimitive│Resource Set │ │ │
135 │Name │ Class │ Type │ Default │ Access │
136 ├────────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
137 │XmNbottomShadowColor │ XmCBottomShadowColor │ Pixel │ dynamic │ CSG │
138 ├────────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
139 │XmNbottomShadowPixmap │ XmCBottomShadowPixmap │ Pixmap │ XmUNSPECIFIED_PIXMAP │ CSG │
140 ├────────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
141 │XmNconvertCallback │ XmCCallback │ XtCallbackList │ NULL │ C │
142 ├────────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
143 │XmNforeground │ XmCForeground │ Pixel │ dynamic │ CSG │
144 ├────────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
145 │XmNhelpCallback │ XmCCallback │ XtCallbackList │ NULL │ C │
146 ├────────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
147 │XmNhighlightColor │ XmCHighlightColor │ Pixel │ dynamic │ CSG │
148 ├────────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
149 │XmNhighlightOnEnter │ XmCHighlightOnEnter │ Boolean │ False │ CSG │
150 ├────────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
151 │XmNhighlightPixmap │ XmCHighlightPixmap │ Pixmap │ dynamic │ CSG │
152 ├────────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
153 │XmNhighlightThickness │ XmCHighlightThickness │ Dimension │ 0 │ CSG │
154 ├────────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
155 │XmNlayoutDirection │ XmCLayoutDirection │ XmDirection │ dynamic │ CG │
156 ├────────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
157 │XmNnavigationType │ XmCNavigationType │ XmNavigationType │ XmNONE │ CSG │
158 ├────────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
159 │XmNpopupHandlerCallback │ XmCCallback │ XtCallbackList │ NULL │ C │
160 ├────────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
161 │XmNshadowThickness │ XmCShadowThickness │ Dimension │ 2 │ CSG │
162 ├────────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
163 │XmNtopShadowColor │ XmCTopShadowColor │ Pixel │ dynamic │ CSG │
164 ├────────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
165 │XmNtopShadowPixmap │ XmCTopShadowPixmap │ Pixmap │ dynamic │ CSG │
166 ├────────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
167 │XmNtraversalOn │ XmCTraversalOn │ Boolean │ False │ G │
168 ├────────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
169 │XmNunitType │ XmCUnitType │ unsigned char │ dynamic │ CSG │
170 ├────────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
171 │XmNuserData │ XmCUserData │ XtPointer │ NULL │ CSG │
172 ├────────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
173 └────────────────────────┴───────────────────────┴──────────────────┴──────────────────────┴────────┘
174 ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
175 │ │ Core Resource Se│t │ │ │
176 │Name │ Class │ Type │ Default │ Access │
177 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
178 │XmNaccelerators │ XmCAccelerators │ XtAccelerators │ dynamic │ CSG │
179 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
180 │XmNancestorSensitive │ XmCSensitive │ Boolean │ dynamic │ G │
181 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
182 │XmNbackground │ XmCBackground │ Pixel │ dynamic │ CSG │
183 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
184 │XmNbackgroundPixmap │ XmCPixmap │ Pixmap │ XmUNSPECIFIED_PIXMAP │ CSG │
185 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
186 │XmNborderColor │ XmCBorderColor │ Pixel │ XtDefaultForeground │ CSG │
187 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
188 │XmNborderPixmap │ XmCPixmap │ Pixmap │ XmUNSPECIFIED_PIXMAP │ CSG │
189 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
190 │XmNborderWidth │ XmCBorderWidth │ Dimension │ 0 │ CSG │
191 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
192 │XmNcolormap │ XmCColormap │ Colormap │ dynamic │ CG │
193 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
194 │XmNdepth │ XmCDepth │ int │ dynamic │ CG │
195 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
196 │XmNdestroyCallback │ XmCCallback │ XtCallbackList │ NULL │ C │
197 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
198 │XmNheight │ XmCHeight │ Dimension │ dynamic │ CSG │
199 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
200 │XmNinitialResourcesPersistent │ XmCInitialResourcesPersistent │ Boolean │ True │ C │
201 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
202 │XmNmappedWhenManaged │ XmCMappedWhenManaged │ Boolean │ True │ CSG │
203 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
204 │XmNscreen │ XmCScreen │ Screen * │ dynamic │ CG │
205 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
206 │XmNsensitive │ XmCSensitive │ Boolean │ True │ CSG │
207 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
208 │XmNtranslations │ XmCTranslations │ XtTranslations │ dynamic │ CSG │
209 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
210 │XmNwidth │ XmCWidth │ Dimension │ dynamic │ CSG │
211 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
212 │XmNx │ XmCPosition │ Position │ 0 │ CSG │
213 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
214 │XmNy │ XmCPosition │ Position │ 0 │ CSG │
215 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
216 └──────────────────────────────┴───────────────────────────────┴────────────────┴──────────────────────┴────────┘
217 Translations
218 There are no translations for XmSeparator.
219
221 Core(3), XmCreateSeparator(3), XmVaCreateSeparator(3), and XmVaCreateM‐
222 anagedSeparator(3).
223 XmSeparator(library call)