1XmSeparatorGadget(library call)                XmSeparatorGadget(library call)
2
3
4

NAME

6       XmSeparatorGadget — The SeparatorGadget widget class
7

SYNOPSIS

9       #include <Xm/SeparatoG.h>
10

DESCRIPTION

12       SeparatorGadget  separates  items  in  a display.  Several line drawing
13       styles are provided, as well as horizontal or vertical orientation.
14
15       Lines drawn  within  the  SeparatorGadget  are  automatically  centered
16       within  the  height of the gadget for a horizontal orientation and cen‐
17       tered within the width of the gadget for a  vertical  orientation.   An
18       XtSetValues with a new XmNseparatorType resizes the widget to its mini‐
19       mal height (for horizontal orientation) or its minimal width (for  ver‐
20       tical  orientation)  unless  height  or  width is explicitly set in the
21       XtSetValues call.
22
23       SeparatorGadget does not draw shadows around the separator.  The Gadget
24       resource XmNshadowThickness is used for the SeparatorGadget's thickness
25       when XmNseparatorType is  XmSHADOW_ETCHED_IN,  XmSHADOW_ETCHED_IN_DASH,
26       XmSHADOW_ETCHED_OUT, or XmSHADOW_ETCHED_OUT_DASH.
27
28       SeparatorGadget does not highlight and allows no traversing. The Gadget
29       resource XmNtraversalOn is forced to False.  SeparatorGadget holds  the
30       XmQTmenuSavvy trait.
31
32   Classes
33       SeparatorGadget  inherits  behavior, resources, and traits from Object,
34       RectObj, and XmGadget.
35
36       The class pointer is xmSeparatorGadgetClass.
37
38       The class name is XmSeparatorGadget.
39
40   New Resources
41       The following table defines a set of widget resources used by the  pro‐
42       grammer  to specify data. The programmer can also set the resource val‐
43       ues for the inherited classes to set attributes  for  this  widget.  To
44       reference  a  resource by name or by class in a .Xdefaults file, remove
45       the XmN or XmC prefix and use the remaining letters. To specify one  of
46       the  defined  values for a resource in a .Xdefaults file, remove the Xm
47       prefix and use the remaining letters (in either lowercase or uppercase,
48       but  include  any  underscores between words).  The codes in the access
49       column indicate if the given resource can be set at creation time  (C),
50       set by using XtSetValues (S), retrieved by using XtGetValues (G), or is
51       not applicable (N/A).
52
53       ┌──────────────────────────────────────────────────────────────────────────────────┐
54       │                 │       XmSeparator│Gadget Resource │Set                  │        │
55Name             Class            Type          Default            Access 
56       ├─────────────────┼──────────────────┼───────────────┼────────────────────┼────────┤
57       │XmNmargin        │ XmCMargin        │ Dimension     │ 0                  │ CSG    │
58       ├─────────────────┼──────────────────┼───────────────┼────────────────────┼────────┤
59       │XmNorientation   │ XmCOrientation   │ unsigned char │ XmHORIZONTAL       │ CSG    │
60       ├─────────────────┼──────────────────┼───────────────┼────────────────────┼────────┤
61       │XmNseparatorType │ XmCSeparatorType │ unsigned char │ XmSHADOW_ETCHED_IN │ CSG    │
62       ├─────────────────┼──────────────────┼───────────────┼────────────────────┼────────┤
63       └─────────────────┴──────────────────┴───────────────┴────────────────────┴────────┘
64       XmNmargin For horizontal orientation, specifies the space on  the  left
65                 and right sides between the border of SeparatorGadget and the
66                 line drawn.  For vertical orientation, specifies the space on
67                 the  top and bottom between the border of SeparatorGadget and
68                 the line drawn.
69
70       XmNorientation
71                 Specifies whether SeparatorGadget is displayed vertically  or
72                 horizontally.   This  resource  can have values of XmVERTICAL
73                 and XmHORIZONTAL.
74
75       XmNseparatorType
76                 Specifies the type of line drawing to be done in the  Separa‐
77                 tor widget.
78
79                 XmSINGLE_LINE
80                           Single line.
81
82                 XmDOUBLE_LINE
83                           Double line.
84
85                 XmSINGLE_DASHED_LINE
86                           Single-dashed line.
87
88                 XmDOUBLE_DASHED_LINE
89                           Double-dashed line.
90
91                 XmNO_LINE No line.
92
93                 XmSHADOW_ETCHED_IN
94                           A  line  whose  shadows  give  the effect of a line
95                           etched into the window. The thickness of  the  line
96                           is  equal  to  the value of XmNshadowThickness. For
97                           horizontal orientation, the top shadow is drawn  in
98                           XmNtopShadowColor and the bottom shadow is drawn in
99                           XmNbottomShadowColor. For vertical orientation, the
100                           left  edge  is  drawn  in XmNtopShadowColor and the
101                           right edge is drawn in XmNbottomShadowColor.
102
103                 XmSHADOW_ETCHED_OUT
104                           A line whose shadows give the effect of  an  etched
105                           line coming out of the window. The thickness of the
106                           line is equal to the value  of  XmNshadowThickness.
107                           For horizontal orientation, the top shadow is drawn
108                           in XmNbottomShadowColor and the  bottom  shadow  is
109                           drawn  in  XmNtopShadowColor. For vertical orienta‐
110                           tion, the left edge is  drawn  in  XmNbottomShadow‐
111                           Color  and the right edge is drawn in XmNtopShadow‐
112                           Color.
113
114                 XmSHADOW_ETCHED_IN_DASH
115                           Identical to XmSHADOW_ETCHED_IN except a series  of
116                           lines creates a dashed line.
117
118                 XmSHADOW_ETCHED_OUT_DASH
119                           Identical to XmSHADOW_ETCHED_OUT except a series of
120                           lines creates a dashed line.
121
122   Inherited Resources
123       SeparatorGadget inherits behavior and resources from  the  superclasses
124       in  the following tables.  For a complete description of each resource,
125       refer to the reference page for that superclass.
126
127       ┌─────────────────────────────────────────────────────────────────────────────────────────────────┐
128       │                      │              XmGadget │Resource Set       │                      │        │
129Name                  Class                 Type             Default              Access 
130       ├──────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
131       │XmNbackground         │ XmCBackground         │ Pixel            │ dynamic              │ CSG    │
132       ├──────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
133       │XmNbackgroundPixmap   │ XmCPixmap             │ Pixmap           │ XmUNSPECIFIED_PIXMAP │ CSG    │
134       ├──────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
135       │XmNbottomShadowColor  │ XmCBottomShadowColor  │ Pixel            │ dynamic              │ CSG    │
136       ├──────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
137       │XmNbottomShadowPixmap │ XmCBottomShadowPixmap │ Pixmap           │ dynamic              │ CSG    │
138       ├──────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
139       │XmNhelpCallback       │ XmCCallback           │ XtCallbackList   │ NULL                 │ C      │
140       ├──────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
141       │XmNforeground         │ XmCForeground         │ Pixel            │ dynamic              │ CSG    │
142       ├──────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
143       │XmNhighlightColor     │ XmCHighlightColor     │ Pixel            │ dynamic              │ CSG    │
144       ├──────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
145       │XmNhighlightOnEnter   │ XmCHighlightOnEnter   │ Boolean          │ False                │ CSG    │
146       ├──────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
147       │XmNhighlightPixmap    │ XmCHighlightPixmap    │ Pixmap           │ dynamic              │ CSG    │
148       ├──────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
149       │XmNhighlightThickness │ XmCHighlightThickness │ Dimension        │ 0                    │ CSG    │
150       ├──────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
151       │XmNlayoutDirection    │ XmNCLayoutDirection   │ XmDirection      │ dynamic              │ CG     │
152       ├──────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
153       │XmNnavigationType     │ XmCNavigationType     │ XmNavigationType │ XmNONE               │ CSG    │
154       ├──────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
155       │XmNshadowThickness    │ XmCShadowThickness    │ Dimension        │ 2                    │ CSG    │
156       ├──────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
157       │XmNtopShadowColor     │ XmCTopShadowColor     │ Pixel            │ dynamic              │ CSG    │
158       ├──────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
159       │XmNtopShadowPixmap    │ XmCTopShadowPixmap    │ Pixmap           │ dynamic              │ CSG    │
160       ├──────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
161       │XmNtraversalOn        │ XmCTraversalOn        │ Boolean          │ False                │ G      │
162       ├──────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
163       │XmNunitType           │ XmCUnitType           │ unsigned char    │ dynamic              │ CSG    │
164       ├──────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
165       │XmNuserData           │ XmCUserData           │ XtPointer        │ NULL                 │ CSG    │
166       ├──────────────────────┼───────────────────────┼──────────────────┼──────────────────────┼────────┤
167       └──────────────────────┴───────────────────────┴──────────────────┴──────────────────────┴────────┘
168       ┌─────────────────────────────────────────────────────────────────────┐
169       │                     │  RectObj Resour│ce Set      │         │        │
170Name                 Class          Type      Default Access 
171       ├─────────────────────┼────────────────┼───────────┼─────────┼────────┤
172       │XmNancestorSensitive │ XmCSensitive   │ Boolean   │ dynamic │ G      │
173       ├─────────────────────┼────────────────┼───────────┼─────────┼────────┤
174       │XmNborderWidth       │ XmCBorderWidth │ Dimension │ 0       │ N/A    │
175       ├─────────────────────┼────────────────┼───────────┼─────────┼────────┤
176       │XmNheight            │ XmCHeight      │ Dimension │ dynamic │ CSG    │
177       ├─────────────────────┼────────────────┼───────────┼─────────┼────────┤
178       │XmNsensitive         │ XmCSensitive   │ Boolean   │ True    │ CSG    │
179       ├─────────────────────┼────────────────┼───────────┼─────────┼────────┤
180       │XmNwidth             │ XmCWidth       │ Dimension │ dynamic │ CSG    │
181       ├─────────────────────┼────────────────┼───────────┼─────────┼────────┤
182       │XmNx                 │ XmCPosition    │ Position  │ 0       │ CSG    │
183       ├─────────────────────┼────────────────┼───────────┼─────────┼────────┤
184       │XmNy                 │ XmCPosition    │ Position  │ 0       │ CSG    │
185       ├─────────────────────┼────────────────┼───────────┼─────────┼────────┤
186       └─────────────────────┴────────────────┴───────────┴─────────┴────────┘
187       ┌─────────────────────────────────────────────────────────────────────┐
188       │                   │    Object Re│source Set       │         │        │
189Name               Class       Type           Default Access 
190       ├───────────────────┼─────────────┼────────────────┼─────────┼────────┤
191       │XmNdestroyCallback │ XmCCallback │ XtCallbackList │ NULL    │ C      │
192       ├───────────────────┼─────────────┼────────────────┼─────────┼────────┤
193       └───────────────────┴─────────────┴────────────────┴─────────┴────────┘
194   Behavior
195       XmSeparatorGadget has no behavior.
196
198       Object(3),   RectObj(3),    XmCreateSeparatorGadget(3),    XmGadget(3),
199       XmVaCreateSeparatorGadget(3), and XmVaCreateManagedSeparatorGadget(3).
200
201
202
203                                               XmSeparatorGadget(library call)
Impressum