atkstateset.xml

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

<varlistentry><term><parameter>set</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkStateSet"><type>AtkStateSet</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-state-set-contains-state" role="function">
<title>atk_state_set_contains_state ()</title>
<indexterm zone="atk-state-set-contains-state"><primary>atk_state_set_contains_state</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            atk_state_set_contains_state        (<link linkend="AtkStateSet">AtkStateSet</link> *set,
                                                         <link linkend="AtkStateType">AtkStateType</link> type);</programlisting>
<para>
Checks whether the state for the specified type is in the specified set.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>set</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkStateSet"><type>AtkStateSet</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkStateType"><type>AtkStateType</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>type</parameter> is the state type is in <parameter>set</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-state-set-contains-states" role="function">
<title>atk_state_set_contains_states ()</title>
<indexterm zone="atk-state-set-contains-states"><primary>atk_state_set_contains_states</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            atk_state_set_contains_states       (<link linkend="AtkStateSet">AtkStateSet</link> *set,
                                                         <link linkend="AtkStateType">AtkStateType</link> *types,
                                                         <link linkend="gint">gint</link> n_types);</programlisting>
<para>
Checks whether the states for all the specified types are in the 
specified set.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>set</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkStateSet"><type>AtkStateSet</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>types</parameter>&nbsp;:</term>
<listitem><simpara> an array of <link linkend="AtkStateType"><type>AtkStateType</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>n_types</parameter>&nbsp;:</term>
<listitem><simpara> The number of elements in the array
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if all the states for <parameter>type</parameter> are in <parameter>set</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-state-set-remove-state" role="function">
<title>atk_state_set_remove_state ()</title>
<indexterm zone="atk-state-set-remove-state"><primary>atk_state_set_remove_state</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            atk_state_set_remove_state          (<link linkend="AtkStateSet">AtkStateSet</link> *set,
                                                         <link linkend="AtkStateType">AtkStateType</link> type);</programlisting>
<para>
Removes the state for the specified type from the state set.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>set</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkStateSet"><type>AtkStateSet</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkType"><type>AtkType</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>type</parameter> was the state type is in <parameter>set</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-state-set-and-sets" role="function">
<title>atk_state_set_and_sets ()</title>
<indexterm zone="atk-state-set-and-sets"><primary>atk_state_set_and_sets</primary></indexterm><programlisting><link linkend="AtkStateSet">AtkStateSet</link>*        atk_state_set_and_sets              (<link linkend="AtkStateSet">AtkStateSet</link> *set,
                                                         <link linkend="AtkStateSet">AtkStateSet</link> *compare_set);</programlisting>
<para>
Constructs the intersection of the two sets, returning <link linkend="NULL:CAPS"><literal>NULL</literal></link> if the
intersection is empty.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>set</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkStateSet"><type>AtkStateSet</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>compare_set</parameter>&nbsp;:</term>
<listitem><simpara> another <link linkend="AtkStateSet"><type>AtkStateSet</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="AtkStateSet"><type>AtkStateSet</type></link> which is the intersection of the two sets.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-state-set-or-sets" role="function">
<title>atk_state_set_or_sets ()</title>
<indexterm zone="atk-state-set-or-sets"><primary>atk_state_set_or_sets</primary></indexterm><programlisting><link linkend="AtkStateSet">AtkStateSet</link>*        atk_state_set_or_sets               (<link linkend="AtkStateSet">AtkStateSet</link> *set,
                                                         <link linkend="AtkStateSet">AtkStateSet</link> *compare_set);</programlisting>
<para>
Constructs the union of the two sets.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>set</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkStateSet"><type>AtkStateSet</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>compare_set</parameter>&nbsp;:</term>
<listitem><simpara> another <link linkend="AtkStateSet"><type>AtkStateSet</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="AtkStateSet"><type>AtkStateSet</type></link> which is the union of the two sets,
returning <link linkend="NULL:CAPS"><literal>NULL</literal></link> is empty.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-state-set-xor-sets" role="function">
<title>atk_state_set_xor_sets ()</title>
<indexterm zone="atk-state-set-xor-sets"><primary>atk_state_set_xor_sets</primary></indexterm><programlisting><link linkend="AtkStateSet">AtkStateSet</link>*        atk_state_set_xor_sets              (<link linkend="AtkStateSet">AtkStateSet</link> *set,
                                                         <link linkend="AtkStateSet">AtkStateSet</link> *compare_set);</programlisting>
<para>
Constructs the exclusive-or of the two sets, returning <link linkend="NULL:CAPS"><literal>NULL</literal></link> is empty.
The set returned by this operation contains the states in exactly
one of the two sets.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>set</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkStateSet"><type>AtkStateSet</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>compare_set</parameter>&nbsp;:</term>
<listitem><simpara> another <link linkend="AtkStateSet"><type>AtkStateSet</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="AtkStateSet"><type>AtkStateSet</type></link> which contains the states which are 
in exactly one of the two sets.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>