<?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="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>
</refnamediv>

<refsect1 id="AtkHyperlink.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="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="atk-hyperlink-get-uri">atk_hyperlink_get_uri</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="AtkObject"><returnvalue>AtkObject</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="atk-hyperlink-get-object">atk_hyperlink_get_object</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-hyperlink-get-end-index">atk_hyperlink_get_end_index</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-hyperlink-get-start-index">atk_hyperlink_get_start_index</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="atk-hyperlink-is-valid">atk_hyperlink_is_valid</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="atk-hyperlink-is-inline">atk_hyperlink_is_inline</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-hyperlink-get-n-anchors">atk_hyperlink_get_n_anchors</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="atk-hyperlink-is-selected-link">atk_hyperlink_is_selected_link</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="AtkHyperlink.properties" role="properties">
<title role="properties.title">Properties</title>
<informaltable frame="none">
<tgroup cols="3">
<colspec colname="properties_type" colwidth="150px"/>
<colspec colname="properties_name" colwidth="300px"/>
<colspec colname="properties_flags" colwidth="200px"/>
<tbody>
<row><entry role="property_type"><link linkend="gint"><type>gint</type></link></entry><entry role="property_name"><link linkend="AtkHyperlink--end-index">end-index</link></entry><entry role="property_flags">Read</entry></row>
<row><entry role="property_type"><link linkend="gint"><type>gint</type></link></entry><entry role="property_name"><link linkend="AtkHyperlink--number-of-anchors">number-of-anchors</link></entry><entry role="property_flags">Read</entry></row>
<row><entry role="property_type"><link linkend="gboolean"><type>gboolean</type></link></entry><entry role="property_name"><link linkend="AtkHyperlink--selected-link">selected-link</link></entry><entry role="property_flags">Read</entry></row>
<row><entry role="property_type"><link linkend="gint"><type>gint</type></link></entry><entry role="property_name"><link linkend="AtkHyperlink--start-index">start-index</link></entry><entry role="property_flags">Read</entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="AtkHyperlink.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="AtkHyperlink-link-activated">link-activated</link></entry><entry role="signal_flags"><link linkend="G-SIGNAL-RUN-LAST:CAPS">Run Last</link></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="AtkHyperlink.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">struct</entry><entry role="function_name"><link linkend="AtkHyperlink-struct">AtkHyperlink</link></entry></row>
<row><entry role="datatype_keyword">enum</entry><entry role="function_name"><link linkend="AtkHyperlinkStateFlags">AtkHyperlinkStateFlags</link></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="AtkHyperlink.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<screen>    <link linkend="GFlags">GFlags</link>
    <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> AtkHyperlinkStateFlags
    <link linkend="GObject">GObject</link>
    <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> AtkHyperlink
</screen>
</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.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.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="atk-hyperlink-get-uri" role="function">
<title>atk_hyperlink_get_uri&#160;()</title>
<indexterm zone="atk-hyperlink-get-uri"><primary>atk_hyperlink_get_uri</primary></indexterm>
<programlisting language="C"><link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
atk_hyperlink_get_uri (<parameter><link linkend="AtkHyperlink"><type>AtkHyperlink</type></link> *link_</parameter>,
                       <parameter><link linkend="gint"><type>gint</type></link> i</parameter>);</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>
<refsect3 id="atk-hyperlink-get-uri.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>link_</para></entry>
<entry role="parameter_description"><para>an <link linkend="AtkHyperlink"><type>AtkHyperlink</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>i</para></entry>
<entry role="parameter_description"><para>a (zero-index) integer specifying the desired anchor</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="atk-hyperlink-get-uri.returns" role="returns">
<title>Returns</title>
<para> a string specifying the URI </para>
</refsect3></refsect2>
<refsect2 id="atk-hyperlink-get-object" role="function">
<title>atk_hyperlink_get_object&#160;()</title>
<indexterm zone="atk-hyperlink-get-object"><primary>atk_hyperlink_get_object</primary></indexterm>
<programlisting language="C"><link linkend="AtkObject"><returnvalue>AtkObject</returnvalue></link>&#160;*
atk_hyperlink_get_object (<parameter><link linkend="AtkHyperlink"><type>AtkHyperlink</type></link> *link_</parameter>,
                          <parameter><link linkend="gint"><type>gint</type></link> i</parameter>);</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>
