|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /proc/22697/root/usr/share/gtk-doc/html/atk/ |
Upload File : |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>AtkText</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="ATK - Accessibility Toolkit">
<link rel="up" href="atk.html" title="ATK Library">
<link rel="prev" href="AtkTable.html" title="AtkTable">
<link rel="next" href="AtkUtil.html" title="AtkUtil">
<meta name="generator" content="GTK-Doc V1.6 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="atk.html" title="ATK Library">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
<link rel="index" href="ix03.html" title="Index of new symbols in ATK 1.3">
<link rel="index" href="ix04.html" title="Index of new symbols in ATK 1.4">
<link rel="index" href="ix05.html" title="Index of new symbols in ATK 1.6">
<link rel="index" href="ix06.html" title="Index of new symbols in ATK 1.9">
<link rel="index" href="ix07.html" title="Index of new symbols in ATK 1.12">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="AtkTable.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="atk.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">ATK - Accessibility Toolkit</th>
<td><a accesskey="n" href="AtkUtil.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2600557" class="shortcut">Top</a>
 | 
<a href="#id2601793" class="shortcut">Description</a>
 | 
<a href="#id2601575" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id2601599" class="shortcut">Known Implementations</a>
 | 
<a href="#id2601622" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="AtkText"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2600557"></a><span class="refentrytitle">AtkText</span>
</h2>
<p>AtkText — The ATK interface implemented by components with text content.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
<a href="AtkText.html#AtkText-struct">AtkText</a>;
enum <a href="AtkText.html#AtkTextBoundary">AtkTextBoundary</a>;
enum <a href="AtkText.html#AtkTextClipType">AtkTextClipType</a>;
<a href="AtkText.html#AtkTextRange">AtkTextRange</a>;
<a href="AtkText.html#AtkTextRectangle">AtkTextRectangle</a>;
<a href="AtkText.html#AtkAttribute">AtkAttribute</a>;
typedef <a href="AtkText.html#AtkAttributeSet">AtkAttributeSet</a>;
enum <a href="AtkText.html#AtkTextAttribute">AtkTextAttribute</a>;
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="AtkText.html#atk-text-get-text">atk_text_get_text</a> (<a href="AtkText.html" title="AtkText">AtkText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> start_offset,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> end_offset);
<a
href="../glib/glib-Unicode-Manipulation.html#gunichar"
>gunichar</a> <a href="AtkText.html#atk-text-get-character-at-offset">atk_text_get_character_at_offset</a>
(<a href="AtkText.html" title="AtkText">AtkText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> offset);
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="AtkText.html#atk-text-get-text-after-offset">atk_text_get_text_after_offset</a> (<a href="AtkText.html" title="AtkText">AtkText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> offset,
<a href="AtkText.html#AtkTextBoundary">AtkTextBoundary</a> boundary_type,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *start_offset,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *end_offset);
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="AtkText.html#atk-text-get-text-at-offset">atk_text_get_text_at_offset</a> (<a href="AtkText.html" title="AtkText">AtkText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> offset,
<a href="AtkText.html#AtkTextBoundary">AtkTextBoundary</a> boundary_type,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *start_offset,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *end_offset);
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="AtkText.html#atk-text-get-text-before-offset">atk_text_get_text_before_offset</a> (<a href="AtkText.html" title="AtkText">AtkText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> offset,
<a href="AtkText.html#AtkTextBoundary">AtkTextBoundary</a> boundary_type,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *start_offset,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *end_offset);
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <a href="AtkText.html#atk-text-get-caret-offset">atk_text_get_caret_offset</a> (<a href="AtkText.html" title="AtkText">AtkText</a> *text);
void <a href="AtkText.html#atk-text-get-character-extents">atk_text_get_character_extents</a> (<a href="AtkText.html" title="AtkText">AtkText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> offset,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *x,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *y,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *width,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *height,
<a href="AtkUtil.html#AtkCoordType">AtkCoordType</a> coords);
<a href="AtkText.html#AtkAttributeSet">AtkAttributeSet</a>* <a href="AtkText.html#atk-text-get-run-attributes">atk_text_get_run_attributes</a>
(<a href="AtkText.html" title="AtkText">AtkText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> offset,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *start_offset,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *end_offset);
<a href="AtkText.html#AtkAttributeSet">AtkAttributeSet</a>* <a href="AtkText.html#atk-text-get-default-attributes">atk_text_get_default_attributes</a>
(<a href="AtkText.html" title="AtkText">AtkText</a> *text);
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <a href="AtkText.html#atk-text-get-character-count">atk_text_get_character_count</a> (<a href="AtkText.html" title="AtkText">AtkText</a> *text);
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <a href="AtkText.html#atk-text-get-offset-at-point">atk_text_get_offset_at_point</a> (<a href="AtkText.html" title="AtkText">AtkText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> x,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> y,
<a href="AtkUtil.html#AtkCoordType">AtkCoordType</a> coords);
<a href="AtkText.html#AtkTextRange">AtkTextRange</a>** <a href="AtkText.html#atk-text-get-bounded-ranges">atk_text_get_bounded_ranges</a> (<a href="AtkText.html" title="AtkText">AtkText</a> *text,
<a href="AtkText.html#AtkTextRectangle">AtkTextRectangle</a> *rect,
<a href="AtkUtil.html#AtkCoordType">AtkCoordType</a> coord_type,
<a href="AtkText.html#AtkTextClipType">AtkTextClipType</a> x_clip_type,
<a href="AtkText.html#AtkTextClipType">AtkTextClipType</a> y_clip_type);
void <a href="AtkText.html#atk-text-get-range-extents">atk_text_get_range_extents</a> (<a href="AtkText.html" title="AtkText">AtkText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> start_offset,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> end_offset,
<a href="AtkUtil.html#AtkCoordType">AtkCoordType</a> coord_type,
<a href="AtkText.html#AtkTextRectangle">AtkTextRectangle</a> *rect);
void <a href="AtkText.html#atk-text-free-ranges">atk_text_free_ranges</a> (<a href="AtkText.html#AtkTextRange">AtkTextRange</a> **ranges);
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <a href="AtkText.html#atk-text-get-n-selections">atk_text_get_n_selections</a> (<a href="AtkText.html" title="AtkText">AtkText</a> *text);
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="AtkText.html#atk-text-get-selection">atk_text_get_selection</a> (<a href="AtkText.html" title="AtkText">AtkText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> selection_num,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *start_offset,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *end_offset);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="AtkText.html#atk-text-add-selection">atk_text_add_selection</a> (<a href="AtkText.html" title="AtkText">AtkText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> start_offset,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> end_offset);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="AtkText.html#atk-text-remove-selection">atk_text_remove_selection</a> (<a href="AtkText.html" title="AtkText">AtkText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> selection_num);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="AtkText.html#atk-text-set-selection">atk_text_set_selection</a> (<a href="AtkText.html" title="AtkText">AtkText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> selection_num,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> start_offset,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> end_offset);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="AtkText.html#atk-text-set-caret-offset">atk_text_set_caret_offset</a> (<a href="AtkText.html" title="AtkText">AtkText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> offset);
void <a href="AtkText.html#atk-attribute-set-free">atk_attribute_set_free</a> (<a href="AtkText.html#AtkAttributeSet">AtkAttributeSet</a> *attrib_set);
<a href="AtkText.html#AtkTextAttribute">AtkTextAttribute</a> <a href="AtkText.html#atk-text-attribute-register">atk_text_attribute_register</a>
(const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="AtkText.html#atk-text-attribute-get-name">atk_text_attribute_get_name</a> (<a href="AtkText.html#AtkTextAttribute">AtkTextAttribute</a> attr);
<a href="AtkText.html#AtkTextAttribute">AtkTextAttribute</a> <a href="AtkText.html#atk-text-attribute-for-name">atk_text_attribute_for_name</a>
(const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="AtkText.html#atk-text-attribute-get-value">atk_text_attribute_get_value</a> (<a href="AtkText.html#AtkTextAttribute">AtkTextAttribute</a> attr,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> index_);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2601575"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GInterface
+----AtkText
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2601599"></a><h2>Known Implementations</h2>
<p>
AtkText is implemented by
<a href="AtkNoOpObject.html" title="AtkNoOpObject">AtkNoOpObject</a>.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2601622"></a><h2>Signals</h2>
<pre class="synopsis">
"<a href="AtkText.html#AtkText-text-attributes-changed">text-attributes-changed</a>"
void user_function (<a href="AtkText.html" title="AtkText">AtkText</a> *atktext,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last
"<a href="AtkText.html#AtkText-text-caret-moved">text-caret-moved</a>"
void user_function (<a href="AtkText.html" title="AtkText">AtkText</a> *atktext,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> arg1,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last
"<a href="AtkText.html#AtkText-text-changed">text-changed</a>"
void user_function (<a href="AtkText.html" title="AtkText">AtkText</a> *atktext,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> arg1,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> arg2,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last / Has details
"<a href="AtkText.html#AtkText-text-selection-changed">text-selection-changed</a>"
void user_function (<a href="AtkText.html" title="AtkText">AtkText</a> *atktext,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2601793"></a><h2>Description</h2>
<p>
<a href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> should be implemented by <span class="type">AtkObjects</span> on behalf of widgets that
have text content which is either attributed or otherwise non-trivial.
<span class="type">AtkObjects</span> whose text content is simple, unattributed, and very brief
may expose that content via <a href="AtkObject.html#atk-object-get-name"><span class="type">atk_object_get_name</span></a> instead; however if the
text is editable, multi-line, typically longer than three or four words,
attributed, selectable, or if the object already uses the 'name' ATK
property for other information, the <a href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> interface should be used
to expose the text content. In the case of editable text content,
<a href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a> (a subtype of the <a href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> interface) should be
implemented instead.
</p>
<p>
<a href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> provides not only traversal facilities and change notification
for text content, but also caret tracking and glyph bounding box
calculations. Note that the text strings are exposed as UTF-8, and are
therefore potentially multi-byte, and caret-to-byte offset mapping makes
no assumptions about the character length; also bounding box
glyph-to-offset mapping may be complex for languages which use ligatures.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2601890"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2601900"></a><h3>
<a name="AtkText-struct"></a>AtkText</h3>
<a class="indexterm" name="id2601913"></a><pre class="programlisting">typedef struct _AtkText AtkText;</pre>
<p>
The AtkText structure does not contain any fields.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2601929"></a><h3>
<a name="AtkTextBoundary"></a>enum AtkTextBoundary</h3>
<a class="indexterm" name="id2601942"></a><pre class="programlisting">typedef enum {
ATK_TEXT_BOUNDARY_CHAR,
ATK_TEXT_BOUNDARY_WORD_START,
ATK_TEXT_BOUNDARY_WORD_END,
ATK_TEXT_BOUNDARY_SENTENCE_START,
ATK_TEXT_BOUNDARY_SENTENCE_END,
ATK_TEXT_BOUNDARY_LINE_START,
ATK_TEXT_BOUNDARY_LINE_END
} AtkTextBoundary;
</pre>
<p>
Text boundary types used for specifying boundaries for regions of text</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><a name="ATK-TEXT-BOUNDARY-CHAR:CAPS"></a><code class="literal">ATK_TEXT_BOUNDARY_CHAR</code></span></td>
<td> Boundary is the boundary between characters
(including non-printing characters)
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-BOUNDARY-WORD-START:CAPS"></a><code class="literal">ATK_TEXT_BOUNDARY_WORD_START</code></span></td>
<td> Boundary is the start (i.e. first character) of a word.
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-BOUNDARY-WORD-END:CAPS"></a><code class="literal">ATK_TEXT_BOUNDARY_WORD_END</code></span></td>
<td> Boundary is the end (i.e. last character) of a word.
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-BOUNDARY-SENTENCE-START:CAPS"></a><code class="literal">ATK_TEXT_BOUNDARY_SENTENCE_START</code></span></td>
<td> Boundary is the first character in a sentence.
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-BOUNDARY-SENTENCE-END:CAPS"></a><code class="literal">ATK_TEXT_BOUNDARY_SENTENCE_END</code></span></td>
<td> Boundary is the last (terminal) character in a sentence;
in languages which use "sentence stop" punctuation such as English, the boundary is thus the
'.', '?', or similar terminal punctuation character.
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-BOUNDARY-LINE-START:CAPS"></a><code class="literal">ATK_TEXT_BOUNDARY_LINE_START</code></span></td>
<td> Boundary is the initial character of the content or a
character immediately following a newline, linefeed, or return character.
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-BOUNDARY-LINE-END:CAPS"></a><code class="literal">ATK_TEXT_BOUNDARY_LINE_END</code></span></td>
<td> Boundary is the linefeed, or return character.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602141"></a><h3>
<a name="AtkTextClipType"></a>enum AtkTextClipType</h3>
<a class="indexterm" name="id2602155"></a><pre class="programlisting">typedef enum {
ATK_TEXT_CLIP_NONE,
ATK_TEXT_CLIP_MIN,
ATK_TEXT_CLIP_MAX,
ATK_TEXT_CLIP_BOTH
} AtkTextClipType;
</pre>
<p>
Describes the type of clipping required.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><a name="ATK-TEXT-CLIP-NONE:CAPS"></a><code class="literal">ATK_TEXT_CLIP_NONE</code></span></td>
<td> No clipping to be done
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-CLIP-MIN:CAPS"></a><code class="literal">ATK_TEXT_CLIP_MIN</code></span></td>
<td> Text clipped by min coordinate is omitted
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-CLIP-MAX:CAPS"></a><code class="literal">ATK_TEXT_CLIP_MAX</code></span></td>
<td> Text clipped by max coordinate is omitted
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-CLIP-BOTH:CAPS"></a><code class="literal">ATK_TEXT_CLIP_BOTH</code></span></td>
<td> Only text fully within mix/max bound is retained
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602272"></a><h3>
<a name="AtkTextRange"></a>AtkTextRange</h3>
<a class="indexterm" name="id2602284"></a><pre class="programlisting">typedef struct {
AtkTextRectangle bounds;
gint start_offset;
gint end_offset;
gchar* content;
} AtkTextRange;
</pre>
<p>
A structure used to describe a text range.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><a href="AtkText.html#AtkTextRectangle">AtkTextRectangle</a> <em class="structfield"><code>bounds</code></em>;</span></td>
<td> A rectangle giving the bounds of the text range
</td>
</tr>
<tr>
<td><span class="term"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <em class="structfield"><code>start_offset</code></em>;</span></td>
<td> The start offset of a AtkTextRange
</td>
</tr>
<tr>
<td><span class="term"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <em class="structfield"><code>end_offset</code></em>;</span></td>
<td> The end offset of a AtkTextRange
</td>
</tr>
<tr>
<td><span class="term"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *<em class="structfield"><code>content</code></em>;</span></td>
<td> The text in the text range
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602392"></a><h3>
<a name="AtkTextRectangle"></a>AtkTextRectangle</h3>
<a class="indexterm" name="id2602405"></a><pre class="programlisting">typedef struct {
gint x;
gint y;
gint width;
gint height;
} AtkTextRectangle;
</pre>
<p>
A structure used to store a rectangle used by AtkText.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <em class="structfield"><code>x</code></em>;</span></td>
<td> The horizontal coordinate of a rectangle
</td>
</tr>
<tr>
<td><span class="term"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <em class="structfield"><code>y</code></em>;</span></td>
<td> The vertical coordinate of a rectangle
</td>
</tr>
<tr>
<td><span class="term"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <em class="structfield"><code>width</code></em>;</span></td>
<td> The width of a rectangle
</td>
</tr>
<tr>
<td><span class="term"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <em class="structfield"><code>height</code></em>;</span></td>
<td> The height of a rectangle
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602512"></a><h3>
<a name="AtkAttribute"></a>AtkAttribute</h3>
<a class="indexterm" name="id2602525"></a><pre class="programlisting">typedef struct {
gchar* name;
gchar* value;
} AtkAttribute;
</pre>
<p>
A string name/value pair representing a text attribute.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *<em class="structfield"><code>name</code></em>;</span></td>
<td> The attribute name. Call <code class="function">atk_text_attr_get_name()</code>
</td>
</tr>
<tr>
<td><span class="term"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *<em class="structfield"><code>value</code></em>;</span></td>
<td> the value of the attribute, represented as a string.
Call <code class="function">atk_text_attr_get_value()</code> for those which are strings.
For values which are numbers, the string representation of the number
is in value.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602617"></a><h3>
<a name="AtkAttributeSet"></a>AtkAttributeSet</h3>
<a class="indexterm" name="id2602630"></a><pre class="programlisting">typedef GSList AtkAttributeSet;
</pre>
<p>
This is a singly-linked list (a <a
href="../glib/glib-Singly-Linked-Lists.html#GSList"
><span class="type">GSList</span></a>) of <a href="AtkText.html#AtkAttribute"><span class="type">AtkAttribute</span></a>. It is
used by <a href="AtkText.html#atk-text-get-run-attributes"><code class="function">atk_text_get_run_attributes()</code></a>, <a href="AtkText.html#atk-text-get-default-attributes"><code class="function">atk_text_get_default_attributes()</code></a>
and <a href="AtkEditableText.html#atk-editable-text-set-run-attributes"><code class="function">atk_editable_text_set_run_attributes()</code></a></p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602700"></a><h3>
<a name="AtkTextAttribute"></a>enum AtkTextAttribute</h3>
<a class="indexterm" name="id2602712"></a><pre class="programlisting">typedef enum
{
ATK_TEXT_ATTR_INVALID = 0,
ATK_TEXT_ATTR_LEFT_MARGIN,
ATK_TEXT_ATTR_RIGHT_MARGIN,
ATK_TEXT_ATTR_INDENT,
ATK_TEXT_ATTR_INVISIBLE,
ATK_TEXT_ATTR_EDITABLE,
ATK_TEXT_ATTR_PIXELS_ABOVE_LINES,
ATK_TEXT_ATTR_PIXELS_BELOW_LINES,
ATK_TEXT_ATTR_PIXELS_INSIDE_WRAP,
ATK_TEXT_ATTR_BG_FULL_HEIGHT,
ATK_TEXT_ATTR_RISE,
ATK_TEXT_ATTR_UNDERLINE,
ATK_TEXT_ATTR_STRIKETHROUGH,
ATK_TEXT_ATTR_SIZE,
ATK_TEXT_ATTR_SCALE,
ATK_TEXT_ATTR_WEIGHT,
ATK_TEXT_ATTR_LANGUAGE,
ATK_TEXT_ATTR_FAMILY_NAME,
ATK_TEXT_ATTR_BG_COLOR,
ATK_TEXT_ATTR_FG_COLOR,
ATK_TEXT_ATTR_BG_STIPPLE,
ATK_TEXT_ATTR_FG_STIPPLE,
ATK_TEXT_ATTR_WRAP_MODE,
ATK_TEXT_ATTR_DIRECTION,
ATK_TEXT_ATTR_JUSTIFICATION,
ATK_TEXT_ATTR_STRETCH,
ATK_TEXT_ATTR_VARIANT,
ATK_TEXT_ATTR_STYLE,
ATK_TEXT_ATTR_LAST_DEFINED
} AtkTextAttribute;
</pre>
<p>
Describes the text attributes supported</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><a name="ATK-TEXT-ATTR-INVALID:CAPS"></a><code class="literal">ATK_TEXT_ATTR_INVALID</code></span></td>
<td> Invalid attribute
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-ATTR-LEFT-MARGIN:CAPS"></a><code class="literal">ATK_TEXT_ATTR_LEFT_MARGIN</code></span></td>
<td> The pixel width of the left margin
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-ATTR-RIGHT-MARGIN:CAPS"></a><code class="literal">ATK_TEXT_ATTR_RIGHT_MARGIN</code></span></td>
<td> The pixel width of the right margin
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-ATTR-INDENT:CAPS"></a><code class="literal">ATK_TEXT_ATTR_INDENT</code></span></td>
<td> The number of pixels that the text is indented
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-ATTR-INVISIBLE:CAPS"></a><code class="literal">ATK_TEXT_ATTR_INVISIBLE</code></span></td>
<td> Either "true" or "false" indicating whether text is visible or not
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-ATTR-EDITABLE:CAPS"></a><code class="literal">ATK_TEXT_ATTR_EDITABLE</code></span></td>
<td> Either "true" or "false" indicating whether text is editable or not
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-ATTR-PIXELS-ABOVE-LINES:CAPS"></a><code class="literal">ATK_TEXT_ATTR_PIXELS_ABOVE_LINES</code></span></td>
<td> Pixels of blank space to leave above each newline-terminated line.
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-ATTR-PIXELS-BELOW-LINES:CAPS"></a><code class="literal">ATK_TEXT_ATTR_PIXELS_BELOW_LINES</code></span></td>
<td> Pixels of blank space to leave below each newline-terminated line.
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-ATTR-PIXELS-INSIDE-WRAP:CAPS"></a><code class="literal">ATK_TEXT_ATTR_PIXELS_INSIDE_WRAP</code></span></td>
<td> Pixels of blank space to leave between wrapped lines inside the same newline-terminated line (paragraph).
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-ATTR-BG-FULL-HEIGHT:CAPS"></a><code class="literal">ATK_TEXT_ATTR_BG_FULL_HEIGHT</code></span></td>
<td> "true" or "false" whether to make the background color for each character the height of the highest font used on the current line, or the height of the font used for the current character.
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-ATTR-RISE:CAPS"></a><code class="literal">ATK_TEXT_ATTR_RISE</code></span></td>
<td> Number of pixels that the characters are risen above the baseline
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-ATTR-UNDERLINE:CAPS"></a><code class="literal">ATK_TEXT_ATTR_UNDERLINE</code></span></td>
<td> "none", "single", "double" or "low"
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-ATTR-STRIKETHROUGH:CAPS"></a><code class="literal">ATK_TEXT_ATTR_STRIKETHROUGH</code></span></td>
<td> "true" or "false" whether the text is strikethrough
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-ATTR-SIZE:CAPS"></a><code class="literal">ATK_TEXT_ATTR_SIZE</code></span></td>
<td> The size of the characters.
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-ATTR-SCALE:CAPS"></a><code class="literal">ATK_TEXT_ATTR_SCALE</code></span></td>
<td> The scale of the characters. The value is a string representation of a double
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-ATTR-WEIGHT:CAPS"></a><code class="literal">ATK_TEXT_ATTR_WEIGHT</code></span></td>
<td> The weight of the characters.
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-ATTR-LANGUAGE:CAPS"></a><code class="literal">ATK_TEXT_ATTR_LANGUAGE</code></span></td>
<td> The language used
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-ATTR-FAMILY-NAME:CAPS"></a><code class="literal">ATK_TEXT_ATTR_FAMILY_NAME</code></span></td>
<td> The font family name
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-ATTR-BG-COLOR:CAPS"></a><code class="literal">ATK_TEXT_ATTR_BG_COLOR</code></span></td>
<td> The background color. The value is an RGB value of the format "<code class="literal">u</code>,<code class="literal">u</code>,<code class="literal">u</code>"
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-ATTR-FG-COLOR:CAPS"></a><code class="literal">ATK_TEXT_ATTR_FG_COLOR</code></span></td>
<td>The foreground color. The value is an RGB value of the format "<code class="literal">u</code>,<code class="literal">u</code>,<code class="literal">u</code>"
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-ATTR-BG-STIPPLE:CAPS"></a><code class="literal">ATK_TEXT_ATTR_BG_STIPPLE</code></span></td>
<td> "true" if a <a
href="../gdk/gdk-Bitmaps-and-Pixmaps.html#GdkBitmap"
><span class="type">GdkBitmap</span></a> is set for stippling the background color.
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-ATTR-FG-STIPPLE:CAPS"></a><code class="literal">ATK_TEXT_ATTR_FG_STIPPLE</code></span></td>
<td> "true" if a <a
href="../gdk/gdk-Bitmaps-and-Pixmaps.html#GdkBitmap"
><span class="type">GdkBitmap</span></a> is set for stippling the foreground color.
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-ATTR-WRAP-MODE:CAPS"></a><code class="literal">ATK_TEXT_ATTR_WRAP_MODE</code></span></td>
<td> The wrap mode of the text, if any. Values are "none", "char" or "word"
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-ATTR-DIRECTION:CAPS"></a><code class="literal">ATK_TEXT_ATTR_DIRECTION</code></span></td>
<td> The direction of the text, if set. Values are "none", "ltr" or "rtl"
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-ATTR-JUSTIFICATION:CAPS"></a><code class="literal">ATK_TEXT_ATTR_JUSTIFICATION</code></span></td>
<td> The justification of the text, if set. Values are "left", "right", "center" or "fill"
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-ATTR-STRETCH:CAPS"></a><code class="literal">ATK_TEXT_ATTR_STRETCH</code></span></td>
<td> The stretch of the text, if set. Values are "ultra_condensed", "extra_condensed", "condensed", "semi_condensed", "normal", "semi_expanded", "expanded", "extra_expanded" or "ultra_expanded"
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-ATTR-VARIANT:CAPS"></a><code class="literal">ATK_TEXT_ATTR_VARIANT</code></span></td>
<td> The capitalization variant of the text, if set. Values are "normal" or "small_caps"
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-ATTR-STYLE:CAPS"></a><code class="literal">ATK_TEXT_ATTR_STYLE</code></span></td>
<td> The slant style of the text, if set. Values are "normal", "oblique" or "italic"
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-TEXT-ATTR-LAST-DEFINED:CAPS"></a><code class="literal">ATK_TEXT_ATTR_LAST_DEFINED</code></span></td>
<td> not a valid text attribute, used for finding end of enumeration
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603513"></a><h3>
<a name="atk-text-get-text"></a>atk_text_get_text ()</h3>
<a class="indexterm" name="id2603526"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* atk_text_get_text (<a href="AtkText.html" title="AtkText">AtkText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> start_offset,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> end_offset);</pre>
<p>
Gets the specified text.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>text</code></em> :</span></td>
<td> an <a href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>start_offset</code></em> :</span></td>
<td> start position
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>end_offset</code></em> :</span></td>
<td> end position
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the text from <em class="parameter"><code>start_offset</code></em> up to, but not including <em class="parameter"><code>end_offset</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603650"></a><h3>
<a name="atk-text-get-character-at-offset"></a>atk_text_get_character_at_offset ()</h3>
<a class="indexterm" name="id2603662"></a><pre class="programlisting"><a
href="../glib/glib-Unicode-Manipulation.html#gunichar"
>gunichar</a> atk_text_get_character_at_offset
(<a href="AtkText.html" title="AtkText">AtkText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> offset);</pre>
<p>
Gets the specified text.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>text</code></em> :</span></td>
<td> an <a href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>offset</code></em> :</span></td>
<td> position
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the character at <em class="parameter"><code>offset</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603759"></a><h3>
<a name="atk-text-get-text-after-offset"></a>atk_text_get_text_after_offset ()</h3>
<a class="indexterm" name="id2603772"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* atk_text_get_text_after_offset (<a href="AtkText.html" title="AtkText">AtkText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> offset,
<a href="AtkText.html#AtkTextBoundary">AtkTextBoundary</a> boundary_type,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *start_offset,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *end_offset);</pre>
<p>
Gets the specified text.
</p>
<p>
If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character after the
offset is returned.
</p>
<p>
If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START the returned string
is from the word start after the offset to the next word start.
</p>
<p>
The returned string will contain the word after the offset if the offset
is inside a word or if the offset is not inside a word.
</p>
<p>
If the boundary_type is ATK_TEXT_BOUNDARY_WORD_END the returned string
is from the word end at or after the offset to the next work end.
</p>
<p>
The returned string will contain the word after the offset if the offset
is inside a word and will contain the word after the word after the offset
if the offset is not inside a word.
</p>
<p>
If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the returned
string is from the sentence start after the offset to the next sentence
start.
</p>
<p>
The returned string will contain the sentence after the offset if the offset
is inside a sentence or if the offset is not inside a sentence.
</p>
<p>
If the boundary_type is ATK_TEXT_BOUNDARY_SENTENCE_END the returned string
is from the sentence end at or after the offset to the next sentence end.
</p>
<p>
The returned string will contain the sentence after the offset if the offset
is inside a sentence and will contain the sentence after the sentence
after the offset if the offset is not inside a sentence.
</p>
<p>
If the boundary type is ATK_TEXT_BOUNDARY_LINE_START the returned
string is from the line start after the offset to the next line start.
</p>
<p>
If the boundary_type is ATK_TEXT_BOUNDARY_LINE_END the returned string
is from the line end at or after the offset to the next line start.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>text</code></em> :</span></td>
<td> an <a href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>offset</code></em> :</span></td>
<td> position
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>boundary_type</code></em> :</span></td>
<td> An <a href="AtkText.html#AtkTextBoundary"><span class="type">AtkTextBoundary</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>start_offset</code></em> :</span></td>
<td> the start offset of the returned string
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>end_offset</code></em> :</span></td>
<td> the offset of the first character after the
returned substring
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the text after <em class="parameter"><code>offset</code></em> bounded by the specified <em class="parameter"><code>boundary_type</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604013"></a><h3>
<a name="atk-text-get-text-at-offset"></a>atk_text_get_text_at_offset ()</h3>
<a class="indexterm" name="id2604027"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* atk_text_get_text_at_offset (<a href="AtkText.html" title="AtkText">AtkText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> offset,
<a href="AtkText.html#AtkTextBoundary">AtkTextBoundary</a> boundary_type,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *start_offset,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *end_offset);</pre>
<p>
Gets the specified text.
</p>
<p>
If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character at the
offset is returned.
</p>
<p>
If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START 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 the boundary_type is ATK_TEXT_BOUNDARY_WORD_END the returned string
is from the word end before the offset to the word end at or 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 after to the offset if the
offset is not inside a word.
</p>
<p>
If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START 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 the boundary_type is ATK_TEXT_BOUNDARY_SENTENCE_END the returned string
is from the sentence end before the offset to the sentence end at or
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 after the offset
if the offset is not inside a sentence.
</p>
<p>
If the boundary type is ATK_TEXT_BOUNDARY_LINE_START the returned
string is from the line start at or before the offset to the line
start after the offset.
</p>
<p>
If the boundary_type is ATK_TEXT_BOUNDARY_LINE_END the returned string
is from the line end before the offset to the line end at or after
the offset.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>text</code></em> :</span></td>
<td> an <a href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>offset</code></em> :</span></td>
<td> position
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>boundary_type</code></em> :</span></td>
<td> An <a href="AtkText.html#AtkTextBoundary"><span class="type">AtkTextBoundary</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>start_offset</code></em> :</span></td>
<td> the start offset of the returned string
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>end_offset</code></em> :</span></td>
<td> the offset of the first character after the
returned substring
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the text at <em class="parameter"><code>offset</code></em> bounded by the specified <em class="parameter"><code>boundary_type</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604270"></a><h3>
<a name="atk-text-get-text-before-offset"></a>atk_text_get_text_before_offset ()</h3>
<a class="indexterm" name="id2604283"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* atk_text_get_text_before_offset (<a href="AtkText.html" title="AtkText">AtkText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> offset,
<a href="AtkText.html#AtkTextBoundary">AtkTextBoundary</a> boundary_type,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *start_offset,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *end_offset);</pre>
<p>
Gets the specified text.
</p>
<p>
If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character before the
offset is returned.
</p>
<p>
If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START the returned string
is from the word start before the word start before the offset to
the word start before the offset.
</p>
<p>
The returned string will contain the word before the offset if the offset
is inside a word and will contain the word before the word before the
offset if the offset is not inside a word.
</p>
<p>
If the boundary_type is ATK_TEXT_BOUNDARY_WORD_END the returned string
is from the word end before the word end at or before the offset to the
word end at or before the offset.
</p>
<p>
The returned string will contain the word before the offset if the offset
is inside a word or if the offset is not inside a word.
</p>
<p>
If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the returned
string is from the sentence start before the sentence start before
the offset to the sentence start before the offset.
</p>
<p>
The returned string will contain the sentence before the offset if the
offset is inside a sentence and will contain the sentence before the
sentence before the offset if the offset is not inside a sentence.
</p>
<p>
If the boundary_type is ATK_TEXT_BOUNDARY_SENTENCE_END the returned string
is from the sentence end before the sentence end at or before the offset to
the sentence end at or before the offset.
</p>
<p>
The returned string will contain the sentence before the offset if the
offset is inside a sentence or if the offset is not inside a sentence.
</p>
<p>
If the boundary type is ATK_TEXT_BOUNDARY_LINE_START the returned
string is from the line start before the line start ar or before the offset
to the line start ar or before the offset.
</p>
<p>
If the boundary_type is ATK_TEXT_BOUNDARY_LINE_END the returned string
is from the line end before the line end before the offset to the
line end before the offset.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>text</code></em> :</span></td>
<td> an <a href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>offset</code></em> :</span></td>
<td> position
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>boundary_type</code></em> :</span></td>
<td> An <a href="AtkText.html#AtkTextBoundary"><span class="type">AtkTextBoundary</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>start_offset</code></em> :</span></td>
<td> the start offset of the returned string
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>end_offset</code></em> :</span></td>
<td> the offset of the first character after the
returned substring
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the text before <em class="parameter"><code>offset</code></em> bounded by the specified <em class="parameter"><code>boundary_type</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604528"></a><h3>
<a name="atk-text-get-caret-offset"></a>atk_text_get_caret_offset ()</h3>
<a class="indexterm" name="id2604542"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> atk_text_get_caret_offset (<a href="AtkText.html" title="AtkText">AtkText</a> *text);</pre>
<p>
Gets the offset position of the caret (cursor).</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>text</code></em> :</span></td>
<td> an <a href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the offset position of the caret (cursor).
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604611"></a><h3>
<a name="atk-text-get-character-extents"></a>atk_text_get_character_extents ()</h3>
<a class="indexterm" name="id2604625"></a><pre class="programlisting">void atk_text_get_character_extents (<a href="AtkText.html" title="AtkText">AtkText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> offset,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *x,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *y,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *width,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *height,
<a href="AtkUtil.html#AtkCoordType">AtkCoordType</a> coords);</pre>
<p>
Get the bounding box containing the glyph representing the character at
a particular text offset.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>text</code></em> :</span></td>
<td> an <a href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>offset</code></em> :</span></td>
<td> The offset of the text character for which bounding information is required.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>x</code></em> :</span></td>
<td> Pointer for the x cordinate of the bounding box
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>y</code></em> :</span></td>
<td> Pointer for the y cordinate of the bounding box
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>width</code></em> :</span></td>
<td> Pointer for the width of the bounding box
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>height</code></em> :</span></td>
<td> Pointer for the height of the bounding box
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>coords</code></em> :</span></td>
<td> specify whether coordinates are relative to the screen or widget window
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604817"></a><h3>
<a name="atk-text-get-run-attributes"></a>atk_text_get_run_attributes ()</h3>
<a class="indexterm" name="id2604831"></a><pre class="programlisting"><a href="AtkText.html#AtkAttributeSet">AtkAttributeSet</a>* atk_text_get_run_attributes
(<a href="AtkText.html" title="AtkText">AtkText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> offset,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *start_offset,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *end_offset);</pre>
<p>
Creates an <a href="AtkText.html#AtkAttributeSet"><span class="type">AtkAttributeSet</span></a> which consists of the attributes explicitly
set at the position <em class="parameter"><code>offset</code></em> in the text. <em class="parameter"><code>start_offset</code></em> and <em class="parameter"><code>end_offset</code></em> are
set to the start and end of the range around <em class="parameter"><code>offset</code></em> where the attributes are
invariant. Note that <em class="parameter"><code>end_offset</code></em> is the offset of the first character
after the range. See the enum AtkTextAttribute for types of text
attributes that can be returned. Note that other attributes may also be
returned.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>text</code></em> :</span></td>
<td> an <a href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>offset</code></em> :</span></td>
<td> the offset at which to get the attributes
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>start_offset</code></em> :</span></td>
<td> the address to put the start offset of the range
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>end_offset</code></em> :</span></td>
<td> the address to put the end offset of the range
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> an <a href="AtkText.html#AtkAttributeSet"><span class="type">AtkAttributeSet</span></a> which contains the attributes explicitly set
at <em class="parameter"><code>offset</code></em>. This <a href="AtkText.html#AtkAttributeSet"><span class="type">AtkAttributeSet</span></a> should be freed by a call to
<a href="AtkText.html#atk-attribute-set-free"><code class="function">atk_attribute_set_free()</code></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605045"></a><h3>
<a name="atk-text-get-default-attributes"></a>atk_text_get_default_attributes ()</h3>
<a class="indexterm" name="id2605058"></a><pre class="programlisting"><a href="AtkText.html#AtkAttributeSet">AtkAttributeSet</a>* atk_text_get_default_attributes
(<a href="AtkText.html" title="AtkText">AtkText</a> *text);</pre>
<p>
Creates an <a href="AtkText.html#AtkAttributeSet"><span class="type">AtkAttributeSet</span></a> which consists of the default values of
attributes for the text. See the enum AtkTextAttribute for types of text
attributes that can be returned. Note that other attributes may also be
returned.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>text</code></em> :</span></td>
<td> an <a href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> an <a href="AtkText.html#AtkAttributeSet"><span class="type">AtkAttributeSet</span></a> which contains the default values of attributes.
at <em class="parameter"><code>offset</code></em>. This <a href="AtkText.html#AtkAttributeSet"><span class="type">AtkAttributeSet</span></a> should be freed by a call to
<a href="AtkText.html#atk-attribute-set-free"><code class="function">atk_attribute_set_free()</code></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605174"></a><h3>
<a name="atk-text-get-character-count"></a>atk_text_get_character_count ()</h3>
<a class="indexterm" name="id2605188"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> atk_text_get_character_count (<a href="AtkText.html" title="AtkText">AtkText</a> *text);</pre>
<p>
Gets the character count.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>text</code></em> :</span></td>
<td> an <a href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the number of characters.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605256"></a><h3>
<a name="atk-text-get-offset-at-point"></a>atk_text_get_offset_at_point ()</h3>
<a class="indexterm" name="id2605270"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> atk_text_get_offset_at_point (<a href="AtkText.html" title="AtkText">AtkText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> x,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> y,
<a href="AtkUtil.html#AtkCoordType">AtkCoordType</a> coords);</pre>
<p>
Gets the offset of the character located at coordinates <em class="parameter"><code>x</code></em> and <em class="parameter"><code>y</code></em>. <em class="parameter"><code>x</code></em> and <em class="parameter"><code>y</code></em>
are interpreted as being relative to the screen or this widget's window
depending on <em class="parameter"><code>coords</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>text</code></em> :</span></td>
<td> an <a href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>x</code></em> :</span></td>
<td> screen x-position of character
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>y</code></em> :</span></td>
<td> screen y-position of character
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>coords</code></em> :</span></td>
<td> specify whether coordinates are relative to the screen or
widget window
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the offset to the character which is located at
the specified <em class="parameter"><code>x</code></em> and <em class="parameter"><code>y</code></em> coordinates.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605447"></a><h3>
<a name="atk-text-get-bounded-ranges"></a>atk_text_get_bounded_ranges ()</h3>
<a class="indexterm" name="id2605463"></a><pre class="programlisting"><a href="AtkText.html#AtkTextRange">AtkTextRange</a>** atk_text_get_bounded_ranges (<a href="AtkText.html" title="AtkText">AtkText</a> *text,
<a href="AtkText.html#AtkTextRectangle">AtkTextRectangle</a> *rect,
<a href="AtkUtil.html#AtkCoordType">AtkCoordType</a> coord_type,
<a href="AtkText.html#AtkTextClipType">AtkTextClipType</a> x_clip_type,
<a href="AtkText.html#AtkTextClipType">AtkTextClipType</a> y_clip_type);</pre>
<p>
Get the ranges of text in the specified bounding box.
</p>
<p>
Returns:</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>text</code></em> :</span></td>
<td> an <a href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>rect</code></em> :</span></td>
<td> An AtkTextRectagle giving the dimensions of the bounding box.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>coord_type</code></em> :</span></td>
<td> Specify whether coordinates are relative to the screen or widget window.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>x_clip_type</code></em> :</span></td>
<td> Specify the horizontal clip type.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>y_clip_type</code></em> :</span></td>
<td> Specify the vertical clip type.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> Array of AtkTextRange. The last element of the array returned
by this function will be NULL.
</td>
</tr>
</tbody>
</table></div>
<p>Since ATK 1.3
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605632"></a><h3>
<a name="atk-text-get-range-extents"></a>atk_text_get_range_extents ()</h3>
<a class="indexterm" name="id2605648"></a><pre class="programlisting">void atk_text_get_range_extents (<a href="AtkText.html" title="AtkText">AtkText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> start_offset,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> end_offset,
<a href="AtkUtil.html#AtkCoordType">AtkCoordType</a> coord_type,
<a href="AtkText.html#AtkTextRectangle">AtkTextRectangle</a> *rect);</pre>
<p>
Get the bounding box for text within the specified range.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>text</code></em> :</span></td>
<td> an <a href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>start_offset</code></em> :</span></td>
<td> The offset of the first text character for which boundary
information is required.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>end_offset</code></em> :</span></td>
<td> The offset of the text character after the last character
for which boundary information is required.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>coord_type</code></em> :</span></td>
<td> Specify whether coordinates are relative to the screen or widget window.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>rect</code></em> :</span></td>
<td> A pointer to a AtkTextRectangle which is filled in by this function.
</td>
</tr>
</tbody>
</table></div>
<p>Since ATK 1.3
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605803"></a><h3>
<a name="atk-text-free-ranges"></a>atk_text_free_ranges ()</h3>
<a class="indexterm" name="id2605819"></a><pre class="programlisting">void atk_text_free_ranges (<a href="AtkText.html#AtkTextRange">AtkTextRange</a> **ranges);</pre>
<p>
Frees the memory associated with an array of AtkTextRange. It is assumed
that the array was returned by the function atk_text_get_bounded_ranges
and is NULL terminated.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><em class="parameter"><code>ranges</code></em> :</span></td>
<td> A pointer to an array of <a href="AtkText.html#AtkTextRange"><span class="type">AtkTextRange</span></a> which is to be freed.
</td>
</tr></tbody>
</table></div>
<p>Since ATK 1.3
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605885"></a><h3>
<a name="atk-text-get-n-selections"></a>atk_text_get_n_selections ()</h3>
<a class="indexterm" name="id2605899"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> atk_text_get_n_selections (<a href="AtkText.html" title="AtkText">AtkText</a> *text);</pre>
<p>
Gets the number of selected regions.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>text</code></em> :</span></td>
<td> an <a href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The number of selected regions, or -1 if a failure
occurred.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605968"></a><h3>
<a name="atk-text-get-selection"></a>atk_text_get_selection ()</h3>
<a class="indexterm" name="id2605981"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* atk_text_get_selection (<a href="AtkText.html" title="AtkText">AtkText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> selection_num,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *start_offset,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *end_offset);</pre>
<p>
Gets the text from the specified selection.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>text</code></em> :</span></td>
<td> an <a href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>selection_num</code></em> :</span></td>
<td> The selection number. The selected regions are
assigned numbers that correspond to how far the region is from the
start of the text. The selected region closest to the beginning
of the text region is assigned the number 0, etc. Note that adding,
moving or deleting a selected region can change the numbering.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>start_offset</code></em> :</span></td>
<td> passes back the start position of the selected region
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>end_offset</code></em> :</span></td>
<td> passes back the end position of (e.g. offset immediately past)
the selected region
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the selected text.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2606122"></a><h3>
<a name="atk-text-add-selection"></a>atk_text_add_selection ()</h3>
<a class="indexterm" name="id2606135"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> atk_text_add_selection (<a href="AtkText.html" title="AtkText">AtkText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> start_offset,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> end_offset);</pre>
<p>
Adds a selection bounded by the specified offsets.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>text</code></em> :</span></td>
<td> an <a href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>start_offset</code></em> :</span></td>
<td> the start position of the selected region
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>end_offset</code></em> :</span></td>
<td> the offset of the first character after the selected region.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if success, <a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> otherwise
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2606269"></a><h3>
<a name="atk-text-remove-selection"></a>atk_text_remove_selection ()</h3>
<a class="indexterm" name="id2606283"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> atk_text_remove_selection (<a href="AtkText.html" title="AtkText">AtkText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> selection_num);</pre>
<p>
Removes the specified selection.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>text</code></em> :</span></td>
<td> an <a href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>selection_num</code></em> :</span></td>
<td> The selection number. The selected regions are
assigned numbers that correspond to how far the region is from the
start of the text. The selected region closest to the beginning
of the text region is assigned the number 0, etc. Note that adding,
moving or deleting a selected region can change the numbering.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if success, <a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> otherwise
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2606398"></a><h3>
<a name="atk-text-set-selection"></a>atk_text_set_selection ()</h3>
<a class="indexterm" name="id2606411"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> atk_text_set_selection (<a href="AtkText.html" title="AtkText">AtkText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> selection_num,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> start_offset,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> end_offset);</pre>
<p>
Changes the start and end offset of the specified selection.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>text</code></em> :</span></td>
<td> an <a href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>selection_num</code></em> :</span></td>
<td> The selection number. The selected regions are
assigned numbers that correspond to how far the region is from the
start of the text. The selected region closest to the beginning
of the text region is assigned the number 0, etc. Note that adding,
moving or deleting a selected region can change the numbering.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>start_offset</code></em> :</span></td>
<td> the new start position of the selection
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>end_offset</code></em> :</span></td>
<td> the new end position of (e.g. offset immediately past)
the selection
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if success, <a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> otherwise
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2606572"></a><h3>
<a name="atk-text-set-caret-offset"></a>atk_text_set_caret_offset ()</h3>
<a class="indexterm" name="id2606586"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> atk_text_set_caret_offset (<a href="AtkText.html" title="AtkText">AtkText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> offset);</pre>
<p>
Sets the caret (cursor) position to the specified <em class="parameter"><code>offset</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>text</code></em> :</span></td>
<td> an <a href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>offset</code></em> :</span></td>
<td> position
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if success, <a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2606702"></a><h3>
<a name="atk-attribute-set-free"></a>atk_attribute_set_free ()</h3>
<a class="indexterm" name="id2606715"></a><pre class="programlisting">void atk_attribute_set_free (<a href="AtkText.html#AtkAttributeSet">AtkAttributeSet</a> *attrib_set);</pre>
<p>
Frees the memory used by an <a href="AtkText.html#AtkAttributeSet"><span class="type">AtkAttributeSet</span></a>, including all its
<span class="type">AtkAttributes</span>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><em class="parameter"><code>attrib_set</code></em> :</span></td>
<td> The <a href="AtkText.html#AtkAttributeSet"><span class="type">AtkAttributeSet</span></a> to free
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2606792"></a><h3>
<a name="atk-text-attribute-register"></a>atk_text_attribute_register ()</h3>
<a class="indexterm" name="id2606806"></a><pre class="programlisting"><a href="AtkText.html#AtkTextAttribute">AtkTextAttribute</a> atk_text_attribute_register
(const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);</pre>
<p>
Associate <em class="parameter"><code>name</code></em> with a new <a href="AtkText.html#AtkTextAttribute"><span class="type">AtkTextAttribute</span></a></p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> a name string
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> an <a href="AtkText.html#AtkTextAttribute"><span class="type">AtkTextAttribute</span></a> associated with <em class="parameter"><code>name</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2606894"></a><h3>
<a name="atk-text-attribute-get-name"></a>atk_text_attribute_get_name ()</h3>
<a class="indexterm" name="id2606908"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* atk_text_attribute_get_name (<a href="AtkText.html#AtkTextAttribute">AtkTextAttribute</a> attr);</pre>
<p>
Gets the name corresponding to the <a href="AtkText.html#AtkTextAttribute"><span class="type">AtkTextAttribute</span></a></p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>attr</code></em> :</span></td>
<td> The <a href="AtkText.html#AtkTextAttribute"><span class="type">AtkTextAttribute</span></a> whose name is required
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a string containing the name; this string should not be freed
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2606987"></a><h3>
<a name="atk-text-attribute-for-name"></a>atk_text_attribute_for_name ()</h3>
<a class="indexterm" name="id2607001"></a><pre class="programlisting"><a href="AtkText.html#AtkTextAttribute">AtkTextAttribute</a> atk_text_attribute_for_name
(const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);</pre>
<p>
Get the <a href="AtkText.html#AtkTextAttribute"><span class="type">AtkTextAttribute</span></a> type corresponding to a text attribute name.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> a string which is the (non-localized) name of an ATK text attribute.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the <a href="AtkText.html#AtkTextAttribute"><span class="type">AtkTextAttribute</span></a> enumerated type corresponding to the specified
name,
or <span class="type">ATK_TEXT_ATTRIBUTE_INVALID</span> if no matching text attribute is found.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2607093"></a><h3>
<a name="atk-text-attribute-get-value"></a>atk_text_attribute_get_value ()</h3>
<a class="indexterm" name="id2607106"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* atk_text_attribute_get_value (<a href="AtkText.html#AtkTextAttribute">AtkTextAttribute</a> attr,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> index_);</pre>
<p>
Gets the value for the index of the <a href="AtkText.html#AtkTextAttribute"><span class="type">AtkTextAttribute</span></a></p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>attr</code></em> :</span></td>
<td> The <a href="AtkText.html#AtkTextAttribute"><span class="type">AtkTextAttribute</span></a> for which a value is required
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>index_</code></em> :</span></td>
<td> The index of the required value
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a string containing the value; this string should not be freed;
NULL is returned if there are no values maintained for the attr value.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2607209"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id2607220"></a><h3>
<a name="AtkText-text-attributes-changed"></a>The "text-attributes-changed" signal</h3>
<a class="indexterm" name="id2607231"></a><pre class="programlisting">void user_function (<a href="AtkText.html" title="AtkText">AtkText</a> *atktext,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last</pre>
<p>
The "text-attributes-changed" signal is emitted when the text attributes of
the text of an object which implements AtkText changes.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>atktext</code></em> :</span></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2607301"></a><h3>
<a name="AtkText-text-caret-moved"></a>The "text-caret-moved" signal</h3>
<a class="indexterm" name="id2607312"></a><pre class="programlisting">void user_function (<a href="AtkText.html" title="AtkText">AtkText</a> *atktext,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> arg1,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last</pre>
<p>
The "text-caret-moved" signal is emitted when the caret position of
the text of an object which implements AtkText changes.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>atktext</code></em> :</span></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>arg1</code></em> :</span></td>
<td>The new position of the text caret.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2607404"></a><h3>
<a name="AtkText-text-changed"></a>The "text-changed" signal</h3>
<a class="indexterm" name="id2607415"></a><pre class="programlisting">void user_function (<a href="AtkText.html" title="AtkText">AtkText</a> *atktext,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> arg1,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> arg2,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last / Has details</pre>
<p>
The "text-changed" signal is emitted when the text of the object which
implements the AtkText interface changes, This signal will have a detail
which is either "insert" or "delete" which identifies whether the text
change was an insertion or a deletion
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>atktext</code></em> :</span></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>arg1</code></em> :</span></td>
<td>The position (character offset) of the insertion or deletion.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>arg2</code></em> :</span></td>
<td>The length (in characters) of text inserted or deleted.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2607532"></a><h3>
<a name="AtkText-text-selection-changed"></a>The "text-selection-changed" signal</h3>
<a class="indexterm" name="id2607544"></a><pre class="programlisting">void user_function (<a href="AtkText.html" title="AtkText">AtkText</a> *atktext,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last</pre>
<p>
The "text-selection-changed" signal is emitted when the selected text of
an object which implements AtkText changes.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>atktext</code></em> :</span></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>