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
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "../version.xml">
<!ENTITY api_version SYSTEM "../api_version.xml">
]>
<refentry id="libinftext-04-inf-text-buffer">
<refmeta>
<refentrytitle role="top_of_page" id="libinftext-04-inf-text-buffer.top_of_page">inf-text-buffer</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBINFTEXT-0.4 Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>inf-text-buffer</refname>
<refpurpose></refpurpose>
</refnamediv>
<refsynopsisdiv id="libinftext-04-inf-text-buffer.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<anchor id="InfTextBuffer"/>
<synopsis>
<link linkend="InfTextBuffer-struct">InfTextBuffer</link>;
<link linkend="InfTextBufferIface">InfTextBufferIface</link>;
<link linkend="InfTextBufferIter">InfTextBufferIter</link>;
const <link linkend="gchar">gchar</link> * <link linkend="inf-text-buffer-get-encoding">inf_text_buffer_get_encoding</link> (<link linkend="InfTextBuffer">InfTextBuffer</link> *buffer);
<link linkend="guint">guint</link> <link linkend="inf-text-buffer-get-length">inf_text_buffer_get_length</link> (<link linkend="InfTextBuffer">InfTextBuffer</link> *buffer);
<link linkend="InfTextChunk">InfTextChunk</link> * <link linkend="inf-text-buffer-get-slice">inf_text_buffer_get_slice</link> (<link linkend="InfTextBuffer">InfTextBuffer</link> *buffer,
<link linkend="guint">guint</link> pos,
<link linkend="guint">guint</link> len);
<link linkend="void">void</link> <link linkend="inf-text-buffer-insert-text">inf_text_buffer_insert_text</link> (<link linkend="InfTextBuffer">InfTextBuffer</link> *buffer,
<link linkend="guint">guint</link> pos,
<link linkend="gconstpointer">gconstpointer</link> text,
<link linkend="gsize">gsize</link> bytes,
<link linkend="guint">guint</link> len,
<link linkend="InfUser">InfUser</link> *user);
<link linkend="void">void</link> <link linkend="inf-text-buffer-insert-chunk">inf_text_buffer_insert_chunk</link> (<link linkend="InfTextBuffer">InfTextBuffer</link> *buffer,
<link linkend="guint">guint</link> pos,
<link linkend="InfTextChunk">InfTextChunk</link> *chunk,
<link linkend="InfUser">InfUser</link> *user);
<link linkend="void">void</link> <link linkend="inf-text-buffer-erase-text">inf_text_buffer_erase_text</link> (<link linkend="InfTextBuffer">InfTextBuffer</link> *buffer,
<link linkend="guint">guint</link> pos,
<link linkend="guint">guint</link> len,
<link linkend="InfUser">InfUser</link> *user);
<link linkend="InfTextBufferIter">InfTextBufferIter</link> * <link linkend="inf-text-buffer-create-iter">inf_text_buffer_create_iter</link> (<link linkend="InfTextBuffer">InfTextBuffer</link> *buffer);
<link linkend="void">void</link> <link linkend="inf-text-buffer-destroy-iter">inf_text_buffer_destroy_iter</link> (<link linkend="InfTextBuffer">InfTextBuffer</link> *buffer,
<link linkend="InfTextBufferIter">InfTextBufferIter</link> *iter);
<link linkend="gboolean">gboolean</link> <link linkend="inf-text-buffer-iter-next">inf_text_buffer_iter_next</link> (<link linkend="InfTextBuffer">InfTextBuffer</link> *buffer,
<link linkend="InfTextBufferIter">InfTextBufferIter</link> *iter);
<link linkend="gboolean">gboolean</link> <link linkend="inf-text-buffer-iter-prev">inf_text_buffer_iter_prev</link> (<link linkend="InfTextBuffer">InfTextBuffer</link> *buffer,
<link linkend="InfTextBufferIter">InfTextBufferIter</link> *iter);
<link linkend="gpointer">gpointer</link> <link linkend="inf-text-buffer-iter-get-text">inf_text_buffer_iter_get_text</link> (<link linkend="InfTextBuffer">InfTextBuffer</link> *buffer,
<link linkend="InfTextBufferIter">InfTextBufferIter</link> *iter);
<link linkend="guint">guint</link> <link linkend="inf-text-buffer-iter-get-length">inf_text_buffer_iter_get_length</link> (<link linkend="InfTextBuffer">InfTextBuffer</link> *buffer,
<link linkend="InfTextBufferIter">InfTextBufferIter</link> *iter);
<link linkend="gsize">gsize</link> <link linkend="inf-text-buffer-iter-get-bytes">inf_text_buffer_iter_get_bytes</link> (<link linkend="InfTextBuffer">InfTextBuffer</link> *buffer,
<link linkend="InfTextBufferIter">InfTextBufferIter</link> *iter);
<link linkend="guint">guint</link> <link linkend="inf-text-buffer-iter-get-author">inf_text_buffer_iter_get_author</link> (<link linkend="InfTextBuffer">InfTextBuffer</link> *buffer,
<link linkend="InfTextBufferIter">InfTextBufferIter</link> *iter);
</synopsis>
</refsynopsisdiv>
<refsect1 id="libinftext-04-inf-text-buffer.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GInterface">GInterface</link>
+----InfTextBuffer
</synopsis>
</refsect1>
<refsect1 id="libinftext-04-inf-text-buffer.prerequisites" role="prerequisites">
<title role="prerequisites.title">Prerequisites</title>
<para>
InfTextBuffer requires
<link linkend="InfBuffer">InfBuffer</link> and <link linkend="GObject">GObject</link>.</para>
</refsect1>
<refsect1 id="libinftext-04-inf-text-buffer.implementations" role="implementations">
<title role="implementations.title">Known Implementations</title>
<para>
InfTextBuffer is implemented by
<link linkend="InfTextDefaultBuffer">InfTextDefaultBuffer</link>.</para>
</refsect1>
<refsect1 id="libinftext-04-inf-text-buffer.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
"<link linkend="InfTextBuffer-erase-text">erase-text</link>" : Run Last
"<link linkend="InfTextBuffer-insert-text">insert-text</link>" : Run Last
</synopsis>
</refsect1>
<refsect1 id="libinftext-04-inf-text-buffer.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="libinftext-04-inf-text-buffer.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="InfTextBuffer-struct" role="struct">
<title>InfTextBuffer</title>
<indexterm zone="InfTextBuffer-struct"><primary sortas="InfTextBuffer">InfTextBuffer</primary></indexterm><programlisting>typedef struct _InfTextBuffer InfTextBuffer;</programlisting>
<para>
</para></refsect2>
<refsect2 id="InfTextBufferIface" role="struct">
<title>InfTextBufferIface</title>
<indexterm zone="InfTextBufferIface"><primary sortas="InfTextBufferIface">InfTextBufferIface</primary></indexterm><programlisting>typedef struct {
GTypeInterface parent;
/* Virtual table */
const gchar* (*get_encoding)(InfTextBuffer* buffer);
guint(*get_length)(InfTextBuffer* buffer);
InfTextChunk*(*get_slice)(InfTextBuffer* buffer,
guint pos,
guint len);
InfTextBufferIter*(*create_iter)(InfTextBuffer* buffer);
void(*destroy_iter)(InfTextBuffer* buffer,
InfTextBufferIter* iter);
gboolean(*iter_next)(InfTextBuffer* buffer,
InfTextBufferIter* iter);
gboolean(*iter_prev)(InfTextBuffer* buffer,
InfTextBufferIter* iter);
gpointer(*iter_get_text)(InfTextBuffer* buffer,
InfTextBufferIter* iter);
guint(*iter_get_length)(InfTextBuffer* buffer,
InfTextBufferIter* iter);
gsize(*iter_get_bytes)(InfTextBuffer* buffer,
InfTextBufferIter* iter);
guint(*iter_get_author)(InfTextBuffer* buffer,
InfTextBufferIter* iter);
/* Signals */
void(*insert_text)(InfTextBuffer* buffer,
guint pos,
InfTextChunk* chunk,
InfUser* user);
void(*erase_text)(InfTextBuffer* buffer,
guint pos,
guint len,
InfUser* user);
} InfTextBufferIface;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="InfTextBufferIter" role="struct">
<title>InfTextBufferIter</title>
<indexterm zone="InfTextBufferIter"><primary sortas="InfTextBufferIter">InfTextBufferIter</primary></indexterm><programlisting>typedef struct _InfTextBufferIter InfTextBufferIter;</programlisting>
<para>
</para></refsect2>
<refsect2 id="inf-text-buffer-get-encoding" role="function">
<title>inf_text_buffer_get_encoding ()</title>
<indexterm zone="inf-text-buffer-get-encoding"><primary sortas="inf_text_buffer_get_encoding">inf_text_buffer_get_encoding</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> * inf_text_buffer_get_encoding (<link linkend="InfTextBuffer">InfTextBuffer</link> *buffer);</programlisting>
<para>
Returns the character encoding that the buffer uses. This means that all
<link linkend="InfTextChunk"><type>InfTextChunk</type></link> return values are encoded in this encoding and all
<link linkend="InfTextChunk"><type>InfTextChunk</type></link> parameters are expected to be encoded in that encoding.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>buffer</parameter> :</term>
<listitem><simpara> A <link linkend="InfTextBuffer"><type>InfTextBuffer</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The character encoding for <parameter>buffer</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="inf-text-buffer-get-length" role="function">
<title>inf_text_buffer_get_length ()</title>
<indexterm zone="inf-text-buffer-get-length"><primary sortas="inf_text_buffer_get_length">inf_text_buffer_get_length</primary></indexterm><programlisting><link linkend="guint">guint</link> inf_text_buffer_get_length (<link linkend="InfTextBuffer">InfTextBuffer</link> *buffer);</programlisting>
<para>
Returns the number of characters in <parameter>buffer</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>buffer</parameter> :</term>
<listitem><simpara> A <link linkend="InfTextBuffer"><type>InfTextBuffer</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The length of <parameter>buffer</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="inf-text-buffer-get-slice" role="function">
<title>inf_text_buffer_get_slice ()</title>
<indexterm zone="inf-text-buffer-get-slice"><primary sortas="inf_text_buffer_get_slice">inf_text_buffer_get_slice</primary></indexterm><programlisting><link linkend="InfTextChunk">InfTextChunk</link> * inf_text_buffer_get_slice (<link linkend="InfTextBuffer">InfTextBuffer</link> *buffer,
<link linkend="guint">guint</link> pos,
<link linkend="guint">guint</link> len);</programlisting>
<para>
Reads <parameter>len</parameter> characters, starting at <parameter>pos</parameter>, from the buffer, and returns them
as a <link linkend="InfTextChunk"><type>InfTextChunk</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>buffer</parameter> :</term>
<listitem><simpara> A <link linkend="InfTextBuffer"><type>InfTextBuffer</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>pos</parameter> :</term>
<listitem><simpara> Character offset of where to start extracting.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>len</parameter> :</term>
<listitem><simpara> Number of characters to extract.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="InfTextChunk"><type>InfTextChunk</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="inf-text-buffer-insert-text" role="function">
<title>inf_text_buffer_insert_text ()</title>
<indexterm zone="inf-text-buffer-insert-text"><primary sortas="inf_text_buffer_insert_text">inf_text_buffer_insert_text</primary></indexterm><programlisting><link linkend="void">void</link> inf_text_buffer_insert_text (<link linkend="InfTextBuffer">InfTextBuffer</link> *buffer,
<link linkend="guint">guint</link> pos,
<link linkend="gconstpointer">gconstpointer</link> text,
<link linkend="gsize">gsize</link> bytes,
<link linkend="guint">guint</link> len,
<link linkend="InfUser">InfUser</link> *user);</programlisting>
<para>
Inserts <parameter>text</parameter> into <parameter>buffer</parameter> as written by <parameter>author</parameter>. <parameter>text</parameter> must be encoded in
the character encoding of the buffer, see <link linkend="inf-text-buffer-get-encoding"><function>inf_text_buffer_get_encoding()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>buffer</parameter> :</term>
<listitem><simpara> A <link linkend="InfTextBuffer"><type>InfTextBuffer</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>pos</parameter> :</term>
<listitem><simpara> A character offset into <parameter>buffer</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>text</parameter> :</term>
<listitem><simpara> A pointer to the text to insert.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>bytes</parameter> :</term>
<listitem><simpara> The length (in bytes) of <parameter>text</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>len</parameter> :</term>
<listitem><simpara> The length (in characters) of <parameter>text</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user</parameter> :</term>
<listitem><simpara> A <link linkend="InfUser"><type>InfUser</type></link> that has inserted the new text, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="inf-text-buffer-insert-chunk" role="function">
<title>inf_text_buffer_insert_chunk ()</title>
<indexterm zone="inf-text-buffer-insert-chunk"><primary sortas="inf_text_buffer_insert_chunk">inf_text_buffer_insert_chunk</primary></indexterm><programlisting><link linkend="void">void</link> inf_text_buffer_insert_chunk (<link linkend="InfTextBuffer">InfTextBuffer</link> *buffer,
<link linkend="guint">guint</link> pos,
<link linkend="InfTextChunk">InfTextChunk</link> *chunk,
<link linkend="InfUser">InfUser</link> *user);</programlisting>
<para>
Inserts a <link linkend="InfTextChunk"><type>InfTextChunk</type></link> into <parameter>buffer</parameter>. <parameter>user</parameter> must not necessarily be the
author of <parameter>chunk</parameter> (<parameter>chunk</parameter> may even consist of multiple segments). This
happens when undoing a delete operation that erased another user's text.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>buffer</parameter> :</term>
<listitem><simpara> A <link linkend="InfTextBuffer"><type>InfTextBuffer</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>pos</parameter> :</term>
<listitem><simpara> A character offset into <parameter>buffer</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>chunk</parameter> :</term>
<listitem><simpara> A <link linkend="InfTextChunk"><type>InfTextChunk</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user</parameter> :</term>
<listitem><simpara> A <link linkend="InfUser"><type>InfUser</type></link> inserting <parameter>chunk</parameter>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="inf-text-buffer-erase-text" role="function">
<title>inf_text_buffer_erase_text ()</title>
<indexterm zone="inf-text-buffer-erase-text"><primary sortas="inf_text_buffer_erase_text">inf_text_buffer_erase_text</primary></indexterm><programlisting><link linkend="void">void</link> inf_text_buffer_erase_text (<link linkend="InfTextBuffer">InfTextBuffer</link> *buffer,
<link linkend="guint">guint</link> pos,
<link linkend="guint">guint</link> len,
<link linkend="InfUser">InfUser</link> *user);</programlisting>
<para>
Erases characters from the text buffer.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>buffer</parameter> :</term>
<listitem><simpara> A <link linkend="InfTextBuffer"><type>InfTextBuffer</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>pos</parameter> :</term>
<listitem><simpara> The position to begin deleting characters from.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>len</parameter> :</term>
<listitem><simpara> The amount of characters to delete.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user</parameter> :</term>
<listitem><simpara> A <link linkend="InfUser"><type>InfUser</type></link> that erases the text, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="inf-text-buffer-create-iter" role="function">
<title>inf_text_buffer_create_iter ()</title>
<indexterm zone="inf-text-buffer-create-iter"><primary sortas="inf_text_buffer_create_iter">inf_text_buffer_create_iter</primary></indexterm><programlisting><link linkend="InfTextBufferIter">InfTextBufferIter</link> * inf_text_buffer_create_iter (<link linkend="InfTextBuffer">InfTextBuffer</link> *buffer);</programlisting>
<para>
Creates a <link linkend="InfTextBufferIter"><type>InfTextBufferIter</type></link> pointing to the first segment of <parameter>buffer</parameter>.
A <link linkend="InfTextBufferIter"><type>InfTextBufferIter</type></link> is used to traverse the buffer contents in steps of
so-called segments each of which is written by the same user. The function
returns <link linkend="NULL--CAPS"><literal>NULL</literal></link> if there are no segments (i.e. the buffer is empty).
</para>
<para>
The iterator stays valid as long as the buffer remains unmodified and
must be freed with <link linkend="inf-text-buffer-destroy-iter"><function>inf_text_buffer_destroy_iter()</function></link> before.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>buffer</parameter> :</term>
<listitem><simpara> A <link linkend="InfTextBuffer"><type>InfTextBuffer</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="InfTextBufferIter"><type>InfTextBufferIter</type></link> to be freed by
<link linkend="inf-text-buffer-destroy-iter"><function>inf_text_buffer_destroy_iter()</function></link> when done using it, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="inf-text-buffer-destroy-iter" role="function">
<title>inf_text_buffer_destroy_iter ()</title>
<indexterm zone="inf-text-buffer-destroy-iter"><primary sortas="inf_text_buffer_destroy_iter">inf_text_buffer_destroy_iter</primary></indexterm><programlisting><link linkend="void">void</link> inf_text_buffer_destroy_iter (<link linkend="InfTextBuffer">InfTextBuffer</link> *buffer,
<link linkend="InfTextBufferIter">InfTextBufferIter</link> *iter);</programlisting>
<para>
Destroys a <link linkend="InfTextBufferIter"><type>InfTextBufferIter</type></link> created by <link linkend="inf-text-buffer-create-iter"><function>inf_text_buffer_create_iter()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>buffer</parameter> :</term>
<listitem><simpara> A <link linkend="InfTextBuffer"><type>InfTextBuffer</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>iter</parameter> :</term>
<listitem><simpara> A <link linkend="InfTextBufferIter"><type>InfTextBufferIter</type></link> pointing into <parameter>buffer</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="inf-text-buffer-iter-next" role="function">
<title>inf_text_buffer_iter_next ()</title>
<indexterm zone="inf-text-buffer-iter-next"><primary sortas="inf_text_buffer_iter_next">inf_text_buffer_iter_next</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> inf_text_buffer_iter_next (<link linkend="InfTextBuffer">InfTextBuffer</link> *buffer,
<link linkend="InfTextBufferIter">InfTextBufferIter</link> *iter);</programlisting>
<para>
Moves <parameter>iter</parameter> to point to the next segment in the buffer. If <parameter>iter</parameter> already
points to the last segment, <parameter>iter</parameter> is left unmodified and the function
returns <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>buffer</parameter> :</term>
<listitem><simpara> A <link linkend="InfTextBuffer"><type>InfTextBuffer</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>iter</parameter> :</term>
<listitem><simpara> A <link linkend="InfTextBufferIter"><type>InfTextBufferIter</type></link> pointing into <parameter>buffer</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Whether <parameter>iter</parameter> was moved.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="inf-text-buffer-iter-prev" role="function">
<title>inf_text_buffer_iter_prev ()</title>
<indexterm zone="inf-text-buffer-iter-prev"><primary sortas="inf_text_buffer_iter_prev">inf_text_buffer_iter_prev</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> inf_text_buffer_iter_prev (<link linkend="InfTextBuffer">InfTextBuffer</link> *buffer,
<link linkend="InfTextBufferIter">InfTextBufferIter</link> *iter);</programlisting>
<para>
Moves <parameter>iter</parameter> to point to the previous segment in the buffer. If <parameter>iter</parameter>
already points to the first segment, <parameter>iter</parameter> is left unmodified and the
function returns <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>buffer</parameter> :</term>
<listitem><simpara> A <link linkend="InfTextBuffer"><type>InfTextBuffer</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>iter</parameter> :</term>
<listitem><simpara> A <link linkend="InfTextBufferIter"><type>InfTextBufferIter</type></link> pointing into <parameter>buffer</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Whether <parameter>iter</parameter> was moved.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="inf-text-buffer-iter-get-text" role="function">
<title>inf_text_buffer_iter_get_text ()</title>
<indexterm zone="inf-text-buffer-iter-get-text"><primary sortas="inf_text_buffer_iter_get_text">inf_text_buffer_iter_get_text</primary></indexterm><programlisting><link linkend="gpointer">gpointer</link> inf_text_buffer_iter_get_text (<link linkend="InfTextBuffer">InfTextBuffer</link> *buffer,
<link linkend="InfTextBufferIter">InfTextBufferIter</link> *iter);</programlisting>
<para>
Returns the text of the segment <parameter>iter</parameter> points to. It is encoded in
<parameter>buffer</parameter>'s encoding (see <link linkend="inf-text-buffer-get-encoding"><function>inf_text_buffer_get_encoding()</function></link>).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>buffer</parameter> :</term>
<listitem><simpara> A <link linkend="InfTextBuffer"><type>InfTextBuffer</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>iter</parameter> :</term>
<listitem><simpara> A <link linkend="InfTextBufferIter"><type>InfTextBufferIter</type></link> pointing into <parameter>buffer</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The text of the segment <parameter>iter</parameter> points to. Free with <link linkend="g-free"><function>g_free()</function></link>
when done using it.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="inf-text-buffer-iter-get-length" role="function">
<title>inf_text_buffer_iter_get_length ()</title>
<indexterm zone="inf-text-buffer-iter-get-length"><primary sortas="inf_text_buffer_iter_get_length">inf_text_buffer_iter_get_length</primary></indexterm><programlisting><link linkend="guint">guint</link> inf_text_buffer_iter_get_length (<link linkend="InfTextBuffer">InfTextBuffer</link> *buffer,
<link linkend="InfTextBufferIter">InfTextBufferIter</link> *iter);</programlisting>
<para>
Returns the length of the segment <parameter>iter</parameter> points to, in characters.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>buffer</parameter> :</term>
<listitem><simpara> A <link linkend="InfTextBuffer"><type>InfTextBuffer</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>iter</parameter> :</term>
<listitem><simpara> A <link linkend="InfTextBufferIter"><type>InfTextBufferIter</type></link> pointing into <parameter>buffer</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The number of characters of the segment <parameter>iter</parameter> points to.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="inf-text-buffer-iter-get-bytes" role="function">
<title>inf_text_buffer_iter_get_bytes ()</title>
<indexterm zone="inf-text-buffer-iter-get-bytes"><primary sortas="inf_text_buffer_iter_get_bytes">inf_text_buffer_iter_get_bytes</primary></indexterm><programlisting><link linkend="gsize">gsize</link> inf_text_buffer_iter_get_bytes (<link linkend="InfTextBuffer">InfTextBuffer</link> *buffer,
<link linkend="InfTextBufferIter">InfTextBufferIter</link> *iter);</programlisting>
<para>
Returns the length of the segment <parameter>iter</parameter> points to, in bytes.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>buffer</parameter> :</term>
<listitem><simpara> A <link linkend="InfTextBuffer"><type>InfTextBuffer</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>iter</parameter> :</term>
<listitem><simpara> A <link linkend="InfTextBufferIter"><type>InfTextBufferIter</type></link> pointing into <parameter>buffer</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The number of bytes of the segment <parameter>iter</parameter> points to.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="inf-text-buffer-iter-get-author" role="function">
<title>inf_text_buffer_iter_get_author ()</title>
<indexterm zone="inf-text-buffer-iter-get-author"><primary sortas="inf_text_buffer_iter_get_author">inf_text_buffer_iter_get_author</primary></indexterm><programlisting><link linkend="guint">guint</link> inf_text_buffer_iter_get_author (<link linkend="InfTextBuffer">InfTextBuffer</link> *buffer,
<link linkend="InfTextBufferIter">InfTextBufferIter</link> *iter);</programlisting>
<para>
Returns the user ID of the user that has written the segment <parameter>iter</parameter> points
to.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>buffer</parameter> :</term>
<listitem><simpara> A <link linkend="InfTextBuffer"><type>InfTextBuffer</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>iter</parameter> :</term>
<listitem><simpara> A <link linkend="InfTextBufferIter"><type>InfTextBufferIter</type></link> pointing into <parameter>buffer</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The user ID of the user that wrote the segment <parameter>iter</parameter> points
to.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="libinftext-04-inf-text-buffer.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="InfTextBuffer-erase-text" role="signal"><title>The <literal>"erase-text"</literal> signal</title>
<indexterm zone="InfTextBuffer-erase-text"><primary sortas="InfTextBuffer::erase-text">InfTextBuffer::erase-text</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="InfTextBuffer">InfTextBuffer</link> *inftextbuffer,
<link linkend="guint">guint</link> arg1,
<link linkend="guint">guint</link> arg2,
<link linkend="InfUser">InfUser</link> *arg3,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>inftextbuffer</parameter> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg2</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg3</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="InfTextBuffer-insert-text" role="signal"><title>The <literal>"insert-text"</literal> signal</title>
<indexterm zone="InfTextBuffer-insert-text"><primary sortas="InfTextBuffer::insert-text">InfTextBuffer::insert-text</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="InfTextBuffer">InfTextBuffer</link> *inftextbuffer,
<link linkend="guint">guint</link> arg1,
<link linkend="InfTextChunk">InfTextChunk</link> *arg2,
<link linkend="InfUser">InfUser</link> *arg3,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>inftextbuffer</parameter> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg2</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg3</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
