Label.xml revision 421c997b
1<sect1 id="Label_Widget">
2<title>Label Widget</title>
3<!-- .XS -->
4<!-- 	Label Widget -->
5<!-- .XE -->
6<!-- .IN "Label widget" "" "@DEF@" -->
7<literallayout class="monospaced">
8<!-- .TA 2.0i -->
9<!-- .ta 2.0i -->
10<!-- .sp -->
11Application header file	&lt;X11/Xaw/Label.h&gt;
12<!-- .IN "Label.h" "" -->
13Class header file	&lt;X11/Xaw/LabelP.h&gt;
14<!-- .IN "LabelP.h" "" -->
15Class	labelWidgetClass
16<!-- .IN "labelWidgetClass" "" -->
17Class Name	Label
18<!-- .IN "Label widget" "class name" -->
19Superclass	Simple
20<!-- .sp -->
21</literallayout>
22<para>
23<!-- .LP -->
24A Label widget holds a graphic displayed within a
25rectangular region of the screen.  The graphic may be a
26text string containing multiple lines of characters in an
278 bit or 16 bit character set (to be displayed with a
28<emphasis remap='I'>font</emphasis>), or in a multi-byte encoding (for use with a
29<emphasis remap='I'>fontset</emphasis>).  The graphic may also be a bitmap or
30pixmap.  The Label widget will allow its graphic to be
31left, right, or center justified.  Normally, this widget
32can be neither selected nor directly edited by the user.
33It is intended for use as an output device only.
34</para>
35<sect2 id='Label::Resources'>
36<title>Resources</title>
37<para>
38<!-- .LP -->
39When creating a Label widget instance, the following resources are
40retrieved from the argument list or from the resource database:
41</para>
42<para>
43<!-- .LP -->
44<!-- .IN "Label widget" "resources" -->
45<informaltable>
46  <tgroup cols='5' align='center'>
47  <colspec colname='c1'/>
48  <colspec colname='c2'/>
49  <colspec colname='c3'/>
50  <colspec colname='c4'/>
51  <colspec colname='c5'/>
52  <thead>
53    <row>
54      <entry>Name</entry>
55      <entry>Class</entry>
56      <entry>Type</entry>
57      <entry>Notes</entry>
58      <entry>Default Value</entry>
59    </row>
60  </thead>
61  <tbody>
62    <row>
63      <entry>accelerators</entry>
64      <entry>Accelerators</entry>
65      <entry>AcceleratorTable</entry>
66      <entry></entry>
67      <entry>NULL</entry>
68    </row>
69    <row>
70      <entry>ancestorSensitive</entry>
71      <entry>AncestorSensitive</entry>
72      <entry>Boolean</entry>
73      <entry>D</entry>
74      <entry>True</entry>
75    </row>
76    <row>
77      <entry>background</entry>
78      <entry>Background</entry>
79      <entry>Pixel</entry>
80      <entry></entry>
81      <entry>XtDefaultBackground</entry>
82    </row>
83    <row>
84      <entry>backgroundPixmap</entry>
85      <entry>Pixmap</entry>
86      <entry>Pixmap</entry>
87      <entry></entry>
88      <entry>XtUnspecifiedPixmap</entry>
89    </row>
90    <row>
91      <entry>bitmap</entry>
92      <entry>Bitmap</entry>
93      <entry>Pixmap</entry>
94      <entry></entry>
95      <entry>None</entry>
96    </row>
97    <row>
98      <entry>borderColor</entry>
99      <entry>BorderColor</entry>
100      <entry>Pixel</entry>
101      <entry></entry>
102      <entry>XtDefaultForeground</entry>
103    </row>
104    <row>
105      <entry>borderPixmap</entry>
106      <entry>Pixmap</entry>
107      <entry>Pixmap</entry>
108      <entry></entry>
109      <entry>XtUnspecifiedPixmap</entry>
110    </row>
111    <row>
112      <entry>borderWidth</entry>
113      <entry>BorderWidth</entry>
114      <entry>Dimension</entry>
115      <entry></entry>
116      <entry>1</entry>
117    </row>
118    <row>
119      <entry>colormap</entry>
120      <entry>Colormap</entry>
121      <entry>Colormap</entry>
122      <entry></entry>
123      <entry>Parent's Colormap</entry>
124    </row>
125    <row>
126      <entry>cursor</entry>
127      <entry>Cursor</entry>
128      <entry>Cursor</entry>
129      <entry></entry>
130      <entry>None</entry>
131    </row>
132    <row>
133      <entry>cursorName</entry>
134      <entry>Cursor</entry>
135      <entry>String</entry>
136      <entry></entry>
137      <entry>NULL</entry>
138    </row>
139    <row>
140      <entry>depth</entry>
141      <entry>Depth</entry>
142      <entry>int</entry>
143      <entry>C</entry>
144      <entry>Parent's Depth</entry>
145    </row>
146    <row>
147      <entry>destroyCallback</entry>
148      <entry>Callback</entry>
149      <entry>XtCallbackList</entry>
150      <entry></entry>
151      <entry>NULL</entry>
152    </row>
153    <row>
154      <entry>encoding</entry>
155      <entry>Encoding</entry>
156      <entry>UnsignedChar</entry>
157      <entry></entry>
158      <entry>XawTextEncoding8bit</entry>
159    </row>
160    <row>
161      <entry>font</entry>
162      <entry>Font</entry>
163      <entry>XFontStruct</entry>
164      <entry></entry>
165      <entry>XtDefaultFont</entry>
166    </row>
167    <row>
168      <entry>fontSet</entry>
169      <entry>FontSet</entry>
170      <entry>XFontSet</entry>
171      <entry></entry>
172      <entry>XtDefaultFontSet</entry>
173    </row>
174    <row>
175      <entry>foreground</entry>
176      <entry>Foreground</entry>
177      <entry>Pixel</entry>
178      <entry></entry>
179      <entry>XtDefaultForeground</entry>
180    </row>
181    <row>
182      <entry>height</entry>
183      <entry>Height</entry>
184      <entry>Dimension</entry>
185      <entry>A</entry>
186      <entry>graphic height + 2 * <function>internalHeight</function></entry>
187    </row>
188    <row>
189      <entry>insensitiveBorder</entry>
190      <entry>Insensitive</entry>
191      <entry>Pixmap</entry>
192      <entry></entry>
193      <entry>GreyPixmap</entry>
194    </row>
195    <row>
196      <entry>internalHeight</entry>
197      <entry>Height</entry>
198      <entry>Dimension</entry>
199      <entry></entry>
200      <entry>2</entry>
201    </row>
202    <row>
203      <entry>internalWidth</entry>
204      <entry>Width</entry>
205      <entry>Dimension</entry>
206      <entry></entry>
207      <entry>4</entry>
208    </row>
209    <row>
210      <entry>international</entry>
211      <entry>International</entry>
212      <entry>Boolean</entry>
213      <entry>C</entry>
214      <entry>False</entry>
215    </row>
216    <row>
217      <entry>justify</entry>
218      <entry>Justify</entry>
219      <entry>Justify</entry>
220      <entry></entry>
221      <entry>XtJustifyCenter (center)</entry>
222    </row>
223    <row>
224      <entry>label</entry>
225      <entry>Label</entry>
226      <entry>String</entry>
227      <entry></entry>
228      <entry>name of widget</entry>
229    </row>
230    <row>
231      <entry>leftBitmap</entry>
232      <entry>LeftBitmap</entry>
233      <entry>Bitmap</entry>
234      <entry></entry>
235      <entry>None</entry>
236    </row>
237    <row>
238      <entry>mappedWhenManaged</entry>
239      <entry>MappedWhenManaged</entry>
240      <entry>Boolean</entry>
241      <entry></entry>
242      <entry>True</entry>
243    </row>
244    <row>
245      <entry>pointerColor</entry>
246      <entry>Foreground</entry>
247      <entry>Pixel</entry>
248      <entry></entry>
249      <entry>XtDefaultForeground</entry>
250    </row>
251    <row>
252      <entry>pointerColorBackground</entry>
253      <entry>Background</entry>
254      <entry>Pixel</entry>
255      <entry></entry>
256      <entry>XtDefaultBackground</entry>
257    </row>
258    <row>
259      <entry>resize</entry>
260      <entry>Resize</entry>
261      <entry>Boolean</entry>
262      <entry></entry>
263      <entry>True</entry>
264    </row>
265    <row>
266      <entry>screen</entry>
267      <entry>Screen</entry>
268      <entry>Screen</entry>
269      <entry>R</entry>
270      <entry>Parent's Screen</entry>
271    </row>
272    <row>
273      <entry>sensitive</entry>
274      <entry>Sensitive</entry>
275      <entry>Boolean</entry>
276      <entry></entry>
277      <entry>True</entry>
278    </row>
279    <row>
280      <entry>translations</entry>
281      <entry>Translations</entry>
282      <entry>TranslationTable</entry>
283      <entry></entry>
284      <entry>See above</entry>
285    </row>
286    <row>
287      <entry>width</entry>
288      <entry>Width</entry>
289      <entry>Dimension</entry>
290      <entry>A</entry>
291      <entry>graphic width + 2 * <function>internalWidth</function></entry>
292    </row>
293    <row>
294      <entry>x</entry>
295      <entry>Position</entry>
296      <entry>Position</entry>
297      <entry></entry>
298      <entry>0</entry>
299    </row>
300    <row>
301      <entry>y</entry>
302      <entry>Position</entry>
303      <entry>Position</entry>
304      <entry></entry>
305      <entry>0</entry>
306    </row>
307  </tbody>
308  </tgroup>
309</informaltable>
310<!-- .Ac -->
311<!-- .As -->
312<!-- .Bg -->
313<!-- .Gp -->
314<!-- .Bm Bold -->
315<!-- .Bc -->
316<!-- .Bp -->
317<!-- .Bw -->
318<!-- .Cm -->
319<!-- .Cu -->
320<!-- .Cn -->
321<!-- .Dp -->
322<!-- .Dc -->
323<!-- .Le Bold -->
324<!-- .Lf Bold -->
325<!-- .Ls Bold -->
326<!-- .Lg Bold -->
327<!-- .Hw -->
328<!-- .Ib -->
329<!-- .Ih Bold -->
330<!-- .In -->
331<!-- .Ju Bold -->
332<!-- .La Bold -->
333<!-- .Ll Bold -->
334<!-- .Mm -->
335<!-- .Pf -->
336<!-- .Pb -->
337<!-- .Re Bold -->
338<!-- .Sc -->
339<!-- .Se -->
340<!-- .Tr -->
341<!-- .Xy -->
342
343</para>
344</sect2>
345</sect1>
346