atkhyperlink.xml

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

</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-hyperlink-get-end-index" role="function">
<title>atk_hyperlink_get_end_index ()</title>
<indexterm zone="atk-hyperlink-get-end-index"><primary>atk_hyperlink_get_end_index</primary></indexterm><programlisting><link linkend="gint">gint</link>                atk_hyperlink_get_end_index         (<link linkend="AtkHyperlink">AtkHyperlink</link> *link_);</programlisting>
<para>
Gets the index with the hypertext document at which this link ends.</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><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the index with the hypertext document at which this link ends
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-hyperlink-get-start-index" role="function">
<title>atk_hyperlink_get_start_index ()</title>
<indexterm zone="atk-hyperlink-get-start-index"><primary>atk_hyperlink_get_start_index</primary></indexterm><programlisting><link linkend="gint">gint</link>                atk_hyperlink_get_start_index       (<link linkend="AtkHyperlink">AtkHyperlink</link> *link_);</programlisting>
<para>
Gets the index with the hypertext document at which this link begins.</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><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the index with the hypertext document at which this link begins
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-hyperlink-is-valid" role="function">
<title>atk_hyperlink_is_valid ()</title>
<indexterm zone="atk-hyperlink-is-valid"><primary>atk_hyperlink_is_valid</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            atk_hyperlink_is_valid              (<link linkend="AtkHyperlink">AtkHyperlink</link> *link_);</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>
<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><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> whether or not this link is still valid
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-hyperlink-is-inline" role="function">
<title>atk_hyperlink_is_inline ()</title>
<indexterm zone="atk-hyperlink-is-inline"><primary>atk_hyperlink_is_inline</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            atk_hyperlink_is_inline             (<link linkend="AtkHyperlink">AtkHyperlink</link> *link_);</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 &amp;lt;src&amp;gt; HTML element will return
          <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>.
a *</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><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> whether or not this link displays its content inline.

</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-hyperlink-get-n-anchors" role="function">
<title>atk_hyperlink_get_n_anchors ()</title>
<indexterm zone="atk-hyperlink-get-n-anchors"><primary>atk_hyperlink_get_n_anchors</primary></indexterm><programlisting><link linkend="gint">gint</link>                atk_hyperlink_get_n_anchors         (<link linkend="AtkHyperlink">AtkHyperlink</link> *link_);</programlisting>
<para>
Gets the number of anchors associated with this hyperlink.</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><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the number of anchors associated with this hyperlink
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-hyperlink-is-selected-link" role="function" condition="deprecated:Please use ATK_STATE_SELECTED to indicate when a hyperlink within a Hypertext container is selected.|since">
<title>atk_hyperlink_is_selected_link ()</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="ATK 1.4

@Deprecated: This method is deprecated since ATK version 1.8.
Please use ATK_STATE_SELECTED to indicate when a hyperlink within a
Hypertext container is selected."><primary>atk_hyperlink_is_selected_link</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            atk_hyperlink_is_selected_link      (<link linkend="AtkHyperlink">AtkHyperlink</link> *link_);</programlisting>
<warning><para><literal>atk_hyperlink_is_selected_link</literal> is deprecated and should not be used in newly-written code. Please use ATK_STATE_SELECTED to indicate when a hyperlink within a Hypertext container is selected.</para></warning>
<para>
Determines whether this AtkHyperlink is selected</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><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> True is the AtkHyperlink is selected, False otherwise
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  ATK 1.4

@Deprecated: This method is deprecated since ATK version 1.8.
Please use ATK_STATE_SELECTED to indicate when a hyperlink within a
Hypertext container is selected.

</para></refsect2>

</refsect1>
<refsect1 id="AtkHyperlink.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="AtkHyperlink--end-index"><title>The <literal>&quot;end-index&quot;</literal> property</title>
<indexterm zone="AtkHyperlink--end-index"><primary>AtkHyperlink:end-index</primary></indexterm><programlisting>  &quot;end-index&quot;                <link linkend="gint">gint</link>                  : Read</programlisting>
<para>The end index of the AtkHyperlink object.</para><para>Allowed values: &gt;= 0</para>
<para>Default value: 0</para>
</refsect2>
<refsect2 id="AtkHyperlink--number-of-anchors"><title>The <literal>&quot;number-of-anchors&quot;</literal> property</title>
<indexterm zone="AtkHyperlink--number-of-anchors"><primary>AtkHyperlink:number-of-anchors</primary></indexterm><programlisting>  &quot;number-of-anchors&quot;        <link linkend="gint">gint</link>                  : Read</programlisting>
<para>The number of anchors associated with the AtkHyperlink object.</para><para>Allowed values: &gt;= 0</para>
<para>Default value: 0</para>
</refsect2>
<refsect2 id="AtkHyperlink--selected-link"><title>The <literal>&quot;selected-link&quot;</literal> property</title>
<indexterm zone="AtkHyperlink--selected-link"><primary>AtkHyperlink:selected-link</primary></indexterm><programlisting>  &quot;selected-link&quot;            <link linkend="gboolean">gboolean</link>              : Read</programlisting>
<para>Specifies whether the AtkHyperlink object is selected.</para><para>Default value: FALSE</para>
</refsect2>
<refsect2 id="AtkHyperlink--start-index"><title>The <literal>&quot;start-index&quot;</literal> property</title>
<indexterm zone="AtkHyperlink--start-index"><primary>AtkHyperlink:start-index</primary></indexterm><programlisting>  &quot;start-index&quot;              <link linkend="gint">gint</link>                  : Read</programlisting>
<para>The start index of the AtkHyperlink object.</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"><title>The <literal>&quot;link-activated&quot;</literal> signal</title>
<indexterm zone="AtkHyperlink-link-activated"><primary>AtkHyperlink::link-activated</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="AtkHyperlink">AtkHyperlink</link> *atkhyperlink,
                                                        <link linkend="gpointer">gpointer</link>      user_data)         : Run Last</programlisting>
<para>
The signal link-activated is emitted when a link is activated.
</para><variablelist role="params">
<varlistentry><term><parameter>atkhyperlink</parameter>&nbsp;:</term>
<listitem><simpara>the object which received the signal.

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