← Back to branch summary

~ubuntu-branches/ubuntu/utopic/gridengine/utopic

« back to all changes in this revision

Viewing changes to source/3rdparty/qmon/Xbae/XbaeCaption.man

  • Committer: Bazaar Package Importer
  • Author(s): Mark Hymers
  • Date: 2008-06-25 22:36:13 UTC
  • Revision ID: james.westby@ubuntu.com-20080625223613-tvd9xlhuoct9kyhm
Tags: upstream-6.2~beta2
Import upstream version 6.2~beta2

Show diffs side-by-side

added added

removed removed

Lines of Context:
source/3rdparty/qmon/Xbae/XbaeCaption.man
 
1
'\" t
 
2
.\" describe how a callback arg item is formatted
 
3
..
 
4
.de cI
 
5
.IP \fI\\$1\fR 10
 
6
..
 
7
.de LI
 
8
.IP \fB\\$1\fR 5
 
9
..
 
10
.TH XbaeCaption 3x "15 June, 1999" "Version 4.7" "Xbae Widget Set"
 
11
.SH NAME
 
12
XbaeCaption
 
13
\- The Bellcore Application Environment (BAE) XbaeCaption widget class.
 
14
.SH SYNOPSIS
 
15
#include <Xbae/Caption.h>
 
16
.SH DESCRIPTION
 
17
.B XbaeCaption
 
18
is a simple manager used to associate a label with its
 
19
single child. The label may be either an
 
20
.B XmString
 
21
or a Pixmap and can be displayed in any one of twelve positions
 
22
around the edge of the child.
 
23
.B XbaeCaption
 
24
performs geometry management so that its size
 
25
always matches its child's size plus the size of the label and label
 
26
offset. By using
 
27
.B XbaeCaption
 
28
with an
 
29
.B XmFrame
 
30
child, groups of related
 
31
widgets can be labeled in a visually appealing manner.
 
32
.B XbaeCaption
 
33
is also useful for associating labels with individual
 
34
.BR XmTextFields .
 
35
.SS "Classes"
 
36
.B XbaeCaption
 
37
inherits behavior and resources from the
 
38
.BR Core ,
 
39
.BR Composite ,
 
40
.B Constraint
 
41
and
 
42
.B XmManager
 
43
widget classes.
 
44
.br
 
45
The class pointer is
 
46
.BR xbaeCaptionWidgetClass .
 
47
.br
 
48
The class name is
 
49
.BR XbaeCaption .
 
50
.SS "New Resources"
 
51
The following table lists the new resources defined by
 
52
.BR XbaeCaption .
 
53
The codes in the Access column indicate whether
 
54
the given resource can be set at creation time (C), or set by
 
55
using XtSetValues (S), or retrieved by using XtGetValues (G).
 
56
 
 
57
.TS
 
58
expand box;
 
59
c s s s s
 
60
lb | lb | lb | lb | lb
 
61
lp8 | lp8 | lp8 | lp8 | lp8 .
 
62
XbaeCaption Resource Set
 
63
_
 
64
Name    Class   Type    Default Access
 
65
=
 
66
XmNfontList     XmCFontList     FontList        dynamic CSG
 
67
_
 
68
XmNlabelAlignment       XmCLabelAlignment       XbaeLabelAlignment      XbaeAlignmentCenter     CSG
 
69
_
 
70
XmNlabelOffset  XmCLabelOffset  Int     0       CSG
 
71
_
 
72
XmNlabelPixmap  XmCLabelPixmap  PrimForegroundPixmap    XmUNSPECIFIED_PIXMAP    CSG
 
73
_
 
74
XmNlabelPosition        XmCLabelPosition        XbaeLabelPosition       XbaePositionLeft        CSG
 
75
_
 
76
XmNlabelString  XmCXmString     XmString        widget name     CSG
 
77
_
 
78
XmNlabelTextAlignment   XmCAlignment    Alignment       XmALIGNMENT_CENTER      CSG
 
79
_
 
80
XmNlabelType    XmCLabelType    LabelType       XmString        CSG
 
81
.TE
 
82
.sp
 
83
.LI XmNfontList
 
84
Specifies the font of the text used in the caption label. If this
 
85
value is
 
86
.SM NULL
 
87
at initialization, it is initialized by looking up the
 
88
parent hierarchy of the widget for an ancestor that is a subclass of
 
89
the
 
90
.BR XmBulletinBoard ,
 
91
.B VendorShell
 
92
or
 
93
.B XmMenuShell
 
94
widget class. If such
 
95
an ancestor is found, the font list is initialized to the appropriate
 
96
default font list of the ancestor widget
 
97
.B XmNdefaultFontList for
 
98
.B VendorShell
 
99
and
 
100
.BR XmMenuShell ,
 
101
.B XmNlabelFontList
 
