1 | /* GTK - The GIMP Toolkit |
2 | * gtktextiter.h Copyright (C) 2000 Red Hat, Inc. |
3 | * |
4 | * This library is free software; you can redistribute it and/or |
5 | * modify it under the terms of the GNU Lesser General Public |
6 | * License as published by the Free Software Foundation; either |
7 | * version 2 of the License, or (at your option) any later version. |
8 | * |
9 | * This library is distributed in the hope that it will be useful, |
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
12 | * Lesser General Public License for more details. |
13 | * |
14 | * You should have received a copy of the GNU Lesser General Public |
15 | * License along with this library. If not, see <http://www.gnu.org/licenses/>. |
16 | */ |
17 | |
18 | /* |
19 | * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS |
20 | * file for a list of people on the GTK+ Team. See the ChangeLog |
21 | * files for a list of changes. These files are distributed with |
22 | * GTK+ at ftp://ftp.gtk.org/pub/gtk/. |
23 | */ |
24 | |
25 | #ifndef __GTK_TEXT_ITER_H__ |
26 | #define __GTK_TEXT_ITER_H__ |
27 | |
28 | #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION) |
29 | #error "Only <gtk/gtk.h> can be included directly." |
30 | #endif |
31 | |
32 | #include <gtk/gtktextchild.h> |
33 | #include <gtk/gtktexttag.h> |
34 | |
35 | G_BEGIN_DECLS |
36 | |
37 | /** |
38 | * GtkTextSearchFlags: |
39 | * @GTK_TEXT_SEARCH_VISIBLE_ONLY: Search only visible data. A search match may |
40 | * have invisible text interspersed. |
41 | * @GTK_TEXT_SEARCH_TEXT_ONLY: Search only text. A match may have paintables or |
42 | * child widgets mixed inside the matched range. |
43 | * @GTK_TEXT_SEARCH_CASE_INSENSITIVE: The text will be matched regardless of |
44 | * what case it is in. |
45 | * |
46 | * Flags affecting how a search is done. |
47 | * |
48 | * If neither %GTK_TEXT_SEARCH_VISIBLE_ONLY nor %GTK_TEXT_SEARCH_TEXT_ONLY are |
49 | * enabled, the match must be exact; the special 0xFFFC character will match |
50 | * embedded paintables or child widgets. |
51 | */ |
52 | typedef enum { |
53 | GTK_TEXT_SEARCH_VISIBLE_ONLY = 1 << 0, |
54 | GTK_TEXT_SEARCH_TEXT_ONLY = 1 << 1, |
55 | GTK_TEXT_SEARCH_CASE_INSENSITIVE = 1 << 2 |
56 | /* Possible future plans: SEARCH_REGEXP */ |
57 | } GtkTextSearchFlags; |
58 | |
59 | /* |
60 | * Iter: represents a location in the text. Becomes invalid if the |
61 | * characters/pixmaps/widgets (indexable objects) in the text buffer |
62 | * are changed. |
63 | */ |
64 | |
65 | typedef struct _GtkTextBuffer GtkTextBuffer; |
66 | |
67 | #define GTK_TYPE_TEXT_ITER (gtk_text_iter_get_type ()) |
68 | |
69 | struct _GtkTextIter { |
70 | /* GtkTextIter is an opaque datatype; ignore all these fields. |
71 | * Initialize the iter with gtk_text_buffer_get_iter_* |
72 | * functions |
73 | */ |
74 | /*< private >*/ |
75 | gpointer dummy1; |
76 | gpointer dummy2; |
77 | int dummy3; |
78 | int dummy4; |
79 | int dummy5; |
80 | int dummy6; |
81 | int dummy7; |
82 | int dummy8; |
83 | gpointer dummy9; |
84 | gpointer dummy10; |
85 | int dummy11; |
86 | int dummy12; |
87 | /* padding */ |
88 | int dummy13; |
89 | gpointer dummy14; |
90 | }; |
91 | |
92 | |
93 | /* This is primarily intended for language bindings that want to avoid |
94 | a "buffer" argument to text insertions, deletions, etc. */ |
95 | GDK_AVAILABLE_IN_ALL |
96 | GtkTextBuffer *gtk_text_iter_get_buffer (const GtkTextIter *iter); |
97 | |
98 | /* |
99 | * Life cycle |
100 | */ |
101 | |
102 | GDK_AVAILABLE_IN_ALL |
103 | GtkTextIter *gtk_text_iter_copy (const GtkTextIter *iter); |
104 | GDK_AVAILABLE_IN_ALL |
105 | void gtk_text_iter_free (GtkTextIter *iter); |
106 | GDK_AVAILABLE_IN_ALL |
107 | void gtk_text_iter_assign (GtkTextIter *iter, |
108 | const GtkTextIter *other); |
109 | |
110 | GDK_AVAILABLE_IN_ALL |
111 | GType gtk_text_iter_get_type (void) G_GNUC_CONST; |
112 | |
113 | /* |
114 | * Convert to different kinds of index |
115 | */ |
116 | |
117 | GDK_AVAILABLE_IN_ALL |
118 | int gtk_text_iter_get_offset (const GtkTextIter *iter); |
119 | GDK_AVAILABLE_IN_ALL |
120 | int gtk_text_iter_get_line (const GtkTextIter *iter); |
121 | GDK_AVAILABLE_IN_ALL |
122 | int gtk_text_iter_get_line_offset (const GtkTextIter *iter); |
123 | GDK_AVAILABLE_IN_ALL |
124 | int gtk_text_iter_get_line_index (const GtkTextIter *iter); |
125 | |
126 | GDK_AVAILABLE_IN_ALL |
127 | int gtk_text_iter_get_visible_line_offset (const GtkTextIter *iter); |
128 | GDK_AVAILABLE_IN_ALL |
129 | int gtk_text_iter_get_visible_line_index (const GtkTextIter *iter); |
130 | |
131 | |
132 | /* |
133 | * “Dereference” operators |
134 | */ |
135 | GDK_AVAILABLE_IN_ALL |
136 | gunichar gtk_text_iter_get_char (const GtkTextIter *iter); |
137 | |
138 | /* includes the 0xFFFC char for pixmaps/widgets, so char offsets |
139 | * into the returned string map properly into buffer char offsets |
140 | */ |
141 | GDK_AVAILABLE_IN_ALL |
142 | char *gtk_text_iter_get_slice (const GtkTextIter *start, |
143 | const GtkTextIter *end); |
144 | |
145 | /* includes only text, no 0xFFFC */ |
146 | GDK_AVAILABLE_IN_ALL |
147 | char *gtk_text_iter_get_text (const GtkTextIter *start, |
148 | const GtkTextIter *end); |
149 | /* exclude invisible chars */ |
150 | GDK_AVAILABLE_IN_ALL |
151 | char *gtk_text_iter_get_visible_slice (const GtkTextIter *start, |
152 | const GtkTextIter *end); |
153 | GDK_AVAILABLE_IN_ALL |
154 | char *gtk_text_iter_get_visible_text (const GtkTextIter *start, |
155 | const GtkTextIter *end); |
156 | |
157 | GDK_AVAILABLE_IN_ALL |
158 | GdkPaintable *gtk_text_iter_get_paintable (const GtkTextIter *iter); |
159 | GDK_AVAILABLE_IN_ALL |
160 | GSList *gtk_text_iter_get_marks (const GtkTextIter *iter); |
161 | |
162 | GDK_AVAILABLE_IN_ALL |
163 | GtkTextChildAnchor* gtk_text_iter_get_child_anchor (const GtkTextIter *iter); |
164 | |
165 | /* Return list of tags toggled at this point (toggled_on determines |
166 | * whether the list is of on-toggles or off-toggles) |
167 | */ |
168 | GDK_AVAILABLE_IN_ALL |
169 | GSList *gtk_text_iter_get_toggled_tags (const GtkTextIter *iter, |
170 | gboolean toggled_on); |
171 | |
172 | GDK_AVAILABLE_IN_ALL |
173 | gboolean gtk_text_iter_starts_tag (const GtkTextIter *iter, |
174 | GtkTextTag *tag); |
175 | |
176 | GDK_AVAILABLE_IN_ALL |
177 | gboolean gtk_text_iter_ends_tag (const GtkTextIter *iter, |
178 | GtkTextTag *tag); |
179 | |
180 | GDK_AVAILABLE_IN_ALL |
181 | gboolean gtk_text_iter_toggles_tag (const GtkTextIter *iter, |
182 | GtkTextTag *tag); |
183 | |
184 | GDK_AVAILABLE_IN_ALL |
185 | gboolean gtk_text_iter_has_tag (const GtkTextIter *iter, |
186 | GtkTextTag *tag); |
187 | GDK_AVAILABLE_IN_ALL |
188 | GSList *gtk_text_iter_get_tags (const GtkTextIter *iter); |
189 | |
190 | GDK_AVAILABLE_IN_ALL |
191 | gboolean gtk_text_iter_editable (const GtkTextIter *iter, |
192 | gboolean default_setting); |
193 | GDK_AVAILABLE_IN_ALL |
194 | gboolean gtk_text_iter_can_insert (const GtkTextIter *iter, |
195 | gboolean default_editability); |
196 | |
197 | GDK_AVAILABLE_IN_ALL |
198 | gboolean gtk_text_iter_starts_word (const GtkTextIter *iter); |
199 | GDK_AVAILABLE_IN_ALL |
200 | gboolean gtk_text_iter_ends_word (const GtkTextIter *iter); |
201 | GDK_AVAILABLE_IN_ALL |
202 | gboolean gtk_text_iter_inside_word (const GtkTextIter *iter); |
203 | GDK_AVAILABLE_IN_ALL |
204 | gboolean gtk_text_iter_starts_sentence (const GtkTextIter *iter); |
205 | GDK_AVAILABLE_IN_ALL |
206 | gboolean gtk_text_iter_ends_sentence (const GtkTextIter *iter); |
207 | GDK_AVAILABLE_IN_ALL |
208 | gboolean gtk_text_iter_inside_sentence (const GtkTextIter *iter); |
209 | GDK_AVAILABLE_IN_ALL |
210 | gboolean gtk_text_iter_starts_line (const GtkTextIter *iter); |
211 | GDK_AVAILABLE_IN_ALL |
212 | gboolean gtk_text_iter_ends_line (const GtkTextIter *iter); |
213 | GDK_AVAILABLE_IN_ALL |
214 | gboolean gtk_text_iter_is_cursor_position (const GtkTextIter *iter); |
215 | |
216 | GDK_AVAILABLE_IN_ALL |
217 | int gtk_text_iter_get_chars_in_line (const GtkTextIter *iter); |
218 | GDK_AVAILABLE_IN_ALL |
219 | int gtk_text_iter_get_bytes_in_line (const GtkTextIter *iter); |
220 | |
221 | GDK_AVAILABLE_IN_ALL |
222 | PangoLanguage* gtk_text_iter_get_language (const GtkTextIter *iter); |
223 | GDK_AVAILABLE_IN_ALL |
224 | gboolean gtk_text_iter_is_end (const GtkTextIter *iter); |
225 | GDK_AVAILABLE_IN_ALL |
226 | gboolean gtk_text_iter_is_start (const GtkTextIter *iter); |
227 | |
228 | /* |
229 | * Moving around the buffer |
230 | */ |
231 | |
232 | GDK_AVAILABLE_IN_ALL |
233 | gboolean gtk_text_iter_forward_char (GtkTextIter *iter); |
234 | GDK_AVAILABLE_IN_ALL |
235 | gboolean gtk_text_iter_backward_char (GtkTextIter *iter); |
236 | GDK_AVAILABLE_IN_ALL |
237 | gboolean gtk_text_iter_forward_chars (GtkTextIter *iter, |
238 | int count); |
239 | GDK_AVAILABLE_IN_ALL |
240 | gboolean gtk_text_iter_backward_chars (GtkTextIter *iter, |
241 | int count); |
242 | GDK_AVAILABLE_IN_ALL |
243 | gboolean gtk_text_iter_forward_line (GtkTextIter *iter); |
244 | GDK_AVAILABLE_IN_ALL |
245 | gboolean gtk_text_iter_backward_line (GtkTextIter *iter); |
246 | GDK_AVAILABLE_IN_ALL |
247 | gboolean gtk_text_iter_forward_lines (GtkTextIter *iter, |
248 | int count); |
249 | GDK_AVAILABLE_IN_ALL |
250 | gboolean gtk_text_iter_backward_lines (GtkTextIter *iter, |
251 | int count); |
252 | GDK_AVAILABLE_IN_ALL |
253 | gboolean gtk_text_iter_forward_word_end (GtkTextIter *iter); |
254 | GDK_AVAILABLE_IN_ALL |
255 | gboolean gtk_text_iter_backward_word_start (GtkTextIter *iter); |
256 | GDK_AVAILABLE_IN_ALL |
257 | gboolean gtk_text_iter_forward_word_ends (GtkTextIter *iter, |
258 | int count); |
259 | GDK_AVAILABLE_IN_ALL |
260 | gboolean gtk_text_iter_backward_word_starts (GtkTextIter *iter, |
261 | int count); |
262 | |
263 | GDK_AVAILABLE_IN_ALL |
264 | gboolean gtk_text_iter_forward_visible_line (GtkTextIter *iter); |
265 | GDK_AVAILABLE_IN_ALL |
266 | gboolean gtk_text_iter_backward_visible_line (GtkTextIter *iter); |
267 | GDK_AVAILABLE_IN_ALL |
268 | gboolean gtk_text_iter_forward_visible_lines (GtkTextIter *iter, |
269 | int count); |
270 | GDK_AVAILABLE_IN_ALL |
271 | gboolean gtk_text_iter_backward_visible_lines (GtkTextIter *iter, |
272 | int count); |
273 | |
274 | GDK_AVAILABLE_IN_ALL |
275 | gboolean gtk_text_iter_forward_visible_word_end (GtkTextIter *iter); |
276 | GDK_AVAILABLE_IN_ALL |
277 | gboolean gtk_text_iter_backward_visible_word_start (GtkTextIter *iter); |
278 | GDK_AVAILABLE_IN_ALL |
279 | gboolean gtk_text_iter_forward_visible_word_ends (GtkTextIter *iter, |
280 | int count); |
281 | GDK_AVAILABLE_IN_ALL |
282 | gboolean gtk_text_iter_backward_visible_word_starts (GtkTextIter *iter, |
283 | int count); |
284 | |
285 | GDK_AVAILABLE_IN_ALL |
286 | gboolean gtk_text_iter_forward_sentence_end (GtkTextIter *iter); |
287 | GDK_AVAILABLE_IN_ALL |
288 | gboolean gtk_text_iter_backward_sentence_start (GtkTextIter *iter); |
289 | GDK_AVAILABLE_IN_ALL |
290 | gboolean gtk_text_iter_forward_sentence_ends (GtkTextIter *iter, |
291 | int count); |
292 | GDK_AVAILABLE_IN_ALL |
293 | gboolean gtk_text_iter_backward_sentence_starts (GtkTextIter *iter, |
294 | int count); |
295 | /* cursor positions are almost equivalent to chars, but not quite; |
296 | * in some languages, you can’t put the cursor between certain |
297 | * chars. Also, you can’t put the cursor between \r\n at the end |
298 | * of a line. |
299 | */ |
300 | GDK_AVAILABLE_IN_ALL |
301 | gboolean gtk_text_iter_forward_cursor_position (GtkTextIter *iter); |
302 | GDK_AVAILABLE_IN_ALL |
303 | gboolean gtk_text_iter_backward_cursor_position (GtkTextIter *iter); |
304 | GDK_AVAILABLE_IN_ALL |
305 | gboolean gtk_text_iter_forward_cursor_positions (GtkTextIter *iter, |
306 | int count); |
307 | GDK_AVAILABLE_IN_ALL |
308 | gboolean gtk_text_iter_backward_cursor_positions (GtkTextIter *iter, |
309 | int count); |
310 | |
311 | GDK_AVAILABLE_IN_ALL |
312 | gboolean gtk_text_iter_forward_visible_cursor_position (GtkTextIter *iter); |
313 | GDK_AVAILABLE_IN_ALL |
314 | gboolean gtk_text_iter_backward_visible_cursor_position (GtkTextIter *iter); |
315 | GDK_AVAILABLE_IN_ALL |
316 | gboolean gtk_text_iter_forward_visible_cursor_positions (GtkTextIter *iter, |
317 | int count); |
318 | GDK_AVAILABLE_IN_ALL |
319 | gboolean gtk_text_iter_backward_visible_cursor_positions (GtkTextIter *iter, |
320 | int count); |
321 | |
322 | GDK_AVAILABLE_IN_ALL |
323 | void gtk_text_iter_set_offset (GtkTextIter *iter, |
324 | int char_offset); |
325 | GDK_AVAILABLE_IN_ALL |
326 | void gtk_text_iter_set_line (GtkTextIter *iter, |
327 | int line_number); |
328 | GDK_AVAILABLE_IN_ALL |
329 | void gtk_text_iter_set_line_offset (GtkTextIter *iter, |
330 | int char_on_line); |
331 | GDK_AVAILABLE_IN_ALL |
332 | void gtk_text_iter_set_line_index (GtkTextIter *iter, |
333 | int byte_on_line); |
334 | GDK_AVAILABLE_IN_ALL |
335 | void gtk_text_iter_forward_to_end (GtkTextIter *iter); |
336 | GDK_AVAILABLE_IN_ALL |
337 | gboolean gtk_text_iter_forward_to_line_end (GtkTextIter *iter); |
338 | |
339 | GDK_AVAILABLE_IN_ALL |
340 | void gtk_text_iter_set_visible_line_offset (GtkTextIter *iter, |
341 | int char_on_line); |
342 | GDK_AVAILABLE_IN_ALL |
343 | void gtk_text_iter_set_visible_line_index (GtkTextIter *iter, |
344 | int byte_on_line); |
345 | |
346 | /* returns TRUE if a toggle was found; NULL for the tag pointer |
347 | * means “any tag toggle”, otherwise the next toggle of the |
348 | * specified tag is located. |
349 | */ |
350 | GDK_AVAILABLE_IN_ALL |
351 | gboolean gtk_text_iter_forward_to_tag_toggle (GtkTextIter *iter, |
352 | GtkTextTag *tag); |
353 | |
354 | GDK_AVAILABLE_IN_ALL |
355 | gboolean gtk_text_iter_backward_to_tag_toggle (GtkTextIter *iter, |
356 | GtkTextTag *tag); |
357 | |
358 | /** |
359 | * GtkTextCharPredicate: |
360 | * @ch: a Unicode code point |
361 | * @user_data: data passed to the callback |
362 | * |
363 | * The predicate function used by gtk_text_iter_forward_find_char() and |
364 | * gtk_text_iter_backward_find_char(). |
365 | * |
366 | * Returns: %TRUE if the predicate is satisfied, and the iteration should |
367 | * stop, and %FALSE otherwise |
368 | */ |
369 | typedef gboolean (* GtkTextCharPredicate) (gunichar ch, gpointer user_data); |
370 | |
371 | GDK_AVAILABLE_IN_ALL |
372 | gboolean gtk_text_iter_forward_find_char (GtkTextIter *iter, |
373 | GtkTextCharPredicate pred, |
374 | gpointer user_data, |
375 | const GtkTextIter *limit); |
376 | GDK_AVAILABLE_IN_ALL |
377 | gboolean gtk_text_iter_backward_find_char (GtkTextIter *iter, |
378 | GtkTextCharPredicate pred, |
379 | gpointer user_data, |
380 | const GtkTextIter *limit); |
381 | |
382 | GDK_AVAILABLE_IN_ALL |
383 | gboolean gtk_text_iter_forward_search (const GtkTextIter *iter, |
384 | const char *str, |
385 | GtkTextSearchFlags flags, |
386 | GtkTextIter *match_start, |
387 | GtkTextIter *match_end, |
388 | const GtkTextIter *limit); |
389 | |
390 | GDK_AVAILABLE_IN_ALL |
391 | gboolean gtk_text_iter_backward_search (const GtkTextIter *iter, |
392 | const char *str, |
393 | GtkTextSearchFlags flags, |
394 | GtkTextIter *match_start, |
395 | GtkTextIter *match_end, |
396 | const GtkTextIter *limit); |
397 | |
398 | /* |
399 | * Comparisons |
400 | */ |
401 | GDK_AVAILABLE_IN_ALL |
402 | gboolean gtk_text_iter_equal (const GtkTextIter *lhs, |
403 | const GtkTextIter *rhs); |
404 | GDK_AVAILABLE_IN_ALL |
405 | int gtk_text_iter_compare (const GtkTextIter *lhs, |
406 | const GtkTextIter *rhs); |
407 | GDK_AVAILABLE_IN_ALL |
408 | gboolean gtk_text_iter_in_range (const GtkTextIter *iter, |
409 | const GtkTextIter *start, |
410 | const GtkTextIter *end); |
411 | |
412 | /* Put these two in ascending order */ |
413 | GDK_AVAILABLE_IN_ALL |
414 | void gtk_text_iter_order (GtkTextIter *first, |
415 | GtkTextIter *second); |
416 | |
417 | G_END_DECLS |
418 | |
419 | #endif |
420 | |