1 /* GTK - The GIMP Toolkit
2 * gtktextiter.h Copyright (C) 2000 Red Hat, Inc.
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.
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.
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.
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/.
27 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
28 #error "Only <gtk/gtk.h> can be included directly."
31 #ifndef __GTK_TEXT_ITER_H__
32 #define __GTK_TEXT_ITER_H__
34 #include <gtk/gtktextattributes.h>
35 #include <gtk/gtktextchild.h>
36 #include <gtk/gtktexttag.h>
41 GTK_TEXT_SEARCH_VISIBLE_ONLY = 1 << 0,
42 GTK_TEXT_SEARCH_TEXT_ONLY = 1 << 1,
43 GTK_TEXT_SEARCH_CASE_INSENSITIVE = 1 << 2
44 /* Possible future plans: SEARCH_REGEXP */
48 * Iter: represents a location in the text. Becomes invalid if the
49 * characters/pixmaps/widgets (indexable objects) in the text buffer
53 typedef struct _GtkTextBuffer GtkTextBuffer;
55 #define GTK_TYPE_TEXT_ITER (gtk_text_iter_get_type ())
58 /* GtkTextIter is an opaque datatype; ignore all these fields.
59 * Initialize the iter with gtk_text_buffer_get_iter_*
81 /* This is primarily intended for language bindings that want to avoid
82 a "buffer" argument to text insertions, deletions, etc. */
83 GtkTextBuffer *gtk_text_iter_get_buffer (const GtkTextIter *iter);
89 GtkTextIter *gtk_text_iter_copy (const GtkTextIter *iter);
90 void gtk_text_iter_free (GtkTextIter *iter);
91 void gtk_text_iter_assign (GtkTextIter *iter,
92 const GtkTextIter *other);
94 GType gtk_text_iter_get_type (void) G_GNUC_CONST;
97 * Convert to different kinds of index
100 gint gtk_text_iter_get_offset (const GtkTextIter *iter);
101 gint gtk_text_iter_get_line (const GtkTextIter *iter);
102 gint gtk_text_iter_get_line_offset (const GtkTextIter *iter);
103 gint gtk_text_iter_get_line_index (const GtkTextIter *iter);
105 gint gtk_text_iter_get_visible_line_offset (const GtkTextIter *iter);
106 gint gtk_text_iter_get_visible_line_index (const GtkTextIter *iter);
110 * "Dereference" operators
112 gunichar gtk_text_iter_get_char (const GtkTextIter *iter);
114 /* includes the 0xFFFC char for pixmaps/widgets, so char offsets
115 * into the returned string map properly into buffer char offsets
117 gchar *gtk_text_iter_get_slice (const GtkTextIter *start,
118 const GtkTextIter *end);
120 /* includes only text, no 0xFFFC */
121 gchar *gtk_text_iter_get_text (const GtkTextIter *start,
122 const GtkTextIter *end);
123 /* exclude invisible chars */
124 gchar *gtk_text_iter_get_visible_slice (const GtkTextIter *start,
125 const GtkTextIter *end);
126 gchar *gtk_text_iter_get_visible_text (const GtkTextIter *start,
127 const GtkTextIter *end);
129 GdkPixbuf* gtk_text_iter_get_pixbuf (const GtkTextIter *iter);
130 GSList * gtk_text_iter_get_marks (const GtkTextIter *iter);
132 GtkTextChildAnchor* gtk_text_iter_get_child_anchor (const GtkTextIter *iter);
134 /* Return list of tags toggled at this point (toggled_on determines
135 * whether the list is of on-toggles or off-toggles)
137 GSList *gtk_text_iter_get_toggled_tags (const GtkTextIter *iter,
138 gboolean toggled_on);
140 gboolean gtk_text_iter_begins_tag (const GtkTextIter *iter,
143 gboolean gtk_text_iter_ends_tag (const GtkTextIter *iter,
146 gboolean gtk_text_iter_toggles_tag (const GtkTextIter *iter,
149 gboolean gtk_text_iter_has_tag (const GtkTextIter *iter,
151 GSList *gtk_text_iter_get_tags (const GtkTextIter *iter);
153 gboolean gtk_text_iter_editable (const GtkTextIter *iter,
154 gboolean default_setting);
155 gboolean gtk_text_iter_can_insert (const GtkTextIter *iter,
156 gboolean default_editability);
158 gboolean gtk_text_iter_starts_word (const GtkTextIter *iter);
159 gboolean gtk_text_iter_ends_word (const GtkTextIter *iter);
160 gboolean gtk_text_iter_inside_word (const GtkTextIter *iter);
161 gboolean gtk_text_iter_starts_sentence (const GtkTextIter *iter);
162 gboolean gtk_text_iter_ends_sentence (const GtkTextIter *iter);
163 gboolean gtk_text_iter_inside_sentence (const GtkTextIter *iter);
164 gboolean gtk_text_iter_starts_line (const GtkTextIter *iter);
165 gboolean gtk_text_iter_ends_line (const GtkTextIter *iter);
166 gboolean gtk_text_iter_is_cursor_position (const GtkTextIter *iter);
168 gint gtk_text_iter_get_chars_in_line (const GtkTextIter *iter);
169 gint gtk_text_iter_get_bytes_in_line (const GtkTextIter *iter);
171 gboolean gtk_text_iter_get_attributes (const GtkTextIter *iter,
172 GtkTextAttributes *values);
173 PangoLanguage* gtk_text_iter_get_language (const GtkTextIter *iter);
174 gboolean gtk_text_iter_is_end (const GtkTextIter *iter);
175 gboolean gtk_text_iter_is_start (const GtkTextIter *iter);
178 * Moving around the buffer
181 gboolean gtk_text_iter_forward_char (GtkTextIter *iter);
182 gboolean gtk_text_iter_backward_char (GtkTextIter *iter);
183 gboolean gtk_text_iter_forward_chars (GtkTextIter *iter,
185 gboolean gtk_text_iter_backward_chars (GtkTextIter *iter,
187 gboolean gtk_text_iter_forward_line (GtkTextIter *iter);
188 gboolean gtk_text_iter_backward_line (GtkTextIter *iter);
189 gboolean gtk_text_iter_forward_lines (GtkTextIter *iter,
191 gboolean gtk_text_iter_backward_lines (GtkTextIter *iter,
193 gboolean gtk_text_iter_forward_word_end (GtkTextIter *iter);
194 gboolean gtk_text_iter_backward_word_start (GtkTextIter *iter);
195 gboolean gtk_text_iter_forward_word_ends (GtkTextIter *iter,
197 gboolean gtk_text_iter_backward_word_starts (GtkTextIter *iter,
200 gboolean gtk_text_iter_forward_visible_line (GtkTextIter *iter);
201 gboolean gtk_text_iter_backward_visible_line (GtkTextIter *iter);
202 gboolean gtk_text_iter_forward_visible_lines (GtkTextIter *iter,
204 gboolean gtk_text_iter_backward_visible_lines (GtkTextIter *iter,
207 gboolean gtk_text_iter_forward_visible_word_end (GtkTextIter *iter);
208 gboolean gtk_text_iter_backward_visible_word_start (GtkTextIter *iter);
209 gboolean gtk_text_iter_forward_visible_word_ends (GtkTextIter *iter,
211 gboolean gtk_text_iter_backward_visible_word_starts (GtkTextIter *iter,
214 gboolean gtk_text_iter_forward_sentence_end (GtkTextIter *iter);
215 gboolean gtk_text_iter_backward_sentence_start (GtkTextIter *iter);
216 gboolean gtk_text_iter_forward_sentence_ends (GtkTextIter *iter,
218 gboolean gtk_text_iter_backward_sentence_starts (GtkTextIter *iter,
220 /* cursor positions are almost equivalent to chars, but not quite;
221 * in some languages, you can't put the cursor between certain
222 * chars. Also, you can't put the cursor between \r\n at the end
225 gboolean gtk_text_iter_forward_cursor_position (GtkTextIter *iter);
226 gboolean gtk_text_iter_backward_cursor_position (GtkTextIter *iter);
227 gboolean gtk_text_iter_forward_cursor_positions (GtkTextIter *iter,
229 gboolean gtk_text_iter_backward_cursor_positions (GtkTextIter *iter,
232 gboolean gtk_text_iter_forward_visible_cursor_position (GtkTextIter *iter);
233 gboolean gtk_text_iter_backward_visible_cursor_position (GtkTextIter *iter);
234 gboolean gtk_text_iter_forward_visible_cursor_positions (GtkTextIter *iter,
236 gboolean gtk_text_iter_backward_visible_cursor_positions (GtkTextIter *iter,
239 void gtk_text_iter_set_offset (GtkTextIter *iter,
241 void gtk_text_iter_set_line (GtkTextIter *iter,
243 void gtk_text_iter_set_line_offset (GtkTextIter *iter,
245 void gtk_text_iter_set_line_index (GtkTextIter *iter,
247 void gtk_text_iter_forward_to_end (GtkTextIter *iter);
248 gboolean gtk_text_iter_forward_to_line_end (GtkTextIter *iter);
250 void gtk_text_iter_set_visible_line_offset (GtkTextIter *iter,
252 void gtk_text_iter_set_visible_line_index (GtkTextIter *iter,
255 /* returns TRUE if a toggle was found; NULL for the tag pointer
256 * means "any tag toggle", otherwise the next toggle of the
257 * specified tag is located.
259 gboolean gtk_text_iter_forward_to_tag_toggle (GtkTextIter *iter,
262 gboolean gtk_text_iter_backward_to_tag_toggle (GtkTextIter *iter,
265 typedef gboolean (* GtkTextCharPredicate) (gunichar ch, gpointer user_data);
267 gboolean gtk_text_iter_forward_find_char (GtkTextIter *iter,
268 GtkTextCharPredicate pred,
270 const GtkTextIter *limit);
271 gboolean gtk_text_iter_backward_find_char (GtkTextIter *iter,
272 GtkTextCharPredicate pred,
274 const GtkTextIter *limit);
276 gboolean gtk_text_iter_forward_search (const GtkTextIter *iter,
278 GtkTextSearchFlags flags,
279 GtkTextIter *match_start,
280 GtkTextIter *match_end,
281 const GtkTextIter *limit);
283 gboolean gtk_text_iter_backward_search (const GtkTextIter *iter,
285 GtkTextSearchFlags flags,
286 GtkTextIter *match_start,
287 GtkTextIter *match_end,
288 const GtkTextIter *limit);
293 gboolean gtk_text_iter_equal (const GtkTextIter *lhs,
294 const GtkTextIter *rhs);
295 gint gtk_text_iter_compare (const GtkTextIter *lhs,
296 const GtkTextIter *rhs);
297 gboolean gtk_text_iter_in_range (const GtkTextIter *iter,
298 const GtkTextIter *start,
299 const GtkTextIter *end);
301 /* Put these two in ascending order */
302 void gtk_text_iter_order (GtkTextIter *first,
303 GtkTextIter *second);