File: classGFC_1_1Atk_1_1Registry.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 (296 lines) | stat: -rw-r--r-- 15,000 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
<!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>GFC::Atk::Registry Class Reference</h1>An AtkRegistry C++ wrapper class.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="registry_8hh-source.html">gfc/atk/registry.hh</a>&gt;</code>
<p>
<p>Inheritance diagram for GFC::Atk::Registry:
<p><center><img src="classGFC_1_1Atk_1_1Registry.png" usemap="#GFC::Atk::Registry_map" border="0" alt=""></center>
<map name="GFC::Atk::Registry_map">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html" alt="GFC::G::Object" shape="rect" coords="0,112,134,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="0,56,134,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,134,24">
</map>
<a href="classGFC_1_1Atk_1_1Registry-members.html">List of all members.</a><h2>Public Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="anchor" name="z47_0" doxytag="GFC::Atk::Registry::~Registry" ></a>
virtual <a class="el" href="classGFC_1_1Atk_1_1Registry.html#z47_0">~Registry</a> ()
<dl class="el"><dd class="mdescRight">Destructor. <br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z48_0" doxytag="GFC::Atk::Registry::atk_registry" ></a>
AtkRegistry * <a class="el" href="classGFC_1_1Atk_1_1Registry.html#z48_0">atk_registry</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the AtkRegistry structure. <br></dl><li><a class="anchor" name="z48_1" doxytag="GFC::Atk::Registry::operator AtkRegistry *" ></a>
<a class="el" href="classGFC_1_1Atk_1_1Registry.html#z48_1">operator AtkRegistry *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts a <a class="el" href="classGFC_1_1Atk_1_1Registry.html">Registry</a> to an AtkRegistry pointer. <br></dl><li>GType <a class="el" href="classGFC_1_1Atk_1_1Registry.html#z48_2">get_factory_type</a> (GType <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html#z121_2">type</a>) const
<dl class="el"><dd class="mdescRight">Provides a GType indicating the <a class="el" href="classGFC_1_1Atk_1_1ObjectFactory.html">ObjectFactory</a> subclass associated with type.  <a href="#z48_2"></a><br></dl><li><a class="el" href="classGFC_1_1Atk_1_1ObjectFactory.html">ObjectFactory</a> * <a class="el" href="classGFC_1_1Atk_1_1Registry.html#z48_3">get_factory</a> (GType <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html#z121_2">type</a>) const
<dl class="el"><dd class="mdescRight">Gets an <a class="el" href="classGFC_1_1Atk_1_1ObjectFactory.html">ObjectFactory</a> appropriate for creating Atk::Objects appropriate for <em>type</em>.  <a href="#z48_3"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Methods</div></td></tr>
<ul>
<li>void <a class="el" href="classGFC_1_1Atk_1_1Registry.html#z49_0">set_factory_type</a> (GType <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html#z121_2">type</a>, GType factory_type)
<dl class="el"><dd class="mdescRight">Associate an <a class="el" href="classGFC_1_1Atk_1_1ObjectFactory.html">ObjectFactory</a> subclass with a GType.  <a href="#z49_0"></a><br></dl></ul>
<h2>Static Public Member Functions</h2>
<ul>
<li><a class="el" href="classGFC_1_1Atk_1_1Registry.html">Registry</a> * <a class="el" href="classGFC_1_1Atk_1_1Registry.html#e0">get_default</a> ()
<dl class="el"><dd class="mdescRight">Gets a default implementation of the ObjectFactory/type registry.  <a href="#e0"></a><br></dl></ul>
<h2>Protected Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="el" href="classGFC_1_1Atk_1_1Registry.html#z46_0">Registry</a> (AtkRegistry *registry, bool <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html#z143_1">owns_reference</a>=true)
<dl class="el"><dd class="mdescRight">Construct a new <a class="el" href="classGFC_1_1Atk_1_1Registry.html">Registry</a> from an existing AtkRegistry.  <a href="#z46_0"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An AtkRegistry C++ wrapper class. 
<p>
<a class="el" href="classGFC_1_1Atk_1_1Registry.html">Registry</a> is an object that is used to store the GType of the factories used to create an accessible object for an object of a particular GType. 
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="z46_0" doxytag="GFC::Atk::Registry::Registry" ></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"> GFC::Atk::Registry::Registry           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">AtkRegistry *&nbsp;</td>
          <td class="mdname" nowrap> <em>registry</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>bool&nbsp;</td>
          <td class="mdname" nowrap> <em>owns_reference</em> = <code>true</code></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [explicit, protected]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Construct a new <a class="el" href="classGFC_1_1Atk_1_1Registry.html">Registry</a> from an existing AtkRegistry. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>registry</em>&nbsp;</td><td>A pointer to a AtkRegistry. </td></tr>
    <tr><td></td><td valign=top><em>owns_reference</em>&nbsp;</td><td>Set false if the initial reference count is floating, set true if it's not.</td></tr>
  </table>
</dl>
<br>
The <em>registry</em> can be a newly created AtkRegistry or an existing AtkRegistry. (see <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html#z68_0">G::Object::Object</a>).     </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e0" doxytag="GFC::Atk::Registry::get_default" ></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="classGFC_1_1Atk_1_1Registry.html">Registry</a>* GFC::Atk::Registry::get_default           </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><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Gets a default implementation of the ObjectFactory/type registry. 
<p>
<dl compact><dt><b>Returns:</b></dt><dd>A default implementation of the ObjectFactory/type registry.</dd></dl>
<br>
<b>Note:</b> For most toolkit maintainers, this will be the correct registry for registering new AtkObject factories. Following a call to this function, maintainers may call <a class="el" href="classGFC_1_1Atk_1_1Registry.html#z49_0">set_factory_type()</a> to associate an <a class="el" href="classGFC_1_1Atk_1_1ObjectFactory.html">ObjectFactory</a> subclass with the GType of objects for whom accessibility information will be provided.     </td>
  </tr>
</table>
<a class="anchor" name="z48_3" doxytag="GFC::Atk::Registry::get_factory" ></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="classGFC_1_1Atk_1_1ObjectFactory.html">ObjectFactory</a>* GFC::Atk::Registry::get_factory           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">GType&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>type</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const</td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Gets an <a class="el" href="classGFC_1_1Atk_1_1ObjectFactory.html">ObjectFactory</a> appropriate for creating Atk::Objects appropriate for <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>A GType with which to look up the associated <a class="el" href="classGFC_1_1Atk_1_1ObjectFactory.html">ObjectFactory</a>. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>An <a class="el" href="classGFC_1_1Atk_1_1ObjectFactory.html">ObjectFactory</a> appropriate for creating Atk::Objects appropriate for <em>type</em>. </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="z48_2" doxytag="GFC::Atk::Registry::get_factory_type" ></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"> GType GFC::Atk::Registry::get_factory_type           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">GType&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>type</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const</td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Provides a GType indicating the <a class="el" href="classGFC_1_1Atk_1_1ObjectFactory.html">ObjectFactory</a> subclass associated with type. 
<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>A GType with which to look up the associated <a class="el" href="classGFC_1_1Atk_1_1ObjectFactory.html">ObjectFactory</a> subclass. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A GType associated with type <em>type</em>. </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="z49_0" doxytag="GFC::Atk::Registry::set_factory_type" ></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"> void GFC::Atk::Registry::set_factory_type           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">GType&nbsp;</td>
          <td class="mdname" nowrap> <em>type</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>GType&nbsp;</td>
          <td class="mdname" nowrap> <em>factory_type</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Associate an <a class="el" href="classGFC_1_1Atk_1_1ObjectFactory.html">ObjectFactory</a> subclass with a GType. 
<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 <a class="el" href="classGFC_1_1Atk_1_1Object.html">Atk::Object</a> type. </td></tr>
    <tr><td></td><td valign=top><em>factory_type</em>&nbsp;</td><td>An <a class="el" href="classGFC_1_1Atk_1_1ObjectFactory.html">ObjectFactory</a> type to associate with <em>type</em> (must implement an <a class="el" href="classGFC_1_1Atk_1_1Object.html">Atk::Object</a> appropriate for <em>type</em>).</td></tr>
  </table>
</dl>
<br>
<b>Note:</b> The associated factory_type will thereafter be responsible for the creation of new <a class="el" href="classGFC_1_1Atk_1_1Object.html">Atk::Object</a> implementations for instances appropriate for type.     </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="registry_8hh-source.html">registry.hh</a></ul>
<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>