102
or
 
103
.B XmNbuttonFontList
 
104
for
 
105
.B XmBulletinBoard.
 
106
Refer to
 
107
.B XmFontList(3X)
 
108
for more information on the
 
109
creation and structure of a font list. This resource is copied.
 
110
.LI XmNlabelAlignment
 
111
Specifies the alignment of the caption label along the side of the
 
112
caption child.  Must be one of the enumerated
 
113
.B XbaeLabelAlignment
 
114
types:
 
115
.BR XbaeAlignmentTopOrLeft ,
 
116
.BR XbaeAlignmentCenter ,
 
117
.BR XbaeAlignmentBottomOrRight .
 
118
.LI XmNlabelOffset
 
119
Specifies the offset, in pixels, of the caption
 
120
label from the caption child. If the offset is negative, then the
 
121
caption label will overlap the caption child by that many pixels.
 
122
.LI XmNlabelPixmap
 
123
Specifies the caption label pixmap when
 
124
.B XmNlabelType
 
125
is
 
126
.BR XmPIXMAP .
 
127
.LI XmNlabelPosition
 
128
Specifies on which side of the caption child the caption label should
 
129
be placed.  Must be one of the enumerated
 
130
.B XbaeLabelPosition
 
131
types: 
 
132
.BR XbaePositionLeft ,
 
133
.BR XbaePositionRight ,
 
134
.BR XbaePositionTop ,
 
135
.BR XbaePositionBottom .
 
136
.LI XmNlabelString
 
137
Specifies the compound string when the
 
138
.B XmNlabelType is
 
139
.BR XmSTRING .
 
140
If this value is
 
141
.SM NULL,
 
142
it is initialized by converting the name of the
 
143
widget to a compound string. Refer to
 
144
.B XmString(3X)
 
145
for more information on the creation and structure of compound strings.
 
146
.LI XmNlabelTextAlignment
 
147
Specifies the text alignment for the caption label. This resource is
 
148
only useful for multi line caption labels. Valid values are:
 
149
.B XmALIGNMENT_BEGINNING
 
150
left alignment causes the left sides of the lines of text to be 
 
151
vertically aligned.
 
152
.B XmALIGNMENT_CENTER
 
153
center alignment causes the centers of the lines of text to be vertically
 
154
aligned.
 
155
.B XmALIGNMENT_END
 
156
right alignment causes the right sides of the
 
157
lines of text to be vertically aligned.
 
158
.LI XmNlabelType
 
159
Specifies the caption label type. Valid values are:
 
160
.B XmSTRING
 
161
- the caption label will display the
 
162
.BR XmNlabelString .
 
163
.B XmPIXMAP
 
164
- the caption label will display the
 
165
.BR XmNlabelPixmap .
 
166
.PP
 
167
.SS "Inherited Resources"
 
168
The following table lists the resources which
 
169
.B XbaeCaption
 
170
inherits from
 
171
it's superclasses
 
172
.BR XmManager ,
 
173
.B Compositeand
 
174
.BR Core .
 
175
For a complete
 
176
description of each resource, refer to the man page for that superclass.
 
177
The codes in the "Access" column indicate whether the given resource can
 
178
be set at creation time (C), or set by using XtSetValues (S), or
 
179
retrieved by using XtGetValues (G).
 
180
.LP
 
181
.TS
 
182
expand box;
 
183
c s s s s
 
184
lb | lb | lb | lb | lb
 
185
lp8 | lp8 | lp8 | lp8 | lp8 .
 
186
XmManager Resource Set
 
187
_
 
188
Name    Class   Type    Default Access
 
189
=
 
190
XmNbottomShadowColor    XmCBottomShadowColor    Pixel   dynamic CSG
 
191
_
 
192
XmNbottomShadowPixmap   XmCBottomShadowPixmap   Pixmap  XmUNSPECIFIED_PIXMAP    CSG
 
193
_
 
194
XmNforeground   XmCForeground   Pixel   dynamic CSG
 
195
_
 
196
XmNhelpCallback XmCCallback     Callback        NULL    CSG
 
197
_
 
198
XmNhighlightColor       XmCHighlightColor       Pixel   dynamic CSG
 
199
_
 
200
XmNhighlightPixmap      XmCHighlightPixmap      Pixmap  dynamic CSG
 
201
_
 
202
XmNnavigationType       XmCNavigationType       XmNavigationType        XmTAB_GROUP     CSG
 
203
_
 
204
XmNshadowThickness      XmCShadowThickness      Dimension       2       CSG
 
205
_
 
206
XmNstringDirection      XmCStringDirection      XmStringDirection       dynamic CG
 
207
_
 
208
XmNtopShadowColor       XmCTopShadowColor       Pixel   dynamic CSG
 
209
_
 
