File: util_8hh.html

package info (click to toggle)
gfcui 2.3.1-2
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 43,420 kB
  • ctags: 18,023
  • sloc: cpp: 53,967; sh: 31,555; makefile: 1,322; perl: 108
file content (419 lines) | stat: -rw-r--r-- 20,878 bytes parent folder | download | duplicates (3)
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
<!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>&nbsp; |&nbsp; <a
 href="../html/namespaces.html">Namespace List</a>&nbsp; |&nbsp; <a
 href="classes.html">Alphabetical List</a>&nbsp; |&nbsp; <a
 href="../html/annotated.html">Class List</a>&nbsp; |&nbsp; <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>util.hh File Reference</h1>An ATK Utility C++ wrapper interface. <a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="elRef" doxygen="gfccore.tag:" href="utfstring_8hh.html">gfc/utfstring.hh</a>&gt;</code><br>
<code>#include &lt;atk/atkutil.h&gt;</code><br>

<p>
<a href="util_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>RelationType Methods</h2>
<ul>
<li><a class="el" href="namespaceGFC_1_1Atk.html#a202">RelationType</a> <a class="el" href="namespaceGFC_1_1Atk.html#a187">relation_type_register</a> (const String &amp;name)
<dl class="el"><dd class="mdescRight">Associate name with a new RelationType.  <a href="#a187"></a><br></dl><li>String <a class="el" href="namespaceGFC_1_1Atk.html#a188">relation_type_get_name</a> (<a class="el" href="namespaceGFC_1_1Atk.html#a202">RelationType</a> type)
<dl class="el"><dd class="mdescRight">Gets the description string describing the RelationType <em>type</em>.  <a href="#a188"></a><br></dl><li><a class="el" href="namespaceGFC_1_1Atk.html#a202">RelationType</a> <a class="el" href="namespaceGFC_1_1Atk.html#a189">relation_type_for_name</a> (const String &amp;name)
<dl class="el"><dd class="mdescRight">Get the RelationType type corresponding to a relation name.  <a href="#a189"></a><br></dl></ul>
<h2>Toolkit Methods</h2>
<ul>
<li><a class="anchor" name="a190" doxytag="util.hh::get_root" ></a>
Object * <a class="el" href="namespaceGFC_1_1Atk.html#a190">get_root</a> ()
<dl class="el"><dd class="mdescRight">Returns the root accessible container for the current application. <br></dl><li>Object * <a class="el" href="namespaceGFC_1_1Atk.html#a191">get_focus_object</a> ()
<dl class="el"><dd class="mdescRight">Gets the currently focused accessible object.  <a href="#a191"></a><br></dl><li><a class="anchor" name="a192" doxytag="util.hh::get_toolkit_name" ></a>
String <a class="el" href="namespaceGFC_1_1Atk.html#a192">get_toolkit_name</a> ()
<dl class="el"><dd class="mdescRight">Returns the name string for the GUI toolkit implementing ATK for this application. <br></dl><li><a class="anchor" name="a193" doxytag="util.hh::get_toolkit_version" ></a>
String <a class="el" href="namespaceGFC_1_1Atk.html#a193">get_toolkit_version</a> ()
<dl class="el"><dd class="mdescRight">Returns the version string for the GUI toolkit implementing ATK for this application. <br></dl></ul>
<h2>Typedefs</h2>
<ul>
<li><a class="anchor" name="a151" doxytag="util.hh::State" ></a>
typedef AtkState <a class="el" href="namespaceGFC_1_1Atk.html#a151">State</a>
<dl class="el"><dd class="mdescRight">State is a typedef for AtkState. <br></dl></ul>
<h2>Enumerations</h2>
<ul>
<li>enum <a class="el" href="namespaceGFC_1_1Atk.html#a200">CoordType</a> { <br>
&nbsp;&nbsp;<a class="el" href="namespaceGFC_1_1Atk.html#a200a152">XY_SCREEN</a> =  ATK_XY_SCREEN, 
<br>
&nbsp;&nbsp;<a class="el" href="namespaceGFC_1_1Atk.html#a200a153">XY_WINDOW</a> =  ATK_XY_WINDOW
<br>
 }
