libgail-doc 2.24.32-1ubuntu1 / usr / share / gtk-doc / html / gail-libgail-util / gail-libgail-util-GailTextUtil.html

This file is indexed.

/usr/share/gtk-doc/html/gail-libgail-util/gail-libgail-util-GailTextUtil.html is in libgail-doc 2.24.32-1ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GailTextUtil: GAIL Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GAIL Reference Manual">
<link rel="up" href="libgail-util-main.html" title="GAIL libgail-util Library">
<link rel="prev" href="libgail-util-main.html" title="GAIL libgail-util Library">
<link rel="next" href="gail-libgail-util-GailMisc.html" title="GailMisc">
<meta name="generator" content="GTK-Doc V1.26.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#gail-libgail-util-GailTextUtil.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libgail-util-main.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libgail-util-main.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gail-libgail-util-GailMisc.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gail-libgail-util-GailTextUtil"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gail-libgail-util-GailTextUtil.top_of_page"></a>GailTextUtil</span></h2>
<p>GailTextUtil — GailTextUtil is a utility class which can be used to
  implement some of the <span class="type">AtkText</span> functions for accessible objects
  which implement <span class="type">AtkText</span>.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gail-libgail-util-GailTextUtil.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="gail-libgail-util-GailTextUtil.html#GailTextUtil" title="struct GailTextUtil"><span class="returnvalue">GailTextUtil</span></a> *
</td>
<td class="function_name">
<a class="link" href="gail-libgail-util-GailTextUtil.html#gail-text-util-new" title="gail_text_util_new ()">gail_text_util_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gail-libgail-util-GailTextUtil.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="gail-libgail-util-GailTextUtil.html#GailTextUtil" title="struct GailTextUtil">GailTextUtil</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="gail-libgail-util-GailTextUtil.html#GailOffsetType" title="enum GailOffsetType">GailOffsetType</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gail-libgail-util-GailTextUtil.description"></a><h2>Description</h2>
<p>GailTextUtil is a utility class which can be used to implement the
<span class="type">AtkText</span> functions which get text for accessible objects which implement
<span class="type">AtkText</span>.</p>
<p>In GAIL it is used by the accsesible objects for <span class="type">GnomeCanvasText</span>, <a href="../gtk4/GtkEntry.html#GtkEntry-struct"><span class="type">GtkEntry</span></a>,
<a href="../gtk4/GtkLabel.html#GtkLabel-struct"><span class="type">GtkLabel</span></a>, <a href="../gtk4/GtkCellRendererText.html#GtkCellRendererText-struct"><span class="type">GtkCellRendererText</span></a> and <a href="../gtk4/GtkTextView.html#GtkTextView-struct"><span class="type">GtkTextView</span></a>.</p>
</div>
<div class="refsect1">
<a name="gail-libgail-util-GailTextUtil.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gail-text-util-new"></a><h3>gail_text_util_new ()</h3>
<pre class="programlisting"><a class="link" href="gail-libgail-util-GailTextUtil.html#GailTextUtil" title="struct GailTextUtil"><span class="returnvalue">GailTextUtil</span></a> *
gail_text_util_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>This function creates a new GailTextUtil object.</p>
<div class="refsect3">
<a name="gail-text-util-new.returns"></a><h4>Returns</h4>
<p> the GailTextUtil object</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gail-text-util-text-setup"></a><h3>gail_text_util_text_setup ()</h3>
<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>,
                           <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>);</pre>
<p>This function initializes the GailTextUtil with the specified character string,</p>
<div class="refsect3">
<a name="gail-text-util-text-setup.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>textutil</p></td>
<td class="parameter_description"><p>The <a class="link" href="gail-libgail-util-GailTextUtil.html#GailTextUtil" title="struct GailTextUtil"><span class="type">GailTextUtil</span></a> to be initialized.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p>A gchar* which points to the text to be stored in the GailTextUtil</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gail-text-util-buffer-setup"></a><h3>gail_text_util_buffer_setup ()</h3>
<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>,
                             <em class="parameter"><code><a href="../gtk4/GtkTextBuffer.html#GtkTextBuffer-struct"><span class="type">GtkTextBuffer</span></a> *buffer</code></em>);</pre>
