atkstateset.xml

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

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

<refnamediv>
<refname>AtkStateSet</refname>
<refpurpose>An AtkStateSet determines a component's state set.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="atk-AtkStateSet.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
<link linkend="AtkStateSet">AtkStateSet</link>*        <link linkend="atk-state-set-new">atk_state_set_new</link>                   (void);
<link linkend="gboolean">gboolean</link>            <link linkend="atk-state-set-is-empty">atk_state_set_is_empty</link>              (<link linkend="AtkStateSet">AtkStateSet</link> *set);
<link linkend="gboolean">gboolean</link>            <link linkend="atk-state-set-add-state">atk_state_set_add_state</link>             (<link linkend="AtkStateSet">AtkStateSet</link> *set,
                                                         <link linkend="AtkStateType">AtkStateType</link> type);
<link linkend="void">void</link>                <link linkend="atk-state-set-add-states">atk_state_set_add_states</link>            (<link linkend="AtkStateSet">AtkStateSet</link> *set,
                                                         <link linkend="AtkStateType">AtkStateType</link> *types,
                                                         <link linkend="gint">gint</link> n_types);
<link linkend="void">void</link>                <link linkend="atk-state-set-clear-states">atk_state_set_clear_states</link>          (<link linkend="AtkStateSet">AtkStateSet</link> *set);
<link linkend="gboolean">gboolean</link>            <link linkend="atk-state-set-contains-state">atk_state_set_contains_state</link>        (<link linkend="AtkStateSet">AtkStateSet</link> *set,
                                                         <link linkend="AtkStateType">AtkStateType</link> type);
<link linkend="gboolean">gboolean</link>            <link linkend="atk-state-set-contains-states">atk_state_set_contains_states</link>       (<link linkend="AtkStateSet">AtkStateSet</link> *set,
                                                         <link linkend="AtkStateType">AtkStateType</link> *types,
                                                         <link linkend="gint">gint</link> n_types);
<link linkend="gboolean">gboolean</link>            <link linkend="atk-state-set-remove-state">atk_state_set_remove_state</link>          (<link linkend="AtkStateSet">AtkStateSet</link> *set,
                                                         <link linkend="AtkStateType">AtkStateType</link> type);
<link linkend="AtkStateSet">AtkStateSet</link>*        <link linkend="atk-state-set-and-sets">atk_state_set_and_sets</link>              (<link linkend="AtkStateSet">AtkStateSet</link> *set,
                                                         <link linkend="AtkStateSet">AtkStateSet</link> *compare_set);
<link linkend="AtkStateSet">AtkStateSet</link>*        <link linkend="atk-state-set-or-sets">atk_state_set_or_sets</link>               (<link linkend="AtkStateSet">AtkStateSet</link> *set,
                                                         <link linkend="AtkStateSet">AtkStateSet</link> *compare_set);
<link linkend="AtkStateSet">AtkStateSet</link>*        <link linkend="atk-state-set-xor-sets">atk_state_set_xor_sets</link>              (<link linkend="AtkStateSet">AtkStateSet</link> *set,
                                                         <link linkend="AtkStateSet">AtkStateSet</link> *compare_set);
</synopsis>
</refsynopsisdiv>









<refsect1 id="atk-AtkStateSet.description" role="desc">
<title role="desc.title">Description</title>
<para>
An AtkStateSet determines a component's state set. It is composed of a set 
of AtkStates.
</para>
</refsect1>

<refsect1 id="atk-AtkStateSet.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="atk-state-set-new" role="function">
<title>atk_state_set_new ()</title>
<indexterm zone="atk-state-set-new"><primary>atk_state_set_new</primary></indexterm><programlisting><link linkend="AtkStateSet">AtkStateSet</link>*        atk_state_set_new                   (void);</programlisting>
<para>
Creates a new empty state set.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="AtkStateSet"><type>AtkStateSet</type></link> 
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-state-set-is-empty" role="function">
<title>atk_state_set_is_empty ()</title>
<indexterm zone="atk-state-set-is-empty"><primary>atk_state_set_is_empty</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            atk_state_set_is_empty              (<link linkend="AtkStateSet">AtkStateSet</link> *set);</programlisting>
<para>
Checks whether the state set is empty, i.e. has no states set.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>set</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>set</parameter> has no states set, otherwise <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-state-set-add-state" role="function">
<title>atk_state_set_add_state ()</title>
<indexterm zone="atk-state-set-add-state"><primary>atk_state_set_add_state</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            atk_state_set_add_state             (<link linkend="AtkStateSet">AtkStateSet</link> *set,
                                                         <link linkend="AtkStateType">AtkStateType</link> type);</programlisting>
<para>
Add a new state for the specified type to the current state set if
it is not already present.</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  the state for <parameter>type</parameter> is not already in <parameter>set</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-state-set-add-states" role="function">
<title>atk_state_set_add_states ()</title>
<indexterm zone="atk-state-set-add-states"><primary>atk_state_set_add_states</primary></indexterm><programlisting><link linkend="void">void</link>                atk_state_set_add_states            (<link linkend="AtkStateSet">AtkStateSet</link> *set,
                                                         <link linkend="AtkStateType">AtkStateType</link> *types,
                                                         <link linkend="gint">gint</link> n_types);</programlisting>
<para>
Add the states for the specified types to the current 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>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>
</variablelist></refsect2>
<refsect2 id="atk-state-set-clear-states" role="function">
<title>atk_state_set_clear_states ()</title>
<indexterm zone="atk-state-set-clear-states"><primary>atk_state_set_clear_states</primary></indexterm><programlisting><link linkend="void">void</link>                atk_state_set_clear_states          (<link linkend="AtkStateSet">AtkStateSet</link> *set);</programlisting>
<para>
Removes all states from the state set.</para>
<para>

</para><variablelist role="params">