210
XmNtopShadowPixmap      XmCTopShadowPixmap      Pixmap  dynamic CSG
 
211
_
 
212
XmNtraversalOn  XmCTraversalOn  Boolean True    CSG
 
213
_
 
214
XmNunitType     XmCUnitType     UnsignedChar    dynamic CSG
 
215
_
 
216
XmNuserData     XmCUserData     Pointer NULL    CSG
 
217
.TE
 
218
.LP
 
219
.sp
 
220
.TS
 
221
expand box;
 
222
c s s s s
 
223
lb | lb | lb | lb | lb
 
224
lp8 | lp8 | lp8 | lp8 | lp8 .
 
225
Composite Resource Set
 
226
=
 
227
Name    Class   Type    Default Access
 
228
_
 
229
XmNchildren     XmCReadOnly     WidgetList      private G
 
230
_
 
231
XmNinsertPosition       XmCInsertPosition       Function        NULL    CSG
 
232
_
 
233
XmNnumChildren  XmCReadOnly     Cardinal        4       G
 
234
.TE
 
235
.LP
 
236
.sp
 
237
.TS
 
238
expand box;
 
239
c s s s s
 
240
lb | lb | lb | lb | lb
 
241
lp8 | lp8 | lp8 | lp8 | lp8 .
 
242
Core Resource Set
 
243
=
 
244
Name    Class   Type    Default Access
 
245
_
 
246
XmNaccelerators XmCAccelerators AcceleratorTable        NULL    CSG
 
247
_
 
248
XmNancestorSensitive    XmCSensitive    Boolean dynamic CSG
 
249
_
 
250
XmNbackground   XmCBackground   Pixel   dynamic G
 
251
_
 
252
XmNbackgroundPixmap     XmCPixmap       Pixmap  XmUNSPECIFIED_PIXMAP    CSG
 
253
_
 
254
XmNborderColor  XmCBorderColor  Pixel   XtDefaultForeground     CSG
 
255
_
 
256
XmNborderPixmap XmCPixmap       Pixmap  XmUNSPECIFIED_PIXMAP    CSG
 
257
_
 
258
XmNborderWidth  XmCBorderWidth  Dimension       0       CSG
 
259
_
 
260
XmNcolormap     XmCColormap     Colormap        dynamic CG
 
261
_
 
262
XmNdepth        XmCDepth        Int     dynamic CG
 
263
_
 
264
XmNdestroyCallback      XmCCallback     Callback        NULL    CSG
 
265
_
 
266
XmNheight       XmCHeight       Dimension       dynamic CSG
 
267
_
 
268
XmNinitialResourcesPersistent   XmCInitialResourcesPersistent   Boolean True    CG
 
269
_
 
270
XmNmappedWhenManaged    XmCMappedWhenManaged    Boolean True    CSG
 
271
_
 
272
XmNscreen       XmCScreen       Screen  dynamic CG
 
273
_
 
274
XmNsensitive    XmCSensitive    Boolean True    CSG
 
275
_
 
276
XmNtranslations XmCTranslations TranslationTable        internal        CSG
 
277
_
 
278
XmNwidth        XmCWidth        Dimension       dynamic CSG
 
279
_
 
280
XmNx    XmCPosition     Position        0       CSG
 
281
_
 
282
XmNy    XmCPosition     Position        0       CSG
 
283
.TE
 
284
.sp
 
285
.SS Translations
 
286
.B XbaeCaption inherits translations from
 
287
.BR XmManager .
 
288
.SS "Type Converters"
 
289
.sp
 
290
.PP
 
291
In addition to the standard type converters registered by Xt and Motif,
 
292
.B XbaeCaption
 
293
registers the following additional type converters:
 
294
.IP \fCCvtStringToLabelAlignment(\|)\fP
 
295
Converts a String to the enumerated
 
296
.B XbaeLabelAlignment
 
297
type. The
 
298
Strings
 
299
.BR TopOrLeft ,
 
300
.B Top 
 
301
and
 
302
.B Left
 
303
are converted to
 
304
.BR XbaeAlignmentTopOrLeft .
 
305
The String
 
306
.B Center
 
307
is converted to
 
308
.BR XbaeAlignmentCenter .
 
309
The Strings
 
310
.BR BottomOrRight ,
 
311
.B Bottom
 
312
and
 
313
.B Right
 
314
are converted to
 
315
.BR XbaeAlignmentBottomOrRight .
 
316
This converter allows the
 
317
.B XmNlabelAlignment
 
318
resource to be specified in a resource file. The converter is case
 
319
insensitive.
 
320
.IP \fCCvtStringToLabelPosition(\|)\fP
 
321
Converts a String to the enumerated
 
322
.B XbaeLabelPosition
 
323
type. The String
 
324
.B Left
 
325
is converted to
 
