← Back to branch summary

~ubuntu-branches/ubuntu/raring/gtk+2.0/raring-proposed

« back to all changes in this revision

Viewing changes to docs/reference/libgail-util/html/gail-libgail-util-GailTextUtil.html

  • Committer: Package Import Robot
  • Author(s): Robert Ancell
  • Date: 2013-01-10 12:53:20 UTC
  • mfrom: (1.14.16)
  • Revision ID: package-import@ubuntu.com-20130110125320-x13bjpwtqq36izs2
Tags: 2.24.14-0ubuntu1
New upstream release

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/libgail-util/html/gail-libgail-util-GailTextUtil.html
8
8
<link rel="up" href="libgail-util-main.html" title="GAIL libgail-util Library">
9
9
<link rel="prev" href="libgail-util-main.html" title="GAIL libgail-util Library">
10
10
<link rel="next" href="gail-libgail-util-GailMisc.html" title="GailMisc">
11
 
<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
32
32
<td valign="top">
33
33
<h2><span class="refentrytitle"><a name="gail-libgail-util-GailTextUtil.top_of_page"></a>GailTextUtil</span></h2>
34
34
<p>GailTextUtil — GailTextUtil is a utility class which can be used to
35
 
  implement some of the <span class="type">AtkText</span> functions for accessible objects
36
 
  which implement <span class="type">AtkText</span>.</p>
 
35
  implement some of the <a href="/usr/share/gtk-doc/html/atk/AtkText.html"><span class="type">AtkText</span></a> functions for accessible objects
 
36
  which implement <a href="/usr/share/gtk-doc/html/atk/AtkText.html"><span class="type">AtkText</span></a>.</p>
37
37
</td>
38
38
<td valign="top" align="right"></td>
39
39
</tr></table></div>
43
43
enum                <a class="link" href="gail-libgail-util-GailTextUtil.html#GailOffsetType" title="enum GailOffsetType">GailOffsetType</a>;
44
44
<a class="link" href="gail-libgail-util-GailTextUtil.html#GailTextUtil" title="struct GailTextUtil"><span class="returnvalue">GailTextUtil</span></a> *      <a class="link" href="gail-libgail-util-GailTextUtil.html#gail-text-util-new" title="gail_text_util_new ()">gail_text_util_new</a>                  (<em class="parameter"><code><span class="type">void</span></code></em>);
45
45
<span class="returnvalue">void</span>                <a class="link" href="gail-libgail-util-GailTextUtil.html#gail-text-util-text-setup" title="gail_text_util_text_setup ()">gail_text_util_text_setup</a>           (<em class="parameter"><code><a class="link" href="gail-libgail-util-GailTextUtil.html#GailTextUtil" title="struct GailTextUtil"><span class="type">GailTextUtil</span></a> *textutil</code></em>,
46
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>);
 
