1XbaeCaption(3x) XbaeCaption(3x)
2
6 XbaeCaption - The Bellcore Application Environment (BAE) XbaeCaption
7 widget class.
8
10 #include <Xbae/Caption.h>
11
13 XbaeCaption is a simple manager used to associate a label with its sin‐
14 gle child. The label may be either an XmString or a Pixmap and can be
15 displayed in any one of twelve positions around the edge of the child.
16 XbaeCaption performs geometry management so that its size always
17 matches its child's size plus the size of the label and label offset.
18 By using XbaeCaption with an XmFrame child, groups of related widgets
19 can be labeled in a visually appealing manner. XbaeCaption is also
20 useful for associating labels with individual XmTextFields.
21 Classes
23 XbaeCaption inherits behavior and resources from the Core, Composite,
24 Constraint and XmManager widget classes.
25 The class pointer is xbaeCaptionWidgetClass.
26 The class name is XbaeCaption.
27 New Resources
29 The following table lists the new resources defined by XbaeCaption.
30 The codes in the Access column indicate whether the given resource can
31 be set at creation time (C), or set by using XtSetValues (S), or
32 retrieved by using XtGetValues (G).
33 ┌───────────────────────────────────────────────────────────────────────────────────┐
36 │ XbaeCaption Resource Set │
37 ├────────────────────┬────────────────┬───────────────────┬───────────────────┬─────┤
38 │Name │Class │Type │Default │Access│
39 ├────────────────────┼────────────────┼───────────────────┼───────────────────┼─────┤
40 │XmNfontList │XmCFontList │FontList │dynamic │CSG │
41 ├────────────────────┼────────────────┼───────────────────┼───────────────────┼─────┤
42 │XmNlabelAlignment │XmCLabelAlignment│XbaeLabelAlignment │XbaeAlignmentCenter │CSG │
43 ├────────────────────┼────────────────┼───────────────────┼───────────────────┼─────┤
44 │XmNlabelOffset │XmCLabelOffset │Int │0 │CSG │
45 ├────────────────────┼────────────────┼───────────────────┼───────────────────┼─────┤
46 │XmNlabelPixmap │XmCLabelPixmap │PrimForegroundPixmap│XmUNSPECIFIED_PIXMAP│CSG │
47 ├────────────────────┼────────────────┼───────────────────┼───────────────────┼─────┤
48 │XmNlabelPosition │XmCLabelPosition │XbaeLabelPosition │XbaePositionLeft │CSG │
49 ├────────────────────┼────────────────┼───────────────────┼───────────────────┼─────┤
50 │XmNlabelString │XmCXmString │XmString │widget name │CSG │
51 ├────────────────────┼────────────────┼───────────────────┼───────────────────┼─────┤
52 │XmNlabelTextAlignment│XmCAlignment │Alignment │XmALIGNMENT_CENTER │CSG │
53 ├────────────────────┼────────────────┼───────────────────┼───────────────────┼─────┤
54 │XmNlabelType │XmCLabelType │LabelType │XmString │CSG │
55 └────────────────────┴────────────────┴───────────────────┴───────────────────┴─────┘
56 XmNfontList
58 Specifies the font of the text used in the caption label. If this
59 value is NULL at initialization, it is initialized by looking up
60 the parent hierarchy of the widget for an ancestor that is a sub‐
61 class of the XmBulletinBoard, VendorShell or XmMenuShell widget
62 class. If such an ancestor is found, the font list is initialized
63 to the appropriate default font list of the ancestor widget XmNde‐
64 faultFontList for VendorShell and XmMenuShell, XmNlabelFontList or
65 XmNbuttonFontList for XmBulletinBoard. Refer to XmFontList(3X)
66 for more information on the creation and structure of a font list.
67 This resource is copied.
68 XmNlabelAlignment
70 Specifies the alignment of the caption label along the side of the
71 caption child. Must be one of the enumerated XbaeLabelAlignment
72 types: XbaeAlignmentTopOrLeft, XbaeAlignmentCenter, XbaeAlignment‐
73 BottomOrRight.
74 XmNlabelOffset
76 Specifies the offset, in pixels, of the caption label from the
77 caption child. If the offset is negative, then the caption label
78 will overlap the caption child by that many pixels.
79 XmNlabelPixmap
81 Specifies the caption label pixmap when XmNlabelType is XmPIXMAP.
82 XmNlabelPosition
84 Specifies on which side of the caption child the caption label
85 should be placed. Must be one of the enumerated XbaeLabelPosition
86 types: XbaePositionLeft, XbaePositionRight, XbaePositionTop, Xbae‐
87 PositionBottom.
88 XmNlabelString
90 Specifies the compound string when the XmNlabelType is XmSTRING.
91 If this value is NULL, it is initialized by converting the name of
92 the widget to a compound string. Refer to XmString(3X) for more
93 information on the creation and structure of compound strings.
94 XmNlabelTextAlignment
96 Specifies the text alignment for the caption label. This resource
97 is only useful for multi line caption labels. Valid values are:
98 XmALIGNMENT_BEGINNING left alignment causes the left sides of the
99 lines of text to be vertically aligned. XmALIGNMENT_CENTER center
100 alignment causes the centers of the lines of text to be vertically
101 aligned. XmALIGNMENT_END right alignment causes the right sides
102 of the lines of text to be vertically aligned.
103 XmNlabelType
105 Specifies the caption label type. Valid values are: XmSTRING - the
106 caption label will display the XmNlabelString. XmPIXMAP - the
107 caption label will display the XmNlabelPixmap.
108 Inherited Resources
110 The following table lists the resources which XbaeCaption inherits from
111 it's superclasses XmManager, Compositeand Core. For a complete
112 description of each resource, refer to the man page for that super‐
113 class. The codes in the "Access" column indicate whether the given
114 resource can be set at creation time (C), or set by using XtSetValues
115 (S), or retrieved by using XtGetValues (G).
116 ┌────────────────────────────────────────────────────────────────────────────────────┐
118 │ XmManager Resource Set │
119 ├────────────────────┬────────────────────┬────────────────┬───────────────────┬─────┤
120 │Name │Class │Type │Default │Access│
121 ├────────────────────┼────────────────────┼────────────────┼───────────────────┼─────┤
122 │XmNbottomShadowColor │XmCBottomShadowColor │Pixel │dynamic │CSG │
123 ├────────────────────┼────────────────────┼────────────────┼───────────────────┼─────┤
124 │XmNbottomShadowPixmap│XmCBottomShadowPixmap│Pixmap │XmUNSPECIFIED_PIXMAP│CSG │
125 ├────────────────────┼────────────────────┼────────────────┼───────────────────┼─────┤
126 │XmNforeground │XmCForeground │Pixel │dynamic │CSG │
127 ├────────────────────┼────────────────────┼────────────────┼───────────────────┼─────┤
128 │XmNhelpCallback │XmCCallback │Callback │NULL │CSG │
129 ├────────────────────┼────────────────────┼────────────────┼───────────────────┼─────┤
130 │XmNhighlightColor │XmCHighlightColor │Pixel │dynamic │CSG │
131 ├────────────────────┼────────────────────┼────────────────┼───────────────────┼─────┤
132 │XmNhighlightPixmap │XmCHighlightPixmap │Pixmap │dynamic │CSG │
133 ├────────────────────┼────────────────────┼────────────────┼───────────────────┼─────┤
134 │XmNnavigationType │XmCNavigationType │XmNavigationType │XmTAB_GROUP │CSG │
135 ├────────────────────┼────────────────────┼────────────────┼───────────────────┼─────┤
136 │XmNshadowThickness │XmCShadowThickness │Dimension │2 │CSG │
137 ├────────────────────┼────────────────────┼────────────────┼───────────────────┼─────┤
138 │XmNstringDirection │XmCStringDirection │XmStringDirection│dynamic │CG │
139 ├────────────────────┼────────────────────┼────────────────┼───────────────────┼─────┤
140 │XmNtopShadowColor │XmCTopShadowColor │Pixel │dynamic │CSG │
141 ├────────────────────┼────────────────────┼────────────────┼───────────────────┼─────┤
142 │XmNtopShadowPixmap │XmCTopShadowPixmap │Pixmap │dynamic │CSG │
143 ├────────────────────┼────────────────────┼────────────────┼───────────────────┼─────┤
144 │XmNtraversalOn │XmCTraversalOn │Boolean │True │CSG │
145 ├────────────────────┼────────────────────┼────────────────┼───────────────────┼─────┤
146 │XmNunitType │XmCUnitType │UnsignedChar │dynamic │CSG │
147 ├────────────────────┼────────────────────┼────────────────┼───────────────────┼─────┤
148 │XmNuserData │XmCUserData │Pointer │NULL │CSG │
149 └────────────────────┴────────────────────┴────────────────┴───────────────────┴─────┘
150 ┌──────────────────────────────────────────────────────────────────────┐
151 │ Composite Resource Set │
152 ├──────────────────┬───────────────────┬────────────┬─────────┬────────┤
153 │Name │ Class │ Type │ Default │ Access │
154 ├──────────────────┼───────────────────┼────────────┼─────────┼────────┤
155 │XmNchildren │ XmCReadOnly │ WidgetList │ private │ G │
156 ├──────────────────┼───────────────────┼────────────┼─────────┼────────┤
157 │XmNinsertPosition │ XmCInsertPosition │ Function │ NULL │ CSG │
158 ├──────────────────┼───────────────────┼────────────┼─────────┼────────┤
159 │XmNnumChildren │ XmCReadOnly │ Cardinal │ 4 │ G │
160 └──────────────────┴───────────────────┴────────────┴─────────┴────────┘
161 ┌───────────────────────────────────────────────────────────────────────────────────────────────────┐
162 │ Core Resource Set │
163 ├────────────────────────────┬────────────────────────────┬───────────────┬───────────────────┬─────┤
164 │Name │Class │Type │Default │Access│
165 ├────────────────────────────┼────────────────────────────┼───────────────┼───────────────────┼─────┤
166 │XmNaccelerators │XmCAccelerators │AcceleratorTable│NULL │CSG │
167 ├────────────────────────────┼────────────────────────────┼───────────────┼───────────────────┼─────┤
168 │XmNancestorSensitive │XmCSensitive │Boolean │dynamic │CSG │
169 ├────────────────────────────┼────────────────────────────┼───────────────┼───────────────────┼─────┤
170 │XmNbackground │XmCBackground │Pixel │dynamic │G │
171 ├────────────────────────────┼────────────────────────────┼───────────────┼───────────────────┼─────┤
172 │XmNbackgroundPixmap │XmCPixmap │Pixmap │XmUNSPECIFIED_PIXMAP│CSG │
173 ├────────────────────────────┼────────────────────────────┼───────────────┼───────────────────┼─────┤
174 │XmNborderColor │XmCBorderColor │Pixel │XtDefaultForeground │CSG │
175 ├────────────────────────────┼────────────────────────────┼───────────────┼───────────────────┼─────┤
176 │XmNborderPixmap │XmCPixmap │Pixmap │XmUNSPECIFIED_PIXMAP│CSG │
177 ├────────────────────────────┼────────────────────────────┼───────────────┼───────────────────┼─────┤
178 │XmNborderWidth │XmCBorderWidth │Dimension │0 │CSG │
179 ├────────────────────────────┼────────────────────────────┼───────────────┼───────────────────┼─────┤
180 │XmNcolormap │XmCColormap │Colormap │dynamic │CG │
181 ├────────────────────────────┼────────────────────────────┼───────────────┼───────────────────┼─────┤
182 │XmNdepth │XmCDepth │Int │dynamic │CG │
183 ├────────────────────────────┼────────────────────────────┼───────────────┼───────────────────┼─────┤
184 │XmNdestroyCallback │XmCCallback │Callback │NULL │CSG │
185 ├────────────────────────────┼────────────────────────────┼───────────────┼───────────────────┼─────┤
186 │XmNheight │XmCHeight │Dimension │dynamic │CSG │
187 ├────────────────────────────┼────────────────────────────┼───────────────┼───────────────────┼─────┤
188 │XmNinitialResourcesPersistent│XmCInitialResourcesPersistent│Boolean │True │CG │
189 ├────────────────────────────┼────────────────────────────┼───────────────┼───────────────────┼─────┤
190 │XmNmappedWhenManaged │XmCMappedWhenManaged │Boolean │True │CSG │
191 ├────────────────────────────┼────────────────────────────┼───────────────┼───────────────────┼─────┤
192 │XmNscreen │XmCScreen │Screen │dynamic │CG │
193 ├────────────────────────────┼────────────────────────────┼───────────────┼───────────────────┼─────┤
194 │XmNsensitive │XmCSensitive │Boolean │True │CSG │
195 ├────────────────────────────┼────────────────────────────┼───────────────┼───────────────────┼─────┤
196 │XmNtranslations │XmCTranslations │TranslationTable│internal │CSG │
197 ├────────────────────────────┼────────────────────────────┼───────────────┼───────────────────┼─────┤
198 │XmNwidth │XmCWidth │Dimension │dynamic │CSG │
199 ├────────────────────────────┼────────────────────────────┼───────────────┼───────────────────┼─────┤
200 │XmNx │XmCPosition │Position │0 │CSG │
201 ├────────────────────────────┼────────────────────────────┼───────────────┼───────────────────┼─────┤
202 │XmNy │XmCPosition │Position │0 │CSG │
203 └────────────────────────────┴────────────────────────────┴───────────────┴───────────────────┴─────┘
204 Translations
206 XbaeCaption inherits translations from XmManager.
207 Type Converters
209 In addition to the standard type converters registered by Xt and Motif,
210 XbaeCaption registers the following additional type converters:
211 CvtStringToLabelAlignment()
213 Converts a String to the enumerated XbaeLabelAlignment type. The
214 Strings TopOrLeft, Top and Left are converted to XbaeAlignment‐
215 TopOrLeft. The String Center is converted to XbaeAlignmentCen‐
216 ter. The Strings BottomOrRight, Bottom and Right are converted
217 to XbaeAlignmentBottomOrRight. This converter allows the XmNla‐
218 belAlignment resource to be specified in a resource file. The
219 converter is case insensitive.
220 CvtStringToLabelPosition()
222 Converts a String to the enumerated XbaeLabelPosition type. The
223 String Left is converted to XbaePositionLeft. The String Right
224 is converted to XbaePositionRight. The String Top is converted
225 to XbaePositionTop. The String Bottom is converted to XbaePosi‐
226 tionBottom. This converter allows the XmNlabelPosition resource
227 to be specified in a resource file. The converter is case insen‐
228 sitive.
229 Public Functions
232 The following external entry points to XbaeCaption class methods are
233 defined:
234 XbaeCreateCaption()
236 Widget XbaeCreateCaption()
238 Widget parent;
239 String name;
240 ArgList arglist;
241 Cardinal argcount;
242 parent Specifies the parent widget ID.
245 name Specifies the name of the created widget
247 arglist Specifies the argument list
249 argcount Specifies the number of attribute/value pairs in the
251 argument list (arglist)
252 XbaeCreateCaption() creates an instance of an XbaeCaption widget
254 and returns the associated widget ID.
255 Virtual Bindings
257 The bindings for virtual keys are vendor specific. For information
258 about bindings for virtual buttons and keys, see VirtualBindings(3X).
259
261 Andrew Wason, Bellcore, Piscataway NJ; author
262 (aw@bae.bellcore.com)
263 Andrew Lister
265 (lister@db.com)
266
269 This document describes XbaeCaption from Xbae Version 4.9.
270
272 Core(3X), Composite(3X), XmManager(3X), XmLabel(3X)
273
275 Bellcore, previous and current maintainers of the Xbae widgets (collec‐
276 tively 'authors') provide this information solely to professionals who
277 have the appropriate degree of experience to understand and interpret
278 its contents in accordance with generally accepted engineering or other
279 professional standards and applicable regulations. No recommendations
280 as to products or vendors is made or should be implied.
281 While the information contained herein has been prepared from sources
283 deemed to be reliable, the authors reserve the right to revise the
284 information without notice, but have no obligation to do so. Unless the
285 recipient has been expressly granted a license by Bellcore under sepa‐
286 rate applicable written agreement with Bellcore, no license, expressed
287 or implied, is granted under any patents, copyrights or other intellec‐
288 tual property rights. Use of the information is at your discretion and
289 shall not be deemed an inducement by Bellcore to infringe any existing
290 or later-issued patent, copyrights or other intellectual property
291 right.
292 THE AUTHORS MAKE NO REPRESENTATIONS AND EXTENDS NO WARRANTIES, EXPRESS
294 OR IMPLIED, WITH RESPECT TO THE INFORMATION, INCLUDING, BUT NOT LIMITED
295 TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR ANY PAR‐
296 TICULAR PURPOSE, AND THE WARRANTY AGAINST INFRINGEMENT OF PATENTS OR
297 OTHER INTELLECTUAL PROPERTY RIGHTS. THE INFORMATION IS PROVIDED ``AS
298 IS'', AND IN NO EVENT SHALL THE AUTHORS OR ANY OF ITS AFFILIATES BE
299 LIABLE FOR ANY DAMAGES, INCLUDING ANY LOST PROFITS OR OTHER INCIDENTAL
300 OR CONSEQUENTIAL DAMAGES RELATING TO THE INFORMATION.
301 Copyright 1991 Bellcore. All Rights Reserved. Copyright 1995-99
303 Andrew Lister All Rights Reserved.
304 Copyright 1999-2002 LessTif Developers
305 The above no warranty extends to all additions and contributions. No
309 contributor shall be held liable; this work is provided ``as is''. If
310 this is a problem for you, then don't use this software.
311xbae 4.60.4 XbaeCaption(3x)