<p>This function initializes the GailTextUtil with the specified GtkTextBuffer</p>
<div class="refsect3">
<a name="gail-text-util-buffer-setup.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>textutil</p></td>
<td class="parameter_description"><p>A <a class="link" href="gail-libgail-util-GailTextUtil.html#GailTextUtil" title="struct GailTextUtil"><span class="type">GailTextUtil</span></a> to be initialized</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>buffer</p></td>
<td class="parameter_description"><p>The <a href="../gtk4/GtkTextBuffer.html#GtkTextBuffer-struct"><span class="type">GtkTextBuffer</span></a> which identifies the text to be stored in the GailUtil.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gail-text-util-get-text"></a><h3>gail_text_util_get_text ()</h3>
<pre class="programlisting"><a href="../glib/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>,
                         <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> layout</code></em>,
                         <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>,
                         <em class="parameter"><code><span class="type">AtkTextBoundary</span> boundary_type</code></em>,
                         <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> offset</code></em>,
                         <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *start_offset</code></em>,
                         <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *end_offset</code></em>);</pre>
<p>This function gets the requested substring from the text in the GtkTextUtil.
The layout is used only for getting the text on a line. The value is NULL 
for a GtkTextView which is not wrapped, is a GtkTextView for a GtkTextView 
which is wrapped and is a PangoLayout otherwise.</p>
<div class="refsect3">
<a name="gail-text-util-get-text.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>textutil</p></td>
<td class="parameter_description"><p>A <a class="link" href="gail-libgail-util-GailTextUtil.html#GailTextUtil" title="struct GailTextUtil"><span class="type">GailTextUtil</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>layout</p></td>
<td class="parameter_description"><p>A gpointer which is a PangoLayout, a GtkTreeView of NULL</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>function</p></td>
<td class="parameter_description"><p>An enumeration specifying whether to return the text before, at, or
after the offset.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>boundary_type</p></td>
<td class="parameter_description"><p>The boundary type.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>offset</p></td>
<td class="parameter_description"><p>The offset of the text in the GailTextUtil </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_offset</p></td>
<td class="parameter_description"><p>Address of location in which the start offset is returned</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>end_offset</p></td>
<td class="parameter_description"><p>Address of location in which the end offset is returned</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gail-text-util-get-text.returns"></a><h4>Returns</h4>
<p> the substring requested</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gail-text-util-get-substring"></a><h3>gail_text_util_get_substring ()</h3>
<pre class="programlisting"><a href="../glib/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>,
                              <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> start_pos</code></em>,
                              <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> end_pos</code></em>);</pre>
<p>Gets the substring indicated by <em class="parameter"><code>start_pos</code></em>
 and <em class="parameter"><code>end_pos</code></em>
</p>
<div class="refsect3">
<a name="gail-text-util-get-substring.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>textutil</p></td>
<td class="parameter_description"><p>A <a class="link" href="gail-libgail-util-GailTextUtil.html#GailTextUtil" title="struct GailTextUtil"><span class="type">GailTextUtil</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_pos</p></td>
<td class="parameter_description"><p>The start position of the substring</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>end_pos</p></td>
<td class="parameter_description"><p>The end position of the substring.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gail-text-util-get-substring.returns"></a><h4>Returns</h4>
<p> the substring indicated by <em class="parameter"><code>start_pos</code></em>
and <em class="parameter"><code>end_pos</code></em>
</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="gail-libgail-util-GailTextUtil.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GailTextUtil"></a><h3>struct GailTextUtil</h3>
<pre class="programlisting">struct GailTextUtil {
  GObject parent;

  GtkTextBuffer *buffer;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GailOffsetType"></a><h3>enum GailOffsetType</h3>
<p>Specifies which of the functions <code class="function">atk_text_get_text_before_offset()</code>,
<code class="function">atk_text_get_text_at_offset()</code>, <code class="function">atk_text_get_text_after_offset()</code> the
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.</p>
<div class="refsect3">
<a name="GailOffsetType.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="GAIL-BEFORE-OFFSET:CAPS"></a>GAIL_BEFORE_OFFSET</p></td>
<td class="enum_member_description">
<p>Text before offset is required.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GAIL-AT-OFFSET:CAPS"></a>GAIL_AT_OFFSET</p></td>
<td class="enum_member_description">
<p>Text at offset is required,</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GAIL-AFTER-OFFSET:CAPS"></a>GAIL_AFTER_OFFSET</p></td>
<td class="enum_member_description">
<p>Text after offset is required.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.26.1</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.