46
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);
47
47
<span class="returnvalue">void</span>                <a class="link" href="gail-libgail-util-GailTextUtil.html#gail-text-util-buffer-setup" title="gail_text_util_buffer_setup ()">gail_text_util_buffer_setup</a>         (<em class="parameter"><code><a class="link" href="gail-libgail-util-GailTextUtil.html#GailTextUtil" title="struct GailTextUtil"><span class="type">GailTextUtil</span></a> *textutil</code></em>,
48
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkTextBuffer.html"><span class="type">GtkTextBuffer</span></a> *buffer</code></em>);
49
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="gail-libgail-util-GailTextUtil.html#gail-text-util-get-text" title="gail_text_util_get_text ()">gail_text_util_get_text</a>             (<em class="parameter"><code><a class="link" href="gail-libgail-util-GailTextUtil.html#GailTextUtil" title="struct GailTextUtil"><span class="type">GailTextUtil</span></a> *textutil</code></em>,
50
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> layout</code></em>,
 
48
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkTextBuffer.html"><span class="type">GtkTextBuffer</span></a> *buffer</code></em>);
 
49
<span class="returnvalue">gchar</span> *             <a class="link" href="gail-libgail-util-GailTextUtil.html#gail-text-util-get-text" title="gail_text_util_get_text ()">gail_text_util_get_text</a>             (<em class="parameter"><code><a class="link" href="gail-libgail-util-GailTextUtil.html#GailTextUtil" title="struct GailTextUtil"><span class="type">GailTextUtil</span></a> *textutil</code></em>,
 
50
                                                         <em class="parameter"><code><span class="type">gpointer</span> layout</code></em>,
51
51
                                                         <em class="parameter"><code><a class="link" href="gail-libgail-util-GailTextUtil.html#GailOffsetType" title="enum GailOffsetType"><span class="type">GailOffsetType</span></a> function</code></em>,
52
 
                                                         <em class="parameter"><code><span class="type">AtkTextBoundary</span> boundary_type</code></em>,
53
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> offset</code></em>,
54
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *start_offset</code></em>,
55
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *end_offset</code></em>);
56
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="gail-libgail-util-GailTextUtil.html#gail-text-util-get-substring" title="gail_text_util_get_substring ()">gail_text_util_get_substring</a>        (<em class="parameter"><code><a class="link" href="gail-libgail-util-GailTextUtil.html#GailTextUtil" title="struct GailTextUtil"><span class="type">GailTextUtil</span></a> *textutil</code></em>,
57
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> start_pos</code></em>,
58
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> end_pos</code></em>);
 
52
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/atk/AtkText.html#AtkTextBoundary"><span class="type">AtkTextBoundary</span></a> boundary_type</code></em>,
 
53
                                                         <em class="parameter"><code><span class="type">gint</span> offset</code></em>,
 
54
                                                         <em class="parameter"><code><span class="type">gint</span> *start_offset</code></em>,
 
55
                                                         <em class="parameter"><code><span class="type">gint</span> *end_offset</code></em>);
 
56
<span class="returnvalue">gchar</span> *             <a class="link" href="gail-libgail-util-GailTextUtil.html#gail-text-util-get-substring" title="gail_text_util_get_substring ()">gail_text_util_get_substring</a>        (<em class="parameter"><code><a class="link" href="gail-libgail-util-GailTextUtil.html#GailTextUtil" title="struct GailTextUtil"><span class="type">GailTextUtil</span></a> *textutil</code></em>,
 
57
                                                         <em class="parameter"><code><span class="type">gint</span> start_pos</code></em>,
 
58
                                                         <em class="parameter"><code><span class="type">gint</span> end_pos</code></em>);
59
59
</pre>
60
60
</div>
61
61
<div class="refsect1">
62
62
<a name="gail-libgail-util-GailTextUtil.description"></a><h2>Description</h2>
63
63
<p>
64
64
GailTextUtil is a utility class which can be used to implement the
65
 
<span class="type">AtkText</span> functions which get text for accessible objects which implement
66
 
<span class="type">AtkText</span>.
 
65
<a href="/usr/share/gtk-doc/html/atk/AtkText.html"><span class="type">AtkText</span></a> functions which get text for accessible objects which implement
 
66
<a href="/usr/share/gtk-doc/html/atk/AtkText.html"><span class="type">AtkText</span></a>.
67
67
</p>
68
68
<p>
69
 
In GAIL it is used by the accsesible objects for <span class="type">GnomeCanvasText</span>, <a href="http://library.gnome.org/devel/gtk3/GtkEntry.html"><span class="type">GtkEntry</span></a>,
70
 
<a href="http://library.gnome.org/devel/gtk3/GtkLabel.html"><span class="type">GtkLabel</span></a>, <a href="http://library.gnome.org/devel/gtk3/GtkCellRendererText.html"><span class="type">GtkCellRendererText</span></a> and <a href="http://library.gnome.org/devel/gtk3/GtkTextView.html"><span class="type">GtkTextView</span></a>.
 
69
In GAIL it is used by the accsesible objects for <span class="type">GnomeCanvasText</span>, <a href="http://developer.gnome.org/gtk2/GtkEntry.html"><span class="type">GtkEntry</span></a>,
 
70
<a href="http://developer.gnome.org/gtk2/GtkLabel.html"><span class="type">GtkLabel</span></a>, <a href="http://developer.gnome.org/gtk2/GtkCellRendererText.html"><span class="type">GtkCellRendererText</span></a> and <a href="http://developer.gnome.org/gtk2/GtkTextView.html"><span class="type">GtkTextView</span></a>.
71
71
</p>
72
72
</div>
73
73
<div class="refsect1">
93
93
} GailOffsetType;
94
94
</pre>
95
95
<p>
96
 
Specifies which of the functions <code class="function">atk_text_get_text_before_offset()</code>,
97
 
<code class="function">atk_text_get_text_at_offset()</code>, <code class="function">atk_text_get_text_after_offset()</code> the
 
96
Specifies which of the functions <a href="/usr/share/gtk-doc/html/atk/AtkText.html#atk-text-get-text-before-offset"><code class="function">atk_text_get_text_before_offset()</code></a>,
 
97
<a href="/usr/share/gtk-doc/html/atk/AtkText.html#atk-text-get-text-at-offset"><code class="function">atk_text_get_text_at_offset()</code></a>, <a href="/usr/share/gtk-doc/html/atk/AtkText.html#atk-text-get-text-after-offset"><code class="function">atk_text_get_text_after_offset()</code></a> the
98
98
function <a class="link" href="gail-libgail-util-GailTextUtil.html#gail-text-util-get-text" title="gail_text_util_get_text ()"><code class="function">gail_text_util_get_text()</code></a> is being called for.
99
99
</p>
100
100
<div class="variablelist"><table border="0" class="variablelist">
143
143
<div class="refsect2">
144
144
<a name="gail-text-util-text-setup"></a><h3>gail_text_util_text_setup ()</h3>
145
145
<pre class="programlisting"><span class="returnvalue">void</span>                gail_text_util_text_setup           (<em class="parameter"><code><a class="link" href="gail-libgail-util-GailTextUtil.html#GailTextUtil" title="struct GailTextUtil"><span class="type">GailTextUtil</span></a> *textutil</code></em>,
146
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>);</pre>
 
