1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="content-type">
<title>GTK+ Foundation Classes</title>
<link href="gfc.css" rel="stylesheet" type="text/css">
<meta content="The GFC Development Team" name="author">
<meta content="Core Library Reference Manual" name="description">
</head>
<body style="color: rgb(0, 0, 0); background-color: rgb(243, 244, 248);"
alink="#000099" link="#000099" vlink="#990099">
<table style="text-align: left; width: 1227px; height: 117px;"
border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td
style="text-align: center; background-color: rgb(255, 255, 255); width: 220px; vertical-align: top;"><img
alt="GFC Logo" src="../images/gfc.png"
style="width: 207px; height: 92px;"></td>
<td
style="text-align: center; background-color: rgb(87, 107, 152); vertical-align: middle;"><img
alt="GFC Title Logo" src="../images/gfc-title.png"
style="width: 418px; height: 76px;"><br>
</td>
</tr>
<tr>
<td
style="text-align: center; background-color: rgb(65, 77, 104); vertical-align: middle;"><big><span
style="color: rgb(255, 255, 153); font-weight: bold;">Reference Manual</span></big><br>
</td>
<td
style="text-align: center; background-color: rgb(148, 164, 200); vertical-align: middle;"><small
style="font-family: helvetica,arial,sans-serif;"><a
href="../html/index.html">Main Page</a> | <a
href="../html/namespaces.html">Namespace List</a> | <a
href="classes.html">Alphabetical List</a> | <a
href="../html/annotated.html">Class List</a> | <a
href="../html/files.html">File List</a></small><br>
</td>
</tr>
</tbody>
</table>
<small> </small>
</body>
</html>
<!-- Generated by Doxygen 1.3.8 -->
<h1>object.hh File Reference</h1>An AtkObject C++ wrapper interface. <a href="#_details">More...</a>
<p>
<code>#include <gfc/glib/object.hh></code><br>
<code>#include <<a class="el" href="util_8hh-source.html">gfc/atk/util.hh</a>></code><br>
<code>#include <atk/atkobject.h></code><br>
<code>#include <gfc/atk/inline/object.inl></code><br>
<p>
<a href="atk_2object_8hh-source.html">Go to the source code of this file.</a><h2>Namespaces</h2>
<ul>
<li>namespace <a class="elRef" doxygen="gfccore.tag:" href="namespaceGFC.html">GFC</a>
<li>namespace <a class="el" href="namespaceGFC_1_1Atk.html">GFC::Atk</a>
</ul>
<h2>Classes</h2>
<ul>
<li>class <a class="el" href="classGFC_1_1Atk_1_1Object.html">GFC::Atk::Object</a>
<dl class="el"><dd class="mdescRight">An AtkObject C++ wrapper class. <a href="classGFC_1_1Atk_1_1Object.html#_details">More...</a><br></dl></ul>
<h2>Role Methods</h2>
<ul>
<li><a class="el" href="namespaceGFC_1_1Atk.html#a195">Role</a> <a class="el" href="namespaceGFC_1_1Atk.html#a176">role_register</a> (const String &name)
<dl class="el"><dd class="mdescRight">Registers the role specified by name. <a href="#a176"></a><br></dl><li>String <a class="el" href="namespaceGFC_1_1Atk.html#a177">role_get_name</a> (<a class="el" href="namespaceGFC_1_1Atk.html#a195">Role</a> role)
<dl class="el"><dd class="mdescRight">Gets the description string describing the Role <em>role</em>. <a href="#a177"></a><br></dl><li>String <a class="el" href="namespaceGFC_1_1Atk.html#a178">role_get_localized_name</a> (<a class="el" href="namespaceGFC_1_1Atk.html#a195">Role</a> role)
<dl class="el"><dd class="mdescRight">Gets the localized description string describing the Role <em>role</em>. <a href="#a178"></a><br></dl><li><a class="el" href="namespaceGFC_1_1Atk.html#a195">Role</a> <a class="el" href="namespaceGFC_1_1Atk.html#a179">role_for_name</a> (const String &name)
<dl class="el"><dd class="mdescRight">Get the Role type corresponding to a role <em>name</em>. <a href="#a179"></a><br></dl></ul>
<h2>Enumerations</h2>
<ul>
<li>enum <a class="el" href="namespaceGFC_1_1Atk.html#a195">Role</a> { <br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a2">ROLE_INVALID</a> = ATK_ROLE_INVALID,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a3">ROLE_ACCEL_LABEL</a> = ATK_ROLE_ACCEL_LABEL,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a4">ROLE_ALERT</a> = ATK_ROLE_ALERT,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a5">ROLE_ANIMATION</a> = ATK_ROLE_ANIMATION,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a6">ROLE_ARROW</a> = ATK_ROLE_ARROW,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a7">ROLE_CALENDAR</a> = ATK_ROLE_CALENDAR,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a8">ROLE_CANVAS</a> = ATK_ROLE_CANVAS,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a9">ROLE_CHECK_BOX</a> = ATK_ROLE_CHECK_BOX,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a10">ROLE_CHECK_MENU_ITEM</a> = ATK_ROLE_CHECK_MENU_ITEM,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a11">ROLE_COLOR_CHOOSER</a> = ATK_ROLE_COLOR_CHOOSER,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a12">ROLE_COLUMN_HEADER</a> = ATK_ROLE_COLUMN_HEADER,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a13">ROLE_COMBO_BOX</a> = ATK_ROLE_COMBO_BOX,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a14">ROLE_DATE_EDITOR</a> = ATK_ROLE_DATE_EDITOR,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a15">ROLE_DESKTOP_ICON</a> = ATK_ROLE_DESKTOP_ICON,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a16">ROLE_DESKTOP_FRAME</a> = ATK_ROLE_DESKTOP_FRAME,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a17">ROLE_DIAL</a> = ATK_ROLE_DIAL,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a18">ROLE_DIALOG</a> = ATK_ROLE_DIALOG,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a19">ROLE_DIRECTORY_PANE</a> = ATK_ROLE_DIRECTORY_PANE,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a20">ROLE_DRAWING_AREA</a> = ATK_ROLE_DRAWING_AREA,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a21">ROLE_FILE_CHOOSER</a> = ATK_ROLE_FILE_CHOOSER,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a22">ROLE_FILLER</a> = ATK_ROLE_FILLER,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a23">ROLE_FONT_CHOOSER</a> = ATK_ROLE_FONT_CHOOSER,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a24">ROLE_FRAME</a> = ATK_ROLE_FRAME,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a25">ROLE_GLASS_PANE</a> = ATK_ROLE_GLASS_PANE,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a26">ROLE_HTML_CONTAINER</a> = ATK_ROLE_HTML_CONTAINER,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a27">ROLE_ICON</a> = ATK_ROLE_ICON,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a28">ROLE_IMAGE</a> = ATK_ROLE_IMAGE,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a29">ROLE_INTERNAL_FRAME</a> = ATK_ROLE_INTERNAL_FRAME,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a30">ROLE_LABEL</a> = ATK_ROLE_LABEL,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a31">ROLE_LAYERED_PANE</a> = ATK_ROLE_LAYERED_PANE,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a32">ROLE_LIST</a> = ATK_ROLE_LIST,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a33">ROLE_LIST_ITEM</a> = ATK_ROLE_LIST_ITEM,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a34">ROLE_MENU</a> = ATK_ROLE_MENU,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a35">ROLE_MENU_BAR</a> = ATK_ROLE_MENU_BAR,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a36">ROLE_MENU_ITEM</a> = ATK_ROLE_MENU_ITEM,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a37">ROLE_OPTION_PANE</a> = ATK_ROLE_OPTION_PANE,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a38">ROLE_PAGE_TAB</a> = ATK_ROLE_PAGE_TAB,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a39">ROLE_PAGE_TAB_LIST</a> = ATK_ROLE_PAGE_TAB_LIST,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a40">ROLE_PANEL</a> = ATK_ROLE_PANEL,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a41">ROLE_PASSWORD_TEXT</a> = ATK_ROLE_PASSWORD_TEXT,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a42">ROLE_POPUP_MENU</a> = ATK_ROLE_POPUP_MENU,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a43">ROLE_PROGRESS_BAR</a> = ATK_ROLE_PROGRESS_BAR,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a44">ROLE_PUSH_BUTTON</a> = ATK_ROLE_PUSH_BUTTON,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a45">ROLE_RADIO_BUTTON</a> = ATK_ROLE_RADIO_BUTTON,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a46">ROLE_RADIO_MENU_ITEM</a> = ATK_ROLE_RADIO_MENU_ITEM,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a47">OLE_ROOT_PANE</a> = ATK_ROLE_ROOT_PANE,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a48">ROLE_ROW_HEADER</a> = ATK_ROLE_ROW_HEADER,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a49">ROLE_SCROLL_BAR</a> = ATK_ROLE_SCROLL_BAR,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a50">ROLE_SCROLL_PANE</a> = ATK_ROLE_SCROLL_PANE,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a51">ROLE_SEPARATOR</a> = ATK_ROLE_SEPARATOR,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a52">ROLE_SLIDER</a> = ATK_ROLE_SLIDER,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a53">ROLE_SPLIT_PANE</a> = ATK_ROLE_SPLIT_PANE,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a54">ROLE_SPIN_BUTTON</a> = ATK_ROLE_SPIN_BUTTON,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a55">ROLE_STATUSBAR</a> = ATK_ROLE_STATUSBAR,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a56">ROLE_TABLE</a> = ATK_ROLE_TABLE,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a57">ROLE_TABLE_CELL</a> = ATK_ROLE_TABLE_CELL,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a58">ROLE_TABLE_COLUMN_HEADER</a> = ATK_ROLE_TABLE_COLUMN_HEADER,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a59">ROLE_TABLE_ROW_HEADER</a> = ATK_ROLE_TABLE_ROW_HEADER,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a60">ROLE_TEAR_OFF_MENU_ITEM</a> = ATK_ROLE_TEAR_OFF_MENU_ITEM,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a61">ROLE_TERMINAL</a> = ATK_ROLE_TERMINAL,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a62">ROLE_TEXT</a> = ATK_ROLE_TEXT,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a63">ROLE_TOGGLE_BUTTON</a> = ATK_ROLE_TOGGLE_BUTTON,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a64">ROLE_TOOL_BAR</a> = ATK_ROLE_TOOL_BAR,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a65">ROLE_TOOL_TIP</a> = ATK_ROLE_TOOL_TIP,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a66">ROLE_TREE</a> = ATK_ROLE_TREE,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a67">ROLE_TREE_TABLE</a> = ATK_ROLE_TREE_TABLE,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a68">ROLE_UNKNOWN</a> = ATK_ROLE_UNKNOWN,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a69">ROLE_VIEWPORT</a> = ATK_ROLE_VIEWPORT,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a70">ROLE_WINDOW</a> = ATK_ROLE_WINDOW,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a71">ROLE_HEADER</a> = ATK_ROLE_HEADER,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a72">ROLE_FOOTER</a> = ATK_ROLE_FOOTER,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a73">ROLE_PARAGRAPH</a> = ATK_ROLE_PARAGRAPH,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a74">ROLE_RULER</a> = ATK_ROLE_RULER,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a75">ROLE_APPLICATION</a> = ATK_ROLE_APPLICATION,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a76">ROLE_AUTOCOMPLETE</a> = ATK_ROLE_AUTOCOMPLETE,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a77">ROLE_EDITBAR</a> = ATK_ROLE_EDITBAR,
<br>
<a class="el" href="namespaceGFC_1_1Atk.html#a195a78">ROLE_LAST_DEFINED</a> = ATK_ROLE_LAST_DEFINED
<br>
}
<dl class="el"><dd class="mdescRight">Describes the role of an object. <a href="#a195">More...</a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An AtkObject C++ wrapper interface.
<p>
Provides Object, the base object class for the Accessibility Toolkit API.<hr><h2>Enumeration Type Documentation</h2>
<a class="anchor" name="a195" doxytag="atk/object.hh::Role" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> enum <a class="el" href="namespaceGFC_1_1Atk.html#a195">Role</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Describes the role of an object.
<p>
<dl compact><dt><b>Enumeration values: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em><a class="anchor" name="a195a2" doxytag="ROLE_INVALID" ></a>ROLE_INVALID</em> </td><td>
Invalid role. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a3" doxytag="ROLE_ACCEL_LABEL" ></a>ROLE_ACCEL_LABEL</em> </td><td>
A label which represents an accelerator. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a4" doxytag="ROLE_ALERT" ></a>ROLE_ALERT</em> </td><td>
An object which is an alert to the user. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a5" doxytag="ROLE_ANIMATION" ></a>ROLE_ANIMATION</em> </td><td>
An object which is an animated image. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a6" doxytag="ROLE_ARROW" ></a>ROLE_ARROW</em> </td><td>
An arrow in one of the four cardinal directions. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a7" doxytag="ROLE_CALENDAR" ></a>ROLE_CALENDAR</em> </td><td>
An object that displays a calendar and allows the user to select a date. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a8" doxytag="ROLE_CANVAS" ></a>ROLE_CANVAS</em> </td><td>
An object that can be drawn into and is used to trap events. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a9" doxytag="ROLE_CHECK_BOX" ></a>ROLE_CHECK_BOX</em> </td><td>
A choice that can be checked or unchecked and provides a separate indicator for the current state. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a10" doxytag="ROLE_CHECK_MENU_ITEM" ></a>ROLE_CHECK_MENU_ITEM</em> </td><td>
A menu item with a check box. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a11" doxytag="ROLE_COLOR_CHOOSER" ></a>ROLE_COLOR_CHOOSER</em> </td><td>
A specialized dialog that lets the user choose a color. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a12" doxytag="ROLE_COLUMN_HEADER" ></a>ROLE_COLUMN_HEADER</em> </td><td>
The header for a column of data. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a13" doxytag="ROLE_COMBO_BOX" ></a>ROLE_COMBO_BOX</em> </td><td>
A list of choices the user can select from. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a14" doxytag="ROLE_DATE_EDITOR" ></a>ROLE_DATE_EDITOR</em> </td><td>
An object whose purpose is to allow a user to edit a date. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a15" doxytag="ROLE_DESKTOP_ICON" ></a>ROLE_DESKTOP_ICON</em> </td><td>
An inconifed internal frame within a DESKTOP_PANE. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a16" doxytag="ROLE_DESKTOP_FRAME" ></a>ROLE_DESKTOP_FRAME</em> </td><td>
A pane that supports internal frames and iconified versions of those internal frames. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a17" doxytag="ROLE_DIAL" ></a>ROLE_DIAL</em> </td><td>
An object whose purpose is to allow a user to set a value. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a18" doxytag="ROLE_DIALOG" ></a>ROLE_DIALOG</em> </td><td>
A top level window with title bar and a border. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a19" doxytag="ROLE_DIRECTORY_PANE" ></a>ROLE_DIRECTORY_PANE</em> </td><td>
A pane that allows the user to navigate through and select the contents of a directory. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a20" doxytag="ROLE_DRAWING_AREA" ></a>ROLE_DRAWING_AREA</em> </td><td>
An object used for drawing custom user interface elements. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a21" doxytag="ROLE_FILE_CHOOSER" ></a>ROLE_FILE_CHOOSER</em> </td><td>
A specialized dialog that lets the user choose a file. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a22" doxytag="ROLE_FILLER" ></a>ROLE_FILLER</em> </td><td>
A object that fills up space in a user interface. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a23" doxytag="ROLE_FONT_CHOOSER" ></a>ROLE_FONT_CHOOSER</em> </td><td>
A specialized dialog that lets the user choose a font. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a24" doxytag="ROLE_FRAME" ></a>ROLE_FRAME</em> </td><td>
A top level window with a title bar, border, menubar, etc. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a25" doxytag="ROLE_GLASS_PANE" ></a>ROLE_GLASS_PANE</em> </td><td>
A pane that is guaranteed to be painted on top of all panes beneath it. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a26" doxytag="ROLE_HTML_CONTAINER" ></a>ROLE_HTML_CONTAINER</em> </td><td>
A document container for HTML, whose children represent the document content. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a27" doxytag="ROLE_ICON" ></a>ROLE_ICON</em> </td><td>
A small fixed size picture, typically used to decorate components. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a28" doxytag="ROLE_IMAGE" ></a>ROLE_IMAGE</em> </td><td>
An object whose primary purpose is to display an image. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a29" doxytag="ROLE_INTERNAL_FRAME" ></a>ROLE_INTERNAL_FRAME</em> </td><td>
A frame-like object that is clipped by a desktop pane. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a30" doxytag="ROLE_LABEL" ></a>ROLE_LABEL</em> </td><td>
An object used to present an icon or short string in an interface. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a31" doxytag="ROLE_LAYERED_PANE" ></a>ROLE_LAYERED_PANE</em> </td><td>
A specialized pane that allows its children to be drawn in layers, providing a form of stacking order. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a32" doxytag="ROLE_LIST" ></a>ROLE_LIST</em> </td><td>
An object that presents a list of objects to the user and allows the user to select one or more of them. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a33" doxytag="ROLE_LIST_ITEM" ></a>ROLE_LIST_ITEM</em> </td><td>
An object that represents an element of a list. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a34" doxytag="ROLE_MENU" ></a>ROLE_MENU</em> </td><td>
An object usually found inside a menu bar that contains a list of actions the user can choose from. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a35" doxytag="ROLE_MENU_BAR" ></a>ROLE_MENU_BAR</em> </td><td>
An object usually drawn at the top of the primary dialog box of an application that contains a list of menus the user can choose from. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a36" doxytag="ROLE_MENU_ITEM" ></a>ROLE_MENU_ITEM</em> </td><td>
An object usually contained in a menu that presents an action the user can choose. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a37" doxytag="ROLE_OPTION_PANE" ></a>ROLE_OPTION_PANE</em> </td><td>
A specialized pane whose primary use is inside a DIALOG. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a38" doxytag="ROLE_PAGE_TAB" ></a>ROLE_PAGE_TAB</em> </td><td>
An object that is a child of a page tab list. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a39" doxytag="ROLE_PAGE_TAB_LIST" ></a>ROLE_PAGE_TAB_LIST</em> </td><td>
An object that presents a series of panels (or page tabs), one at a time, through some mechanism provided by the object. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a40" doxytag="ROLE_PANEL" ></a>ROLE_PANEL</em> </td><td>
A generic container that is often used to group objects. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a41" doxytag="ROLE_PASSWORD_TEXT" ></a>ROLE_PASSWORD_TEXT</em> </td><td>
A text object uses for passwords, or other places where the text content is not shown visibly to the user. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a42" doxytag="ROLE_POPUP_MENU" ></a>ROLE_POPUP_MENU</em> </td><td>
A temporary window that is usually used to offer the user a list of choices, and then hides when the user selects one of those choices. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a43" doxytag="ROLE_PROGRESS_BAR" ></a>ROLE_PROGRESS_BAR</em> </td><td>
An object used to indicate how much of a task has been completed. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a44" doxytag="ROLE_PUSH_BUTTON" ></a>ROLE_PUSH_BUTTON</em> </td><td>
An object the user can manipulate to tell the application to do something. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a45" doxytag="ROLE_RADIO_BUTTON" ></a>ROLE_RADIO_BUTTON</em> </td><td>
A specialized check box that will cause other radio buttons in the same group to become unchecked when this one is checked. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a46" doxytag="ROLE_RADIO_MENU_ITEM" ></a>ROLE_RADIO_MENU_ITEM</em> </td><td>
A check menu item which belongs to a group; at each instant exactly one of the radio menu items from a group is selected. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a47" doxytag="OLE_ROOT_PANE" ></a>OLE_ROOT_PANE</em> </td><td>
A specialized pane that has a glass pane and a layered pane as its children. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a48" doxytag="ROLE_ROW_HEADER" ></a>ROLE_ROW_HEADER</em> </td><td>
The header for a row of data. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a49" doxytag="ROLE_SCROLL_BAR" ></a>ROLE_SCROLL_BAR</em> </td><td>
An object usually used to allow a user to incrementally view a large amount of data. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a50" doxytag="ROLE_SCROLL_PANE" ></a>ROLE_SCROLL_PANE</em> </td><td>
An object that allows a user to incrementally view a large amount of information. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a51" doxytag="ROLE_SEPARATOR" ></a>ROLE_SEPARATOR</em> </td><td>
An object usually contained in a menu to provide a visible and logical separation of the contents in a menu. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a52" doxytag="ROLE_SLIDER" ></a>ROLE_SLIDER</em> </td><td>
An object that allows the user to select from a bounded range. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a53" doxytag="ROLE_SPLIT_PANE" ></a>ROLE_SPLIT_PANE</em> </td><td>
A specialized panel that presents two other panels at the same time. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a54" doxytag="ROLE_SPIN_BUTTON" ></a>ROLE_SPIN_BUTTON</em> </td><td>
An object used to get an integer or floating point number from the user. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a55" doxytag="ROLE_STATUSBAR" ></a>ROLE_STATUSBAR</em> </td><td>
An object which reports messages of minor importance to the user. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a56" doxytag="ROLE_TABLE" ></a>ROLE_TABLE</em> </td><td>
An object used to represent information in terms of rows and columns. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a57" doxytag="ROLE_TABLE_CELL" ></a>ROLE_TABLE_CELL</em> </td><td>
A cell in a table. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a58" doxytag="ROLE_TABLE_COLUMN_HEADER" ></a>ROLE_TABLE_COLUMN_HEADER</em> </td><td>
The header for a column of a table. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a59" doxytag="ROLE_TABLE_ROW_HEADER" ></a>ROLE_TABLE_ROW_HEADER</em> </td><td>
The header for a row of a table. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a60" doxytag="ROLE_TEAR_OFF_MENU_ITEM" ></a>ROLE_TEAR_OFF_MENU_ITEM</em> </td><td>
A menu item used to tear off and reattach its menu. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a61" doxytag="ROLE_TERMINAL" ></a>ROLE_TERMINAL</em> </td><td>
An object that represents an accessible terminal. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a62" doxytag="ROLE_TEXT" ></a>ROLE_TEXT</em> </td><td>
An object that presents text to the user. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a63" doxytag="ROLE_TOGGLE_BUTTON" ></a>ROLE_TOGGLE_BUTTON</em> </td><td>
A specialized push button that can be checked or unchecked, but does not provide a separate indicator for the current state. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a64" doxytag="ROLE_TOOL_BAR" ></a>ROLE_TOOL_BAR</em> </td><td>
A bar or palette usually composed of push buttons or toggle buttons. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a65" doxytag="ROLE_TOOL_TIP" ></a>ROLE_TOOL_TIP</em> </td><td>
An object that provides information about another object. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a66" doxytag="ROLE_TREE" ></a>ROLE_TREE</em> </td><td>
An object used to represent hierarchical information to the user. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a67" doxytag="ROLE_TREE_TABLE" ></a>ROLE_TREE_TABLE</em> </td><td>
An object capable of expanding and collapsing rows as well as showing multiple columns of data. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a68" doxytag="ROLE_UNKNOWN" ></a>ROLE_UNKNOWN</em> </td><td>
The object contains some Accessible information, but its role is not known. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a69" doxytag="ROLE_VIEWPORT" ></a>ROLE_VIEWPORT</em> </td><td>
An object usually used in a scroll pane. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a70" doxytag="ROLE_WINDOW" ></a>ROLE_WINDOW</em> </td><td>
A top level window with no title or border. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a71" doxytag="ROLE_HEADER" ></a>ROLE_HEADER</em> </td><td>
An object that serves as a document header. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a72" doxytag="ROLE_FOOTER" ></a>ROLE_FOOTER</em> </td><td>
An object that serves as a document footer. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a73" doxytag="ROLE_PARAGRAPH" ></a>ROLE_PARAGRAPH</em> </td><td>
An object which is contains a paragraph of text content. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a74" doxytag="ROLE_RULER" ></a>ROLE_RULER</em> </td><td>
An object which describes margins and tab stops for text objects which it controls (should have CONTROLLER_FOR relation to such). </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a75" doxytag="ROLE_APPLICATION" ></a>ROLE_APPLICATION</em> </td><td>
The object is an application object, which may contain ROLE_FRAME objects or other types of accessibles. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a76" doxytag="ROLE_AUTOCOMPLETE" ></a>ROLE_AUTOCOMPLETE</em> </td><td>
The object is a dialog or list containing items for insertion into an entry widget, for instance a list of words for completion of a text entry. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a77" doxytag="ROLE_EDITBAR" ></a>ROLE_EDITBAR</em> </td><td>
The object is an editable text object in a toolbar. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a195a78" doxytag="ROLE_LAST_DEFINED" ></a>ROLE_LAST_DEFINED</em> </td><td>
Not a valid role, used for finding end of the enumeration. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="a179" doxytag="atk/object.hh::role_for_name" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceGFC_1_1Atk.html#a195">Role</a> role_for_name </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const String & </td>
<td class="mdname1" valign="top" nowrap> <em>name</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get the Role type corresponding to a role <em>name</em>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>name</em> </td><td>A string which is the (non-localized) name of an ATK role. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The Role type corresponding to the specified name, or ROLE_INVALID if no matching role is found. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a178" doxytag="atk/object.hh::role_get_localized_name" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> String role_get_localized_name </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceGFC_1_1Atk.html#a195">Role</a> </td>
<td class="mdname1" valign="top" nowrap> <em>role</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the localized description string describing the Role <em>role</em>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>role</em> </td><td>The Role whose localized name is required. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A localized string describing the <em>role</em>. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a177" doxytag="atk/object.hh::role_get_name" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> String role_get_name </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceGFC_1_1Atk.html#a195">Role</a> </td>
<td class="mdname1" valign="top" nowrap> <em>role</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the description string describing the Role <em>role</em>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>role</em> </td><td>The Role whose name is required. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A string describing the <em>role</em>. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a176" doxytag="atk/object.hh::role_register" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceGFC_1_1Atk.html#a195">Role</a> role_register </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const String & </td>
<td class="mdname1" valign="top" nowrap> <em>name</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Registers the role specified by name.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>name</em> </td><td>A character string describing the new role. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A Role for the new role. </dd></dl>
</td>
</tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:33 2004 for GFC-UI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address>
</body>
</html>
|