<dl class="el"><dd class="mdescRight">Specifies how xy coordinates are to be interpreted.  <a href="#a200">More...</a><br></dl><li>enum <a class="el" href="namespaceGFC_1_1Atk.html#a201">Layer</a> { <br>
&nbsp;&nbsp;<a class="el" href="namespaceGFC_1_1Atk.html#a201a154">LAYER_INVALID</a> =  ATK_LAYER_INVALID, 
<br>
&nbsp;&nbsp;<a class="el" href="namespaceGFC_1_1Atk.html#a201a155">LAYER_BACKGROUND</a> =  ATK_LAYER_BACKGROUND, 
<br>
&nbsp;&nbsp;<a class="el" href="namespaceGFC_1_1Atk.html#a201a156">LAYER_CANVAS</a> =  ATK_LAYER_CANVAS, 
<br>
&nbsp;&nbsp;<a class="el" href="namespaceGFC_1_1Atk.html#a201a157">LAYER_WIDGET</a> =  ATK_LAYER_WIDGET, 
<br>
&nbsp;&nbsp;<a class="el" href="namespaceGFC_1_1Atk.html#a201a158">LAYER_MDI</a> =  ATK_LAYER_MDI, 
<br>
&nbsp;&nbsp;<a class="el" href="namespaceGFC_1_1Atk.html#a201a159">LAYER_POPUP</a> =  ATK_LAYER_POPUP, 
<br>
&nbsp;&nbsp;<a class="el" href="namespaceGFC_1_1Atk.html#a201a160">LAYER_OVERLAY</a> =  ATK_LAYER_OVERLAY, 
<br>
&nbsp;&nbsp;<a class="el" href="namespaceGFC_1_1Atk.html#a201a161">LAYER_WINDOW</a> =  ATK_LAYER_WINDOW
<br>
 }
<dl class="el"><dd class="mdescRight">Describes the layer of a component.  <a href="#a201">More...</a><br></dl><li>enum <a class="el" href="namespaceGFC_1_1Atk.html#a202">RelationType</a> { <br>
&nbsp;&nbsp;<a class="el" href="namespaceGFC_1_1Atk.html#a202a162">RELATION_NULL</a> =  ATK_RELATION_NULL, 
<br>
&nbsp;&nbsp;<a class="el" href="namespaceGFC_1_1Atk.html#a202a163">RELATION_CONTROLLED_BY</a> =  ATK_RELATION_CONTROLLED_BY, 
<br>
&nbsp;&nbsp;<a class="el" href="namespaceGFC_1_1Atk.html#a202a164">RELATION_CONTROLLER_FOR</a> =  ATK_RELATION_CONTROLLER_FOR, 
<br>
&nbsp;&nbsp;<a class="el" href="namespaceGFC_1_1Atk.html#a202a165">RELATION_LABEL_FOR</a> =  ATK_RELATION_LABEL_FOR, 
<br>
&nbsp;&nbsp;<a class="el" href="namespaceGFC_1_1Atk.html#a202a166">RELATION_LABELLED_BY</a> =  ATK_RELATION_LABELLED_BY, 
<br>
&nbsp;&nbsp;<a class="el" href="namespaceGFC_1_1Atk.html#a202a167">RELATION_MEMBER_OF</a> =  ATK_RELATION_MEMBER_OF, 
<br>
&nbsp;&nbsp;<a class="el" href="namespaceGFC_1_1Atk.html#a202a168">RELATION_NODE_CHILD_OF</a> =  ATK_RELATION_NODE_CHILD_OF, 
<br>
&nbsp;&nbsp;<a class="el" href="namespaceGFC_1_1Atk.html#a202a169">RELATION_FLOWS_TO</a> =  ATK_RELATION_FLOWS_TO, 
<br>
&nbsp;&nbsp;<a class="el" href="namespaceGFC_1_1Atk.html#a202a170">RELATION_FLOWS_FROM</a> =  ATK_RELATION_FLOWS_FROM, 
<br>
&nbsp;&nbsp;<a class="el" href="namespaceGFC_1_1Atk.html#a202a171">RELATION_SUBWINDOW_OF</a> =  ATK_RELATION_SUBWINDOW_OF, 
<br>
&nbsp;&nbsp;<a class="el" href="namespaceGFC_1_1Atk.html#a202a172">RELATION_EMBEDS</a> =  ATK_RELATION_EMBEDS, 
<br>
&nbsp;&nbsp;<a class="el" href="namespaceGFC_1_1Atk.html#a202a173">RELATION_EMBEDDED_BY</a> =  ATK_RELATION_EMBEDDED_BY, 
<br>
&nbsp;&nbsp;<a class="el" href="namespaceGFC_1_1Atk.html#a202a174">RELATION_POPUP_FOR</a> =  ATK_RELATION_POPUP_FOR, 
<br>
&nbsp;&nbsp;<a class="el" href="namespaceGFC_1_1Atk.html#a202a175">RELATION_LAST_DEFINED</a> =  ATK_RELATION_LAST_DEFINED
<br>
 }