<refsect3 id="atk-hyperlink-get-object.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>link_</para></entry>
<entry role="parameter_description"><para>an <link linkend="AtkHyperlink"><type>AtkHyperlink</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>i</para></entry>
<entry role="parameter_description"><para>a (zero-index) integer specifying the desired anchor</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="atk-hyperlink-get-object.returns" role="returns">
<title>Returns</title>
<para>an <link linkend="AtkObject"><type>AtkObject</type></link> associated with this hyperlinks
i-th anchor. </para>
<para><emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="atk-hyperlink-get-end-index" role="function">
<title>atk_hyperlink_get_end_index&#160;()</title>
<indexterm zone="atk-hyperlink-get-end-index"><primary>atk_hyperlink_get_end_index</primary></indexterm>
<programlisting language="C"><link linkend="gint"><returnvalue>gint</returnvalue></link>
atk_hyperlink_get_end_index (<parameter><link linkend="AtkHyperlink"><type>AtkHyperlink</type></link> *link_</parameter>);</programlisting>
<para>Gets the index with the hypertext document at which this link ends.</para>
<refsect3 id="atk-hyperlink-get-end-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>link_</para></entry>
<entry role="parameter_description"><para>an <link linkend="AtkHyperlink"><type>AtkHyperlink</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="atk-hyperlink-get-end-index.returns" role="returns">
<title>Returns</title>
<para> the index with the hypertext document at which this link ends</para>
</refsect3></refsect2>
<refsect2 id="atk-hyperlink-get-start-index" role="function">
<title>atk_hyperlink_get_start_index&#160;()</title>
<indexterm zone="atk-hyperlink-get-start-index"><primary>atk_hyperlink_get_start_index</primary></indexterm>
<programlisting language="C"><link linkend="gint"><returnvalue>gint</returnvalue></link>
atk_hyperlink_get_start_index (<parameter><link linkend="AtkHyperlink"><type>AtkHyperlink</type></link> *link_</parameter>);</programlisting>
<para>Gets the index with the hypertext document at which this link begins.</para>
<refsect3 id="atk-hyperlink-get-start-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>link_</para></entry>
<entry role="parameter_description"><para>an <link linkend="AtkHyperlink"><type>AtkHyperlink</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="atk-hyperlink-get-start-index.returns" role="returns">
<title>Returns</title>
<para> the index with the hypertext document at which this link begins</para>
</refsect3></refsect2>
<refsect2 id="atk-hyperlink-is-valid" role="function">
<title>atk_hyperlink_is_valid&#160;()</title>
<indexterm zone="atk-hyperlink-is-valid"><primary>atk_hyperlink_is_valid</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
atk_hyperlink_is_valid (<parameter><link linkend="AtkHyperlink"><type>AtkHyperlink</type></link> *link_</parameter>);</programlisting>
<para>Since the document that a link is associated with may have changed
this method returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the link is still valid (with
respect to the document it references) and <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.</para>
<refsect3 id="atk-hyperlink-is-valid.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>link_</para></entry>
<entry role="parameter_description"><para>an <link linkend="AtkHyperlink"><type>AtkHyperlink</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="atk-hyperlink-is-valid.returns" role="returns">
<title>Returns</title>
<para> whether or not this link is still valid</para>
</refsect3></refsect2>
<refsect2 id="atk-hyperlink-is-inline" role="function">
<title>atk_hyperlink_is_inline&#160;()</title>
<indexterm zone="atk-hyperlink-is-inline"><primary>atk_hyperlink_is_inline</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
atk_hyperlink_is_inline (<parameter><link linkend="AtkHyperlink"><type>AtkHyperlink</type></link> *link_</parameter>);</programlisting>
<para>Indicates whether the link currently displays some or all of its
          content inline.  Ordinary HTML links will usually return
          <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>, but an inline &lt;src&gt; HTML element will return
          <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>.</para>
<refsect3 id="atk-hyperlink-is-inline.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>link_</para></entry>
<entry role="parameter_description"><para>an <link linkend="AtkHyperlink"><type>AtkHyperlink</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="atk-hyperlink-is-inline.returns" role="returns">
<title>Returns</title>
<para> whether or not this link displays its content inline.</para>
</refsect3></refsect2>
<refsect2 id="atk-hyperlink-get-n-anchors" role="function">
<title>atk_hyperlink_get_n_anchors&#160;()</title>
<indexterm zone="atk-hyperlink-get-n-anchors"><primary>atk_hyperlink_get_n_anchors</primary></indexterm>
<programlisting language="C"><link linkend="gint"><returnvalue>gint</returnvalue></link>
atk_hyperlink_get_n_anchors (<parameter><link linkend="AtkHyperlink"><type>AtkHyperlink</type></link> *link_</parameter>);</programlisting>
<para>Gets the number of anchors associated with this hyperlink.</para>
<refsect3 id="atk-hyperlink-get-n-anchors.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>link_</para></entry>
<entry role="parameter_description"><para>an <link linkend="AtkHyperlink"><type>AtkHyperlink</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="atk-hyperlink-get-n-anchors.returns" role="returns">
<title>Returns</title>
<para> the number of anchors associated with this hyperlink</para>
</refsect3></refsect2>
<refsect2 id="atk-hyperlink-is-selected-link" role="function" condition="deprecated|since:1.4">
<title>atk_hyperlink_is_selected_link&#160;()</title>
<indexterm zone="atk-hyperlink-is-selected-link" role="deprecated"><primary>atk_hyperlink_is_selected_link</primary></indexterm><indexterm zone="atk-hyperlink-is-selected-link" role="1.4"><primary>atk_hyperlink_is_selected_link</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
atk_hyperlink_is_selected_link (<parameter><link linkend="AtkHyperlink"><type>AtkHyperlink</type></link> *link_</parameter>);</programlisting>
<warning><para><literal>atk_hyperlink_is_selected_link</literal> has been deprecated since version 1.8 and should not be used in newly-written code.</para> <para>Please use ATK_STATE_FOCUSABLE for all links,
and ATK_STATE_FOCUSED for focused links.</para>
</warning>
<para>Determines whether this AtkHyperlink is selected</para>
<refsect3 id="atk-hyperlink-is-selected-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>link_</para></entry>
<entry role="parameter_description"><para>an <link linkend="AtkHyperlink"><type>AtkHyperlink</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="atk-hyperlink-is-selected-link.returns" role="returns">
<title>Returns</title>
<para> True if the AtkHyperlink is selected, False otherwise</para>
</refsect3><para role="since">Since: <link linkend="api-index-1.4">1.4</link></para></refsect2>