326
.BR XbaePositionLeft .
 
327
The String
 
328
.B Right
 
329
is converted to
 
330
.BR XbaePositionRight .
 
331
The String
 
332
.B Top is converted to
 
333
.BR XbaePositionTop .
 
334
The String
 
335
.B Bottom is converted to
 
336
.BR XbaePositionBottom .
 
337
This converter allows the
 
338
.B XmNlabelPosition
 
339
resource to be specified in a resource file. The converter is case
 
340
insensitive.
 
341
.sp
 
342
.SS "Public Functions"
 
343
.sp
 
344
The following external entry points to
 
345
.B XbaeCaption
 
346
class methods are
 
347
defined:
 
348
.sp
 
349
.ne 6
 
350
.B XbaeCreateCaption(\|)
 
351
.PP
 
352
.RS
 
353
.TS
 
354
l s s
 
355
l l li .
 
356
Widget XbaeCreateCaption(\|)
 
357
        Widget  parent;
 
358
        String  name;
 
359
        ArgList arglist;
 
360
        Cardinal        argcount;
 
361
.TE
 
362
.sp
 
363
.cI parent
 
364
Specifies the parent widget ID.
 
365
.cI name
 
366
Specifies the name of the created widget
 
367
.cI arglist
 
368
Specifies the argument list
 
369
.cI argcount
 
370
Specifies the number of attribute/value pairs in the argument list (arglist)
 
371
.PP
 
372
.B XbaeCreateCaption(\|)
 
373
creates an instance of an XbaeCaption widget and returns the associated
 
374
widget ID.
 
375
.PP
 
376
.SS "Virtual Bindings"
 
377
.sp
 
378
The bindings for virtual keys are vendor specific. For information about
 
379
bindings for virtual buttons and keys, see
 
380
.BR VirtualBindings(3X) .
 
381
.SH AUTHOR
 
382
.B Andrew Wason,
 
383
Bellcore, Piscataway NJ; author
 
384
.br
 
385
(aw@bae.bellcore.com)
 
386
.sp
 
387
.B Andrew Lister;
 
388
current maintainer
 
389
.br
 
390
(lister@syd.net.au)
 
391
.sp
 
392
.SH RELEASE
 
393
.sp
 
394
This document describes XbaeCaption from Xbae Version 4.6.
 
395
.SH "SEE ALSO"
 
396
.B Core(3X), Composite(3X), XmManager(3X), XmLabel(3X)
 
397
.SH "Notice of Limitation"
 
398
.sp
 
399
Bellcore, previous and current maintainers of the Xbae widgets
 
400
(collectively 'authors') provide this information solely
 
401
to professionals who have the appropriate degree of experience to
 
402
understand and interpret its contents in accordance with generally
 
403
accepted engineering or other professional standards and applicable
 
404
regulations. No recommendations as to products or vendors is made or
 
405
should be implied.
 
406
.PP
 
407
While the information contained herein has been prepared from sources
 
408
deemed to be reliable, the authors reserve the right to revise the
 
409
information without notice, but have no obligation to do so. Unless the
 
410
recipient has been expressly granted a license by Bellcore under
 
411
separate applicable written agreement with Bellcore, no license,
 
412
expressed or implied, is granted under any patents, copyrights or other
 
413
intellectual property rights. Use of the information is at your
 
414
discretion and shall not be deemed an inducement by Bellcore to infringe
 
415
any existing or later-issued patent, copyrights or other intellectual
 
416
property right.
 
417
.PP
 
418
THE AUTHORS MAKE NO REPRESENTATIONS AND EXTENDS NO WARRANTIES, EXPRESS OR
 
419
IMPLIED, WITH RESPECT TO THE INFORMATION, INCLUDING, BUT NOT LIMITED TO,
 
420
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR ANY PARTICULAR
 
421
PURPOSE, AND THE WARRANTY AGAINST INFRINGEMENT OF PATENTS OR OTHER
 
422
INTELLECTUAL PROPERTY RIGHTS. THE INFORMATION IS PROVIDED ``AS IS'', AND
 
423
IN NO EVENT SHALL THE AUTHORS OR ANY OF ITS AFFILIATES BE LIABLE FOR ANY
 
424
DAMAGES, INCLUDING ANY LOST PROFITS OR OTHER INCIDENTAL OR CONSEQUENTIAL
 
425
DAMAGES RELATING TO THE INFORMATION.
 
426
.PP
 
427
Copyright 1991 Bellcore.  All Rights Reserved.
 
428
Copyright 1995-99 Andrew Lister
 
429
All Rights Reserved.
 
430
.sp 3
 
431
The above no warranty extends to all additions and contributions.  No
 
432
contributor shall be held liable; this work is provided ``as is''.  If
 
433
this is a problem for you, then don't use this software.