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, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
18 */
19
20/*
21 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
25 */
26
27#ifndef __GTK_TEXT_ITER_H__
28#define __GTK_TEXT_ITER_H__
29
30#if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
31#error "Only <gtk/gtk.h> can be included directly."
32#endif
33
34#include <gtk/gtktexttag.h>
35#include <gtk/gtktextchild.h>
36
37G_BEGIN_DECLS
38
39typedef enum {
40 GTK_TEXT_SEARCH_VISIBLE_ONLY = 1 << 0,
41 GTK_TEXT_SEARCH_TEXT_ONLY = 1 << 1
42 /* Possible future plans: SEARCH_CASE_INSENSITIVE, SEARCH_REGEXP */
43} GtkTextSearchFlags;
44
45/*
46 * Iter: represents a location in the text. Becomes invalid if the
47 * characters/pixmaps/widgets (indexable objects) in the text buffer
48 * are changed.
49 */
50
51typedef struct _GtkTextBuffer GtkTextBuffer;
52
53#define GTK_TYPE_TEXT_ITER (gtk_text_iter_get_type ())
54
55struct _GtkTextIter {
56 /* GtkTextIter is an opaque datatype; ignore all these fields.
57 * Initialize the iter with gtk_text_buffer_get_iter_*
58 * functions
59 */
60 /*< private >*/
61 gpointer dummy1;
62 gpointer dummy2;
63 gint dummy3;
64 gint dummy4;
65 gint dummy5;
66 gint dummy6;
67 gint dummy7;
68 gint dummy8;
69 gpointer dummy9;
70 gpointer dummy10;
71 gint dummy11;
72 gint dummy12;
73 /* padding */
74 gint dummy13;
75 gpointer dummy14;
76};
77
78
79/* This is primarily intended for language bindings that want to avoid
80 a "buffer" argument to text insertions, deletions, etc. */
81GtkTextBuffer *gtk_text_iter_get_buffer (const GtkTextIter *iter);
82
83/*
84 * Life cycle
85 */
86
87GtkTextIter *gtk_text_iter_copy (const GtkTextIter *iter);
88void gtk_text_iter_free (GtkTextIter *iter);
89
90GType gtk_text_iter_get_type (void) G_GNUC_CONST;
91
92/*
93 * Convert to different kinds of index
94 */
95
96gint gtk_text_iter_get_offset (const GtkTextIter *iter);
97gint gtk_text_iter_get_line (const GtkTextIter *iter);
98gint gtk_text_iter_get_line_offset (const GtkTextIter *iter);
99gint gtk_text_iter_get_line_index (const GtkTextIter *iter);
100
101gint gtk_text_iter_get_visible_line_offset (const GtkTextIter *iter);
102gint gtk_text_iter_get_visible_line_index (const GtkTextIter *iter);
103
104
105/*
106 * "Dereference" operators
107 */
108gunichar gtk_text_iter_get_char (const GtkTextIter *iter);
109
110/* includes the 0xFFFC char for pixmaps/widgets, so char offsets
111 * into the returned string map properly into buffer char offsets
112 */
113gchar *gtk_text_iter_get_slice (const GtkTextIter *start,
114 const GtkTextIter *end);
115
116/* includes only text, no 0xFFFC */
117gchar *gtk_text_iter_get_text (const GtkTextIter *start,
118 const GtkTextIter *end);
119/* exclude invisible chars */
120gchar *gtk_text_iter_get_visible_slice (const GtkTextIter *start,
121 const GtkTextIter *end);
122gchar *gtk_text_iter_get_visible_text (const GtkTextIter *start,
123 const GtkTextIter *end);
124
125GdkPixbuf* gtk_text_iter_get_pixbuf (const GtkTextIter *iter);
126GSList * gtk_text_iter_get_marks (const GtkTextIter *iter);
127
128GtkTextChildAnchor* gtk_text_iter_get_child_anchor (const GtkTextIter *iter);
129
130/* Return list of tags toggled at this point (toggled_on determines
131 * whether the list is of on-toggles or off-toggles)
132 */
133GSList *gtk_text_iter_get_toggled_tags (const GtkTextIter *iter,
134 gboolean toggled_on);
135
136gboolean gtk_text_iter_begins_tag (const GtkTextIter *iter,
137 GtkTextTag *tag);
138
139gboolean gtk_text_iter_ends_tag (const GtkTextIter *iter,
140 GtkTextTag *tag);
141
142gboolean gtk_text_iter_toggles_tag (const GtkTextIter *iter,
143 GtkTextTag *tag);
144
145gboolean gtk_text_iter_has_tag (const GtkTextIter *iter,
146 GtkTextTag *tag);
147GSList *gtk_text_iter_get_tags (const GtkTextIter *iter);
148
149gboolean gtk_text_iter_editable (const GtkTextIter *iter,
150 gboolean default_setting);
151gboolean gtk_text_iter_can_insert (const GtkTextIter *iter,
152 gboolean default_editability);
153
154gboolean gtk_text_iter_starts_word (const GtkTextIter *iter);
155gboolean gtk_text_iter_ends_word (const GtkTextIter *iter);
156gboolean gtk_text_iter_inside_word (const GtkTextIter *iter);
157gboolean gtk_text_iter_starts_sentence (const GtkTextIter *iter);
158gboolean gtk_text_iter_ends_sentence (const GtkTextIter *iter);
159gboolean gtk_text_iter_inside_sentence (const GtkTextIter *iter);
160gboolean gtk_text_iter_starts_line (const GtkTextIter *iter);
161gboolean gtk_text_iter_ends_line (const GtkTextIter *iter);
162gboolean gtk_text_iter_is_cursor_position (const GtkTextIter *iter);
163
164gint gtk_text_iter_get_chars_in_line (const GtkTextIter *iter);
165gint gtk_text_iter_get_bytes_in_line (const GtkTextIter *iter);
166
167gboolean gtk_text_iter_get_attributes (const GtkTextIter *iter,
168 GtkTextAttributes *values);
169PangoLanguage* gtk_text_iter_get_language (const GtkTextIter *iter);
170gboolean gtk_text_iter_is_end (const GtkTextIter *iter);
171gboolean gtk_text_iter_is_start (const GtkTextIter *iter);
172
173/*
174 * Moving around the buffer
175 */
176
177gboolean gtk_text_iter_forward_char (GtkTextIter *iter);
178gboolean gtk_text_iter_backward_char (GtkTextIter *iter);
179gboolean gtk_text_iter_forward_chars (GtkTextIter *iter,
180 gint count);
181gboolean gtk_text_iter_backward_chars (GtkTextIter *iter,
182 gint count);
183gboolean gtk_text_iter_forward_line (GtkTextIter *iter);
184gboolean gtk_text_iter_backward_line (GtkTextIter *iter);
185gboolean gtk_text_iter_forward_lines (GtkTextIter *iter,
186 gint count);
187gboolean gtk_text_iter_backward_lines (GtkTextIter *iter,
188 gint count);
189gboolean gtk_text_iter_forward_word_end (GtkTextIter *iter);
190gboolean gtk_text_iter_backward_word_start (GtkTextIter *iter);
191gboolean gtk_text_iter_forward_word_ends (GtkTextIter *iter,
192 gint count);
193gboolean gtk_text_iter_backward_word_starts (GtkTextIter *iter,
194 gint count);
195
196gboolean gtk_text_iter_forward_visible_line (GtkTextIter *iter);
197gboolean gtk_text_iter_backward_visible_line (GtkTextIter *iter);
198gboolean gtk_text_iter_forward_visible_lines (GtkTextIter *iter,
199 gint count);
200gboolean gtk_text_iter_backward_visible_lines (GtkTextIter *iter,
201 gint count);
202
203gboolean gtk_text_iter_forward_visible_word_end (GtkTextIter *iter);
204gboolean gtk_text_iter_backward_visible_word_start (GtkTextIter *iter);
205gboolean gtk_text_iter_forward_visible_word_ends (GtkTextIter *iter,
206 gint count);
207gboolean gtk_text_iter_backward_visible_word_starts (GtkTextIter *iter,
208 gint count);
209
210gboolean gtk_text_iter_forward_sentence_end (GtkTextIter *iter);
211gboolean gtk_text_iter_backward_sentence_start (GtkTextIter *iter);
212gboolean gtk_text_iter_forward_sentence_ends (GtkTextIter *iter,
213 gint count);
214gboolean gtk_text_iter_backward_sentence_starts (GtkTextIter *iter,
215 gint count);
216/* cursor positions are almost equivalent to chars, but not quite;
217 * in some languages, you can't put the cursor between certain
218 * chars. Also, you can't put the cursor between \r\n at the end
219 * of a line.
220 */
221gboolean gtk_text_iter_forward_cursor_position (GtkTextIter *iter);
222gboolean gtk_text_iter_backward_cursor_position (GtkTextIter *iter);
223gboolean gtk_text_iter_forward_cursor_positions (GtkTextIter *iter,
224 gint count);
225gboolean gtk_text_iter_backward_cursor_positions (GtkTextIter *iter,
226 gint count);
227
228gboolean gtk_text_iter_forward_visible_cursor_position (GtkTextIter *iter);
229gboolean gtk_text_iter_backward_visible_cursor_position (GtkTextIter *iter);
230gboolean gtk_text_iter_forward_visible_cursor_positions (GtkTextIter *iter,
231 gint count);
232gboolean gtk_text_iter_backward_visible_cursor_positions (GtkTextIter *iter,
233 gint count);
234
235
236void gtk_text_iter_set_offset (GtkTextIter *iter,
237 gint char_offset);
238void gtk_text_iter_set_line (GtkTextIter *iter,
239 gint line_number);
240void gtk_text_iter_set_line_offset (GtkTextIter *iter,
241 gint char_on_line);
242void gtk_text_iter_set_line_index (GtkTextIter *iter,
243 gint byte_on_line);
244void gtk_text_iter_forward_to_end (GtkTextIter *iter);
245gboolean gtk_text_iter_forward_to_line_end (GtkTextIter *iter);
246
247void gtk_text_iter_set_visible_line_offset (GtkTextIter *iter,
248 gint char_on_line);
249void gtk_text_iter_set_visible_line_index (GtkTextIter *iter,
250 gint byte_on_line);
251
252/* returns TRUE if a toggle was found; NULL for the tag pointer
253 * means "any tag toggle", otherwise the next toggle of the
254 * specified tag is located.
255 */
256gboolean gtk_text_iter_forward_to_tag_toggle (GtkTextIter *iter,
257 GtkTextTag *tag);
258
259gboolean gtk_text_iter_backward_to_tag_toggle (GtkTextIter *iter,
260 GtkTextTag *tag);
261
262typedef gboolean (* GtkTextCharPredicate) (gunichar ch, gpointer user_data);
263
264gboolean gtk_text_iter_forward_find_char (GtkTextIter *iter,
265 GtkTextCharPredicate pred,
266 gpointer user_data,
267 const GtkTextIter *limit);
268gboolean gtk_text_iter_backward_find_char (GtkTextIter *iter,
269 GtkTextCharPredicate pred,
270 gpointer user_data,
271 const GtkTextIter *limit);
272
273gboolean gtk_text_iter_forward_search (const GtkTextIter *iter,
274 const gchar *str,
275 GtkTextSearchFlags flags,
276 GtkTextIter *match_start,
277 GtkTextIter *match_end,
278 const GtkTextIter *limit);
279
280gboolean gtk_text_iter_backward_search (const GtkTextIter *iter,
281 const gchar *str,
282 GtkTextSearchFlags flags,
283 GtkTextIter *match_start,
284 GtkTextIter *match_end,
285 const GtkTextIter *limit);
286
287
288/*
289 * Comparisons
290 */
291gboolean gtk_text_iter_equal (const GtkTextIter *lhs,
292 const GtkTextIter *rhs);
293gint gtk_text_iter_compare (const GtkTextIter *lhs,
294 const GtkTextIter *rhs);
295gboolean gtk_text_iter_in_range (const GtkTextIter *iter,
296 const GtkTextIter *start,
297 const GtkTextIter *end);
298
299/* Put these two in ascending order */
300void gtk_text_iter_order (GtkTextIter *first,
301 GtkTextIter *second);
302
303G_END_DECLS
304
305#endif
306
307
308