| Current File : //proc/self/root/kunden/usr/share/gtk-doc/html/libatspi/AtspiHyperlink.html |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AtspiHyperlink: libatspi Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="libatspi Reference Manual">
<link rel="up" href="ch01.html" title="API reference">
<link rel="prev" href="AtspiDeviceListener.html" title="AtspiDeviceListener">
<link rel="next" href="libatspi-atspi-editabletext.html" title="atspi-editabletext">
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#AtspiHyperlink.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#AtspiHyperlink.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="AtspiDeviceListener.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libatspi-atspi-editabletext.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="AtspiHyperlink"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="AtspiHyperlink.top_of_page"></a>AtspiHyperlink</span></h2>
<p>AtspiHyperlink</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="AtspiHyperlink.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="AtspiHyperlink.html#atspi-hyperlink-get-n-anchors" title="atspi_hyperlink_get_n_anchors ()">atspi_hyperlink_get_n_anchors</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="AtspiHyperlink.html#atspi-hyperlink-get-uri" title="atspi_hyperlink_get_uri ()">atspi_hyperlink_get_uri</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="returnvalue">AtspiAccessible</span></a> *
</td>
<td class="function_name">
<a class="link" href="AtspiHyperlink.html#atspi-hyperlink-get-object" title="atspi_hyperlink_get_object ()">atspi_hyperlink_get_object</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libatspi-atspi-text.html#AtspiRange"><span class="returnvalue">AtspiRange</span></a> *
</td>
<td class="function_name">
<a class="link" href="AtspiHyperlink.html#atspi-hyperlink-get-index-range" title="atspi_hyperlink_get_index_range ()">atspi_hyperlink_get_index_range</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="AtspiHyperlink.html#atspi-hyperlink-get-start-index" title="atspi_hyperlink_get_start_index ()">atspi_hyperlink_get_start_index</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="AtspiHyperlink.html#atspi-hyperlink-get-end-index" title="atspi_hyperlink_get_end_index ()">atspi_hyperlink_get_end_index</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="AtspiHyperlink.html#atspi-hyperlink-is-valid" title="atspi_hyperlink_is_valid ()">atspi_hyperlink_is_valid</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="AtspiHyperlink.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="AtspiHyperlink.html#AtspiHyperlink-struct" title="AtspiHyperlink">AtspiHyperlink</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="AtspiHyperlink.html#AtspiHyperlinkClass" title="struct AtspiHyperlinkClass">AtspiHyperlinkClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="AtspiHyperlink.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> <a class="link" href="AtspiObject.html" title="AtspiObject">AtspiObject</a>
<span class="lineart">╰──</span> AtspiHyperlink
</pre>
</div>
<div class="refsect1">
<a name="AtspiHyperlink.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="AtspiHyperlink.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="atspi-hyperlink-get-n-anchors"></a><h3>atspi_hyperlink_get_n_anchors ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
atspi_hyperlink_get_n_anchors (<em class="parameter"><code><a class="link" href="AtspiHyperlink.html" title="AtspiHyperlink"><span class="type">AtspiHyperlink</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Gets the total number of anchors which an <a class="link" href="AtspiHyperlink.html" title="AtspiHyperlink"><span class="type">AtspiHyperlink</span></a> implementor has.
Though typical hyperlinks have only one anchor, client-side image maps and
other hypertext objects may potentially activate or refer to multiple
URIs. For each anchor there is a corresponding URI and object.</p>
<p>see: <a class="link" href="AtspiHyperlink.html#atspi-hyperlink-get-uri" title="atspi_hyperlink_get_uri ()"><span class="type">atspi_hyperlink_get_uri</span></a> and <a class="link" href="AtspiHyperlink.html#atspi-hyperlink-get-object" title="atspi_hyperlink_get_object ()"><span class="type">atspi_hyperlink_get_object</span></a>.</p>
<div class="refsect3">
<a name="atspi-hyperlink-get-n-anchors.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>obj</p></td>
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiHyperlink.html" title="AtspiHyperlink"><span class="type">AtspiHyperlink</span></a> object on which to operate.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-hyperlink-get-n-anchors.returns"></a><h4>Returns</h4>
<p> a <span class="type">gint</span> indicating the number of anchors in this hyperlink.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-hyperlink-get-uri"></a><h3>atspi_hyperlink_get_uri ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
atspi_hyperlink_get_uri (<em class="parameter"><code><a class="link" href="AtspiHyperlink.html" title="AtspiHyperlink"><span class="type">AtspiHyperlink</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">int</span> i</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Gets the URI associated with a particular hyperlink anchor.</p>
<div class="refsect3">
<a name="atspi-hyperlink-get-uri.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>obj</p></td>
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiHyperlink.html" title="AtspiHyperlink"><span class="type">AtspiHyperlink</span></a> implementor on which to operate.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>i</p></td>
<td class="parameter_description"><p>a (zero-index) integer indicating which hyperlink anchor to query.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-hyperlink-get-uri.returns"></a><h4>Returns</h4>
<p> a UTF-8 string giving the URI of the <em class="parameter"><code>ith</code></em>
hyperlink anchor.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-hyperlink-get-object"></a><h3>atspi_hyperlink_get_object ()</h3>
<pre class="programlisting"><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="returnvalue">AtspiAccessible</span></a> *
atspi_hyperlink_get_object (<em class="parameter"><code><a class="link" href="AtspiHyperlink.html" title="AtspiHyperlink"><span class="type">AtspiHyperlink</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> i</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Gets the object associated with a particular hyperlink anchor, as an
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a>.</p>
<div class="refsect3">
<a name="atspi-hyperlink-get-object.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>obj</p></td>
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiHyperlink.html" title="AtspiHyperlink"><span class="type">AtspiHyperlink</span></a> implementor on which to operate.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>i</p></td>
<td class="parameter_description"><p>a (zero-index) <span class="type">gint</span> indicating which hyperlink anchor to query.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-hyperlink-get-object.returns"></a><h4>Returns</h4>
<p>an <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> that represents the object
associated with the <em class="parameter"><code>ith</code></em>
anchor of the specified <a class="link" href="AtspiHyperlink.html" title="AtspiHyperlink"><span class="type">AtspiHyperlink</span></a>. </p>
<p><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-hyperlink-get-index-range"></a><h3>atspi_hyperlink_get_index_range ()</h3>
<pre class="programlisting"><a class="link" href="libatspi-atspi-text.html#AtspiRange"><span class="returnvalue">AtspiRange</span></a> *
atspi_hyperlink_get_index_range (<em class="parameter"><code><a class="link" href="AtspiHyperlink.html" title="AtspiHyperlink"><span class="type">AtspiHyperlink</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Gets the starting and ending character offsets of the text range
associated with an <a class="link" href="AtspiHyperlink.html" title="AtspiHyperlink"><span class="type">AtspiHyperlink</span></a>, in its originating <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a>.</p>
<div class="refsect3">
<a name="atspi-hyperlink-get-index-range.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>obj</p></td>
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiHyperlink.html" title="AtspiHyperlink"><span class="type">AtspiHyperlink</span></a> implementor on which to operate.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-hyperlink-get-start-index"></a><h3>atspi_hyperlink_get_start_index ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
atspi_hyperlink_get_start_index (<em class="parameter"><code><a class="link" href="AtspiHyperlink.html" title="AtspiHyperlink"><span class="type">AtspiHyperlink</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Gets the starting character offset of the text range associated with
an <a class="link" href="AtspiHyperlink.html" title="AtspiHyperlink"><span class="type">AtspiHyperlink</span></a>, in its originating <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a>.</p>
<div class="refsect3">
<a name="atspi-hyperlink-get-start-index.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>obj</p></td>
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiHyperlink.html" title="AtspiHyperlink"><span class="type">AtspiHyperlink</span></a> implementor on which to operate.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-hyperlink-get-end-index"></a><h3>atspi_hyperlink_get_end_index ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
atspi_hyperlink_get_end_index (<em class="parameter"><code><a class="link" href="AtspiHyperlink.html" title="AtspiHyperlink"><span class="type">AtspiHyperlink</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Gets the ending character offset of the text range associated with
an <a class="link" href="AtspiHyperlink.html" title="AtspiHyperlink"><span class="type">AtspiHyperlink</span></a>, in its originating <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a>.</p>
<div class="refsect3">
<a name="atspi-hyperlink-get-end-index.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>obj</p></td>
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiHyperlink.html" title="AtspiHyperlink"><span class="type">AtspiHyperlink</span></a> implementor on which to operate.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-hyperlink-is-valid"></a><h3>atspi_hyperlink_is_valid ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
atspi_hyperlink_is_valid (<em class="parameter"><code><a class="link" href="AtspiHyperlink.html" title="AtspiHyperlink"><span class="type">AtspiHyperlink</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Tells whether an <a class="link" href="AtspiHyperlink.html" title="AtspiHyperlink"><span class="type">AtspiHyperlink</span></a> object is still valid with respect to its
originating hypertext object.</p>
<div class="refsect3">
<a name="atspi-hyperlink-is-valid.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>obj</p></td>
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiHyperlink.html" title="AtspiHyperlink"><span class="type">AtspiHyperlink</span></a> on which to operate.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-hyperlink-is-valid.returns"></a><h4>Returns</h4>
<p> <span class="type">TRUE</span> if the specified <a class="link" href="AtspiHyperlink.html" title="AtspiHyperlink"><span class="type">AtspiHyperlink</span></a> is still valid with respect
to its originating <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a> object, <span class="type">FALSE</span> otherwise.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="AtspiHyperlink.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="AtspiHyperlink-struct"></a><h3>AtspiHyperlink</h3>
<pre class="programlisting">typedef struct _AtspiHyperlink AtspiHyperlink;</pre>
</div>
<hr>
<div class="refsect2">
<a name="AtspiHyperlinkClass"></a><h3>struct AtspiHyperlinkClass</h3>
<pre class="programlisting">struct AtspiHyperlinkClass {
AtspiObjectClass parent_class;
};
</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>