1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>atk.Registry</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="atk-class-reference.html" title="The atk Class Reference"><link rel="prev" href="class-atkrectangle.html" title="atk.Rectangle"><link rel="next" href="class-atkrelation.html" title="atk.Relation"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">atk.Registry</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-atkrectangle.html">Prev</a> </td><th width="60%" align="center">The atk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-atkrelation.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-atkregistry"></a><div class="titlepage"></div><div class="refnamediv"><h2>atk.Registry</h2><p>atk.Registry — an object used to store the GType of the factories used to
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>atk.Registry</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.1"><link rel="home" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="atk-class-reference.html" title="The atk Class Reference"><link rel="prev" href="class-atkrectangle.html" title="atk.Rectangle"><link rel="next" href="class-atkrelation.html" title="atk.Relation"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">atk.Registry</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-atkrectangle.html">Prev</a> </td><th width="60%" align="center">The atk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-atkrelation.html">Next</a></td></tr></table><hr></div><div class="refentry" title="atk.Registry"><a name="class-atkregistry"></a><div class="titlepage"></div><div class="refnamediv"><h2>atk.Registry</h2><p>atk.Registry — an object used to store the GType of the factories used to
2
2
create an accessible object for an object of a particular GType.
3
</p></div><div class="refsect1" lang="en"><a name="id2799507"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">atk.Registry</span></span>(<span class="ooclass"><span class="classname"><PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK></span></span>):
3
</p></div><div class="refsect1" title="Synopsis"><a name="id3121007"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">atk.Registry</span></span>(<span class="ooclass"><span class="classname"><PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK></span></span>):
4
4
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkregistry.html#method-atkregistry--set-factory-type" title="atk.Registry.set_factory_type">set_factory_type</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>type</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>factory_type</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkregistry.html#method-atkregistry--get-factory-type" title="atk.Registry.get_factory_type">get_factory_type</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>type</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkregistry.html#method-atkregistry--get-factory" title="atk.Registry.get_factory">get_factory</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>type</code></strong></span></span>)</code><br></pre></td></tr></table><pre class="programlisting">
5
5
<span class="bold"><strong>Functions</strong></span>
7
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkregistry.html#function-atk--get-default-registry" title="atk.get_default_registry">atk.get_default_registry</a></span>(<span class="methodparam"></span>)</code></pre></div><div class="refsect1" lang="en"><a name="id2824685"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
7
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkregistry.html#function-atk--get-default-registry" title="atk.get_default_registry">atk.get_default_registry</a></span>(<span class="methodparam"></span>)</code></pre></div><div class="refsect1" title="Ancestry"><a name="id3101607"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
8
8
+-- <a class="link" href="class-atkregistry.html" title="atk.Registry">atk.Registry</a>
9
</pre></div><div class="refsect1" lang="en"><a name="signal-prototypes-atkregistry"></a><h2>atk.Registry Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p></div><div class="refsect1" lang="en"><a name="id2817946"></a><h2>Description</h2><p>The <a class="link" href="class-atkregistry.html" title="atk.Registry"><code class="classname">atk.Registry</code></a> is
9
</pre></div><div class="refsect1" title="atk.Registry Signal Prototypes"><a name="signal-prototypes-atkregistry"></a><h2>atk.Registry Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p></div><div class="refsect1" title="Description"><a name="id3133646"></a><h2>Description</h2><p>The <a class="link" href="class-atkregistry.html" title="atk.Registry"><code class="classname">atk.Registry</code></a> is
10
10
normally used to create appropriate ATK "peers" for user interface
11
11
components. Application developers usually need only interact with the <a class="link" href="class-atkregistry.html" title="atk.Registry"><code class="classname">atk.Registry</code></a> by
12
12
associating appropriate ATK implementation classes with <PYGTKDOCLINK HREF="class-gobject"><code class="classname">gobject.GObject</code></PYGTKDOCLINK>
13
13
classes via the <a class="link" href="class-atkregistry.html#method-atkregistry--set-factory-type" title="atk.Registry.set_factory_type"><code class="methodname">set_factory_type</code>()</a>
14
14
method, passing the appropriate GType for application custom widget
15
classes.</p></div><div class="refsect1" lang="en"><a name="id2803491"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-atkregistry--set-factory-type"></a><h3>atk.Registry.set_factory_type</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_factory_type</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>type</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>factory_type</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>type</code></strong> :</span></p></td><td>an <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a> type</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>factory_type</code></strong> :</span></p></td><td>an <a class="link" href="class-atkobjectfactory.html" title="atk.ObjectFactory"><code class="classname">atk.ObjectFactory</code></a>
15
classes.</p></div><div class="refsect1" title="Methods"><a name="id3102106"></a><h2>Methods</h2><div class="refsect2" title="atk.Registry.set_factory_type"><a name="method-atkregistry--set-factory-type"></a><h3>atk.Registry.set_factory_type</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_factory_type</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>type</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>factory_type</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>type</code></strong> :</span></p></td><td>an <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a> type</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>factory_type</code></strong> :</span></p></td><td>an <a class="link" href="class-atkobjectfactory.html" title="atk.ObjectFactory"><code class="classname">atk.ObjectFactory</code></a>
16
16
type to associate with <em class="parameter"><code>type</code></em>. Must
17
17
implement the <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a>
18
18
appropriate for <em class="parameter"><code>type</code></em>.</td></tr></tbody></table><p>Associate an <a class="link" href="class-atkobjectfactory.html" title="atk.ObjectFactory"><code class="classname">atk.ObjectFactory</code></a>
20
20
type. Note: The associated <em class="parameter"><code>factory_type</code></em> will
21
21
thereafter be responsible for the creation of new <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a>
22
22
implementations for instances appropriate for
23
<em class="parameter"><code>type</code></em>.</p></div><div class="refsect2" lang="en"><a name="method-atkregistry--get-factory-type"></a><h3>atk.Registry.get_factory_type</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_factory_type</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>type</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>type</code></strong> :</span></p></td><td>a <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a>
23
<em class="parameter"><code>type</code></em>.</p></div><div class="refsect2" title="atk.Registry.get_factory_type"><a name="method-atkregistry--get-factory-type"></a><h3>atk.Registry.get_factory_type</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_factory_type</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>type</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>type</code></strong> :</span></p></td><td>a <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a>
24
24
type with which to look up the associated <a class="link" href="class-atkobjectfactory.html" title="atk.ObjectFactory"><code class="classname">atk.ObjectFactory</code></a>
25
25
subclass</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a <a class="link" href="class-atkobjectfactory.html" title="atk.ObjectFactory"><code class="classname">atk.ObjectFactory</code></a>
26
26
type associated with <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a>
27
27
<em class="parameter"><code>type</code></em></td></tr></tbody></table><p>Returns a <a class="link" href="class-atkobjectfactory.html" title="atk.ObjectFactory"><code class="classname">atk.ObjectFactory</code></a>
28
subclass associated with <em class="parameter"><code>type</code></em>.</p></div><div class="refsect2" lang="en"><a name="method-atkregistry--get-factory"></a><h3>atk.Registry.get_factory</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_factory</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>type</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>type</code></strong> :</span></p></td><td>a <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a>
28
subclass associated with <em class="parameter"><code>type</code></em>.</p></div><div class="refsect2" title="atk.Registry.get_factory"><a name="method-atkregistry--get-factory"></a><h3>atk.Registry.get_factory</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_factory</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>type</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>type</code></strong> :</span></p></td><td>a <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a>
29
29
with which to look up the associated <a class="link" href="class-atkobjectfactory.html" title="atk.ObjectFactory"><code class="classname">atk.ObjectFactory</code></a></td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>an <a class="link" href="class-atkobjectfactory.html" title="atk.ObjectFactory"><code class="classname">atk.ObjectFactory</code></a>
30
30
appropriate for creating <em class="parameter"><code>type</code></em> <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a>s.</td></tr></tbody></table><p>Gets an <a class="link" href="class-atkobjectfactory.html" title="atk.ObjectFactory"><code class="classname">atk.ObjectFactory</code></a>
31
appropriate for creating <em class="parameter"><code>type</code></em> <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a>s.</p></div></div><div class="refsect1" lang="en"><a name="id2786327"></a><h2>Functions</h2><div class="refsect2" lang="en"><a name="function-atk--get-default-registry"></a><h3>atk.get_default_registry</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">atk.get_default_registry</span>()</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a default implementation of the <a class="link" href="class-atkobjectfactory.html" title="atk.ObjectFactory"><code class="classname">atk.ObjectFactory</code></a>
31
appropriate for creating <em class="parameter"><code>type</code></em> <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a>s.</p></div></div><div class="refsect1" title="Functions"><a name="id3090237"></a><h2>Functions</h2><div class="refsect2" title="atk.get_default_registry"><a name="function-atk--get-default-registry"></a><h3>atk.get_default_registry</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">atk.get_default_registry</span>()</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a default implementation of the <a class="link" href="class-atkobjectfactory.html" title="atk.ObjectFactory"><code class="classname">atk.ObjectFactory</code></a>
32
32
type registry</td></tr></tbody></table><p>Gets a default implementation of the <a class="link" href="class-atkobjectfactory.html" title="atk.ObjectFactory"><code class="classname">atk.ObjectFactory</code></a>
33
33
type registry. Note: For most toolkit maintainers, this will be the
34
34
correct registry for registering new <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a>