|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /proc/21585/root/usr/share/gtk-doc/html/atk/ |
Upload File : |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>AtkHyperlink</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="ATK - Accessibility Toolkit">
<link rel="up" href="atk.html" title="ATK Library">
<link rel="prev" href="AtkGObjectAccessible.html" title="AtkGObjectAccessible">
<link rel="next" href="atk-AtkHyperlinkImpl.html" title="AtkHyperlinkImpl">
<meta name="generator" content="GTK-Doc V1.6 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="atk.html" title="ATK Library">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
<link rel="index" href="ix03.html" title="Index of new symbols in ATK 1.3">
<link rel="index" href="ix04.html" title="Index of new symbols in ATK 1.4">
<link rel="index" href="ix05.html" title="Index of new symbols in ATK 1.6">
<link rel="index" href="ix06.html" title="Index of new symbols in ATK 1.9">
<link rel="index" href="ix07.html" title="Index of new symbols in ATK 1.12">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="AtkGObjectAccessible.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="atk.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">ATK - Accessibility Toolkit</th>
<td><a accesskey="n" href="atk-AtkHyperlinkImpl.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2544908" class="shortcut">Top</a>
 | 
<a href="#id2545315" class="shortcut">Description</a>
 | 
<a href="#id2545135" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id2545160" class="shortcut">Implemented Interfaces</a>
 | 
<a href="#id2545182" class="shortcut">Properties</a>
 | 
