atkregistry.xml

The ATK library provides a set of interfaces for accessibility.By supporting the ATK interfaces, an

<refentry id="AtkRegistry">
<refmeta>
<refentrytitle role="top_of_page" id="AtkRegistry.top_of_page">AtkRegistry</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>ATK Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>AtkRegistry</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>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="AtkRegistry.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
                    <link linkend="AtkRegistry-struct">AtkRegistry</link>;
<link linkend="void">void</link>                <link linkend="atk-registry-set-factory-type">atk_registry_set_factory_type</link>       (<link linkend="AtkRegistry">AtkRegistry</link> *registry,
                                                         <link linkend="GType">GType</link> type,
                                                         <link linkend="GType">GType</link> factory_type);
<link linkend="GType">GType</link>               <link linkend="atk-registry-get-factory-type">atk_registry_get_factory_type</link>       (<link linkend="AtkRegistry">AtkRegistry</link> *registry,
                                                         <link linkend="GType">GType</link> type);
<link linkend="AtkObjectFactory">AtkObjectFactory</link>*   <link linkend="atk-registry-get-factory">atk_registry_get_factory</link>            (<link linkend="AtkRegistry">AtkRegistry</link> *registry,
                                                         <link linkend="GType">GType</link> type);
<link linkend="AtkRegistry">AtkRegistry</link>*        <link linkend="atk-get-default-registry">atk_get_default_registry</link>            (void);
</synopsis>
</refsynopsisdiv>

<refsect1 id="AtkRegistry.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----AtkRegistry
</synopsis>

</refsect1>








<refsect1 id="AtkRegistry.description" role="desc">
<title role="desc.title">Description</title>
<para>
The AtkRegistry is normally used to create appropriate ATK "peers" for user
interface components.  Application developers usually need only interact with
the AtkRegistry by associating appropriate ATK implementation classes with
GObject classes via the atk_registry_set_factory_type call, passing the
appropriate GType for application custom widget classes.
</para>
</refsect1>

<refsect1 id="AtkRegistry.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="AtkRegistry-struct" role="struct">
<title>AtkRegistry</title>
<indexterm zone="AtkRegistry-struct"><primary>AtkRegistry</primary></indexterm><programlisting>typedef struct _AtkRegistry AtkRegistry;</programlisting>
<para>
The AtkRegistry structure should not be accessed directly.

</para></refsect2>
<refsect2 id="atk-registry-set-factory-type" role="function">
<title>atk_registry_set_factory_type ()</title>
<indexterm zone="atk-registry-set-factory-type"><primary>atk_registry_set_factory_type</primary></indexterm><programlisting><link linkend="void">void</link>                atk_registry_set_factory_type       (<link linkend="AtkRegistry">AtkRegistry</link> *registry,
                                                         <link linkend="GType">GType</link> type,
                                                         <link linkend="GType">GType</link> factory_type);</programlisting>
<para>
Associate an <link linkend="AtkObjectFactory"><type>AtkObjectFactory</type></link> subclass with a <link linkend="GType"><type>GType</type></link>. Note:
The associated <parameter>factory_type</parameter> will thereafter be responsible for
the creation of new <link linkend="AtkObject"><type>AtkObject</type></link> implementations for instances
appropriate for <parameter>type</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>registry</parameter>&nbsp;:</term>
<listitem><simpara> the <link linkend="AtkRegistry"><type>AtkRegistry</type></link> in which to register the type association
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkObject"><type>AtkObject</type></link> type 
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>factory_type</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkObjectFactory"><type>AtkObjectFactory</type></link> type to associate with <parameter>type</parameter>.  Must
implement AtkObject appropriate for <parameter>type</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-registry-get-factory-type" role="function">
<title>atk_registry_get_factory_type ()</title>
<indexterm zone="atk-registry-get-factory-type"><primary>atk_registry_get_factory_type</primary></indexterm><programlisting><link linkend="GType">GType</link>               atk_registry_get_factory_type       (<link linkend="AtkRegistry">AtkRegistry</link> *registry,
                                                         <link linkend="GType">GType</link> type);</programlisting>
<para>
Provides a <link linkend="GType"><type>GType</type></link> indicating the <link linkend="AtkObjectFactory"><type>AtkObjectFactory</type></link> subclass
associated with <parameter>type</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>registry</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkRegistry"><type>AtkRegistry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GType"><type>GType</type></link> with which to look up the associated <link linkend="AtkObjectFactory"><type>AtkObjectFactory</type></link>
subclass
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="GType"><type>GType</type></link> associated with type <parameter>type</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-registry-get-factory" role="function">
<title>atk_registry_get_factory ()</title>
<indexterm zone="atk-registry-get-factory"><primary>atk_registry_get_factory</primary></indexterm><programlisting><link linkend="AtkObjectFactory">AtkObjectFactory</link>*   atk_registry_get_factory            (<link linkend="AtkRegistry">AtkRegistry</link> *registry,
                                                         <link linkend="GType">GType</link> type);</programlisting>
<para>
Gets an <link linkend="AtkObjectFactory"><type>AtkObjectFactory</type></link> appropriate for creating <link linkend="AtkObjects"><type>AtkObjects</type></link>
appropriate for <parameter>type</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>registry</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkRegistry"><type>AtkRegistry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GType"><type>GType</type></link> with which to look up the associated <link linkend="AtkObjectFactory"><type>AtkObjectFactory</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an <link linkend="AtkObjectFactory"><type>AtkObjectFactory</type></link> appropriate for creating <link linkend="AtkObjects"><type>AtkObjects</type></link>
appropriate for <parameter>type</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-get-default-registry" role="function">
<title>atk_get_default_registry ()</title>
<indexterm zone="atk-get-default-registry"><primary>atk_get_default_registry</primary></indexterm><programlisting><link linkend="AtkRegistry">AtkRegistry</link>*        atk_get_default_registry            (void);</programlisting>
<para>
Gets a default implementation of the <link linkend="AtkObjectFactory"><type>AtkObjectFactory</type></link>/type
registry.
Note: For most toolkit maintainers, this will be the correct
registry for registering new <link linkend="AtkObject"><type>AtkObject</type></link> factories. Following
a call to this function, maintainers may call <link linkend="atk-registry-set-factory-type"><function>atk_registry_set_factory_type()</function></link>
to associate an <link linkend="AtkObjectFactory"><type>AtkObjectFactory</type></link> subclass with the GType of objects
for whom accessibility information will be provided.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a default implementation of the <link linkend="AtkObjectFactory"><type>AtkObjectFactory</type></link>/type
registry
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>