atkrelationset.xml

linux下图形库开发包atk-1.4.0.tar.gz

<refentry id="AtkRelationSet">
<refmeta>
<refentrytitle>AtkRelationSet</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>ATK Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>AtkRelationSet</refname><refpurpose>A set of AtkRelations, normally the set of AtkRelations which an AtkObject has.</refpurpose>
</refnamediv>

<refsynopsisdiv><title>Synopsis</title>

<synopsis>



struct      <link linkend="AtkRelationSet-struct">AtkRelationSet</link>;
<link linkend="AtkRelationSet">AtkRelationSet</link>* <link linkend="atk-relation-set-new">atk_relation_set_new</link>        (void);
<link linkend="gboolean">gboolean</link>    <link linkend="atk-relation-set-contains">atk_relation_set_contains</link>       (<link linkend="AtkRelationSet">AtkRelationSet</link> *set,
                                             <link linkend="AtkRelationType">AtkRelationType</link> relationship);
<link linkend="void">void</link>        <link linkend="atk-relation-set-remove">atk_relation_set_remove</link>         (<link linkend="AtkRelationSet">AtkRelationSet</link> *set,
                                             <link linkend="AtkRelation">AtkRelation</link> *relation);
<link linkend="void">void</link>        <link linkend="atk-relation-set-add">atk_relation_set_add</link>            (<link linkend="AtkRelationSet">AtkRelationSet</link> *set,
                                             <link linkend="AtkRelation">AtkRelation</link> *relation);
<link linkend="gint">gint</link>        <link linkend="atk-relation-set-get-n-relations">atk_relation_set_get_n_relations</link>
                                            (<link linkend="AtkRelationSet">AtkRelationSet</link> *set);
<link linkend="AtkRelation">AtkRelation</link>* <link linkend="atk-relation-set-get-relation">atk_relation_set_get_relation</link>  (<link linkend="AtkRelationSet">AtkRelationSet</link> *set,
                                             <link linkend="gint">gint</link> i);
<link linkend="AtkRelation">AtkRelation</link>* <link linkend="atk-relation-set-get-relation-by-type">atk_relation_set_get_relation_by_type</link>
                                            (<link linkend="AtkRelationSet">AtkRelationSet</link> *set,
                                             <link linkend="AtkRelationType">AtkRelationType</link> relationship);

</synopsis>
</refsynopsisdiv>

<refsect1>
<title>Object Hierarchy</title>
<synopsis>

  <link linkend="GObject">GObject</link>
   +----AtkRelationSet
</synopsis>

</refsect1>








<refsect1>
<title>Description</title>
<para>

</para>
</refsect1>

<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="AtkRelationSet-struct"/>struct AtkRelationSet</title>
<indexterm><primary>AtkRelationSet</primary></indexterm><programlisting>struct AtkRelationSet;</programlisting>
<para>
The AtkRelationSet structure should not be accessed directly.

</para></refsect2>
<refsect2>
<title><anchor id="atk-relation-set-new"/>atk_relation_set_new ()</title>
<indexterm><primary>atk_relation_set_new</primary></indexterm><programlisting><link linkend="AtkRelationSet">AtkRelationSet</link>* atk_relation_set_new        (void);</programlisting>
<para>
Creates a new empty relation set.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="AtkRelationSet"><type>AtkRelationSet</type></link> 
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-relation-set-contains"/>atk_relation_set_contains ()</title>
<indexterm><primary>atk_relation_set_contains</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    atk_relation_set_contains       (<link linkend="AtkRelationSet">AtkRelationSet</link> *set,
                                             <link linkend="AtkRelationType">AtkRelationType</link> relationship);</programlisting>
<para>
Determines whether the relation set contains a relation that matches the
specified type.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>set</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkRelationSet"><type>AtkRelationSet</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>relationship</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkRelationType"><type>AtkRelationType</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> if <parameter>relationship</parameter> is the relationship type of a relation
in <parameter>set</parameter>, <literal>FALSE</literal> otherwise
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-relation-set-remove"/>atk_relation_set_remove ()</title>
<indexterm><primary>atk_relation_set_remove</primary></indexterm><programlisting><link linkend="void">void</link>        atk_relation_set_remove         (<link linkend="AtkRelationSet">AtkRelationSet</link> *set,
                                             <link linkend="AtkRelation">AtkRelation</link> *relation);</programlisting>
<para>
Removes a relation from the relation set.
This function unref's the <link linkend="AtkRelation"><type>AtkRelation</type></link> so it will be deleted unless there
is another reference to it.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>set</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkRelationSet"><type>AtkRelationSet</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>relation</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkRelation"><type>AtkRelation</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-relation-set-add"/>atk_relation_set_add ()</title>
<indexterm><primary>atk_relation_set_add</primary></indexterm><programlisting><link linkend="void">void</link>        atk_relation_set_add            (<link linkend="AtkRelationSet">AtkRelationSet</link> *set,
                                             <link linkend="AtkRelation">AtkRelation</link> *relation);</programlisting>
<para>
Add a new relation to the current relation set if it is not already
present.
This function ref's the AtkRelation so the caller of this function
should unref it to ensure that it will be destroyed when the AtkRelationSet
is destroyed.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>set</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkRelationSet"><type>AtkRelationSet</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>relation</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkRelation"><type>AtkRelation</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-relation-set-get-n-relations"/>atk_relation_set_get_n_relations ()</title>
<indexterm><primary>atk_relation_set_get_n_relations</primary></indexterm><programlisting><link linkend="gint">gint</link>        atk_relation_set_get_n_relations
                                            (<link linkend="AtkRelationSet">AtkRelationSet</link> *set);</programlisting>
<para>
Determines the number of relations in a relation set.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>set</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkRelationSet"><type>AtkRelationSet</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> an integer representing the number of relations in the set.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-relation-set-get-relation"/>atk_relation_set_get_relation ()</title>
<indexterm><primary>atk_relation_set_get_relation</primary></indexterm><programlisting><link linkend="AtkRelation">AtkRelation</link>* atk_relation_set_get_relation  (<link linkend="AtkRelationSet">AtkRelationSet</link> *set,
                                             <link linkend="gint">gint</link> i);</programlisting>
<para>
Determines the relation at the specified position in the relation set.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>set</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkRelationSet"><type>AtkRelationSet</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>i</parameter>&nbsp;:</term>
<listitem><simpara> a gint representing a position in the set, starting from 0.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="AtkRelation"><type>AtkRelation</type></link>, which is the relation at position i in the set.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-relation-set-get-relation-by-type"/>atk_relation_set_get_relation_by_type ()</title>
<indexterm><primary>atk_relation_set_get_relation_by_type</primary></indexterm><programlisting><link linkend="AtkRelation">AtkRelation</link>* atk_relation_set_get_relation_by_type
                                            (<link linkend="AtkRelationSet">AtkRelationSet</link> *set,
                                             <link linkend="AtkRelationType">AtkRelationType</link> relationship);</programlisting>
<para>
Finds a relation that matches the specified type.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>set</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkRelationSet"><type>AtkRelationSet</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>relationship</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkRelationType"><type>AtkRelationType</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> an <link linkend="AtkRelation"><type>AtkRelation</type></link>, which is a relation matching the specified type.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>