| Current File : //proc/thread-self/root/kunden/usr/share/gtk-doc/html/libatspi/libatspi-atspi-text.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>atspi-text: 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="ch01.html" title="API reference">
<link rel="next" href="AtspiStateSet.html" title="AtspiStateSet">
<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="#libatspi-atspi-text.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#libatspi-atspi-text.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_implementations"> <span class="dim">|</span>
<a href="#libatspi-atspi-text.implementations" class="shortcut">Known Implementations</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="ch01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="AtspiStateSet.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libatspi-atspi-text"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libatspi-atspi-text.top_of_page"></a>atspi-text</span></h2>
<p>atspi-text</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libatspi-atspi-text.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">
<a class="link" href="libatspi-atspi-text.html#AtspiRange"><span class="returnvalue">AtspiRange</span></a> *
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-text.html#atspi-range-copy" title="atspi_range_copy ()">atspi_range_copy</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GType</span>
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-text.html#atspi-text-get-type" title="atspi_text_get_type ()">atspi_text_get_type</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GType</span>
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-text.html#atspi-text-range-get-type" title="atspi_text_range_get_type ()">atspi_text_range_get_type</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="libatspi-atspi-text.html#atspi-text-get-character-count" title="atspi_text_get_character_count ()">atspi_text_get_character_count</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="libatspi-atspi-text.html#atspi-text-get-text" title="atspi_text_get_text ()">atspi_text_get_text</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="libatspi-atspi-text.html#atspi-text-get-caret-offset" title="atspi_text_get_caret_offset ()">atspi_text_get_caret_offset</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GHashTable</span> *
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-text.html#atspi-text-get-attributes" title="atspi_text_get_attributes ()">atspi_text_get_attributes</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GHashTable</span> *
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-text.html#atspi-text-get-attribute-run" title="atspi_text_get_attribute_run ()">atspi_text_get_attribute_run</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="libatspi-atspi-text.html#atspi-text-get-attribute-value" title="atspi_text_get_attribute_value ()">atspi_text_get_attribute_value</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GHashTable</span> *
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-text.html#atspi-text-get-default-attributes" title="atspi_text_get_default_attributes ()">atspi_text_get_default_attributes</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="libatspi-atspi-text.html#atspi-text-set-caret-offset" title="atspi_text_set_caret_offset ()">atspi_text_set_caret_offset</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libatspi-atspi-text.html#AtspiTextRange"><span class="returnvalue">AtspiTextRange</span></a> *
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-text.html#atspi-text-get-text-before-offset" title="atspi_text_get_text_before_offset ()">atspi_text_get_text_before_offset</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libatspi-atspi-text.html#AtspiTextRange"><span class="returnvalue">AtspiTextRange</span></a> *
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-text.html#atspi-text-get-text-at-offset" title="atspi_text_get_text_at_offset ()">atspi_text_get_text_at_offset</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libatspi-atspi-text.html#AtspiTextRange"><span class="returnvalue">AtspiTextRange</span></a> *
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-text.html#atspi-text-get-text-after-offset" title="atspi_text_get_text_after_offset ()">atspi_text_get_text_after_offset</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-text.html#atspi-text-get-character-at-offset" title="atspi_text_get_character_at_offset ()">atspi_text_get_character_at_offset</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="returnvalue">AtspiRect</span></a> *
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-text.html#atspi-text-get-character-extents" title="atspi_text_get_character_extents ()">atspi_text_get_character_extents</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="libatspi-atspi-text.html#atspi-text-get-offset-at-point" title="atspi_text_get_offset_at_point ()">atspi_text_get_offset_at_point</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="returnvalue">AtspiRect</span></a> *
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-text.html#atspi-text-get-range-extents" title="atspi_text_get_range_extents ()">atspi_text_get_range_extents</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GArray</span> *
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-text.html#atspi-text-get-bounded-ranges" title="atspi_text_get_bounded_ranges ()">atspi_text_get_bounded_ranges</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="libatspi-atspi-text.html#atspi-text-get-n-selections" title="atspi_text_get_n_selections ()">atspi_text_get_n_selections</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="libatspi-atspi-text.html#atspi-text-get-selection" title="atspi_text_get_selection ()">atspi_text_get_selection</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="libatspi-atspi-text.html#atspi-text-add-selection" title="atspi_text_add_selection ()">atspi_text_add_selection</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="libatspi-atspi-text.html#atspi-text-remove-selection" title="atspi_text_remove_selection ()">atspi_text_remove_selection</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="libatspi-atspi-text.html#atspi-text-set-selection" title="atspi_text_set_selection ()">atspi_text_set_selection</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libatspi-atspi-text.html#AtspiTextRange"><span class="returnvalue">AtspiTextRange</span></a> *
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-text.html#atspi-text-get-string-at-offset" title="atspi_text_get_string_at_offset ()">atspi_text_get_string_at_offset</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="libatspi-atspi-text.html#atspi-text-get-text-attribute-value" title="atspi_text_get_text_attribute_value ()">atspi_text_get_text_attribute_value</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GHashTable</span> *
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-text.html#atspi-text-get-text-attributes" title="atspi_text_get_text_attributes ()">atspi_text_get_text_attributes</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="libatspi-atspi-text.html#atspi-text-scroll-substring-to" title="atspi_text_scroll_substring_to ()">atspi_text_scroll_substring_to</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="libatspi-atspi-text.html#atspi-text-scroll-substring-to-point" title="atspi_text_scroll_substring_to_point ()">atspi_text_scroll_substring_to_point</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<a name="AtspiRange"></a><a name="AtspiTextRange"></a><a name="AtspiText"></a><div class="refsect1">
<a name="libatspi-atspi-text.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">struct</td>
<td class="function_name"><a class="link" href="libatspi-atspi-text.html#AtspiRange-struct" title="struct AtspiRange">AtspiRange</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="libatspi-atspi-text.html#AtspiTextRange-struct" title="struct AtspiTextRange">AtspiTextRange</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="libatspi-atspi-text.html#AtspiText-struct" title="AtspiText">AtspiText</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libatspi-atspi-text.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-Boxed-Types.html">GBoxed</a>
<span class="lineart">├──</span> AtspiRange
<span class="lineart">╰──</span> AtspiTextRange
<a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a>
<span class="lineart">╰──</span> AtspiText
</pre>
</div>
<div class="refsect1">
<a name="libatspi-atspi-text.implementations"></a><h2>Known Implementations</h2>
<p>
AtspiText is implemented by
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible">AtspiAccessible</a>.</p>
</div>
<div class="refsect1">
<a name="libatspi-atspi-text.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libatspi-atspi-text.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="atspi-range-copy"></a><h3>atspi_range_copy ()</h3>
<pre class="programlisting"><a class="link" href="libatspi-atspi-text.html#AtspiRange"><span class="returnvalue">AtspiRange</span></a> *
atspi_range_copy (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiRange"><span class="type">AtspiRange</span></a> *src</code></em>);</pre>
<p>Gets a copy of an <a class="link" href="libatspi-atspi-text.html#AtspiRange"><span class="type">AtspiRange</span></a> object.</p>
<div class="refsect3">
<a name="atspi-range-copy.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>src</p></td>
<td class="parameter_description"><p>a pointer to the source <a class="link" href="libatspi-atspi-text.html#AtspiRange"><span class="type">AtspiRange</span></a> object that will be copied.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-range-copy.returns"></a><h4>Returns</h4>
<p> the <a class="link" href="libatspi-atspi-text.html#AtspiRange"><span class="type">AtspiRange</span></a> copy of an <a class="link" href="libatspi-atspi-text.html#AtspiRange"><span class="type">AtspiRange</span></a> object.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-type"></a><h3>atspi_text_get_type ()</h3>
<pre class="programlisting"><span class="returnvalue">GType</span>
atspi_text_get_type ();</pre>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-range-get-type"></a><h3>atspi_text_range_get_type ()</h3>
<pre class="programlisting"><span class="returnvalue">GType</span>
atspi_text_range_get_type ();</pre>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-character-count"></a><h3>atspi_text_get_character_count ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
atspi_text_get_character_count (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Gets the character count of an <span class="type">AccessibleText</span> object.</p>
<div class="refsect3">
<a name="atspi-text-get-character-count.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="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object to query.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-text-get-character-count.returns"></a><h4>Returns</h4>
<p> a <span class="type">gint</span> indicating the total number of
characters in the <span class="type">AccessibleText</span> object.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-text"></a><h3>atspi_text_get_text ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
atspi_text_get_text (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> start_offset</code></em>,
<em class="parameter"><code><span class="type">gint</span> end_offset</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Gets a range of text from an <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object. The number of bytes
in the returned string may exceed either end_offset or start_offset, since
UTF-8 is a variable-width encoding.</p>
<div class="refsect3">
<a name="atspi-text-get-text.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="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object to query.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_offset</p></td>
<td class="parameter_description"><p>a <span class="type">gint</span> indicating the start of the desired text range.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>end_offset</p></td>
<td class="parameter_description"><p>a <span class="type">gint</span> indicating the first character past the desired range.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-text-get-text.returns"></a><h4>Returns</h4>
<p> a text string containing characters from <em class="parameter"><code>start_offset</code></em>
to <em class="parameter"><code>end_offset</code></em>
-1, inclusive, encoded as UTF-8.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-caret-offset"></a><h3>atspi_text_get_caret_offset ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
atspi_text_get_caret_offset (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Gets the current offset of the text caret in an <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object.</p>
<div class="refsect3">
<a name="atspi-text-get-caret-offset.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="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object to query.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-text-get-caret-offset.returns"></a><h4>Returns</h4>
<p> a <span class="type">gint</span> indicating the current position of the text caret.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-attributes"></a><h3>atspi_text_get_attributes ()</h3>
<pre class="programlisting"><span class="returnvalue">GHashTable</span> *
atspi_text_get_attributes (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> offset</code></em>,
<em class="parameter"><code><span class="type">gint</span> *start_offset</code></em>,
<em class="parameter"><code><span class="type">gint</span> *end_offset</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="warning">
<p><code class="literal">atspi_text_get_attributes</code> has been deprecated since version 2.10 and should not be used in newly-written code.</p>
<p>Use atspi_text_get_text_attributes instead.</p>
</div>
<p>Gets the attributes applied to a range of text from an <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a>
object. The text attributes correspond to CSS attributes
where possible.</p>
<span style="color: red"><em>DEPRECATED</em></span><p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> atspi_text_get_text_attributes]</span></p>
<div class="refsect3">
<a name="atspi-text-get-attributes.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="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object to query.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>offset</p></td>
<td class="parameter_description"><p>a <span class="type">gint</span> indicating the offset from which the attribute
search is based.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_offset</p></td>
<td class="parameter_description"><p>a <span class="type">gint</span> pointer indicating the start of the desired text
range. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>end_offset</p></td>
<td class="parameter_description"><p>a <span class="type">gint</span> pointer indicating the first character past the desired
range. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-text-get-attributes.returns"></a><h4>Returns</h4>
<p>a <span class="type">GHashTable</span>
describing the attributes at the given character offset. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gchar* gchar*][<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-text-get-attribute-run"></a><h3>atspi_text_get_attribute_run ()</h3>
<pre class="programlisting"><span class="returnvalue">GHashTable</span> *
atspi_text_get_attribute_run (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> offset</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> include_defaults</code></em>,
<em class="parameter"><code><span class="type">gint</span> *start_offset</code></em>,
<em class="parameter"><code><span class="type">gint</span> *end_offset</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Gets a set of attributes applied to a range of text from an <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object, optionally
including its 'default' attributes.</p>
<div class="refsect3">
<a name="atspi-text-get-attribute-run.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="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object to query.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>offset</p></td>
<td class="parameter_description"><p>a <span class="type">gint</span> indicating the offset from which the attribute
search is based.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>include_defaults</p></td>
<td class="parameter_description"><p>a <span class="type">bool</span> that, when set as <span class="type">FALSE</span>, indicates the call
should only return those attributes which are explicitly set on the current
attribute run, omitting any attributes which are inherited from the
default values.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_offset</p></td>
<td class="parameter_description"><p>a <span class="type">gint</span> pointer indicating the start of the desired text
range. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>end_offset</p></td>
<td class="parameter_description"><p>a <span class="type">gint</span> pointer indicating the first character past the desired
range. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-text-get-attribute-run.returns"></a><h4>Returns</h4>
<p>a <span class="type">GHashTable</span> with attributes
defined at the indicated offset, optionally including the 'default' ones. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gchar* gchar*][<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-text-get-attribute-value"></a><h3>atspi_text_get_attribute_value ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
atspi_text_get_attribute_value (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> offset</code></em>,
<em class="parameter"><code><span class="type">gchar</span> *attribute_name</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="warning">
<p><code class="literal">atspi_text_get_attribute_value</code> has been deprecated since version 2.10 and should not be used in newly-written code.</p>
<p>Use atspi_text_get_text_attribute_value instead.</p>
</div>
<p>Gets the value of a named attribute at a given offset.</p>
<p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> atspi_text_get_text_attribute_value]</span></p>
<div class="refsect3">
<a name="atspi-text-get-attribute-value.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="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object to query.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>offset</p></td>
<td class="parameter_description"><p>The character offset at which to query the attribute.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>attribute_name</p></td>
<td class="parameter_description"><p>The attribute to query.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-text-get-attribute-value.returns"></a><h4>Returns</h4>
<p>the value of a given attribute at the given
offset, or <code class="literal">NULL</code> if not present. </p>
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-default-attributes"></a><h3>atspi_text_get_default_attributes ()</h3>
<pre class="programlisting"><span class="returnvalue">GHashTable</span> *
atspi_text_get_default_attributes (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Gets the default attributes applied to an <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a>
object. The text attributes correspond to CSS attributes
where possible. The combination of this attribute set and
the attributes reported by <a class="link" href="libatspi-atspi-text.html#atspi-text-get-attributes" title="atspi_text_get_attributes ()"><span class="type">atspi_text_get_attributes</span></a>
describes the entire set of text attributes over a range.</p>
<div class="refsect3">
<a name="atspi-text-get-default-attributes.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="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object to query.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-text-get-default-attributes.returns"></a><h4>Returns</h4>
<p>a <span class="type">GHashTable</span>
containing the default attributes applied to a text object,
(exclusive of explicitly-set attributes), encoded as UTF-8. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gchar* gchar*][<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-text-set-caret-offset"></a><h3>atspi_text_set_caret_offset ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
atspi_text_set_caret_offset (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> new_offset</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Moves the text caret to a given position.</p>
<div class="refsect3">
<a name="atspi-text-set-caret-offset.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="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>new_offset</p></td>
<td class="parameter_description"><p>the offset to which the text caret is to be moved.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-text-set-caret-offset.returns"></a><h4>Returns</h4>
<p> <span class="type">TRUE</span> if successful, <span class="type">FALSE</span> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-text-before-offset"></a><h3>atspi_text_get_text_before_offset ()</h3>
<pre class="programlisting"><a class="link" href="libatspi-atspi-text.html#AtspiTextRange"><span class="returnvalue">AtspiTextRange</span></a> *
atspi_text_get_text_before_offset (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> offset</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiTextBoundaryType" title="enum AtspiTextBoundaryType"><span class="type">AtspiTextBoundaryType</span></a> type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Gets delimited text from an <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object which precedes a given
text offset.</p>
<div class="refsect3">
<a name="atspi-text-get-text-before-offset.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="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>offset</p></td>
<td class="parameter_description"><p>a <span class="type">gint</span> indicating the offset from which the delimiter
search is based.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type</p></td>
<td class="parameter_description"><p>an <a class="link" href="libatspi-atspi-constants.html#AtspiTextBoundaryType" title="enum AtspiTextBoundaryType"><span class="type">AtspiTextBoundaryType</span></a> indicating whether the desired
text string is a word, sentence, line, or attribute run.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-text-get-text-before-offset.returns"></a><h4>Returns</h4>
<p> an <a class="link" href="libatspi-atspi-text.html#AtspiTextRange"><span class="type">AtspiTextRange</span></a> containing a UTF-8 string representing the
delimited text, both of whose delimiting boundaries are before the
current offset, or an empty string if no such text exists.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-text-at-offset"></a><h3>atspi_text_get_text_at_offset ()</h3>
<pre class="programlisting"><a class="link" href="libatspi-atspi-text.html#AtspiTextRange"><span class="returnvalue">AtspiTextRange</span></a> *
atspi_text_get_text_at_offset (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> offset</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiTextBoundaryType" title="enum AtspiTextBoundaryType"><span class="type">AtspiTextBoundaryType</span></a> type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="warning">
<p><code class="literal">atspi_text_get_text_at_offset</code> has been deprecated since version 2.10 and should not be used in newly-written code.</p>
<p>Use atspi_text_get_string_at_offset.</p>
</div>
<p>Gets delimited text from an <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object which includes a given
text offset.</p>
<div class="refsect3">
<a name="atspi-text-get-text-at-offset.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="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>offset</p></td>
<td class="parameter_description"><p>a <span class="type">gint</span> indicating the offset from which the delimiter
search is based.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type</p></td>
<td class="parameter_description"><p>an <a class="link" href="libatspi-atspi-constants.html#AtspiTextBoundaryType" title="enum AtspiTextBoundaryType"><span class="type">AtspiTextBoundaryType</span></a> indicating whether the desired
text string is a word, sentence, line, or attribute run.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-text-get-text-at-offset.returns"></a><h4>Returns</h4>
<p> an <a class="link" href="libatspi-atspi-text.html#AtspiTextRange"><span class="type">AtspiTextRange</span></a> containing a UTF-8 string representing the
delimited text, whose delimiting boundaries bracket the
current offset, or an empty string if no such text exists.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-text-after-offset"></a><h3>atspi_text_get_text_after_offset ()</h3>
<pre class="programlisting"><a class="link" href="libatspi-atspi-text.html#AtspiTextRange"><span class="returnvalue">AtspiTextRange</span></a> *
atspi_text_get_text_after_offset (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> offset</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiTextBoundaryType" title="enum AtspiTextBoundaryType"><span class="type">AtspiTextBoundaryType</span></a> type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Gets delimited text from an <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object which follows a given
text offset.</p>
<div class="refsect3">
<a name="atspi-text-get-text-after-offset.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="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>offset</p></td>
<td class="parameter_description"><p>a <span class="type">gint</span> indicating the offset from which the delimiter
search is based.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type</p></td>
<td class="parameter_description"><p>an <a class="link" href="libatspi-atspi-constants.html#AtspiTextBoundaryType" title="enum AtspiTextBoundaryType"><span class="type">AtspiTextBoundaryType</span></a> indicating whether the desired
text string is a word, sentence, line, or attribute run.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-text-get-text-after-offset.returns"></a><h4>Returns</h4>
<p> an <a class="link" href="libatspi-atspi-text.html#AtspiTextRange"><span class="type">AtspiTextRange</span></a> containing a UTF-8 string representing the
delimited text, both of whose delimiting boundaries are after or
inclusive of the current offset, or an empty string if no such
text exists.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-character-at-offset"></a><h3>atspi_text_get_character_at_offset ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
atspi_text_get_character_at_offset (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> offset</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Gets the character at a given offset for an <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object.</p>
<div class="refsect3">
<a name="atspi-text-get-character-at-offset.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="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>offset</p></td>
<td class="parameter_description"><p>a <span class="type">gint</span> indicating the text offset where the desired
character is located.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-text-get-character-at-offset.returns"></a><h4>Returns</h4>
<p> a <span class="type">guint</span> representing the
UCS-4 unicode code point of the given character, or
0xFFFFFFFF if the character in question cannot be represented
in the UCS-4 encoding.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-character-extents"></a><h3>atspi_text_get_character_extents ()</h3>
<pre class="programlisting"><a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="returnvalue">AtspiRect</span></a> *
atspi_text_get_character_extents (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> offset</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a> type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Gets a bounding box containing the glyph representing
the character at a particular text offset.
The returned values are meaningful only if the Text has both
STATE_VISIBLE and STATE_SHOWING.</p>
<div class="refsect3">
<a name="atspi-text-get-character-extents.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="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>offset</p></td>
<td class="parameter_description"><p>a <span class="type">gint</span> indicating the offset of the text character for
whom boundary information is requested.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type</p></td>
<td class="parameter_description"><p>an <span class="type">AccessibleCoordType</span> indicating the coordinate system to use
for the returned values.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-text-get-character-extents.returns"></a><h4>Returns</h4>
<p> An <a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="type">AtspiRect</span></a> specifying the position and size of the character.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-offset-at-point"></a><h3>atspi_text_get_offset_at_point ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
atspi_text_get_offset_at_point (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> x</code></em>,
<em class="parameter"><code><span class="type">gint</span> y</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a> type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Gets the character offset into the text at a given point.</p>
<div class="refsect3">
<a name="atspi-text-get-offset-at-point.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="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x</p></td>
<td class="parameter_description"><p>the x coordinate of the point to be queried.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y</p></td>
<td class="parameter_description"><p>the y coordinate of the point to be queried.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type</p></td>
<td class="parameter_description"><p>an <a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a> indicating the coordinate system in which
the values should be returned.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-text-get-offset-at-point.returns"></a><h4>Returns</h4>
<p> the offset (as a <span class="type">gint</span>) at the point (<em class="parameter"><code>x</code></em>
, <em class="parameter"><code>y</code></em>
)
in the specified coordinate system.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-range-extents"></a><h3>atspi_text_get_range_extents ()</h3>
<pre class="programlisting"><a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="returnvalue">AtspiRect</span></a> *
atspi_text_get_range_extents (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> start_offset</code></em>,
<em class="parameter"><code><span class="type">gint</span> end_offset</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a> type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Gets the bounding box for text within a range in an <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object.
The returned values are meaningful only if the Text has both
STATE_VISIBLE and STATE_SHOWING.</p>
<div class="refsect3">
<a name="atspi-text-get-range-extents.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="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_offset</p></td>
<td class="parameter_description"><p>a <span class="type">gint</span> indicating the offset of the first text character for
whom boundary information is requested.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>end_offset</p></td>
<td class="parameter_description"><p>a <span class="type">gint</span> indicating the offset of the text character
after the last character for whom boundary information is requested.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type</p></td>
<td class="parameter_description"><p>an <a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a> indicating the coordinate system to use
for the returned values.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-text-get-range-extents.returns"></a><h4>Returns</h4>
<p> An <a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="type">AtspiRect</span></a> giving the position and size of the specified range
of text.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-bounded-ranges"></a><h3>atspi_text_get_bounded_ranges ()</h3>
<pre class="programlisting"><span class="returnvalue">GArray</span> *
atspi_text_get_bounded_ranges (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> x</code></em>,
<em class="parameter"><code><span class="type">gint</span> y</code></em>,
<em class="parameter"><code><span class="type">gint</span> width</code></em>,
<em class="parameter"><code><span class="type">gint</span> height</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a> type</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiTextClipType" title="enum AtspiTextClipType"><span class="type">AtspiTextClipType</span></a> clipTypeX</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiTextClipType" title="enum AtspiTextClipType"><span class="type">AtspiTextClipType</span></a> clipTypeY</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Gets the ranges of text from an <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object which lie within the
bounds defined by (<em class="parameter"><code>x</code></em>
, <em class="parameter"><code>y</code></em>
) and (<em class="parameter"><code>x</code></em>
+<em class="parameter"><code>width</code></em>
, <em class="parameter"><code>y</code></em>
+<em class="parameter"><code>height</code></em>
).</p>
<div class="refsect3">
<a name="atspi-text-get-bounded-ranges.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="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x</p></td>
<td class="parameter_description"><p>the 'starting' x coordinate of the bounding box.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y</p></td>
<td class="parameter_description"><p>the 'starting' y coordinate of the bounding box.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p>the x extent of the bounding box.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>the y extent of the bounding box.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type</p></td>
<td class="parameter_description"><p>an <span class="type">AccessibleCoordType</span> indicating the coordinate system to use
for the returned values.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>clipTypeX</p></td>
<td class="parameter_description"><p>an <a class="link" href="libatspi-atspi-constants.html#AtspiTextClipType" title="enum AtspiTextClipType"><span class="type">AtspiTextClipType</span></a> indicating how to treat characters that
intersect the bounding box's x extents.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>clipTypeY</p></td>
<td class="parameter_description"><p>an <a class="link" href="libatspi-atspi-constants.html#AtspiTextClipType" title="enum AtspiTextClipType"><span class="type">AtspiTextClipType</span></a> indicating how to treat characters that
intersect the bounding box's y extents.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-text-get-bounded-ranges.returns"></a><h4>Returns</h4>
<p>a null-terminated list of
pointers to <a class="link" href="libatspi-atspi-text.html#AtspiTextRange"><span class="type">AtspiTextRange</span></a> structs detailing the bounded text. </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>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> AtspiTextRange*]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-n-selections"></a><h3>atspi_text_get_n_selections ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
atspi_text_get_n_selections (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Gets the number of active non-contiguous selections for an
<a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object.</p>
<div class="refsect3">
<a name="atspi-text-get-n-selections.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="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</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-text-get-n-selections.returns"></a><h4>Returns</h4>
<p> a <span class="type">gint</span> indicating the current
number of non-contiguous text selections active
within an <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-selection"></a><h3>atspi_text_get_selection ()</h3>
<pre class="programlisting"><a class="link" href="libatspi-atspi-text.html#AtspiRange"><span class="returnvalue">AtspiRange</span></a> *
atspi_text_get_selection (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> selection_num</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Gets the bounds of the <em class="parameter"><code>selection_num</code></em>
-th active text selection for an
<a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object.</p>
<div class="refsect3">
<a name="atspi-text-get-selection.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="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>selection_num</p></td>
<td class="parameter_description"><p>a <span class="type">gint</span> indicating which selection to query.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-add-selection"></a><h3>atspi_text_add_selection ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
atspi_text_add_selection (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> start_offset</code></em>,
<em class="parameter"><code><span class="type">gint</span> end_offset</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Selects some text (adds a text selection) in an <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object.</p>
<div class="refsect3">
<a name="atspi-text-add-selection.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="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_offset</p></td>
<td class="parameter_description"><p>the starting offset of the desired new selection.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>end_offset</p></td>
<td class="parameter_description"><p>the offset of the first character after the new selection.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-text-add-selection.returns"></a><h4>Returns</h4>
<p> <span class="type">TRUE</span> if successful, <span class="type">FALSE</span> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-remove-selection"></a><h3>atspi_text_remove_selection ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
atspi_text_remove_selection (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> selection_num</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>De-selects a text selection.</p>
<div class="refsect3">
<a name="atspi-text-remove-selection.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="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>selection_num</p></td>
<td class="parameter_description"><p>a <span class="type">gint</span> indicating which text selection to remove.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-text-remove-selection.returns"></a><h4>Returns</h4>
<p> <span class="type">TRUE</span> if successful, <span class="type">FALSE</span> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-set-selection"></a><h3>atspi_text_set_selection ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
atspi_text_set_selection (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> selection_num</code></em>,
<em class="parameter"><code><span class="type">gint</span> start_offset</code></em>,
<em class="parameter"><code><span class="type">gint</span> end_offset</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Changes the bounds of an existing <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> text selection.</p>
<div class="refsect3">
<a name="atspi-text-set-selection.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="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>selection_num</p></td>
<td class="parameter_description"><p>a zero-offset index indicating which text selection to modify.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_offset</p></td>
<td class="parameter_description"><p>a <span class="type">gint</span> indicating the new starting offset for the selection.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>end_offset</p></td>
<td class="parameter_description"><p>a <span class="type">gint</span> indicating the desired new offset of the first character
after the selection.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-text-set-selection.returns"></a><h4>Returns</h4>
<p> <span class="type">TRUE</span> if successful, <span class="type">FALSE</span> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-string-at-offset"></a><h3>atspi_text_get_string_at_offset ()</h3>
<pre class="programlisting"><a class="link" href="libatspi-atspi-text.html#AtspiTextRange"><span class="returnvalue">AtspiTextRange</span></a> *
atspi_text_get_string_at_offset (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> offset</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiTextGranularity" title="enum AtspiTextGranularity"><span class="type">AtspiTextGranularity</span></a> granularity</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Gets a portion of the text exposed through an <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> according to a given <em class="parameter"><code>offset</code></em>
and a specific <em class="parameter"><code>granularity</code></em>
, along with the start and end offsets defining the
boundaries of such a portion of text.</p>
<p>If <em class="parameter"><code>granularity</code></em>
is ATSPI_TEXT_GRANULARITY_CHAR the character at the
offset is returned.</p>
<p>If <em class="parameter"><code>granularity</code></em>
is ATSPI_TEXT_GRANULARITY_WORD the returned string
is from the word start at or before the offset to the word start after
the offset.</p>
<p>The returned string will contain the word at the offset if the offset
is inside a word and will contain the word before the offset if the
offset is not inside a word.</p>
<p>If <em class="parameter"><code>granularity</code></em>
is ATSPI_TEXT_GRANULARITY_SENTENCE the returned string
is from the sentence start at or before the offset to the sentence
start after the offset.</p>
<p>The returned string will contain the sentence at the offset if the offset
is inside a sentence and will contain the sentence before the offset
if the offset is not inside a sentence.</p>
<p>If <em class="parameter"><code>granularity</code></em>
is ATSPI_TEXT_GRANULARITY_LINE the returned string
is from the line start at or before the offset to the line
start after the offset.</p>
<p>If <em class="parameter"><code>granularity</code></em>
is ATSPI_TEXT_GRANULARITY_PARAGRAPH the returned string
is from the start of the paragraph at or before the offset to the start
of the following paragraph after the offset.</p>
<div class="refsect3">
<a name="atspi-text-get-string-at-offset.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>an <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>offset</p></td>
<td class="parameter_description"><p>position</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>granularity</p></td>
<td class="parameter_description"><p>An <a class="link" href="libatspi-atspi-constants.html#AtspiTextGranularity" title="enum AtspiTextGranularity"><span class="type">AtspiTextGranularity</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-text-get-string-at-offset.returns"></a><h4>Returns</h4>
<p> a newly allocated string containing the text at the <em class="parameter"><code>offset</code></em>
bounded
by the specified <em class="parameter"><code>granularity</code></em>
. Use <code class="function">g_free()</code> to free the returned string.
Returns <code class="literal">NULL</code> if the offset is invalid or no implementation is available.</p>
</div>
<p class="since">Since: 2.9.90</p>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-text-attribute-value"></a><h3>atspi_text_get_text_attribute_value ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
atspi_text_get_text_attribute_value (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> offset</code></em>,
<em class="parameter"><code><span class="type">gchar</span> *attribute_name</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Gets the value of a named attribute at a given offset.</p>
<div class="refsect3">
<a name="atspi-text-get-text-attribute-value.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="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object to query.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>offset</p></td>
<td class="parameter_description"><p>The character offset at which to query the attribute.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>attribute_name</p></td>
<td class="parameter_description"><p>The attribute to query.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-text-get-text-attribute-value.returns"></a><h4>Returns</h4>
<p>the value of a given attribute at the given offset, or <code class="literal">NULL</code> if
not present. </p>
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-text-attributes"></a><h3>atspi_text_get_text_attributes ()</h3>
<pre class="programlisting"><span class="returnvalue">GHashTable</span> *
atspi_text_get_text_attributes (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> offset</code></em>,
<em class="parameter"><code><span class="type">gint</span> *start_offset</code></em>,
<em class="parameter"><code><span class="type">gint</span> *end_offset</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Gets the attributes applied to a range of text from an <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a>
object. The text attributes correspond to CSS attributes
where possible.</p>
<span style="color: red"><em>DEPRECATED</em></span><div class="refsect3">
<a name="atspi-text-get-text-attributes.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="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object to query.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>offset</p></td>
<td class="parameter_description"><p>a <span class="type">gint</span> indicating the offset from which the attribute
search is based.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_offset</p></td>
<td class="parameter_description"><p>a <span class="type">gint</span> pointer indicating the start of the desired text
range. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>end_offset</p></td>
<td class="parameter_description"><p>a <span class="type">gint</span> pointer indicating the first character past the desired
range. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-text-get-text-attributes.returns"></a><h4>Returns</h4>
<p>a <span class="type">GHashTable</span>
describing the attributes at the given character offset. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gchar* gchar*][<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-text-scroll-substring-to"></a><h3>atspi_text_scroll_substring_to ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
atspi_text_scroll_substring_to (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> start_offset</code></em>,
<em class="parameter"><code><span class="type">gint</span> end_offset</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiScrollType" title="enum AtspiScrollType"><span class="type">AtspiScrollType</span></a> type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Scrolls whatever container of the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> text range so it becomes
visible on the screen.</p>
<div class="refsect3">
<a name="atspi-text-scroll-substring-to.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="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_offset</p></td>
<td class="parameter_description"><p>a <span class="type">gint</span> indicating the start of the desired text range.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>end_offset</p></td>
<td class="parameter_description"><p>a <span class="type">gint</span> indicating the first character past the desired range.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type</p></td>
<td class="parameter_description"><p>a <a class="link" href="libatspi-atspi-constants.html#AtspiScrollType" title="enum AtspiScrollType"><span class="type">AtspiScrollType</span></a> indicating where the object should be placed on the
screen.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-text-scroll-substring-to.returns"></a><h4>Returns</h4>
<p> <span class="type">TRUE</span> if successful, <span class="type">FALSE</span> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-scroll-substring-to-point"></a><h3>atspi_text_scroll_substring_to_point ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
atspi_text_scroll_substring_to_point (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> start_offset</code></em>,
<em class="parameter"><code><span class="type">gint</span> end_offset</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a> coords</code></em>,
<em class="parameter"><code><span class="type">gint</span> x</code></em>,
<em class="parameter"><code><span class="type">gint</span> y</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Scrolls whatever container of the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> text range so it becomes
visible on the screen at a given position.</p>
<div class="refsect3">
<a name="atspi-text-scroll-substring-to-point.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="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_offset</p></td>
<td class="parameter_description"><p>a <span class="type">gint</span> indicating the start of the desired text range.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>end_offset</p></td>
<td class="parameter_description"><p>a <span class="type">gint</span> indicating the first character past the desired range.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>coords</p></td>
<td class="parameter_description"><p>a <a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a> indicating whether the coordinates are relative to
the screen, to the window, or to the parent object.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x</p></td>
<td class="parameter_description"><p>the x coordinate of the point to reach</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y</p></td>
<td class="parameter_description"><p>the y coordinate of the point to reach</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-text-scroll-substring-to-point.returns"></a><h4>Returns</h4>
<p> <span class="type">TRUE</span> if successful, <span class="type">FALSE</span> otherwise.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="libatspi-atspi-text.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="AtspiRange-struct"></a><h3>struct AtspiRange</h3>
<pre class="programlisting">struct AtspiRange {
gint start_offset;
gint end_offset;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="AtspiTextRange-struct"></a><h3>struct AtspiTextRange</h3>
<pre class="programlisting">struct AtspiTextRange {
gint start_offset;
gint end_offset;
gchar *content;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="AtspiText-struct"></a><h3>AtspiText</h3>
<pre class="programlisting">typedef struct _AtspiText AtspiText;</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>