<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
  <!ENTITY % gtkdocentities SYSTEM "../xml/gtkdocentities.ent">
  %gtkdocentities;
]>
<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>
</refnamediv>

<refsect1 id="AtkHypertext.functions" role="functions_proto">
<title role="functions_proto.title">Functions</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="functions_proto_type" colwidth="150px"/>
<colspec colname="functions_proto_name"/>
<tbody>
<row><entry role="function_type"><link linkend="AtkHyperlink"><returnvalue>AtkHyperlink</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="atk-hypertext-get-link">atk_hypertext_get_link</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gint"><returnvalue>gint</returnvalue></link>
</entry><entry role="function_name"><link linkend="atk-hypertext-get-n-links">atk_hypertext_get_n_links</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gint"><returnvalue>gint</returnvalue></link>
</entry><entry role="function_name"><link linkend="atk-hypertext-get-link-index">atk_hypertext_get_link_index</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="AtkHypertext.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<informaltable frame="none">
<tgroup cols="3">
<colspec colname="signal_proto_type" colwidth="150px"/>
<colspec colname="signal_proto_name" colwidth="300px"/>
<colspec colname="signal_proto_flags" colwidth="200px"/>
<tbody>
<row><entry role="signal_type"><link linkend="void"><returnvalue>void</returnvalue></link></entry><entry role="signal_name"><link linkend="AtkHypertext-link-selected">link-selected</link></entry><entry role="signal_flags"><link linkend="G-SIGNAL-RUN-LAST:CAPS">Run Last</link></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="AtkHypertext.other" role="other_proto">
<title role="other_proto.title">Types and Values</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="other_proto_type" colwidth="150px"/>
<colspec colname="other_proto_name"/>
<tbody>
<row><entry role="datatype_keyword"></entry><entry role="function_name"><link linkend="AtkHypertext-struct">AtkHypertext</link></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="AtkHypertext.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<screen>    <link linkend="GInterface">GInterface</link>
    <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> AtkHypertext
</screen>
</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.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.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="atk-hypertext-get-link" role="function">
<title>atk_hypertext_get_link&#160;()</title>
<indexterm zone="atk-hypertext-get-link"><primary>atk_hypertext_get_link</primary></indexterm>
<programlisting language="C"><link linkend="AtkHyperlink"><returnvalue>AtkHyperlink</returnvalue></link>&#160;*
atk_hypertext_get_link (<parameter><link linkend="AtkHypertext"><type>AtkHypertext</type></link> *hypertext</parameter>,
                        <parameter><link linkend="gint"><type>gint</type></link> link_index</parameter>);</programlisting>
<para>Gets the link in this hypertext document at index 
<parameter>link_index</parameter>
</para>
<refsect3 id="atk-hypertext-get-link.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>hypertext</para></entry>
<entry role="parameter_description"><para>an <link linkend="AtkHypertext"><type>AtkHypertext</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>link_index</para></entry>
<entry role="parameter_description"><para>an integer specifying the desired link</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="atk-hypertext-get-link.returns" role="returns">
<title>Returns</title>
<para>the link in this hypertext document at
index <parameter>link_index</parameter>
. </para>
<para><emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="atk-hypertext-get-n-links" role="function">
<title>atk_hypertext_get_n_links&#160;()</title>
<indexterm zone="atk-hypertext-get-n-links"><primary>atk_hypertext_get_n_links</primary></indexterm>
<programlisting language="C"><link linkend="gint"><returnvalue>gint</returnvalue></link>
atk_hypertext_get_n_links (<parameter><link linkend="AtkHypertext"><type>AtkHypertext</type></link> *hypertext</parameter>);</programlisting>
<para>Gets the number of links within this hypertext document.</para>
<refsect3 id="atk-hypertext-get-n-links.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>hypertext</para></entry>
<entry role="parameter_description"><para>an <link linkend="AtkHypertext"><type>AtkHypertext</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="atk-hypertext-get-n-links.returns" role="returns">
<title>Returns</title>
<para> the number of links within this hypertext document</para>
</refsect3></refsect2>
<refsect2 id="atk-hypertext-get-link-index" role="function">
<title>atk_hypertext_get_link_index&#160;()</title>
<indexterm zone="atk-hypertext-get-link-index"><primary>atk_hypertext_get_link_index</primary></indexterm>
<programlisting language="C"><link linkend="gint"><returnvalue>gint</returnvalue></link>
atk_hypertext_get_link_index (<parameter><link linkend="AtkHypertext"><type>AtkHypertext</type></link> *hypertext</parameter>,
                              <parameter><link linkend="gint"><type>gint</type></link> char_index</parameter>);</programlisting>
<para>Gets the index into the array of hyperlinks that is associated with
the character specified by <parameter>char_index</parameter>
.</para>
<refsect3 id="atk-hypertext-get-link-index.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>hypertext</para></entry>
<entry role="parameter_description"><para>an <link linkend="AtkHypertext"><type>AtkHypertext</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>char_index</para></entry>
<entry role="parameter_description"><para>a character index</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="atk-hypertext-get-link-index.returns" role="returns">
<title>Returns</title>
<para> an index into the array of hyperlinks in <parameter>hypertext</parameter>
,
or -1 if there is no hyperlink associated with this character.</para>
</refsect3></refsect2>

</refsect1>
<refsect1 id="AtkHypertext.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="AtkHypertext-struct" role="struct">
<title>AtkHypertext</title>
<indexterm zone="AtkHypertext-struct"><primary>AtkHypertext</primary></indexterm>
<programlisting language="C">typedef struct _AtkHypertext AtkHypertext;</programlisting>
</refsect2>

</refsect1>
<refsect1 id="AtkHypertext.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="AtkHypertext-link-selected" role="signal"><title>The <literal>“link-selected”</literal> signal</title>
<indexterm zone="AtkHypertext-link-selected"><primary>AtkHypertext::link-selected</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
user_function (<link linkend="AtkHypertext"><type>AtkHypertext</type></link> *atkhypertext,
               <link linkend="gint"><type>gint</type></link>          arg1,
               <link linkend="gpointer"><type>gpointer</type></link>      user_data)</programlisting>
<para>The "link-selected" signal is emitted by an AtkHyperText
object when one of the hyperlinks associated with the object
is selected.</para>
<refsect3 id="AtkHypertext-link-selected.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>atkhypertext</para></entry>
<entry role="parameter_description"><para>the object which received the signal.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>arg1</para></entry>
<entry role="parameter_description"><para>the index of the hyperlink which is selected</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><simpara>user_data</simpara></entry>
<entry role="parameter_description"><simpara>user data set when the signal handler was connected.</simpara></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><para>Flags: <link linkend="G-SIGNAL-RUN-LAST:CAPS">Run Last</link></para>
</refsect2>
</refsect1>

</refentry>
