<?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="AtkHyperlinkImpl">
<refmeta>
<refentrytitle role="top_of_page" id="AtkHyperlinkImpl.top_of_page">AtkHyperlinImpl</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>ATK Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>AtkHyperlinImpl</refname>
<refpurpose>An interface from which the AtkHyperlink
associated with an AtkObject may be obtained.</refpurpose>
</refnamediv>

<refsect1 id="AtkHyperlinkImpl.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-hyperlink-impl-get-hyperlink">atk_hyperlink_impl_get_hyperlink</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="AtkHyperlinkImpl.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="AtkHyperlinkImpl-struct">AtkHyperlinkImpl</link></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="AtkHyperlinkImpl.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> AtkHyperlinkImpl
</screen>
</refsect1>


<refsect1 id="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>
<para>The AtkHyperlinkImpl interface should be supported by objects
exposed within the hierarchy as children of an AtkHypertext
container which correspond to "links" or embedded content within
the text.  HTML anchors are not, for instance, normally exposed
this way, but embedded images and components which appear inline in
the content of a text object are. The AtkHyperlinkIface interface
allows a means of determining which children are hyperlinks in this
sense of the word, and for obtaining their corresponding
AtkHyperlink object, from which the embedding range, URI, etc. can
be obtained.</para>
<para>To some extent this interface exists because, for historical
reasons, AtkHyperlink was defined as an object type, not an
interface.  Thus, in order to interact with AtkObjects via
AtkHyperlink semantics, a new interface was required.</para>

</refsect1>
<refsect1 id="AtkHyperlinkImpl.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="atk-hyperlink-impl-get-hyperlink" role="function" condition="since:1.12">
<title>atk_hyperlink_impl_get_hyperlink&#160;()</title>
<indexterm zone="atk-hyperlink-impl-get-hyperlink" role="1.12"><primary>atk_hyperlink_impl_get_hyperlink</primary></indexterm>
<programlisting language="C"><link linkend="AtkHyperlink"><returnvalue>AtkHyperlink</returnvalue></link>&#160;*
atk_hyperlink_impl_get_hyperlink (<parameter><link linkend="AtkHyperlinkImpl"><type>AtkHyperlinkImpl</type></link> *impl</parameter>);</programlisting>
<para>Gets the hyperlink associated with this object.</para>
<refsect3 id="atk-hyperlink-impl-get-hyperlink.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>impl</para></entry>
<entry role="parameter_description"><para>a <link linkend="GObject"><type>GObject</type></link> instance that implements AtkHyperlinkImplIface</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="atk-hyperlink-impl-get-hyperlink.returns" role="returns">
<title>Returns</title>
<para>an AtkHyperlink object which points to this
implementing AtkObject. </para>
<para><emphasis role="annotation">[<acronym>transfer full</acronym>]</emphasis></para>
</refsect3><para role="since">Since: <link linkend="api-index-1.12">1.12</link></para></refsect2>

</refsect1>
<refsect1 id="AtkHyperlinkImpl.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="AtkHyperlinkImpl-struct" role="struct">
<title>AtkHyperlinkImpl</title>
<indexterm zone="AtkHyperlinkImpl-struct"><primary>AtkHyperlinkImpl</primary></indexterm>
<programlisting language="C">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. FTW</para>
</refsect2>

</refsect1>

</refentry>
