atkhypertext.xml

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

<refentry id="AtkHypertext">
<refmeta>
<refentrytitle role="top_of_page" id="AtkHypertext.top_of_page">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>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

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

<synopsis>
                    <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 id="AtkHypertext.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GInterface">GInterface</link>
   +----AtkHypertext
</synopsis>

</refsect1>




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

</refsect1>


<refsect1 id="AtkHypertext.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
  &quot;<link linkend="AtkHypertext-link-selected">link-selected</link>&quot;                                  : Run Last
</synopsis>
</refsect1>


<refsect1 id="AtkHypertext.description" role="desc">
<title role="desc.title">Description</title>
<para>
An interface used for objects which implement linking between multiple
resource or content locations, or multiple 'markers' within a single
document.  A Hypertext instance is associated with one or more Hyperlinks,
which are associated with particular offsets within the Hypertext's included
content.  While this interface is derived from Text, there is no requirement that Hypertext instances have textual content; they may implement Image as well, and Hyperlinks need not have non-zero text offsets.
</para>
</refsect1>

<refsect1 id="AtkHypertext.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="AtkHypertext-struct" role="struct">
<title>AtkHypertext</title>
<indexterm zone="AtkHypertext-struct"><primary>AtkHypertext</primary></indexterm><programlisting>typedef struct _AtkHypertext AtkHypertext;</programlisting>
<para>
The AtkHypertext structure does not contain any fields.
</para></refsect2>
<refsect2 id="atk-hypertext-get-link" role="function">
<title>atk_hypertext_get_link ()</title>
<indexterm zone="atk-hypertext-get-link"><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>&nbsp;:</term><listitem><simpara> the link in this hypertext document at
index <parameter>link_index</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-hypertext-get-n-links" role="function">
<title>atk_hypertext_get_n_links ()</title>
<indexterm zone="atk-hypertext-get-n-links"><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>&nbsp;:</term><listitem><simpara> the number of links within this hypertext document
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-hypertext-get-link-index" role="function">
<title>atk_hypertext_get_link_index ()</title>
<indexterm zone="atk-hypertext-get-link-index"><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>.</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>&nbsp;:</term><listitem><simpara> an index into the array of hyperlinks in <parameter>hypertext</parameter>,
or -1 if there is no hyperlink associated with this character.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>

<refsect1 id="AtkHypertext.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="AtkHypertext-link-selected"><title>The <literal>&quot;link-selected&quot;</literal> signal</title>
<indexterm zone="AtkHypertext-link-selected"><primary>AtkHypertext::link-selected</primary></indexterm><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)         : Run Last</programlisting>
<para>
The "link-selected" signal is emitted by an AtkHyperText object when one of
the hyperlinks associated with the object is selected.
</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>the index of the hyperlink which is selected

</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>


<refsect1 id="AtkHypertext.see-also">
<title>See Also</title>
<para>
AtkHyperlink
</para>
</refsect1>

</refentry>