</refsect1>
<refsect1 id="AtkHyperlink.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="AtkHyperlink-struct" role="struct">
<title>struct AtkHyperlink</title>
<indexterm zone="AtkHyperlink-struct"><primary>AtkHyperlink</primary></indexterm>
<programlisting language="C">struct AtkHyperlink;</programlisting>
</refsect2>
<refsect2 id="AtkHyperlinkStateFlags" role="enum">
<title>enum AtkHyperlinkStateFlags</title>
<indexterm zone="AtkHyperlinkStateFlags"><primary>AtkHyperlinkStateFlags</primary></indexterm>
<para>Describes the type of link</para>
<refsect3 id="AtkHyperlinkStateFlags.members" role="enum_members">
<title>Members</title>
<informaltable role="enum_members_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="enum_members_name" colwidth="300px"/>
<colspec colname="enum_members_description"/>
<colspec colname="enum_members_annotations" colwidth="200px"/>
<tbody>
<row role="constant"><entry role="enum_member_name"><para id="ATK-HYPERLINK-IS-INLINE:CAPS">ATK_HYPERLINK_IS_INLINE</para></entry>
<entry role="enum_member_description"><para>Link is inline</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>

</refsect1>
<refsect1 id="AtkHyperlink.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="AtkHyperlink--end-index" role="property"><title>The <literal>“end-index”</literal> property</title>
<indexterm zone="AtkHyperlink--end-index"><primary>AtkHyperlink:end-index</primary></indexterm>
<programlisting>  “end-index”                <link linkend="gint"><type>gint</type></link></programlisting>
<para>The end index of the AtkHyperlink object.</para><para>Owner: AtkHyperlink</para>
<para>Flags: Read</para>
<para>Allowed values: &gt;= 0</para>
<para>Default value: 0</para>
</refsect2>
<refsect2 id="AtkHyperlink--number-of-anchors" role="property"><title>The <literal>“number-of-anchors”</literal> property</title>
<indexterm zone="AtkHyperlink--number-of-anchors"><primary>AtkHyperlink:number-of-anchors</primary></indexterm>
<programlisting>  “number-of-anchors”        <link linkend="gint"><type>gint</type></link></programlisting>
<para>The number of anchors associated with the AtkHyperlink object.</para><para>Owner: AtkHyperlink</para>
<para>Flags: Read</para>
<para>Allowed values: &gt;= 0</para>
<para>Default value: 0</para>
</refsect2>
<refsect2 id="AtkHyperlink--selected-link" role="property"><title>The <literal>“selected-link”</literal> property</title>
<indexterm zone="AtkHyperlink--selected-link" role="deprecated"><primary>AtkHyperlink:selected-link</primary></indexterm>
<programlisting>  “selected-link”            <link linkend="gboolean"><type>gboolean</type></link></programlisting>
<para>Selected link</para>
<warning><para><literal>AtkHyperlink:selected-link</literal> has been deprecated since version 1.8 and should not be used in newly-written code.</para> <para>Please use ATK_STATE_FOCUSABLE for all links, and
ATK_STATE_FOCUSED for focused links.</para>
</warning>
<para>Owner: AtkHyperlink</para>
<para>Flags: Read</para>
<para>Default value: FALSE</para>
</refsect2>
<refsect2 id="AtkHyperlink--start-index" role="property"><title>The <literal>“start-index”</literal> property</title>
<indexterm zone="AtkHyperlink--start-index"><primary>AtkHyperlink:start-index</primary></indexterm>
<programlisting>  “start-index”              <link linkend="gint"><type>gint</type></link></programlisting>
<para>The start index of the AtkHyperlink object.</para><para>Owner: AtkHyperlink</para>
<para>Flags: Read</para>
<para>Allowed values: &gt;= 0</para>
<para>Default value: 0</para>
</refsect2>

</refsect1>
<refsect1 id="AtkHyperlink.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="AtkHyperlink-link-activated" role="signal"><title>The <literal>“link-activated”</literal> signal</title>
<indexterm zone="AtkHyperlink-link-activated"><primary>AtkHyperlink::link-activated</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
user_function (<link linkend="AtkHyperlink"><type>AtkHyperlink</type></link> *atkhyperlink,
               <link linkend="gpointer"><type>gpointer</type></link>      user_data)</programlisting>
<para>The signal link-activated is emitted when a link is activated.</para>
<refsect3 id="AtkHyperlink-link-activated.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>atkhyperlink</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"><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>
