atkhyperlinkimpl.xml

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

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

<refnamediv>
<refname>AtkHyperlinkImpl</refname>
<refpurpose>An interface from which the AtkHyperlink associated with an
AtkObject may be obtained.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="atk-AtkHyperlinkImpl.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
                    <link linkend="AtkHyperlinkImpl">AtkHyperlinkImpl</link>;
<link linkend="AtkHyperlink">AtkHyperlink</link>*       <link linkend="atk-hyperlink-impl-get-hyperlink">atk_hyperlink_impl_get_hyperlink</link>    (<link linkend="AtkHyperlinkImpl">AtkHyperlinkImpl</link> *obj);
</synopsis>
</refsynopsisdiv>









<refsect1 id="atk-AtkHyperlinkImpl.description" role="desc">
<title role="desc.title">Description</title>
<para>
AtkHyperlinkImpl allows AtkObjects to
refer to their associated AtkHyperlink instance, if one
exists.  AtkHyperlinkImpl differs from AtkHyperlink in that 
AtkHyperlinkImpl is an interface, whereas AtkHyperlink is
a object type.  The AtkHyperlinkImpl interface allows
a client to query an AtkObject for the availability of
an associated AtkHyperlink instance, and obtain that
instance.  It is thus particularly useful in cases where
embedded content or inline content within a text object
is present, since the embedding text object implements
AtkHypertext and the inline/embedded objects are 
exposed as children which implement AtkHyperlinkImpl,
in addition to their being obtainable via AtkHypertext:getLink
followed by AtkHyperlink:getObject.
</para>
</refsect1>

<refsect1 id="atk-AtkHyperlinkImpl.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="AtkHyperlinkImpl" role="struct">
<title>AtkHyperlinkImpl</title>
<indexterm zone="AtkHyperlinkImpl"><primary>AtkHyperlinkImpl</primary></indexterm><programlisting>typedef struct _AtkHyperlinkImpl AtkHyperlinkImpl;</programlisting>
<para>
A queryable interface which allows AtkHyperlink instances associated with an 
AtkObject to be obtained.  AtkHyperlinkImpl corresponds to AT-SPI's 
Hyperlink interface, and differs from AtkHyperlink in that AtkHyperlink 
is an object type, rather than an interface, and thus cannot be directly 
queried.
</para></refsect2>
<refsect2 id="atk-hyperlink-impl-get-hyperlink" role="function" condition="since:ATK 1.12">
<title>atk_hyperlink_impl_get_hyperlink ()</title>
<indexterm zone="atk-hyperlink-impl-get-hyperlink" role="ATK 1.12"><primary>atk_hyperlink_impl_get_hyperlink</primary></indexterm><programlisting><link linkend="AtkHyperlink">AtkHyperlink</link>*       atk_hyperlink_impl_get_hyperlink    (<link linkend="AtkHyperlinkImpl">AtkHyperlinkImpl</link> *obj);</programlisting>
<para>
Gets the hyperlink associated with this object.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>obj</parameter>&nbsp;:</term>
<listitem><simpara> a GObject instance that implements AtkHyperlinkImplIface
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>an AtkHyperlink object which points to this implementing AtkObject.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  ATK 1.12
</para></refsect2>

</refsect1>




</refentry>