<a href="#id2545266" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="AtkHyperlink"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2544908"></a><span class="refentrytitle">AtkHyperlink</span>
</h2>
<p>AtkHyperlink — An ATK object which encapsulates a link or set of links in a hypertext document.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
<a href="AtkHyperlink.html#AtkHyperlink-struct">AtkHyperlink</a>;
enum <a href="AtkHyperlink.html#AtkHyperlinkStateFlags">AtkHyperlinkStateFlags</a>;
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="AtkHyperlink.html#atk-hyperlink-get-uri">atk_hyperlink_get_uri</a> (<a href="AtkHyperlink.html" title="AtkHyperlink">AtkHyperlink</a> *link_,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> i);
<a href="AtkObject.html" title="AtkObject">AtkObject</a>* <a href="AtkHyperlink.html#atk-hyperlink-get-object">atk_hyperlink_get_object</a> (<a href="AtkHyperlink.html" title="AtkHyperlink">AtkHyperlink</a> *link_,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> i);
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <a href="AtkHyperlink.html#atk-hyperlink-get-end-index">atk_hyperlink_get_end_index</a> (<a href="AtkHyperlink.html" title="AtkHyperlink">AtkHyperlink</a> *link_);
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <a href="AtkHyperlink.html#atk-hyperlink-get-start-index">atk_hyperlink_get_start_index</a> (<a href="AtkHyperlink.html" title="AtkHyperlink">AtkHyperlink</a> *link_);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="AtkHyperlink.html#atk-hyperlink-is-valid">atk_hyperlink_is_valid</a> (<a href="AtkHyperlink.html" title="AtkHyperlink">AtkHyperlink</a> *link_);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="AtkHyperlink.html#atk-hyperlink-is-inline">atk_hyperlink_is_inline</a> (<a href="AtkHyperlink.html" title="AtkHyperlink">AtkHyperlink</a> *link_);
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <a href="AtkHyperlink.html#atk-hyperlink-get-n-anchors">atk_hyperlink_get_n_anchors</a> (<a href="AtkHyperlink.html" title="AtkHyperlink">AtkHyperlink</a> *link_);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="AtkHyperlink.html#atk-hyperlink-is-selected-link">atk_hyperlink_is_selected_link</a> (<a href="AtkHyperlink.html" title="AtkHyperlink">AtkHyperlink</a> *link_);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2545135"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----AtkHyperlink
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2545160"></a><h2>Implemented Interfaces</h2>
<p>
AtkHyperlink implements
<a href="AtkAction.html" title="AtkAction">AtkAction</a>.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2545182"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="AtkHyperlink.html#AtkHyperlink--end-index">end-index</a>" <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> : Read
"<a href="AtkHyperlink.html#AtkHyperlink--number-of-anchors">number-of-anchors</a>" <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> : Read
"<a href="AtkHyperlink.html#AtkHyperlink--selected-link">selected-link</a>" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read
"<a href="AtkHyperlink.html#AtkHyperlink--start-index">start-index</a>" <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> : Read
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2545266"></a><h2>Signals</h2>
<pre class="synopsis">
"<a href="AtkHyperlink.html#AtkHyperlink-link-activated">link-activated</a>"
void user_function (<a href="AtkHyperlink.html" title="AtkHyperlink">AtkHyperlink</a> *atkhyperlink,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2545315"></a><h2>Description</h2>
<p>
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.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2545335"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2545345"></a><h3>
<a name="AtkHyperlink-struct"></a>AtkHyperlink</h3>
<a class="indexterm" name="id2545357"></a><pre class="programlisting">typedef struct _AtkHyperlink AtkHyperlink;</pre>
<p>
The AtkHyperlink structure should not be accessed directly.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2545374"></a><h3>
<a name="AtkHyperlinkStateFlags"></a>enum AtkHyperlinkStateFlags</h3>
<a class="indexterm" name="id2545387"></a><pre class="programlisting">typedef enum
{
ATK_HYPERLINK_IS_INLINE = 1 << 0
} AtkHyperlinkStateFlags;
</pre>
<p>
Describes the type of link</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><a name="ATK-HYPERLINK-IS-INLINE:CAPS"></a><code class="literal">ATK_HYPERLINK_IS_INLINE</code></span></td>
<td> Link is inline
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2545434"></a><h3>
<a name="atk-hyperlink-get-uri"></a>atk_hyperlink_get_uri ()</h3>
<a class="indexterm" name="id2545448"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* atk_hyperlink_get_uri (<a href="AtkHyperlink.html" title="AtkHyperlink">AtkHyperlink</a> *link_,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> i);</pre>
<p>
Get a the URI associated with the anchor specified
by <em class="parameter"><code>i</code></em> of <em class="parameter"><code>link_</code></em>.
</p>
<p>
Multiple anchors are primarily used by client-side image maps.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>link_</code></em> :</span></td>
<td> an <a href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>i</code></em> :</span></td>
<td> a (zero-index) integer specifying the desired anchor
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a string specifying the URI
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2545555"></a><h3>
<a name="atk-hyperlink-get-object"></a>atk_hyperlink_get_object ()</h3>
<a class="indexterm" name="id2545568"></a><pre class="programlisting"><a href="AtkObject.html" title="AtkObject">AtkObject</a>* atk_hyperlink_get_object (<a href="AtkHyperlink.html" title="AtkHyperlink">AtkHyperlink</a> *link_,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> i);</pre>
<p>
Returns the item associated with this hyperlinks nth anchor.
For instance, the returned <a href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> will implement <a href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
if <em class="parameter"><code>link_</code></em> is a text hyperlink, <a href="AtkImage.html" title="AtkImage"><span class="type">AtkImage</span></a> if <em class="parameter"><code>link_</code></em> is an image
hyperlink etc.
</p>
<p>
Multiple anchors are primarily used by client-side image maps.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>link_</code></em> :</span></td>
<td> an <a href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>i</code></em> :</span></td>
<td> a (zero-index) integer specifying the desired anchor
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> an <a href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> associated with this hyperlinks i-th anchor
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2545711"></a><h3>
<a name="atk-hyperlink-get-end-index"></a>atk_hyperlink_get_end_index ()</h3>
<a class="indexterm" name="id2545724"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> atk_hyperlink_get_end_index (<a href="AtkHyperlink.html" title="AtkHyperlink">AtkHyperlink</a> *link_);</pre>
<p>
Gets the index with the hypertext document at which this link ends.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>link_</code></em> :</span></td>
<td> an <a href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the index with the hypertext document at which this link ends
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2545795"></a><h3>
<a name="atk-hyperlink-get-start-index"></a>atk_hyperlink_get_start_index ()</h3>
<a class="indexterm" name="id2545808"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> atk_hyperlink_get_start_index (<a href="AtkHyperlink.html" title="AtkHyperlink">AtkHyperlink</a> *link_);</pre>
<p>
Gets the index with the hypertext document at which this link begins.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>link_</code></em> :</span></td>
<td> an <a href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the index with the hypertext document at which this link begins
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2545879"></a><h3>
<a name="atk-hyperlink-is-valid"></a>atk_hyperlink_is_valid ()</h3>
<a class="indexterm" name="id2545892"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> atk_hyperlink_is_valid (<a href="AtkHyperlink.html" title="AtkHyperlink">AtkHyperlink</a> *link_);</pre>
<p>
Since the document that a link is associated with may have changed
this method returns <a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if the link is still valid (with
respect to the document it references) and <a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> otherwise.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>link_</code></em> :</span></td>
<td> an <a href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> whether or not this link is still valid
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2545984"></a><h3>
<a name="atk-hyperlink-is-inline"></a>atk_hyperlink_is_inline ()</h3>
<a class="indexterm" name="id2545997"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> atk_hyperlink_is_inline (<a href="AtkHyperlink.html" title="AtkHyperlink">AtkHyperlink</a> *link_);</pre>
<p>
Indicates whether the link currently displays some or all of its
content inline. Ordinary HTML links will usually return
<a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a>, but an inline &lt;src&gt; HTML element will return
<a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a>.
a *</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>link_</code></em> :</span></td>
<td> an <a href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> whether or not this link displays its content inline.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2546092"></a><h3>
<a name="atk-hyperlink-get-n-anchors"></a>atk_hyperlink_get_n_anchors ()</h3>
<a class="indexterm" name="id2546105"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> atk_hyperlink_get_n_anchors (<a href="AtkHyperlink.html" title="AtkHyperlink">AtkHyperlink</a> *link_);</pre>
<p>
Gets the number of anchors associated with this hyperlink.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>link_</code></em> :</span></td>
<td> an <a href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the number of anchors associated with this hyperlink
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2546175"></a><h3>
<a name="atk-hyperlink-is-selected-link"></a>atk_hyperlink_is_selected_link ()</h3>
<a class="indexterm" name="id2546190"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> atk_hyperlink_is_selected_link (<a href="AtkHyperlink.html" title="AtkHyperlink">AtkHyperlink</a> *link_);</pre>
<p>
Determines whether this AtkHyperlink is selected
</p>
<p>
Returns:</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>link_</code></em> :</span></td>
<td> an <a href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> True is the AtkHyperlink is selected, False otherwise
</td>
</tr>
</tbody>
</table></div>
<p>Since ATK 1.4
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2546270"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2546281"></a><h3>
<a name="AtkHyperlink--end-index"></a>The "<code class="literal">end-index</code>" property</h3>
<a class="indexterm" name="id2546297"></a><pre class="programlisting"> "end-index" <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> : Read</pre>
<p>The end index of the AtkHyperlink object.</p>
<p>Allowed values: >= 0</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2546327"></a><h3>
<a name="AtkHyperlink--number-of-anchors"></a>The "<code class="literal">number-of-anchors</code>" property</h3>
<a class="indexterm" name="id2546344"></a><pre class="programlisting"> "number-of-anchors" <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> : Read</pre>
<p>The number of anchors associated with the AtkHyperlink object.</p>
<p>Allowed values: >= 0</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2546375"></a><h3>
<a name="AtkHyperlink--selected-link"></a>The "<code class="literal">selected-link</code>" property</h3>
<a class="indexterm" name="id2546392"></a><pre class="programlisting"> "selected-link" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read</pre>
<p>Specifies whether the AtkHyperlink object is selected.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2546419"></a><h3>
<a name="AtkHyperlink--start-index"></a>The "<code class="literal">start-index</code>" property</h3>
<a class="indexterm" name="id2546435"></a><pre class="programlisting"> "start-index" <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> : Read</pre>
<p>The start index of the AtkHyperlink object.</p>
<p>Allowed values: >= 0</p>
<p>Default value: 0</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2546467"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id2546477"></a><h3>
<a name="AtkHyperlink-link-activated"></a>The "link-activated" signal</h3>
<a class="indexterm" name="id2546487"></a><pre class="programlisting">void user_function (<a href="AtkHyperlink.html" title="AtkHyperlink">AtkHyperlink</a> *atkhyperlink,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last</pre>
<p>
The signal link-activated is emitted when a link is activated.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>atkhyperlink</code></em> :</span></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>