atkhypertext.xml

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

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

<refnamediv>
<refname>AtkHypertext</refname><refpurpose>The ATK interface which provides standard mechanism for manipulating hyperlinks.</refpurpose>
</refnamediv>

<refsynopsisdiv><title>Synopsis</title>

<synopsis>



struct      <link linkend="AtkHypertext-struct">AtkHypertext</link>;
<link linkend="AtkHyperlink">AtkHyperlink</link>* <link linkend="atk-hypertext-get-link">atk_hypertext_get_link</link>        (<link linkend="AtkHypertext">AtkHypertext</link> *hypertext,
                                             <link linkend="gint">gint</link> link_index);
<link linkend="gint">gint</link>        <link linkend="atk-hypertext-get-n-links">atk_hypertext_get_n_links</link>       (<link linkend="AtkHypertext">AtkHypertext</link> *hypertext);
<link linkend="gint">gint</link>        <link linkend="atk-hypertext-get-link-index">atk_hypertext_get_link_index</link>    (<link linkend="AtkHypertext">AtkHypertext</link> *hypertext,
                                             <link linkend="gint">gint</link> char_index);

</synopsis>
</refsynopsisdiv>

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

  <link linkend="GInterface">GInterface</link>
   +----AtkHypertext
</synopsis>

</refsect1>




<refsect1>
<title>Known Implementations</title>
<para>
AtkHypertext is implemented by
 <link linkend="AtkNoOpObject">AtkNoOpObject</link>.</para>

</refsect1>


<refsect1>
<title>Signal Prototypes</title>
<synopsis>

&quot;<link linkend="AtkHypertext-link-selected">link-selected</link>&quot;
            <link linkend="void">void</link>        user_function      (<link linkend="AtkHypertext">AtkHypertext</link> *atkhypertext,
                                            <link linkend="gint">gint</link> arg1,
                                            <link linkend="gpointer">gpointer</link> user_data);
</synopsis>
</refsect1>


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

</para>
</refsect1>

<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="AtkHypertext-struct"/>struct AtkHypertext</title>
<indexterm><primary>AtkHypertext</primary></indexterm><programlisting>struct AtkHypertext;</programlisting>
<para>
The AtkHypertext structure does not contain any fields.
</para></refsect2>
<refsect2>
<title><anchor id="atk-hypertext-get-link"/>atk_hypertext_get_link ()</title>
<indexterm><primary>atk_hypertext_get_link</primary></indexterm><programlisting><link linkend="AtkHyperlink">AtkHyperlink</link>* atk_hypertext_get_link        (<link linkend="AtkHypertext">AtkHypertext</link> *hypertext,
                                             <link linkend="gint">gint</link> link_index);</programlisting>
<para>
Gets the link in this hypertext document at index 
<parameter>link_index</parameter></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>hypertext</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkHypertext"><type>AtkHypertext</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>link_index</parameter>&nbsp;:</term>
<listitem><simpara> an integer specifying the desired link
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the link in this hypertext document at
index <parameter>link_index</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-hypertext-get-n-links"/>atk_hypertext_get_n_links ()</title>
<indexterm><primary>atk_hypertext_get_n_links</primary></indexterm><programlisting><link linkend="gint">gint</link>        atk_hypertext_get_n_links       (<link linkend="AtkHypertext">AtkHypertext</link> *hypertext);</programlisting>
<para>
Gets the number of links within this hypertext document.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>hypertext</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkHypertext"><type>AtkHypertext</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the number of links within this hypertext document
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-hypertext-get-link-index"/>atk_hypertext_get_link_index ()</title>
<indexterm><primary>atk_hypertext_get_link_index</primary></indexterm><programlisting><link linkend="gint">gint</link>        atk_hypertext_get_link_index    (<link linkend="AtkHypertext">AtkHypertext</link> *hypertext,
                                             <link linkend="gint">gint</link> char_index);</programlisting>
<para>
Gets the index into the array of hyperlinks that is associated with
the character specified by <parameter>char_index</parameter>, or -1 if there is no hyperlink
associated with this character.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>hypertext</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkHypertext"><type>AtkHypertext</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>char_index</parameter>&nbsp;:</term>
<listitem><simpara> a character index
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> an index into the array of hyperlinks in <parameter>hypertext</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>

<refsect1>
<title>Signals</title>
<refsect2><title><anchor id="AtkHypertext-link-selected"/>The &quot;link-selected&quot; signal</title>
<programlisting><link linkend="void">void</link>        user_function                  (<link linkend="AtkHypertext">AtkHypertext</link> *atkhypertext,
                                            <link linkend="gint">gint</link> arg1,
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>atkhypertext</parameter>&nbsp;:</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
<listitem><simpara>

</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>



</refentry>