← Back to branch summary

~ubuntu-branches/ubuntu/quantal/openmotif/quantal

« back to all changes in this revision

Viewing changes to doc/man/man3/XmIconGadget.3

  • Committer: Bazaar Package Importer
  • Author(s): Stefan Bauer
  • Date: 2010-06-23 12:12:31 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20100623121231-u89gxdp51sg9wjj2
Tags: 2.3.0-1
http://bugs.debian.org/379258
http://bugs.debian.org/494375
http://bugs.debian.org/288537
* New Maintainer (Closes: #379258) 
* Acknowledge NMU changes
* New upstream release (Closes: #494375)
* Get rid of security patches as they are already part of new upstream
  release (00-xpmvuln.openmotif.patch, 342092-CVE-2005-3964.patch)
* Bump Standards to 3.8.4
* Added {misc:Depends} to make the package lintian cleaner
* Fix weak-library-dev-dependency by adding ${binary:Version}) for the
  -dev Package of openmotif
* Let package depend on autotools-dev to use newer autotools-helper-files
* Work around an autoconf-bug (Gentoo-Bug #1475)
* Added Client-side anti-aliased fonts support via XFT
* Added UTF-8 and UTF8_STRING atom support
* Ability to show text and pixmaps in Label, LabelGadget and all
  derived widgets
* Support of PNG/JPEG image formats in the same way as XPM is supported
* Increase FILE_OFFSET_BITS to 64 to show files >2GB in file-selector
  Idea taken from Magne Oestlyngen (Closes: #288537)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/man3/XmIconGadget.3
 
1
'\" t
 
2
...\" IconGadg.sgm /main/13 1996/09/08 20:47:14 rws $
 
3
.de P!
 
4
.fl
 
5
\!!1 setgray
 
6
.fl
 
7
\\&.\"
 
8
.fl
 
9
\!!0 setgray
 
10
.fl                     \" force out current output buffer
 
11
\!!save /psv exch def currentpoint translate 0 0 moveto
 
12
\!!/showpage{}def
 
13
.fl                     \" prolog
 
14
.sy sed -e 's/^/!/' \\$1\" bring in postscript file
 
15
\!!psv restore
 
16
.
 
17
.de pF
 
18
.ie     \\*(f1 .ds f1 \\n(.f
 
19
.el .ie \\*(f2 .ds f2 \\n(.f
 
20
.el .ie \\*(f3 .ds f3 \\n(.f
 
21
.el .ie \\*(f4 .ds f4 \\n(.f
 
22
.el .tm ? font overflow
 
23
.ft \\$1
 
24
..
 
25
.de fP
 
26
.ie     !\\*(f4 \{\
 
27
.       ft \\*(f4
 
28
.       ds f4\"
 
29
'       br \}
 
30
.el .ie !\\*(f3 \{\
 
31
.       ft \\*(f3
 
32
.       ds f3\"
 
33
'       br \}
 
34
.el .ie !\\*(f2 \{\
 
35
.       ft \\*(f2
 
36
.       ds f2\"
 
37
'       br \}
 
38
.el .ie !\\*(f1 \{\
 
39
.       ft \\*(f1
 
40
.       ds f1\"
 
41
'       br \}
 
42
.el .tm ? font underflow
 
43
..
 
44
.ds f1\"
 
45
.ds f2\"
 
46
.ds f3\"
 
47
.ds f4\"
 
48
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 
 
49
.TH "XmIconGadget" "library call"
 
50
.SH "NAME"
 
51
\fBXmIconGadget\fR \(em The IconGadget widget class
 
52
.iX "XmIconGadget"
 
53
.iX "iconGadget" "IconGadget"
 
54
.SH "SYNOPSIS"
 
55
.PP
 
56
.nf
 
57
#include <Xm/IconG\&.h>
 
58
.fi
 
59
.SH "DESCRIPTION"
 
60
.PP
 
61
IconGadget is an instantiable widget used to display both text and a pixmap
 
62
in various combinations\&.
 
63
Other widgets that hold the \fBXmQTcontainer\fP trait, such as
 
64
Container, can use IconGadget to represent objects\&.
 
65
.PP
 
66
IconGadget text is a compound string\&. If no text is supplied, then
 
67
the compound string is generated from the gadget name\&. IconGadget
 
68
text is placed relative to the type of associated pixmap\&.
 
69
.PP
 
70
Depending upon the \fBXmNviewType\fP resource, IconGadget can display
 
71
two views:
 
72
.IP "\fBXmLARGE_ICON\fP" 10
 
73
The IconGadget text string is displayed below the
 
74
pixmap, and centered\&.
 
75
.IP "\fBXmSMALL_ICON\fP" 10
 
76
The IconGadget text string is placed on the side of the small icon, in the
 
77
widget\&'s \fBXmNlayoutDirection\fP\&.
 
78
.PP
 
79
A bitmap mask can be supplied for each pixmap to
 
80
clip the pixmap into some shape other than a rectangle\&. The
 
81
\fBXmNlargeIconMask\fP and \fBXmNsmallIconMask\fP resources specify
 
82
the large and small bitmap masks respectively\&. Visual emphasis for
 
83
the IconGadget is
 
84
provided with the \fBXmNvisualEmphasis\fP resource\&.
 
85
IconGadget\&'s \fBXmNdetail\fP and \fBXmNdetailCount\fP resources provide
 
86
a detail view for IconGadgets, enabling the display of Strings alongside the
 
87
IconGadget\&. The exact layout ordering of the strings depends on the
 
88
associated containing widget\&.
 
89
.PP
 
90
IconGadget uses the \fBXmQTcontainer\fP and
 
91
\fBXmQTspecifyRenderTable\fP traits, and
 
92
holds the \fBXmQTcareParentVisual\fP and \fBXmQTcontainerItem\fP traits\&.
 
93
.SS "Classes"
 
94
.PP
 
95
IconGadget inherits behaviour, resources, and traits from \fBObject,
 
96
RectObject\fP,
 
97
and \fBXmGadget\fP classes\&.
 
98
.PP
 
99
The class pointer is \fBxmIconGadgetClass\fP\&.
 
100
.PP
 
101
The class name is \fBXmIconGadget\fR\&.
 
102
.SS "New Resources"
 
103
.PP
 
104
The following table defines a set of widget resources used by the
 
105
programmer to specify data\&. The programmer can also set the resource
 
106
values for the inherited classes to set attributes for this widget\&.
 
107
To reference a resource by name or by class in a \fB\&.Xdefaults\fP file,
 
108
remove the \fBXmN\fP or \fBXmC\fP prefix and use the remaining letters\&.
 
109
To specify one of the defined values for a resource in a \fB\&.Xdefaults\fP
 
110
file, remove the \fBXm\fP prefix and use the remaining letters (in
 
111
either lowercase or uppercase, but include any underscores between
 
112
words)\&. The codes in the access column indicate whether the given resource
 
113
can be set at creation time (C), set by using \fBXtSetValues\fP
 
114
(S), retrieved by using \fBXtGetValues\fP (G), or is not
 
115
applicable (N/A)\&.
 
116
.TS
 
117
tab() box;
 
118
c s s s s
 
119
l| l| l| l| l.
 
120
\fBXmIconGadget Resource Set\fP
 
121
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
 
122
_____
 
123
XmalignmentXmCAlignmentunsigned charXmALIGNMENT_CENTERCSG
 
124
_____
 
125
XmNdetailXmCDetailXmStringTableNULLCSG
 
126
_____
 
127
XmNdetailCountXmCDetailCountCardinal0CSG
 
128
_____
 
129
XmNfontListXmCFontListXmFontListNULLCSG
 
130
_____
 
131
XmNlabelStringXmCXmStringXmStringdynamicCSG
 
132
_____
 
133
XmNlargeIconMaskXmCIconMaskPixmapdynamicCSG
 
134
_____
 
135
XmNlargeIconPixmapXmCIconPixmapPixmapXmUNSPECIFIED_PIXMAPCSG
 
136
_____
 
137
XmNmarginHeightXmCMarginHeightDimension2CSG
 
138
_____
 
139
XmNmarginWidthXmCMarginWidthDimension2CSG
 
140
_____
 
141
XmNrenderTableXmCRenderTableXmRenderTabledynamicCSG
 
142
_____
 
143
XmNsmallIconMaskXmCIconMaskPixmapdynamicCSG
 
144
_____
 
145
XmNsmallIconPixmapXmCIconPixmapPixmapXmUNSPECIFIED_PIXMAPCSG
 
146
_____
 
147
XmNviewTypeXmCViewTypeunsigned charXmLARGE_ICONCSG
 
148
_____
 
149
XmNvisualEmphasisXmCVisualEmphasisunsigned charXmNOT_SELECTEDCSG
 
150
_____
 
151
XmNspacingXmCSpacingDimension4CSG
 
152
_____
 
153
.TE
 
154
.IP "\fBXmNalignment\fP" 10
 
155
Specifies the horizontal alignment of the pixmap with
 
156
respect to the label when the icon is in
 
157
\fBLARGE_ICON\fP
 
158
view\&. Valid values are
 
159
\fBXmALIGNMENT_BEGINNING\fP,
 
160
\fBXmALIGNMENT_CENTER\fP,
 
161
and \fBXmALIGNMENT_END\fP\&.
 
162
.IP "\fBXmNdetail\fP" 10
 
163
Specifies an array of \fBXmString\fRs that are the detail information
 
164
associated with the gadget\&.
 
165
.IP "\fBXmNdetailCount\fP" 10
 
166
Specifies the size of the \fBXmNdetail\fP array\&.
 
167
.IP "\fBXmNfontList\fP" 10
 
168
Specifies the font list associated with \fBXmIconGadget\fR\&. The font list
 
169
is an obsolete construct, and has been superseded by the render table\&.
 
170
It is included for compatibility with earlier versions of Motif, and
 
171
for applications that do not easily support render tables\&. The
 
172
default font list is derived from the default render table, and if
 
173
both a font list and a render table are specified, the render table
 
174
takes precedence\&.
 
175
.IP "\fBXmNlabelString\fP" 10
 
176
Specifies the compound string\&.
 
177
If this value is NULL, it is initialized by converting the name of the
 
178
gadget to a compound string\&.
 
179
Refer to \fBXmString\fP(3)
 
180
for more information on the
 
181
creation and structure of compound strings\&.
 
182
.IP "\fBXmNlargeIconMask\fP" 10
 
183
Specifies the icon mask used when \fBXmNviewType\fP is \fBXmLARGE_ICON\fP\&.
 
184
.IP "\fBXmNlargeIconPixmap\fP" 10
 
185
Specifies the pixmap when \fBXmNviewType\fP is \fBXmLARGE_ICON\fP\&. If
 
186
this resource\&'s value is \fBXmUNSPECIFIED_PIXMAP\fP, there is no
 
187
pixmap\&. If a large
 
188
icon pixmap is specified, and if during conversion an associated mask
 
189
can be fetched, then the
 
190
\fBXmNlargeIconMask\fP resource is set to that mask\&.
 
191
.IP "\fBXmNmarginHeight\fP" 10
 
192
Specifies the amount of vertical space between the highlight
 
193
and the inside (pixmap and label)\&.
 
194
.IP "\fBXmNmarginWidth\fP" 10
 
195
Specifies the amount of horizontal space between the highlight
 
196
and the inside (pixmap and label)\&.
 
197
.IP "\fBXmNrenderTable\fP" 10
 
198
Specifies the \fBXmRenderTable\fR of the text used in the gadget\&.
 
199
If \fBXmNrenderTable\fP is NULL when the IconGadget is created, the parent\&'s
 
200
render table resource value is used if there is a render table\&. If
 
201
the parent does not have a render table,
 
202
the parent hierarchy of the widget is
 
203
searched for a widget that
 
204
holds the \fBXmQTspecifyRenderTable\fP trait\&.
 
205
If such an ancestor is found, the render table is initialized to the
 
206
\fBXmLABEL_RENDER_TABLE\fP value of the ancestor widget\&. If no such widget
 
207
is found, the default is implementation dependent\&.
 
208
Refer to
 
209
\fBXmRenderTable\fP(3) for more information on the creation and
 
210
structure of a \fBXmRenderTable\fR\&.
 
211
If both a render table and a font list are specified, the render table
 
212
will take precedence\&.
 
213
.IP "\fBXmNsmallIconMask\fP" 10
 
214
Specifies the icon mask used when \fBXmNviewType\fP is \fBXmSMALL_ICON\fP\&.
 
215
.IP "\fBXmNsmallIconPixmap\fP" 10
 
216
Specifies the pixmap when \fBXmNviewType\fP is \fBXmSMALL_ICON\fP\&.
 
217
If
 
218
this resource\&'s value is \fBXmUNSPECIFIED_PIXMAP\fP, there is no
 
219
pixmap\&. If a small
 
220
icon pixmap is specified, and if during conversion an associated mask
 
221
can be fetched, then the
 
222
\fBXmNsmallIconMask\fP resource is set to that mask\&.
 
223
.IP "\fBXmNspacing\fP" 10
 
224
Specifies the amount of space between the pixmap and
 
225
the label parts of the icon\&.
 
226
.IP "\fBXmNviewType\fP" 10
 
227
Specifies the view (combination of pixmaps/text) that will be displayed\&.
 
228
If the IconGadget is a child of a Container widget, however, then the
 
229
specification of this resource will be taken from the Container\(em
 
230
if Container\&'s \fBXmNentryViewType\fP is either \fBXmLARGE_ICON\fP or
 
231
\fBXmSMALL_ICON\fP, then IconGadget\&'s \fBXmNviewType\fP takes that value;
 
232
otherwise, the default is \fBXmLARGE_ICON\fP\&.
 
233
This resource is set to one of the following:
 
234
.RS
 
235
.IP "\fBXmLARGE_ICON\fP" 10
 
236
The pixmap specified by \fBXmNlargeIconPixmap\fP is
 
237
displayed with the \fBXmNlabelString\fP beneath it\&.
 
238
.IP "\fBXmSMALL_ICON\fP" 10
 
239
The pixmap specified by \fBXmNsmallIconPixmap\fP is
 
240
displayed with the \fBXmNlabelString\fP displayed in the direction of the
 
241
\fBXmNlayoutDirection\fP resource\&.
 
242
.RE
 
243
.IP "\fBXmNvisualEmphasis\fP" 10
 
244
Specifies the visual state of the IconGadget\&. If the IconGadget is in a
 
245
selected state
 
246
all visuals are displayed using the Container \fBXmNselectColor\fP
 
247
resource\&.
 
248
It is set to one of the following:
 
249
.RS
 
250
.IP "\fBXmSELECTED\fP" 10
 
251
The IconGadget is in the selected state and displays
 
252
the appropriate visuals\&.
 
253
.IP "\fBXmNOT_SELECTED\fP" 10
 
254
The IconGadget is not in the selected state\&.
 
255
.RE
 
256
.SS "Inherited Resources"
 
257
.PP
 
258
IconGadget inherits behavior and resources from the
 
259
superclasses described in the following tables\&.
 
260
For a complete description of each resource, refer to the
 
261
reference page for that superclass\&.
 
262
.TS
 
263
tab() box;
 
264
c s s s s
 
265
l| l| l| l| l.
 
266
\fBXmGadget Resource Set\fP
 
267
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
 
268
_____
 
269
XmNbackgroundXmCBackgroundPixeldynamicCSG
 
270
_____
 
271
XmNbackgroundPixmapXmCPixmapPixmapXmUNSPECIFIED_PIXMAPCSG
 
272
_____
 
273
XmNbottomShadowColorXmCBottomShadowColorPixeldynamicCSG
 
274
_____
 
275
XmNbottomShadowPixmapXmCBottomShadowPixmapPixmapdynamicCSG
 
276
_____
 
277
XmNhelpCallbackXmCCallbackXtCallbackListNULLC
 
278
_____
 
279
XmNforegroundXmCForegroundPixeldynamicCSG
 
280
_____
 
281
XmNhighlightColorXmCHighlightColorPixeldynamicCSG
 
282
_____
 
283
XmNhighlightOnEnterXmCHighlightOnEnterBooleanFalseCSG
 
284
_____
 
285
XmNhighlightPixmapXmCHighlightPixmapPixmapdynamicCSG
 
286
_____
 
287
XmNhighlightThicknessXmCHighlightThicknessDimension0CSG
 
288
_____
 
289
XmNlayoutDirectionXmNCLayoutDirectionXmDirectiondynamicCG
 
290
_____
 
291
XmNnavigationTypeXmCNavigationTypeXmNavigationTypeXmNONECSG
 
292
_____
 
293
XmNshadowThicknessXmCShadowThicknessDimension0CSG
 
294
_____
 
295
XmNtopShadowColorXmCTopShadowColorPixeldynamicCSG
 
296
_____
 
297
XmNtopShadowPixmapXmCTopShadowPixmapPixmapdynamicCSG
 
298
_____
 
299
XmNtraversalOnXmCTraversalOnBooleanFalseCSG
 
300
_____
 
301
XmNunitTypeXmCUnitTypeunsigned chardynamicCSG
 
302
_____
 
303
XmNuserDataXmCUserDataXtPointerNULLCSG
 
304
_____
 
305
.TE
 
306
.TS
 
307
tab() box;
 
308
c s s s s
 
309
l| l| l| l| l.
 
310
\fBRectObj Resource Set\fP
 
311
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
 
312
_____
 
313
XmNancestorSensitiveXmCSensitiveBooleandynamicG
 
314
_____
 
315
XmNborderWidthXmCBorderWidthDimension0N/A
 
316
_____
 
317
XmNheightXmCHeightDimensiondynamicCSG
 
318
_____
 
319
XmNsensitiveXmCSensitiveBooleanTrueCSG
 
320
_____
 
321
XmNwidthXmCWidthDimensiondynamicCSG
 
322
_____
 
323
XmNxXmCPositionPosition0CSG
 
324
_____
 
325
XmNyXmCPositionPosition0CSG
 
326
_____
 
327
.TE
 
328
.TS
 
329
tab() box;
 
330
c s s s s
 
331
l| l| l| l| l.
 
332
\fBObject Resource Set\fP
 
333
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
 
334
_____
 
335
XmNdestroyCallbackXmCCallbackXtCallbackListNULLC
 
336
_____
 
337
.TE
 
338
.SS "Additional Behavior"
 
339
.PP
 
340
IconGadget has no behavior\&.
 
341
.SS "Virtual Bindings"
 
342
.PP
 
343
The bindings for virtual keys are vendor specific\&.
 
344
For information about bindings for virtual buttons and keys, see
 
345
\fBVirtualBindings\fP(3)\&.
 
346
.SS "Errors/Warnings"
 
347
.PP
 
348
The toolkit will display a warning if an incorrect value is given
 
349
for an enumeration resource\&.
 
350
.SH "RELATED"
 
351
.PP
 
352
\fBCore\fP(3),
 
353
\fBXmContainer\fP(3),
 
354
\fBXmCreateIconGadget\fP(3),
 
355
\fBXmGadget\fP(3),
 
356
\fBXmVaCreateIconGadget\fP(3), and
 
357
\fBXmVaCreateManagedIconGadget\fP(3)\&.