<dl class="el"><dd class="mdescRight">Describes the type of the relation.  <a href="#a202">More...</a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An ATK Utility C++ wrapper interface. 
<p>
Provides miscellaneous utility classes and functions.<hr><h2>Enumeration Type Documentation</h2>
<a class="anchor" name="a200" doxytag="util.hh::CoordType" ></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#a200">CoordType</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Specifies how xy coordinates are to be interpreted. 
<p>
Used by functions such as <a class="el" href="classGFC_1_1Atk_1_1Component.html#z5_4">Atk::Component::get_position()</a> and <a class="el" href="classGFC_1_1Atk_1_1Text.html#z89_8">Atk::Text::get_character_extents()</a>. <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="a200a152" doxytag="XY_SCREEN" ></a>XY_SCREEN</em>&nbsp;</td><td>
Specifies xy coordinates relative to the screen. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a200a153" doxytag="XY_WINDOW" ></a>XY_WINDOW</em>&nbsp;</td><td>
Specifies xy coordinates relative to the widget's. </td></tr>
</table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a201" doxytag="util.hh::Layer" ></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#a201">Layer</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Describes the layer of a component. 
<p>
The enumerated "layer values" are used when determining which UI rendering layer a component is drawn into, which can help in making determinations of when components occlude one another. <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="a201a154" doxytag="LAYER_INVALID" ></a>LAYER_INVALID</em>&nbsp;</td><td>
The object does not have a layer. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a201a155" doxytag="LAYER_BACKGROUND" ></a>LAYER_BACKGROUND</em>&nbsp;</td><td>
This layer is reserved for the desktop background. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a201a156" doxytag="LAYER_CANVAS" ></a>LAYER_CANVAS</em>&nbsp;</td><td>
This layer is used for Canvas components. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a201a157" doxytag="LAYER_WIDGET" ></a>LAYER_WIDGET</em>&nbsp;</td><td>
This layer is normally used for components. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a201a158" doxytag="LAYER_MDI" ></a>LAYER_MDI</em>&nbsp;</td><td>
This layer is used for layered components. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a201a159" doxytag="LAYER_POPUP" ></a>LAYER_POPUP</em>&nbsp;</td><td>
This layer is used for popup components, such as menus. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a201a160" doxytag="LAYER_OVERLAY" ></a>LAYER_OVERLAY</em>&nbsp;</td><td>
This layer is reserved for future use. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a201a161" doxytag="LAYER_WINDOW" ></a>LAYER_WINDOW</em>&nbsp;</td><td>
This layer is used for toplevel windows. </td></tr>
</table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a202" doxytag="util.hh::RelationType" ></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#a202">RelationType</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Describes the type of the relation. 
<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="a202a162" doxytag="RELATION_NULL" ></a>RELATION_NULL</em>&nbsp;</td><td>
No relation. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a202a163" doxytag="RELATION_CONTROLLED_BY" ></a>RELATION_CONTROLLED_BY</em>&nbsp;</td><td>
Indicates an object controlled by one or more target objects. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a202a164" doxytag="RELATION_CONTROLLER_FOR" ></a>RELATION_CONTROLLER_FOR</em>&nbsp;</td><td>
Indicates an object is an controller for one or more target objects. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a202a165" doxytag="RELATION_LABEL_FOR" ></a>RELATION_LABEL_FOR</em>&nbsp;</td><td>
Indicates an object is a label for one or more target objects. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a202a166" doxytag="RELATION_LABELLED_BY" ></a>RELATION_LABELLED_BY</em>&nbsp;</td><td>
Indicates an object is labelled by one or more target objects. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a202a167" doxytag="RELATION_MEMBER_OF" ></a>RELATION_MEMBER_OF</em>&nbsp;</td><td>
Indicates an object is a member of a group of one or more target objects. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a202a168" doxytag="RELATION_NODE_CHILD_OF" ></a>RELATION_NODE_CHILD_OF</em>&nbsp;</td><td>
Indicates an object is a cell in a treetable which is displayed because a cell in the same column is expanded and identifies that cell. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a202a169" doxytag="RELATION_FLOWS_TO" ></a>RELATION_FLOWS_TO</em>&nbsp;</td><td>
Indicates that the object has content that flows logically to another <a class="el" href="classGFC_1_1Atk_1_1Object.html">Atk::Object</a> in a sequential way, (for instance text-flow). </td></tr>
<tr><td valign=top><em><a class="anchor" name="a202a170" doxytag="RELATION_FLOWS_FROM" ></a>RELATION_FLOWS_FROM</em>&nbsp;</td><td>
Indicates that the object has content that flows logically from another <a class="el" href="classGFC_1_1Atk_1_1Object.html">Atk::Object</a> in a sequential way, (for instance text-flow). </td></tr>
<tr><td valign=top><em><a class="anchor" name="a202a171" doxytag="RELATION_SUBWINDOW_OF" ></a>RELATION_SUBWINDOW_OF</em>&nbsp;</td><td>
[not sure about this one] </td></tr>
<tr><td valign=top><em><a class="anchor" name="a202a172" doxytag="RELATION_EMBEDS" ></a>RELATION_EMBEDS</em>&nbsp;</td><td>
Indicates that the object visually embeds another object's content, that is this object's content flows around another's content. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a202a173" doxytag="RELATION_EMBEDDED_BY" ></a>RELATION_EMBEDDED_BY</em>&nbsp;</td><td>
Inverse of ATK_RELATION_EMBEDS, indicates that this object's content is visualy embedded in another object. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a202a174" doxytag="RELATION_POPUP_FOR" ></a>RELATION_POPUP_FOR</em>&nbsp;</td><td>
Indicates that an object is a popup for another object. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a202a175" doxytag="RELATION_LAST_DEFINED" ></a>RELATION_LAST_DEFINED</em>&nbsp;</td><td>
Not a valid relation, used for finding end of the enumeration. </td></tr>
</table>
</dl>
    </td>
  </tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="a191" doxytag="util.hh::get_focus_object" ></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"> Object* get_focus_object           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Gets the currently focused accessible object. 
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The currently focused accessible object for the current application. </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a189" doxytag="util.hh::relation_type_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#a202">RelationType</a> relation_type_for_name           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const String &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>name</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get the RelationType type corresponding to a relation 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>&nbsp;</td><td>A string which is the (non-localized) name of an ATK relation type. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The RelationType corresponding to the specified name, or RELATION_NULL if no matching relation type is found. </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a188" doxytag="util.hh::relation_type_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 relation_type_get_name           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="namespaceGFC_1_1Atk.html#a202">RelationType</a>&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>type</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Gets the description string describing the RelationType <em>type</em>. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>type</em>&nbsp;</td><td>The RelationType whose name is required. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The string describing the RelationType. </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a187" doxytag="util.hh::relation_type_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#a202">RelationType</a> relation_type_register           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const String &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>name</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Associate name with a new RelationType. 
<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>&nbsp;</td><td>A name string. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A RelationType associated with <em>name</em>. </dd></dl>
    </td>
  </tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:34 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>