doc/libatspi/html/libatspi-atspi-text.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>atspi-text</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
   7 <link rel="home" href="index.html" title="libatspi Reference Manual">
   8 <link rel="up" href="ch01.html" title="API reference">
   9 <link rel="prev" href="ch01.html" title="API reference">
  10 <link rel="next" href="AtspiStateSet.html" title="atspi-stateset">
  11 <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="ch01.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">libatspi Reference Manual</th>
  21 <td><a accesskey="n" href="AtspiStateSet.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#libatspi-atspi-text.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#libatspi-atspi-text.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#libatspi-atspi-text.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#libatspi-atspi-text.implementations" class="shortcut">Known Implementations</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="libatspi-atspi-text"></a><div class="titlepage"></div>
  35 <div class="refnamediv"><table width="100%"><tr>
  36 <td valign="top">
  37 <h2><span class="refentrytitle"><a name="libatspi-atspi-text.top_of_page"></a>atspi-text</span></h2>
  38 <p>atspi-text — An interface implemented by objects which place textual
  39 information onscreen.</p>
  40 </td>
  41 <td valign="top" align="right"></td>
  42 </tr></table></div>
  43 <div class="refsynopsisdiv">
  44 <a name="libatspi-atspi-text.synopsis"></a><h2>Synopsis</h2>
  45 <a name="AtspiRange"></a><a name="AtspiTextRange"></a><a name="AtspiText"></a><pre class="synopsis">struct              <a class="link" href="libatspi-atspi-text.html#AtspiRange-struct" title="struct AtspiRange">AtspiRange</a>;
  46 #define             <a class="link" href="libatspi-atspi-text.html#ATSPI-TYPE-RANGE:CAPS" title="ATSPI_TYPE_RANGE">ATSPI_TYPE_RANGE</a>
  47 <a class="link" href="libatspi-atspi-text.html#AtspiRange"><span class="returnvalue">AtspiRange</span></a> *        <a class="link" href="libatspi-atspi-text.html#atspi-range-copy" title="atspi_range_copy ()">atspi_range_copy</a>                    (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiRange"><span class="type">AtspiRange</span></a> *src</code></em>);
  48 struct              <a class="link" href="libatspi-atspi-text.html#AtspiTextRange-struct" title="struct AtspiTextRange">AtspiTextRange</a>;
  49 #define             <a class="link" href="libatspi-atspi-text.html#ATSPI-TYPE-TEXT-RANGE:CAPS" title="ATSPI_TYPE_TEXT_RANGE">ATSPI_TYPE_TEXT_RANGE</a>
  50 <a href="../gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>               <a class="link" href="libatspi-atspi-text.html#atspi-text-get-type" title="atspi_text_get_type ()">atspi_text_get_type</a>                 ();
  51                     <a class="link" href="libatspi-atspi-text.html#AtspiText-struct" title="AtspiText">AtspiText</a>;
  52 <a href="../gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>               <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>           ();
  53 <a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <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>      (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
  54                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  55 <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="libatspi-atspi-text.html#atspi-text-get-text" title="atspi_text_get_text ()">atspi_text_get_text</a>                 (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
  56                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> start_offset</code></em>,
  57                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> end_offset</code></em>,
  58                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  59 <a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <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>         (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
  60                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  61 <a href="../glib/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> *        <a class="link" href="libatspi-atspi-text.html#atspi-text-get-attributes" title="atspi_text_get_attributes ()">atspi_text_get_attributes</a>           (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
  62                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> offset</code></em>,
  63                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *start_offset</code></em>,
  64                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *end_offset</code></em>,
  65                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  66 <a href="../glib/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> *        <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>        (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
  67                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> offset</code></em>,
  68                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> include_defaults</code></em>,
  69                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *start_offset</code></em>,
  70                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *end_offset</code></em>,
  71                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  72 <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <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>      (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
  73                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> offset</code></em>,
  74                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *attribute_name</code></em>,
  75                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  76 <a href="../glib/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> *        <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>   (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
  77                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  78 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <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>         (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
  79                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> new_offset</code></em>,
  80                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  81 <a class="link" href="libatspi-atspi-text.html#AtspiTextRange"><span class="returnvalue">AtspiTextRange</span></a> *    <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>   (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
  82                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> offset</code></em>,
  83                                                          <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>,
  84                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  85 <a class="link" href="libatspi-atspi-text.html#AtspiTextRange"><span class="returnvalue">AtspiTextRange</span></a> *    <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>       (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
  86                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> offset</code></em>,
  87                                                          <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>,
  88                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  89 <a class="link" href="libatspi-atspi-text.html#AtspiTextRange"><span class="returnvalue">AtspiTextRange</span></a> *    <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>    (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
  90                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> offset</code></em>,
  91                                                          <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>,
  92                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  93 <a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <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>  (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
  94                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> offset</code></em>,
  95                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  96 <a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="returnvalue">AtspiRect</span></a> *         <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>    (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
  97                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> offset</code></em>,
  98                                                          <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>,
  99                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 100 <a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <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>      (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
 101                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> x</code></em>,
 102                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> y</code></em>,
 103                                                          <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>,
 104                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 105 <a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="returnvalue">AtspiRect</span></a> *         <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>        (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
 106                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> start_offset</code></em>,
 107                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> end_offset</code></em>,
 108                                                          <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>,
 109                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 110 <a href="../glib/glib-Arrays.html#GArray"><span class="returnvalue">GArray</span></a> *            <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>       (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
 111                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> x</code></em>,
 112                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> y</code></em>,
 113                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> width</code></em>,
 114                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> height</code></em>,
 115                                                          <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>,
 116                                                          <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>,
 117                                                          <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>,
 118                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 119 <a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <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>         (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
 120                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 121 <a class="link" href="libatspi-atspi-text.html#AtspiRange"><span class="returnvalue">AtspiRange</span></a> *        <a class="link" href="libatspi-atspi-text.html#atspi-text-get-selection" title="atspi_text_get_selection ()">atspi_text_get_selection</a>            (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
 122                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> selection_num</code></em>,
 123                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 124 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libatspi-atspi-text.html#atspi-text-add-selection" title="atspi_text_add_selection ()">atspi_text_add_selection</a>            (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
 125                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> start_offset</code></em>,
 126                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> end_offset</code></em>,
 127                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 128 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libatspi-atspi-text.html#atspi-text-remove-selection" title="atspi_text_remove_selection ()">atspi_text_remove_selection</a>         (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
 129                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> selection_num</code></em>,
 130                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 131 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libatspi-atspi-text.html#atspi-text-set-selection" title="atspi_text_set_selection ()">atspi_text_set_selection</a>            (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
 132                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> selection_num</code></em>,
 133                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> start_offset</code></em>,
 134                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> end_offset</code></em>,
 135                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 136 </pre>
 137 </div>
 138 <div class="refsect1">
 139 <a name="libatspi-atspi-text.object-hierarchy"></a><h2>Object Hierarchy</h2>
 140 <pre class="synopsis">
 141   GBoxed
 142    +----AtspiRange
 143 </pre>
 144 <pre class="synopsis">
 145   GBoxed
 146    +----AtspiTextRange
 147 </pre>
 148 <pre class="synopsis">
 149   GInterface
 150    +----AtspiText
 151 </pre>
 152 </div>
 153 <div class="refsect1">
 154 <a name="libatspi-atspi-text.implementations"></a><h2>Known Implementations</h2>
 155 <p>
 156 AtspiText is implemented by
 157  <a class="link" href="AtspiAccessible.html" title="AtspiAccessible">AtspiAccessible</a>.</p>
 158 </div>
 159 <div class="refsect1">
 160 <a name="libatspi-atspi-text.description"></a><h2>Description</h2>
 161 <p>
 162 The text interface should be implemented by objects which place textual
 163 information onscreen as character strings or glyphs. The text interface
 164 allows access to textual content including display attributes and
 165 semantic hints associated with runs of text, and to bounding boc
 166 information for glyphs and substrings. It also alows portions of text to
 167 be selected, if the objects StateSet includes STATE_SELECTABLE_TEXT.
 168 </p>
 169 </div>
 170 <div class="refsect1">
 171 <a name="libatspi-atspi-text.details"></a><h2>Details</h2>
 172 <div class="refsect2">
 173 <a name="AtspiRange-struct"></a><h3>struct AtspiRange</h3>
 174 <pre class="programlisting">struct AtspiRange {
 175   gint start_offset;
 176   gint end_offset;
 177 };
 178 </pre>
 179 <p>
 180 </p>
 181 </div>
 182 <hr>
 183 <div class="refsect2">
 184 <a name="ATSPI-TYPE-RANGE:CAPS"></a><h3>ATSPI_TYPE_RANGE</h3>
 185 <pre class="programlisting">#define ATSPI_TYPE_RANGE atspi_range_get_type ()
 186 </pre>
 187 <p>
 188 The <a href="../gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> for a boxed type holding a range within a text bock.
 189 </p>
 190 </div>
 191 <hr>
 192 <div class="refsect2">
 193 <a name="atspi-range-copy"></a><h3>atspi_range_copy ()</h3>
 194 <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>
 195 <p>
 196 Gets a copy of an <a class="link" href="libatspi-atspi-text.html#AtspiRange"><span class="type">AtspiRange</span></a> object.
 197 </p>
 198 <div class="variablelist"><table border="0" class="variablelist">
 199 <colgroup>
 200 <col align="left" valign="top">
 201 <col>
 202 </colgroup>
 203 <tbody>
 204 <tr>
 205 <td><p><span class="term"><em class="parameter"><code>src</code></em> :</span></p></td>
 206 <td>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.</td>
 207 </tr>
 208 <tr>
 209 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 210 <td>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.</td>
 211 </tr>
 212 </tbody>
 213 </table></div>
 214 </div>
 215 <hr>
 216 <div class="refsect2">
 217 <a name="AtspiTextRange-struct"></a><h3>struct AtspiTextRange</h3>
 218 <pre class="programlisting">struct AtspiTextRange {
 219   gint start_offset;
 220   gint end_offset;
 221   gchar *content;
 222 };
 223 </pre>
 224 <p>
 225 </p>
 226 </div>
 227 <hr>
 228 <div class="refsect2">
 229 <a name="ATSPI-TYPE-TEXT-RANGE:CAPS"></a><h3>ATSPI_TYPE_TEXT_RANGE</h3>
 230 <pre class="programlisting">#define ATSPI_TYPE_TEXT_RANGE atspi_text_range_get_type ()
 231 </pre>
 232 <p>
 233 The <a href="../gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> for a boxed type holding a range within a text bock.
 234 </p>
 235 </div>
 236 <hr>
 237 <div class="refsect2">
 238 <a name="atspi-text-get-type"></a><h3>atspi_text_get_type ()</h3>
 239 <pre class="programlisting"><a href="../gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>               atspi_text_get_type                 ();</pre>
 240 <p>
 241 </p>
 242 </div>
 243 <hr>
 244 <div class="refsect2">
 245 <a name="AtspiText-struct"></a><h3>AtspiText</h3>
 246 <pre class="programlisting">typedef struct _AtspiText AtspiText;</pre>
 247 <p>
 248 </p>
 249 </div>
 250 <hr>
 251 <div class="refsect2">
 252 <a name="atspi-text-range-get-type"></a><h3>atspi_text_range_get_type ()</h3>
 253 <pre class="programlisting"><a href="../gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>               atspi_text_range_get_type           ();</pre>
 254 <p>
 255 </p>
 256 </div>
 257 <hr>
 258 <div class="refsect2">
 259 <a name="atspi-text-get-character-count"></a><h3>atspi_text_get_character_count ()</h3>
 260 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                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>,
 261                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 262 <p>
 263 Gets the character count of an <span class="type">AccessibleText</span> object.
 264 </p>
 265 <div class="variablelist"><table border="0" class="variablelist">
 266 <colgroup>
 267 <col align="left" valign="top">
 268 <col>
 269 </colgroup>
 270 <tbody>
 271 <tr>
 272 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 273 <td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object to query.</td>
 274 </tr>
 275 <tr>
 276 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 277 <td>a <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> indicating the total number of
 278 characters in the <span class="type">AccessibleText</span> object.</td>
 279 </tr>
 280 </tbody>
 281 </table></div>
 282 </div>
 283 <hr>
 284 <div class="refsect2">
 285 <a name="atspi-text-get-text"></a><h3>atspi_text_get_text ()</h3>
 286 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             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>,
 287                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> start_offset</code></em>,
 288                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> end_offset</code></em>,
 289                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 290 <p>
 291 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
 292          in the returned string may exceed either end_offset or start_offset, since
 293          UTF-8 is a variable-width encoding.
 294 </p>
 295 <div class="variablelist"><table border="0" class="variablelist">
 296 <colgroup>
 297 <col align="left" valign="top">
 298 <col>
 299 </colgroup>
 300 <tbody>
 301 <tr>
 302 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 303 <td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object to query.</td>
 304 </tr>
 305 <tr>
 306 <td><p><span class="term"><em class="parameter"><code>start_offset</code></em> :</span></p></td>
 307 <td>a <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> indicating the start of the desired text range.</td>
 308 </tr>
 309 <tr>
 310 <td><p><span class="term"><em class="parameter"><code>end_offset</code></em> :</span></p></td>
 311 <td>a <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> indicating the first character past the desired range.</td>
 312 </tr>
 313 <tr>
 314 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 315 <td>a text string containing characters from <em class="parameter"><code>start_offset</code></em>
 316 to <em class="parameter"><code>end_offset</code></em>-1, inclusive, encoded as UTF-8.</td>
 317 </tr>
 318 </tbody>
 319 </table></div>
 320 </div>
 321 <hr>
 322 <div class="refsect2">
 323 <a name="atspi-text-get-caret-offset"></a><h3>atspi_text_get_caret_offset ()</h3>
 324 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                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>,
 325                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 326 <p>
 327 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.
 328 </p>
 329 <div class="variablelist"><table border="0" class="variablelist">
 330 <colgroup>
 331 <col align="left" valign="top">
 332 <col>
 333 </colgroup>
 334 <tbody>
 335 <tr>
 336 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 337 <td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object to query.</td>
 338 </tr>
 339 <tr>
 340 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 341 <td>a <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> indicating the current position of the text caret.</td>
 342 </tr>
 343 </tbody>
 344 </table></div>
 345 </div>
 346 <hr>
 347 <div class="refsect2">
 348 <a name="atspi-text-get-attributes"></a><h3>atspi_text_get_attributes ()</h3>
 349 <pre class="programlisting"><a href="../glib/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> *        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>,
 350                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> offset</code></em>,
 351                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *start_offset</code></em>,
 352                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *end_offset</code></em>,
 353                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 354 <p>
 355 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>
 356 object. The text attributes correspond to CSS attributes
 357 where possible.
 358 <span style="color: red">&lt;em&gt;DEPRECATED&lt;/em&gt;</span>
 359 </p>
 360 <div class="variablelist"><table border="0" class="variablelist">
 361 <colgroup>
 362 <col align="left" valign="top">
 363 <col>
 364 </colgroup>
 365 <tbody>
 366 <tr>
 367 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 368 <td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object to query.</td>
 369 </tr>
 370 <tr>
 371 <td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
 372 <td>a <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> indicating the offset from which the attribute
 373 search is based.</td>
 374 </tr>
 375 <tr>
 376 <td><p><span class="term"><em class="parameter"><code>start_offset</code></em> :</span></p></td>
 377 <td>a <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> pointer indicating the start of the desired text
 378 range. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 379 </td>
 380 </tr>
 381 <tr>
 382 <td><p><span class="term"><em class="parameter"><code>end_offset</code></em> :</span></p></td>
 383 <td>a <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> pointer indicating the first character past the desired
 384 range. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 385 </td>
 386 </tr>
 387 <tr>
 388 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 389 <td>a <a href="../glib/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a>
 390 describing the attributes at the given character offset. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gchar* gchar*][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 391 </td>
 392 </tr>
 393 </tbody>
 394 </table></div>
 395 </div>
 396 <hr>
 397 <div class="refsect2">
 398 <a name="atspi-text-get-attribute-run"></a><h3>atspi_text_get_attribute_run ()</h3>
 399 <pre class="programlisting"><a href="../glib/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> *        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>,
 400                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> offset</code></em>,
 401                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> include_defaults</code></em>,
 402                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *start_offset</code></em>,
 403                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *end_offset</code></em>,
 404                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 405 <p>
 406 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
 407 including its 'default' attributes.
 408 </p>
 409 <div class="variablelist"><table border="0" class="variablelist">
 410 <colgroup>
 411 <col align="left" valign="top">
 412 <col>
 413 </colgroup>
 414 <tbody>
 415 <tr>
 416 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 417 <td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object to query.</td>
 418 </tr>
 419 <tr>
 420 <td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
 421 <td>a <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> indicating the offset from which the attribute
 422 search is based.</td>
 423 </tr>
 424 <tr>
 425 <td><p><span class="term"><em class="parameter"><code>include_defaults</code></em> :</span></p></td>
 426 <td>a <span class="type">bool</span> that, when set as <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a>, indicates the call
 427 should only return those attributes which are explicitly set on the current
 428 attribute run, omitting any attributes which are inherited from the
 429 default values.</td>
 430 </tr>
 431 <tr>
 432 <td><p><span class="term"><em class="parameter"><code>start_offset</code></em> :</span></p></td>
 433 <td>a <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> pointer indicating the start of the desired text
 434 range. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 435 </td>
 436 </tr>
 437 <tr>
 438 <td><p><span class="term"><em class="parameter"><code>end_offset</code></em> :</span></p></td>
 439 <td>a <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> pointer indicating the first character past the desired
 440 range. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 441 </td>
 442 </tr>
 443 <tr>
 444 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 445 <td>a <a href="../glib/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> with attributes
 446 defined at the indicated offset, optionally including the 'default' ones. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gchar* gchar*][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 447 </td>
 448 </tr>
 449 </tbody>
 450 </table></div>
 451 </div>
 452 <hr>
 453 <div class="refsect2">
 454 <a name="atspi-text-get-attribute-value"></a><h3>atspi_text_get_attribute_value ()</h3>
 455 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             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>,
 456                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> offset</code></em>,
 457                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *attribute_name</code></em>,
 458                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 459 <p>
 460 Gets the value of a named attribute at a given offset.
 461 </p>
 462 <div class="variablelist"><table border="0" class="variablelist">
 463 <colgroup>
 464 <col align="left" valign="top">
 465 <col>
 466 </colgroup>
 467 <tbody>
 468 <tr>
 469 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 470 <td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object to query.</td>
 471 </tr>
 472 <tr>
 473 <td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
 474 <td>The character offset at which to query the attribute.</td>
 475 </tr>
 476 <tr>
 477 <td><p><span class="term"><em class="parameter"><code>attribute_name</code></em> :</span></p></td>
 478 <td>The attribute to query.</td>
 479 </tr>
 480 <tr>
 481 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 482 <td>the value of a given attribute at the given offset, or NULL if
 483 not present.</td>
 484 </tr>
 485 </tbody>
 486 </table></div>
 487 </div>
 488 <hr>
 489 <div class="refsect2">
 490 <a name="atspi-text-get-default-attributes"></a><h3>atspi_text_get_default_attributes ()</h3>
 491 <pre class="programlisting"><a href="../glib/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> *        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>,
 492                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 493 <p>
 494 Gets the default attributes applied to an <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a>
 495 object. The text attributes correspond to CSS attributes
 496 where possible. The combination of this attribute set and
 497 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>
 498 describes the entire set of text attributes over a range.
 499 </p>
 500 <div class="variablelist"><table border="0" class="variablelist">
 501 <colgroup>
 502 <col align="left" valign="top">
 503 <col>
 504 </colgroup>
 505 <tbody>
 506 <tr>
 507 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 508 <td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object to query.</td>
 509 </tr>
 510 <tr>
 511 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 512 <td>a <a href="../glib/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a>
 513 containing the default attributes applied to a text object,
 514 (exclusive of explicitly-set attributes), encoded as UTF-8. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gchar* gchar*][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 515 </td>
 516 </tr>
 517 </tbody>
 518 </table></div>
 519 </div>
 520 <hr>
 521 <div class="refsect2">
 522 <a name="atspi-text-set-caret-offset"></a><h3>atspi_text_set_caret_offset ()</h3>
 523 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            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>,
 524                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> new_offset</code></em>,
 525                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 526 <p>
 527 Moves the text caret to a given position.
 528 </p>
 529 <div class="variablelist"><table border="0" class="variablelist">
 530 <colgroup>
 531 <col align="left" valign="top">
 532 <col>
 533 </colgroup>
 534 <tbody>
 535 <tr>
 536 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 537 <td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</td>
 538 </tr>
 539 <tr>
 540 <td><p><span class="term"><em class="parameter"><code>new_offset</code></em> :</span></p></td>
 541 <td>the offset to which the text caret is to be moved.</td>
 542 </tr>
 543 <tr>
 544 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 545 <td>
 546 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if successful, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a> otherwise.</td>
 547 </tr>
 548 </tbody>
 549 </table></div>
 550 </div>
 551 <hr>
 552 <div class="refsect2">
 553 <a name="atspi-text-get-text-before-offset"></a><h3>atspi_text_get_text_before_offset ()</h3>
 554 <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>,
 555                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> offset</code></em>,
 556                                                          <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>,
 557                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 558 <p>
 559 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
 560          text offset.
 561 </p>
 562 <div class="variablelist"><table border="0" class="variablelist">
 563 <colgroup>
 564 <col align="left" valign="top">
 565 <col>
 566 </colgroup>
 567 <tbody>
 568 <tr>
 569 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 570 <td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</td>
 571 </tr>
 572 <tr>
 573 <td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
 574 <td>a <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> indicating the offset from which the delimiter
 575 search is based.</td>
 576 </tr>
 577 <tr>
 578 <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
 579 <td>an <a class="link" href="libatspi-atspi-constants.html#AtspiTextBoundaryType" title="enum AtspiTextBoundaryType"><span class="type">AtspiTextBoundaryType</span></a> indicating whether the desired
 580 text string is a word, sentence, line, or attribute run.</td>
 581 </tr>
 582 <tr>
 583 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 584 <td>an <a class="link" href="libatspi-atspi-text.html#AtspiTextRange"><span class="type">AtspiTextRange</span></a> containing a UTF-8 string representing the
 585 delimited text, both of whose delimiting boundaries are before the
 586 current offset, or an empty string if no such text exists.</td>
 587 </tr>
 588 </tbody>
 589 </table></div>
 590 </div>
 591 <hr>
 592 <div class="refsect2">
 593 <a name="atspi-text-get-text-at-offset"></a><h3>atspi_text_get_text_at_offset ()</h3>
 594 <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>,
 595                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> offset</code></em>,
 596                                                          <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>,
 597                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 598 <p>
 599 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
 600          text offset.
 601 </p>
 602 <div class="variablelist"><table border="0" class="variablelist">
 603 <colgroup>
 604 <col align="left" valign="top">
 605 <col>
 606 </colgroup>
 607 <tbody>
 608 <tr>
 609 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 610 <td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</td>
 611 </tr>
 612 <tr>
 613 <td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
 614 <td>a <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> indicating the offset from which the delimiter
 615 search is based.</td>
 616 </tr>
 617 <tr>
 618 <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
 619 <td>an <a class="link" href="libatspi-atspi-constants.html#AtspiTextBoundaryType" title="enum AtspiTextBoundaryType"><span class="type">AtspiTextBoundaryType</span></a> indicating whether the desired
 620 text string is a word, sentence, line, or attribute run.</td>
 621 </tr>
 622 <tr>
 623 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 624 <td>an <a class="link" href="libatspi-atspi-text.html#AtspiTextRange"><span class="type">AtspiTextRange</span></a> containing a UTF-8 string representing the
 625 delimited text, whose delimiting boundaries bracket the
 626 current offset, or an empty string if no such text exists.</td>
 627 </tr>
 628 </tbody>
 629 </table></div>
 630 </div>
 631 <hr>
 632 <div class="refsect2">
 633 <a name="atspi-text-get-text-after-offset"></a><h3>atspi_text_get_text_after_offset ()</h3>
 634 <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>,
 635                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> offset</code></em>,
 636                                                          <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>,
 637                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 638 <p>
 639 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
 640          text offset.
 641 </p>
 642 <div class="variablelist"><table border="0" class="variablelist">
 643 <colgroup>
 644 <col align="left" valign="top">
 645 <col>
 646 </colgroup>
 647 <tbody>
 648 <tr>
 649 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 650 <td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</td>
 651 </tr>
 652 <tr>
 653 <td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
 654 <td>a <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> indicating the offset from which the delimiter
 655 search is based.</td>
 656 </tr>
 657 <tr>
 658 <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
 659 <td>an <a class="link" href="libatspi-atspi-constants.html#AtspiTextBoundaryType" title="enum AtspiTextBoundaryType"><span class="type">AtspiTextBoundaryType</span></a> indicating whether the desired
 660 text string is a word, sentence, line, or attribute run.</td>
 661 </tr>
 662 <tr>
 663 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 664 <td>an <a class="link" href="libatspi-atspi-text.html#AtspiTextRange"><span class="type">AtspiTextRange</span></a> containing a UTF-8 string representing the
 665 delimited text, both of whose delimiting boundaries are after or
 666 inclusive of the current offset, or an empty string if no such
 667 text exists.</td>
 668 </tr>
 669 </tbody>
 670 </table></div>
 671 </div>
 672 <hr>
 673 <div class="refsect2">
 674 <a name="atspi-text-get-character-at-offset"></a><h3>atspi_text_get_character_at_offset ()</h3>
 675 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               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>,
 676                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> offset</code></em>,
 677                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 678 <p>
 679 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.
 680 </p>
 681 <div class="variablelist"><table border="0" class="variablelist">
 682 <colgroup>
 683 <col align="left" valign="top">
 684 <col>
 685 </colgroup>
 686 <tbody>
 687 <tr>
 688 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 689 <td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</td>
 690 </tr>
 691 <tr>
 692 <td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
 693 <td>a <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> indicating the text offset where the desired
 694 character is located.</td>
 695 </tr>
 696 <tr>
 697 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 698 <td>a <a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a>  representing the
 699 UCS-4 unicode code point of the given character, or
 700 0xFFFFFFFF if the character in question cannot be represented
 701 in the UCS-4 encoding.</td>
 702 </tr>
 703 </tbody>
 704 </table></div>
 705 </div>
 706 <hr>
 707 <div class="refsect2">
 708 <a name="atspi-text-get-character-extents"></a><h3>atspi_text_get_character_extents ()</h3>
 709 <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>,
 710                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> offset</code></em>,
 711                                                          <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>,
 712                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 713 <p>
 714 Gets a bounding box containing the glyph representing
 715        the character at a particular text offset.
 716 </p>
 717 <div class="variablelist"><table border="0" class="variablelist">
 718 <colgroup>
 719 <col align="left" valign="top">
 720 <col>
 721 </colgroup>
 722 <tbody>
 723 <tr>
 724 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 725 <td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</td>
 726 </tr>
 727 <tr>
 728 <td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
 729 <td>a <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> indicating the offset of the text character for
 730 whom boundary information is requested.</td>
 731 </tr>
 732 <tr>
 733 <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
 734 <td>an <span class="type">AccessibleCoordType</span> indicating the coordinate system to use
 735 for the returned values.</td>
 736 </tr>
 737 <tr>
 738 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 739 <td>An <a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="type">AtspiRect</span></a> specifying the position and size of the character.</td>
 740 </tr>
 741 </tbody>
 742 </table></div>
 743 </div>
 744 <hr>
 745 <div class="refsect2">
 746 <a name="atspi-text-get-offset-at-point"></a><h3>atspi_text_get_offset_at_point ()</h3>
 747 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                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>,
 748                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> x</code></em>,
 749                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> y</code></em>,
 750                                                          <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>,
 751                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 752 <p>
 753 Gets the character offset into the text at a given point.
 754 </p>
 755 <div class="variablelist"><table border="0" class="variablelist">
 756 <colgroup>
 757 <col align="left" valign="top">
 758 <col>
 759 </colgroup>
 760 <tbody>
 761 <tr>
 762 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 763 <td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</td>
 764 </tr>
 765 <tr>
 766 <td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
 767 <td>the x coordinate of the point to be queried.</td>
 768 </tr>
 769 <tr>
 770 <td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
 771 <td>the y coordinate of the point to be queried.</td>
 772 </tr>
 773 <tr>
 774 <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
 775 <td>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
 776 the values should be returned.</td>
 777 </tr>
 778 <tr>
 779 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 780 <td>the offset (as a <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>) at the point (<em class="parameter"><code>x</code></em>, <em class="parameter"><code>y</code></em>)
 781 in the specified coordinate system.</td>
 782 </tr>
 783 </tbody>
 784 </table></div>
 785 </div>
 786 <hr>
 787 <div class="refsect2">
 788 <a name="atspi-text-get-range-extents"></a><h3>atspi_text_get_range_extents ()</h3>
 789 <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>,
 790                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> start_offset</code></em>,
 791                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> end_offset</code></em>,
 792                                                          <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>,
 793                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 794 <p>
 795 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.
 796 </p>
 797 <div class="variablelist"><table border="0" class="variablelist">
 798 <colgroup>
 799 <col align="left" valign="top">
 800 <col>
 801 </colgroup>
 802 <tbody>
 803 <tr>
 804 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 805 <td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</td>
 806 </tr>
 807 <tr>
 808 <td><p><span class="term"><em class="parameter"><code>start_offset</code></em> :</span></p></td>
 809 <td>a <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> indicating the offset of the first text character for
 810 whom boundary information is requested.</td>
 811 </tr>
 812 <tr>
 813 <td><p><span class="term"><em class="parameter"><code>end_offset</code></em> :</span></p></td>
 814 <td>a <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> indicating the offset of the text character
 815 after the last character for whom boundary information is requested.</td>
 816 </tr>
 817 <tr>
 818 <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
 819 <td>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
 820 for the returned values.</td>
 821 </tr>
 822 <tr>
 823 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 824 <td>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
 825 of text.</td>
 826 </tr>
 827 </tbody>
 828 </table></div>
 829 </div>
 830 <hr>
 831 <div class="refsect2">
 832 <a name="atspi-text-get-bounded-ranges"></a><h3>atspi_text_get_bounded_ranges ()</h3>
 833 <pre class="programlisting"><a href="../glib/glib-Arrays.html#GArray"><span class="returnvalue">GArray</span></a> *            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>,
 834                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> x</code></em>,
 835                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> y</code></em>,
 836                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> width</code></em>,
 837                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> height</code></em>,
 838                                                          <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>,
 839                                                          <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>,
 840                                                          <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>,
 841                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 842 <p>
 843 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
 844          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>).
 845 </p>
 846 <div class="variablelist"><table border="0" class="variablelist">
 847 <colgroup>
 848 <col align="left" valign="top">
 849 <col>
 850 </colgroup>
 851 <tbody>
 852 <tr>
 853 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 854 <td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</td>
 855 </tr>
 856 <tr>
 857 <td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
 858 <td>the 'starting' x coordinate of the bounding box.</td>
 859 </tr>
 860 <tr>
 861 <td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
 862 <td>the 'starting' y coordinate of the bounding box.</td>
 863 </tr>
 864 <tr>
 865 <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
 866 <td>the x extent of the bounding box.</td>
 867 </tr>
 868 <tr>
 869 <td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
 870 <td>the y extent of the bounding box.</td>
 871 </tr>
 872 <tr>
 873 <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
 874 <td>an <span class="type">AccessibleCoordType</span> indicating the coordinate system to use
 875 for the returned values.</td>
 876 </tr>
 877 <tr>
 878 <td><p><span class="term"><em class="parameter"><code>clipTypeX</code></em> :</span></p></td>
 879 <td>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
 880 intersect the bounding box's x extents.</td>
 881 </tr>
 882 <tr>
 883 <td><p><span class="term"><em class="parameter"><code>clipTypeY</code></em> :</span></p></td>
 884 <td>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
 885 intersect the bounding box's y extents.</td>
 886 </tr>
 887 <tr>
 888 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 889 <td>a null-terminated list of
 890 pointers to <a class="link" href="libatspi-atspi-text.html#AtspiTextRange"><span class="type">AtspiTextRange</span></a> structs detailing the bounded text. <span class="annotation">[<acronym title="Free data after the code is done."><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>
 891 </td>
 892 </tr>
 893 </tbody>
 894 </table></div>
 895 </div>
 896 <hr>
 897 <div class="refsect2">
 898 <a name="atspi-text-get-n-selections"></a><h3>atspi_text_get_n_selections ()</h3>
 899 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                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>,
 900                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 901 <p>
 902 Gets the number of active non-contiguous selections for an
 903          <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object.
 904 </p>
 905 <div class="variablelist"><table border="0" class="variablelist">
 906 <colgroup>
 907 <col align="left" valign="top">
 908 <col>
 909 </colgroup>
 910 <tbody>
 911 <tr>
 912 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 913 <td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</td>
 914 </tr>
 915 <tr>
 916 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 917 <td>a <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> indicating the current
 918 number of non-contiguous text selections active
 919 within an <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object.</td>
 920 </tr>
 921 </tbody>
 922 </table></div>
 923 </div>
 924 <hr>
 925 <div class="refsect2">
 926 <a name="atspi-text-get-selection"></a><h3>atspi_text_get_selection ()</h3>
 927 <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>,
 928                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> selection_num</code></em>,
 929                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 930 <p>
 931 Gets the bounds of the <em class="parameter"><code>selection_num</code></em>-th active text selection for an
 932         <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object.
 933 </p>
 934 <div class="variablelist"><table border="0" class="variablelist">
 935 <colgroup>
 936 <col align="left" valign="top">
 937 <col>
 938 </colgroup>
 939 <tbody>
 940 <tr>
 941 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 942 <td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</td>
 943 </tr>
 944 <tr>
 945 <td><p><span class="term"><em class="parameter"><code>selection_num</code></em> :</span></p></td>
 946 <td>a <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> indicating which selection to query.</td>
 947 </tr>
 948 </tbody>
 949 </table></div>
 950 </div>
 951 <hr>
 952 <div class="refsect2">
 953 <a name="atspi-text-add-selection"></a><h3>atspi_text_add_selection ()</h3>
 954 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            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>,
 955                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> start_offset</code></em>,
 956                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> end_offset</code></em>,
 957                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 958 <p>
 959 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.
 960 </p>
 961 <div class="variablelist"><table border="0" class="variablelist">
 962 <colgroup>
 963 <col align="left" valign="top">
 964 <col>
 965 </colgroup>
 966 <tbody>
 967 <tr>
 968 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 969 <td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</td>
 970 </tr>
 971 <tr>
 972 <td><p><span class="term"><em class="parameter"><code>start_offset</code></em> :</span></p></td>
 973 <td>the starting offset of the desired new selection.</td>
 974 </tr>
 975 <tr>
 976 <td><p><span class="term"><em class="parameter"><code>end_offset</code></em> :</span></p></td>
 977 <td>the offset of the first character after the new selection.</td>
 978 </tr>
 979 <tr>
 980 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 981 <td>
 982 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if successful, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a> otherwise.</td>
 983 </tr>
 984 </tbody>
 985 </table></div>
 986 </div>
 987 <hr>
 988 <div class="refsect2">
 989 <a name="atspi-text-remove-selection"></a><h3>atspi_text_remove_selection ()</h3>
 990 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            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>,
 991                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> selection_num</code></em>,
 992                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 993 <p>
 994 De-selects a text selection.
 995 </p>
 996 <div class="variablelist"><table border="0" class="variablelist">
 997 <colgroup>
 998 <col align="left" valign="top">
 999 <col>
1000 </colgroup>
1001 <tbody>
1002 <tr>
1003 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
1004 <td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</td>
1005 </tr>
1006 <tr>
1007 <td><p><span class="term"><em class="parameter"><code>selection_num</code></em> :</span></p></td>
1008 <td>a <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> indicating which text selection to remove.</td>
1009 </tr>
1010 <tr>
1011 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1012 <td>
1013 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if successful, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a> otherwise.</td>
1014 </tr>
1015 </tbody>
1016 </table></div>
1017 </div>
1018 <hr>
1019 <div class="refsect2">
1020 <a name="atspi-text-set-selection"></a><h3>atspi_text_set_selection ()</h3>
1021 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            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>,
1022                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> selection_num</code></em>,
1023                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> start_offset</code></em>,
1024                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> end_offset</code></em>,
1025                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
1026 <p>
1027 Changes the bounds of an existing <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> text selection.
1028 </p>
1029 <div class="variablelist"><table border="0" class="variablelist">
1030 <colgroup>
1031 <col align="left" valign="top">
1032 <col>
1033 </colgroup>
1034 <tbody>
1035 <tr>
1036 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
1037 <td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</td>
1038 </tr>
1039 <tr>
1040 <td><p><span class="term"><em class="parameter"><code>selection_num</code></em> :</span></p></td>
1041 <td>a zero-offset index indicating which text selection to modify.</td>
1042 </tr>
1043 <tr>
1044 <td><p><span class="term"><em class="parameter"><code>start_offset</code></em> :</span></p></td>
1045 <td>a <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> indicating the new starting offset for the selection.</td>
1046 </tr>
1047 <tr>
1048 <td><p><span class="term"><em class="parameter"><code>end_offset</code></em> :</span></p></td>
1049 <td>a <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> indicating the desired new offset of the first character
1050 after the selection.</td>
1051 </tr>
1052 <tr>
1053 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1054 <td>
1055 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if successful, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a> otherwise.</td>
1056 </tr>
1057 </tbody>
1058 </table></div>
1059 </div>
1060 </div>
1061 </div>
1062 <div class="footer">
1063 <hr>
1064           Generated by GTK-Doc V1.18.1</div>
1065 </body>
1066 </html>