146
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);</pre>
147
147
<p>
148
148
This function initializes the GailTextUtil with the specified character string,
149
149
</p>
168
168
<div class="refsect2">
169
169
<a name="gail-text-util-buffer-setup"></a><h3>gail_text_util_buffer_setup ()</h3>
170
170
<pre class="programlisting"><span class="returnvalue">void</span>                gail_text_util_buffer_setup         (<em class="parameter"><code><a class="link" href="gail-libgail-util-GailTextUtil.html#GailTextUtil" title="struct GailTextUtil"><span class="type">GailTextUtil</span></a> *textutil</code></em>,
171
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkTextBuffer.html"><span class="type">GtkTextBuffer</span></a> *buffer</code></em>);</pre>
 
171
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkTextBuffer.html"><span class="type">GtkTextBuffer</span></a> *buffer</code></em>);</pre>
172
172
<p>
173
173
This function initializes the GailTextUtil with the specified GtkTextBuffer
174
174
</p>
184
184
</tr>
185
185
<tr>
186
186
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
187
 
<td>The <a href="http://library.gnome.org/devel/gtk3/GtkTextBuffer.html"><span class="type">GtkTextBuffer</span></a> which identifies the text to be stored in the GailUtil.</td>
 
187
<td>The <a href="http://developer.gnome.org/gtk2/GtkTextBuffer.html"><span class="type">GtkTextBuffer</span></a> which identifies the text to be stored in the GailUtil.</td>
188
188
</tr>
189
189
</tbody>
190
190
</table></div>
192
192
<hr>
193
193
<div class="refsect2">
194
194
<a name="gail-text-util-get-text"></a><h3>gail_text_util_get_text ()</h3>
195
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             gail_text_util_get_text             (<em class="parameter"><code><a class="link" href="gail-libgail-util-GailTextUtil.html#GailTextUtil" title="struct GailTextUtil"><span class="type">GailTextUtil</span></a> *textutil</code></em>,
196
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> layout</code></em>,
 
195
<pre class="programlisting"><span class="returnvalue">gchar</span> *             gail_text_util_get_text             (<em class="parameter"><code><a class="link" href="gail-libgail-util-GailTextUtil.html#GailTextUtil" title="struct GailTextUtil"><span class="type">GailTextUtil</span></a> *textutil</code></em>,
 
196
                                                         <em class="parameter"><code><span class="type">gpointer</span> layout</code></em>,
197
197
                                                         <em class="parameter"><code><a class="link" href="gail-libgail-util-GailTextUtil.html#GailOffsetType" title="enum GailOffsetType"><span class="type">GailOffsetType</span></a> function</code></em>,
198
 
                                                         <em class="parameter"><code><span class="type">AtkTextBoundary</span> boundary_type</code></em>,
199
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> offset</code></em>,
200
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *start_offset</code></em>,
201
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *end_offset</code></em>);</pre>
 
198
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/atk/AtkText.html#AtkTextBoundary"><span class="type">AtkTextBoundary</span></a> boundary_type</code></em>,
 
199
                                                         <em class="parameter"><code><span class="type">gint</span> offset</code></em>,
 
200
                                                         <em class="parameter"><code><span class="type">gint</span> *start_offset</code></em>,
 
201
                                                         <em class="parameter"><code><span class="type">gint</span> *end_offset</code></em>);</pre>
202
202
<p>
203
203
This function gets the requested substring from the text in the GtkTextUtil.
204
204
The layout is used only for getting the text on a line. The value is NULL 
251
251
<hr>
252
252
<div class="refsect2">
253
253
<a name="gail-text-util-get-substring"></a><h3>gail_text_util_get_substring ()</h3>
254
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             gail_text_util_get_substring        (<em class="parameter"><code><a class="link" href="gail-libgail-util-GailTextUtil.html#GailTextUtil" title="struct GailTextUtil"><span class="type">GailTextUtil</span></a> *textutil</code></em>,
255
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> start_pos</code></em>,
256
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> end_pos</code></em>);</pre>
 
254
<pre class="programlisting"><span class="returnvalue">gchar</span> *             gail_text_util_get_substring        (<em class="parameter"><code><a class="link" href="gail-libgail-util-GailTextUtil.html#GailTextUtil" title="struct GailTextUtil"><span class="type">GailTextUtil</span></a> *textutil</code></em>,
 
255
                                                         <em class="parameter"><code><span class="type">gint</span> start_pos</code></em>,
 
256
                                                         <em class="parameter"><code><span class="type">gint</span> end_pos</code></em>);</pre>
257
257
<p>
258
258
Gets the substring indicated by <em class="parameter"><code>start_pos</code></em> and <em class="parameter"><code>end_pos</code></em>
259
259
</p>
288
288
</div>
289
289
<div class="footer">
290
290
<hr>
291
 
          Generated by GTK-Doc V1.18.1</div>
 
291
          Generated by GTK-Doc V1.18</div>
292
292
</body>
293
293
</html>
 
 
b'\\ No newline at end of file'