1XmButtonBox(3X) XmButtonBox(3X)
2
6 XmButtonBox — The Button Box class
7
9 #include <Xm/ButtonBox.h>
10
12 The Button Box widget manages children (usually buttons) in a single
13 row or single column layout.
14 The Button Box maintains equal spacing between its children at all
16 times and attempts to adjust its height and width as necessary so that
17 all children will fit. If this is not possible, due to parent or appli‐
18 cation programmer constraints, the Button Box will resize its children
19 as necessary to fit within the available space.
20 Note: in what follows, major direction refers to the direction of ori‐
22 entation, and minor direction refers to the perpendicular direction.
23 Classes
25 Button Box inherits behavior, resources, and traits from Core, Compos‐
26 ite, Constraint, and XmManager.
27 The class pointer is xmButtonBoxWidgetClass.
29 The class name is XmButtonBox.
31 New Resources
33 The following table defines a set of widget resources used by the pro‐
34 grammer to specify data. The programmer can also set the resource val‐
35 ues for the inherited classes to set attributes for this widget. To
36 reference a resource by name or by class in a .Xdefaults file, remove
37 the XmN or XmC prefix and use the remaining letters. To specify one of
38 the defined values for a resource in a .Xdefaults file, remove the Xm
39 prefix and use the remaining letters (in either lowercase or uppercase,
40 but include any underscores between words). The codes in the access
41 column indicate if the given resource can be set at creation time (C),
42 set by using XtSetValues (S), retrieved by using XtGetValues (G), or is
43 not applicable (N/A).
44 ┌────────────────────────────────────────────────────────────────────────────────┐
46 │ │ XmButto│nBox Resource Set │ │ │
47 │Name │ Class │ Type │ Default │ Access │
48 ├─────────────────┼────────────────┼─────────────────────┼──────────────┼────────┤
49 │XmNequalSize │ XmCEqualSize │ Boolean │ False │ CSG │
50 ├─────────────────┼────────────────┼─────────────────────┼──────────────┼────────┤
51 │XmNfillOption │ XmCFillOption │ unsigned char │ XmFillNone │ CSG │
52 ├─────────────────┼────────────────┼─────────────────────┼──────────────┼────────┤
53 │XmNmarginHeight │ XmCMargin │ VerticalDimension │ 0 │ CSG │
54 ├─────────────────┼────────────────┼─────────────────────┼──────────────┼────────┤
55 │XmNmarginWidth │ XmCMargin │ HorizontalDimension │ 0 │ CSG │
56 ├─────────────────┼────────────────┼─────────────────────┼──────────────┼────────┤
57 │XmNorientation │ XmCOrientation │ unsigned char │ XmHORIZONTAL │ CSG │
58 ├─────────────────┼────────────────┼─────────────────────┼──────────────┼────────┤
59 │XmNdefaultButton │ XmCWidget │ Widget │ NULL │ SG │
60 ├─────────────────┼────────────────┼─────────────────────┼──────────────┼────────┤
61 └─────────────────┴────────────────┴─────────────────────┴──────────────┴────────┘
62 XmNequalSize
63 Specifies whether the children are to be maintained with
64 equal sized heights and widths. The chosen height and width
65 for the children is found by asking each child for its pre‐
66 ferred size and taking the largest value in each direction.
67 XmNfillOption
69 Specifies how to use any extra space left over once all chil‐
70 dren have been sized according to either their preference or
71 equalSize. There are four options:
72 XmFillNone
74 No automatic filling is performed. Center the chil‐
75 dren in the minor direction and place the children
76 with equal padding between them in the major direc‐
77 tion.
78 XmFillMinor
80 Place the children with equal padding between them
81 in the major direction, but force all the children
82 to take on the Button Box minor dimension as their
83 minor direction.
84 XmFillMajor
86 Center the children in the minor direction, but
87 expand all the children in their major direction so
88 that there is no padding between them. Expand the
89 children such that their relative sizes remain con‐
90 stant.
91 XmFillAll This option combines the placement actions and siz‐
93 ing actions of XmFillMinor and XmFillMajor.
94 Regardless of the fill mode, the ButtonBox widget
96 will always leave the specified margin between its
97 edge and the nearest child. A new String to fillOp‐
98 tion resource converter has been registered to con‐
99 vert the following strings to fill options: "none",
100 "major", "minor", "all." This resource can there‐
101 fore be set in an application defaults file.
102 XmNmarginHeight
104 XmNmarginWidth
106 Specifies the number of pixels to use as a margin around the
107 entire group of children. The marginHeight value applies to
108 both the top and bottom margins, while the marginWidth
109 applies to the left and right margins.
110 XmNorientation
112 Specifies whether children are to be placed in a row or a
113 column. The orientation may be either XmHORIZONTAL or XmVER‐
114 TICAL. If the orientation is XmHORIZONTAL, the children are
115 placed in a row with the major dimension being width and the
116 minor dimension being height. If the value is XmVERTICAL, the
117 children are placed in a column with the major dimension
118 being height and the minor dimension being width. The default
119 value is XmHORIZONTAL.
120 Inherited Resources
122 Button Box inherits behavior and resources from the superclasses
123 described in the following tables. For a complete description of each
124 resource, refer to the reference page for that superclass.
125 ┌────────────────────────────────────────────────────────────────────────────────────────────────────┐
127 │ │ XmManager │Resource Set │ │ │
128 │Name │ Class │ Type │ Default │ Access │
129 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
130 │XmNbottomShadowColor │ XmCBottomShadowColor │ Pixel │ dynamic │ CSG │
131 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
132 │XmNbottomShadowPixmap │ XmCBottomShadowPixmap │ Pixmap │ XmUNSPECIFIED_PIXMAP │ CSG │
133 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
134 │XmNforeground │ XmCForeground │ Pixel │ dynamic │ CSG │
135 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
136 │XmNhelpCallback │ XmCCallback │ XtCallbackList │ NULL │ C │
137 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
138 │XmNhighlightColor │ XmCHighlightColor │ Pixel │ dynamic │ CSG │
139 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
140 │XmNhighlightPixmap │ XmCHighlightPixmap │ Pixmap │ dynamic │ CSG │
141 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
142 │XmNinitialFocus │ XmCInitialFocus │ Widget │ dynamic │ CSG │
143 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
144 │XmNlayoutDirection │ XmCLayoutDirection │ XmDirection │ dynamic │ CG │
145 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
146 │XmNnavigationType │ XmCNavigationType │ XmNavigationType │ XmTAB_GROUP │ CSG │
147 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
148 │XmNpopupHandlerCallback │ XmCCallback │ XtCallbackList │ NULL │ C │
149 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
150 │XmNshadowThickness │ XmCShadowThickness │ Dimension │ dynamic │ CSG │
151 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
152 │XmNstringDirection │ XmCStringDirection │ XmStringDirection │ dynamic │ CG │
153 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
154 │XmNtopShadowColor │ XmCTopShadowColor │ Pixel │ dynamic │ CSG │
155 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
156 │XmNtopShadowPixmap │ XmCTopShadowPixmap │ Pixmap │ dynamic │ CSG │
157 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
158 │XmNtraversalOn │ XmCTraversalOn │ Boolean │ True │ CSG │
159 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
160 │XmNunitType │ XmCUnitType │ unsigned char │ dynamic │ CSG │
161 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
162 │XmNuserData │ XmCUserData │ XtPointer │ NULL │ CSG │
163 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
164 └────────────────────────┴───────────────────────┴───────────────────┴──────────────────────┴────────┘
165 ┌───────────────────────────────────────────────────────────────────────┐
166 │ │ Composite Reso│urce Set │ │ │
167 │Name │ Class │ Type │ Default │ Access │
168 ├──────────────────┼───────────────────┼─────────────┼─────────┼────────┤
169 │XmNchildren │ XmCReadOnly │ WidgetList │ NULL │ G │
170 ├──────────────────┼───────────────────┼─────────────┼─────────┼────────┤
171 │XmNinsertPosition │ XmCInsertPosition │ XtOrderProc │ NULL │ CSG │
172 ├──────────────────┼───────────────────┼─────────────┼─────────┼────────┤
173 │XmNnumChildren │ XmCReadOnly │ Cardinal │ 0 │ G │
174 ├──────────────────┼───────────────────┼─────────────┼─────────┼────────┤
175 └──────────────────┴───────────────────┴─────────────┴─────────┴────────┘
176 ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
177 │ │ Core Resource Se│t │ │ │
178 │Name │ Class │ Type │ Default │ Access │
179 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
180 │XmNaccelerators │ XmCAccelerators │ XtAccelerators │ dynamic │ N/A │
181 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
182 │XmNancestorSensitive │ XmCSensitive │ Boolean │ dynamic │ G │
183 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
184 │XmNbackground │ XmCBackground │ Pixel │ dynamic │ CSG │
185 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
186 │XmNbackgroundPixmap │ XmCPixmap │ Pixmap │ XmUNSPECIFIED_PIXMAP │ CSG │
187 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
188 │XmNborderColor │ XmCBorderColor │ Pixel │ XtDefaultForeground │ CSG │
189 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
190 │XmNborderPixmap │ XmCPixmap │ Pixmap │ XmUNSPECIFIED_PIXMAP │ CSG │
191 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
192 │XmNborderWidth │ XmCBorderWidth │ Dimension │ 0 │ CSG │
193 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
194 │XmNcolormap │ XmCColormap │ Colormap │ dynamic │ CG │
195 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
196 │XmNdepth │ XmCDepth │ int │ dynamic │ CG │
197 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
198 │XmNdestroyCallback │ XmCCallback │ XtCallbackList │ NULL │ C │
199 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
200 │XmNheight │ XmCHeight │ Dimension │ dynamic │ CSG │
201 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
202 │XmNinitialResourcesPersistent │ XmCInitialResourcesPersistent │ Boolean │ True │ C │
203 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
204 │XmNmappedWhenManaged │ XmCMappedWhenManaged │ Boolean │ True │ CSG │
205 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
206 │XmNscreen │ XmCScreen │ Screen * │ dynamic │ CG │
207 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
208 │XmNsensitive │ XmCSensitive │ Boolean │ True │ CSG │
209 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
210 │XmNtranslations │ XmCTranslations │ XtTranslations │ dynamic │ CSG │
211 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
212 │XmNwidth │ XmCWidth │ Dimension │ dynamic │ CSG │
213 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
214 │XmNx │ XmCPosition │ Position │ 0 │ CSG │
215 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
216 │XmNy │ XmCPosition │ Position │ 0 │ CSG │
217 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
218 └──────────────────────────────┴───────────────────────────────┴────────────────┴──────────────────────┴────────┘
219 Translations
220 XmButtonBox inherits translations from XmManager.
221
223 Composite(3), Constraint(3), Core(3), XmCreateButtonBox(3), XmMan‐
224 ager(3), XmVaCreateButtonBox(3), XmVaCreateManagedButtonBox(3).
225
227 Copyright (c) 1992 by Integrated Computer Solutions, Inc.
228 XmButtonBox(3X)