atkhyperlink.xml

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

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

<refnamediv>
<refname>AtkHyperlink</refname>
<refpurpose>An ATK object which encapsulates a link or set of links in a hypertext document.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

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

<synopsis>
                    <link linkend="AtkHyperlink-struct">AtkHyperlink</link>;
enum                <link linkend="AtkHyperlinkStateFlags">AtkHyperlinkStateFlags</link>;
<link linkend="gchar">gchar</link>*              <link linkend="atk-hyperlink-get-uri">atk_hyperlink_get_uri</link>               (<link linkend="AtkHyperlink">AtkHyperlink</link> *link_,
                                                         <link linkend="gint">gint</link> i);
<link linkend="AtkObject">AtkObject</link>*          <link linkend="atk-hyperlink-get-object">atk_hyperlink_get_object</link>            (<link linkend="AtkHyperlink">AtkHyperlink</link> *link_,
                                                         <link linkend="gint">gint</link> i);
<link linkend="gint">gint</link>                <link linkend="atk-hyperlink-get-end-index">atk_hyperlink_get_end_index</link>         (<link linkend="AtkHyperlink">AtkHyperlink</link> *link_);
<link linkend="gint">gint</link>                <link linkend="atk-hyperlink-get-start-index">atk_hyperlink_get_start_index</link>       (<link linkend="AtkHyperlink">AtkHyperlink</link> *link_);
<link linkend="gboolean">gboolean</link>            <link linkend="atk-hyperlink-is-valid">atk_hyperlink_is_valid</link>              (<link linkend="AtkHyperlink">AtkHyperlink</link> *link_);
<link linkend="gboolean">gboolean</link>            <link linkend="atk-hyperlink-is-inline">atk_hyperlink_is_inline</link>             (<link linkend="AtkHyperlink">AtkHyperlink</link> *link_);
<link linkend="gint">gint</link>                <link linkend="atk-hyperlink-get-n-anchors">atk_hyperlink_get_n_anchors</link>         (<link linkend="AtkHyperlink">AtkHyperlink</link> *link_);
<link linkend="gboolean">gboolean</link>            <link linkend="atk-hyperlink-is-selected-link">atk_hyperlink_is_selected_link</link>      (<link linkend="AtkHyperlink">AtkHyperlink</link> *link_);
</synopsis>
</refsynopsisdiv>

<refsect1 id="AtkHyperlink.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----AtkHyperlink
</synopsis>

</refsect1>



<refsect1 id="AtkHyperlink.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
AtkHyperlink implements
 <link linkend="AtkAction">AtkAction</link>.</para>

</refsect1>


<refsect1 id="AtkHyperlink.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
  &quot;<link linkend="AtkHyperlink--end-index">end-index</link>&quot;                <link linkend="gint">gint</link>                  : Read
  &quot;<link linkend="AtkHyperlink--number-of-anchors">number-of-anchors</link>&quot;        <link linkend="gint">gint</link>                  : Read
  &quot;<link linkend="AtkHyperlink--selected-link">selected-link</link>&quot;            <link linkend="gboolean">gboolean</link>              : Read
  &quot;<link linkend="AtkHyperlink--start-index">start-index</link>&quot;              <link linkend="gint">gint</link>                  : Read
</synopsis>
</refsect1>

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


<refsect1 id="AtkHyperlink.description" role="desc">
<title role="desc.title">Description</title>
<para>
An ATK object which encapsulates a link or set of links 
(for instance in the case of client-side image maps) in a hypertext document.
It may implement the AtkAction interface.  AtkHyperlink may also be used
to refer to inline embedded content, since it allows specification of a start
and end offset within the host AtkHypertext object.
</para>
</refsect1>

<refsect1 id="AtkHyperlink.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="AtkHyperlink-struct" role="struct">
<title>AtkHyperlink</title>
<indexterm zone="AtkHyperlink-struct"><primary>AtkHyperlink</primary></indexterm><programlisting>typedef struct _AtkHyperlink AtkHyperlink;</programlisting>
<para>
The AtkHyperlink structure should not be accessed directly.

</para></refsect2>
<refsect2 id="AtkHyperlinkStateFlags" role="enum">
<title>enum AtkHyperlinkStateFlags</title>
<indexterm zone="AtkHyperlinkStateFlags"><primary>AtkHyperlinkStateFlags</primary></indexterm><programlisting>typedef enum 
{
  ATK_HYPERLINK_IS_INLINE = 1 &lt;&lt; 0
} AtkHyperlinkStateFlags;
</programlisting>
<para>
Describes the type of link</para>
<para>

</para><variablelist role="enum">
<varlistentry id="ATK-HYPERLINK-IS-INLINE:CAPS" role="constant">
<term><literal>ATK_HYPERLINK_IS_INLINE</literal></term>
<listitem><simpara> Link is inline
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-hyperlink-get-uri" role="function">
<title>atk_hyperlink_get_uri ()</title>
<indexterm zone="atk-hyperlink-get-uri"><primary>atk_hyperlink_get_uri</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              atk_hyperlink_get_uri               (<link linkend="AtkHyperlink">AtkHyperlink</link> *link_,
                                                         <link linkend="gint">gint</link> i);</programlisting>
<para>
Get a the URI associated with the anchor specified 
by <parameter>i</parameter> of <parameter>link_</parameter>. 
</para>
<para>
Multiple anchors are primarily used by client-side image maps.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>link_</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkHyperlink"><type>AtkHyperlink</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>i</parameter>&nbsp;:</term>
<listitem><simpara> a (zero-index) integer specifying the desired anchor
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a string specifying the URI 
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-hyperlink-get-object" role="function">
<title>atk_hyperlink_get_object ()</title>
<indexterm zone="atk-hyperlink-get-object"><primary>atk_hyperlink_get_object</primary></indexterm><programlisting><link linkend="AtkObject">AtkObject</link>*          atk_hyperlink_get_object            (<link linkend="AtkHyperlink">AtkHyperlink</link> *link_,
                                                         <link linkend="gint">gint</link> i);</programlisting>
<para>
Returns the item associated with this hyperlinks nth anchor.
For instance, the returned <link linkend="AtkObject"><type>AtkObject</type></link> will implement <link linkend="AtkText"><type>AtkText</type></link>
if <parameter>link_</parameter> is a text hyperlink, <link linkend="AtkImage"><type>AtkImage</type></link> if <parameter>link_</parameter> is an image
hyperlink etc. 
</para>
<para>
Multiple anchors are primarily used by client-side image maps.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>link_</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkHyperlink"><type>AtkHyperlink</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>i</parameter>&nbsp;:</term>
<listitem><simpara> a (zero-index) integer specifying the desired anchor
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an <link linkend="AtkObject"><type>AtkObject</type></link> associated with this hyperlinks i-th anchor