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
|
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="class-atkregistry">
<refnamediv>
<refname>atk.Registry</refname>
<refpurpose>an object used to store the GType of the factories used to
create an accessible object for an object of a particular GType.
</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>atk.Registry</classname></ooclass>
<ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
<methodsynopsis language="python">
<methodname><link linkend="method-atkregistry--set-factory-type">set_factory_type</link></methodname>
<methodparam><parameter role="keyword">type</parameter></methodparam>
<methodparam><parameter role="keyword">factory_type</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-atkregistry--get-factory-type">get_factory_type</link></methodname>
<methodparam><parameter role="keyword">type</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-atkregistry--get-factory">get_factory</link></methodname>
<methodparam><parameter role="keyword">type</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<programlisting>
<emphasis role="bold">Functions</emphasis>
<methodsynopsis language="python">
<methodname><link linkend="function-atk--get-default-registry">atk.get_default_registry</link></methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-atkregistry">atk.Registry</link>
</synopsis>
</refsect1>
<refsect1 id="signal-prototypes-atkregistry">
<title>atk.Registry Signal Prototypes</title>
<para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
</refsect1>
<refsect1>
<title>Description</title>
<para>The <link
linkend="class-atkregistry"><classname>atk.Registry</classname></link> is
normally used to create appropriate ATK "peers" for user interface
components. Application developers usually need only interact with the <link
linkend="class-atkregistry"><classname>atk.Registry</classname></link> by
associating appropriate ATK implementation classes with <link
linkend="class-gobject"><classname>gobject.GObject</classname></link>
classes via the <link
linkend="method-atkregistry--set-factory-type"><methodname>set_factory_type</methodname>()</link>
method, passing the appropriate GType for application custom widget
classes.</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-atkregistry--set-factory-type">
<title>atk.Registry.set_factory_type</title>
<programlisting><methodsynopsis language="python">
<methodname>set_factory_type</methodname>
<methodparam><parameter role="keyword">type</parameter></methodparam>
<methodparam><parameter role="keyword">factory_type</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">type</parameter> :</term>
<listitem><simpara>an <link linkend="class-atkobject"><classname>atk.Object</classname></link> type</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">factory_type</parameter> :</term>
<listitem><simpara>an <link
linkend="class-atkobjectfactory"><classname>atk.ObjectFactory</classname></link>
type to associate with <parameter>type</parameter>. Must
implement the <link
linkend="class-atkobject"><classname>atk.Object</classname></link>
appropriate for <parameter>type</parameter>.</simpara></listitem>
</varlistentry>
</variablelist>
<para>Associate an <link
linkend="class-atkobjectfactory"><classname>atk.ObjectFactory</classname></link>
subclass with a <link
linkend="class-atkobject"><classname>atk.Object</classname></link>
type. Note: The associated <parameter>factory_type</parameter> will
thereafter be responsible for the creation of new <link
linkend="class-atkobject"><classname>atk.Object</classname></link>
implementations for instances appropriate for
<parameter>type</parameter>.</para>
</refsect2>
<refsect2 id="method-atkregistry--get-factory-type">
<title>atk.Registry.get_factory_type</title>
<programlisting><methodsynopsis language="python">
<methodname>get_factory_type</methodname>
<methodparam><parameter role="keyword">type</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">type</parameter> :</term>
<listitem><simpara>a <link
linkend="class-atkobject"><classname>atk.Object</classname></link>
type with which to look up the associated <link
linkend="class-atkobjectfactory"><classname>atk.ObjectFactory</classname></link>
subclass</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a <link
linkend="class-atkobjectfactory"><classname>atk.ObjectFactory</classname></link>
type associated with <link
linkend="class-atkobject"><classname>atk.Object</classname></link>
<parameter>type</parameter></simpara></listitem>
</varlistentry>
</variablelist>
<para>Returns a <link
linkend="class-atkobjectfactory"><classname>atk.ObjectFactory</classname></link>
subclass associated with <parameter>type</parameter>.</para>
</refsect2>
<refsect2 id="method-atkregistry--get-factory">
<title>atk.Registry.get_factory</title>
<programlisting><methodsynopsis language="python">
<methodname>get_factory</methodname>
<methodparam><parameter role="keyword">type</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">type</parameter> :</term>
<listitem><simpara>a <link
linkend="class-atkobject"><classname>atk.Object</classname></link>
with which to look up the associated <link
linkend="class-atkobjectfactory"><classname>atk.ObjectFactory</classname></link></simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>an <link
linkend="class-atkobjectfactory"><classname>atk.ObjectFactory</classname></link>
appropriate for creating <parameter>type</parameter> <link
linkend="class-atkobject"><classname>atk.Object</classname></link>s.</simpara></listitem>
</varlistentry>
</variablelist>
<para>Gets an <link
linkend="class-atkobjectfactory"><classname>atk.ObjectFactory</classname></link>
appropriate for creating <parameter>type</parameter> <link
linkend="class-atkobject"><classname>atk.Object</classname></link>s.</para>
</refsect2>
</refsect1>
<refsect1>
<title>Functions</title>
<refsect2 id="function-atk--get-default-registry">
<title>atk.get_default_registry</title>
<programlisting><methodsynopsis language="python">
<methodname>atk.get_default_registry</methodname>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a default implementation of the <link
linkend="class-atkobjectfactory"><classname>atk.ObjectFactory</classname></link>
type registry</simpara></listitem>
</varlistentry>
</variablelist>
<para>Gets a default implementation of the <link
linkend="class-atkobjectfactory"><classname>atk.ObjectFactory</classname></link>
type registry. Note: For most toolkit maintainers, this will be the
correct registry for registering new <link
linkend="class-atkobject"><classname>atk.Object</classname></link>
factories. Following a call to this function, maintainers may call the
<link
linkend="method-atkregistry--set-factory-type"><methodname>set_factory_type</methodname>()</link>
method to associate an <link
linkend="class-atkobjectfactory"><classname>atk.ObjectFactory</classname></link>
subclass with the type of objects for whom accessibility information
will be provided.</para>
</refsect2>
</refsect1>
</refentry>
|
