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 #ifndef GTK_TEXT_ITER_H
28 #define GTK_TEXT_ITER_H
30 #include <gtk/gtktexttag.h>
31 #include <gtk/gtktextchild.h>
35 #endif /* __cplusplus */
38 GTK_TEXT_SEARCH_VISIBLE_ONLY,
39 GTK_TEXT_SEARCH_TEXT_ONLY
40 /* Possible future plans: SEARCH_CASE_INSENSITIVE, SEARCH_REGEXP */
44 * Iter: represents a location in the text. Becomes invalid if the
45 * characters/pixmaps/widgets (indexable objects) in the text buffer
49 typedef struct _GtkTextBuffer GtkTextBuffer;
51 #define GTK_TYPE_TEXT_ITER (gtk_text_iter_get_type ())
54 /* GtkTextIter is an opaque datatype; ignore all these fields.
55 * Initialize the iter with gtk_text_buffer_get_iter_*
77 /* This is primarily intended for language bindings that want to avoid
78 a "buffer" argument to text insertions, deletions, etc. */
79 GtkTextBuffer *gtk_text_iter_get_buffer (const GtkTextIter *iter);
85 GtkTextIter *gtk_text_iter_copy (const GtkTextIter *iter);
86 void gtk_text_iter_free (GtkTextIter *iter);
88 GType gtk_text_iter_get_type (void);
91 * Convert to different kinds of index
94 gint gtk_text_iter_get_offset (const GtkTextIter *iter);
95 gint gtk_text_iter_get_line (const GtkTextIter *iter);
96 gint gtk_text_iter_get_line_offset (const GtkTextIter *iter);
97 gint gtk_text_iter_get_line_index (const GtkTextIter *iter);
99 gint gtk_text_iter_get_visible_line_offset (const GtkTextIter *iter);
100 gint gtk_text_iter_get_visible_line_index (const GtkTextIter *iter);
104 * "Dereference" operators
106 gunichar gtk_text_iter_get_char (const GtkTextIter *iter);
108 /* includes the 0xFFFC char for pixmaps/widgets, so char offsets
109 * into the returned string map properly into buffer char offsets
111 gchar *gtk_text_iter_get_slice (const GtkTextIter *start,
112 const GtkTextIter *end);
114 /* includes only text, no 0xFFFC */
115 gchar *gtk_text_iter_get_text (const GtkTextIter *start,
116 const GtkTextIter *end);
117 /* exclude invisible chars */
118 gchar *gtk_text_iter_get_visible_slice (const GtkTextIter *start,
119 const GtkTextIter *end);
120 gchar *gtk_text_iter_get_visible_text (const GtkTextIter *start,
121 const GtkTextIter *end);
123 GdkPixbuf* gtk_text_iter_get_pixbuf (const GtkTextIter *iter);
124 GSList * gtk_text_iter_get_marks (const GtkTextIter *iter);
126 GtkTextChildAnchor* gtk_text_iter_get_child_anchor (const GtkTextIter *iter);
128 /* Return list of tags toggled at this point (toggled_on determines
129 * whether the list is of on-toggles or off-toggles)
131 GSList *gtk_text_iter_get_toggled_tags (const GtkTextIter *iter,
132 gboolean toggled_on);
134 gboolean gtk_text_iter_begins_tag (const GtkTextIter *iter,
137 gboolean gtk_text_iter_ends_tag (const GtkTextIter *iter,
140 gboolean gtk_text_iter_toggles_tag (const GtkTextIter *iter,
143 gboolean gtk_text_iter_has_tag (const GtkTextIter *iter,
145 GSList *gtk_text_iter_get_tags (const GtkTextIter *iter);
147 gboolean gtk_text_iter_editable (const GtkTextIter *iter,
148 gboolean default_setting);
149 gboolean gtk_text_iter_can_insert (const GtkTextIter *iter,
150 gboolean default_editability);
152 gboolean gtk_text_iter_starts_word (const GtkTextIter *iter);
153 gboolean gtk_text_iter_ends_word (const GtkTextIter *iter);
154 gboolean gtk_text_iter_inside_word (const GtkTextIter *iter);
155 gboolean gtk_text_iter_starts_sentence (const GtkTextIter *iter);
156 gboolean gtk_text_iter_ends_sentence (const GtkTextIter *iter);
157 gboolean gtk_text_iter_inside_sentence (const GtkTextIter *iter);
158 gboolean gtk_text_iter_starts_line (const GtkTextIter *iter);
159 gboolean gtk_text_iter_ends_line (const GtkTextIter *iter);
160 gboolean gtk_text_iter_is_cursor_position (const GtkTextIter *iter);
162 gint gtk_text_iter_get_chars_in_line (const GtkTextIter *iter);
163 gint gtk_text_iter_get_bytes_in_line (const GtkTextIter *iter);
165 gboolean gtk_text_iter_get_attributes (const GtkTextIter *iter,
166 GtkTextAttributes *values);
167 PangoLanguage* gtk_text_iter_get_language (const GtkTextIter *iter);
168 gboolean gtk_text_iter_is_end (const GtkTextIter *iter);
169 gboolean gtk_text_iter_is_start (const GtkTextIter *iter);
172 * Moving around the buffer
175 gboolean gtk_text_iter_forward_char (GtkTextIter *iter);
176 gboolean gtk_text_iter_backward_char (GtkTextIter *iter);
177 gboolean gtk_text_iter_forward_chars (GtkTextIter *iter,
179 gboolean gtk_text_iter_backward_chars (GtkTextIter *iter,
181 gboolean gtk_text_iter_forward_line (GtkTextIter *iter);
182 gboolean gtk_text_iter_backward_line (GtkTextIter *iter);
183 gboolean gtk_text_iter_forward_lines (GtkTextIter *iter,
185 gboolean gtk_text_iter_backward_lines (GtkTextIter *iter,
187 gboolean gtk_text_iter_forward_word_end (GtkTextIter *iter);
188 gboolean gtk_text_iter_backward_word_start (GtkTextIter *iter);
189 gboolean gtk_text_iter_forward_word_ends (GtkTextIter *iter,
191 gboolean gtk_text_iter_backward_word_starts (GtkTextIter *iter,
194 gboolean gtk_text_iter_forward_sentence_end (GtkTextIter *iter);
195 gboolean gtk_text_iter_backward_sentence_start (GtkTextIter *iter);
196 gboolean gtk_text_iter_forward_sentence_ends (GtkTextIter *iter,
198 gboolean gtk_text_iter_backward_sentence_starts (GtkTextIter *iter,
200 /* cursor positions are almost equivalent to chars, but not quite;
201 * in some languages, you can't put the cursor between certain
202 * chars. Also, you can't put the cursor between \r\n at the end
205 gboolean gtk_text_iter_forward_cursor_position (GtkTextIter *iter);
206 gboolean gtk_text_iter_backward_cursor_position (GtkTextIter *iter);
207 gboolean gtk_text_iter_forward_cursor_positions (GtkTextIter *iter,
209 gboolean gtk_text_iter_backward_cursor_positions (GtkTextIter *iter,
213 void gtk_text_iter_set_offset (GtkTextIter *iter,
215 void gtk_text_iter_set_line (GtkTextIter *iter,
217 void gtk_text_iter_set_line_offset (GtkTextIter *iter,
219 void gtk_text_iter_set_line_index (GtkTextIter *iter,
221 void gtk_text_iter_forward_to_end (GtkTextIter *iter);
222 gboolean gtk_text_iter_forward_to_line_end (GtkTextIter *iter);
224 void gtk_text_iter_set_visible_line_offset (GtkTextIter *iter,
226 void gtk_text_iter_set_visible_line_index (GtkTextIter *iter,
229 /* returns TRUE if a toggle was found; NULL for the tag pointer
230 * means "any tag toggle", otherwise the next toggle of the
231 * specified tag is located.
233 gboolean gtk_text_iter_forward_to_tag_toggle (GtkTextIter *iter,
236 gboolean gtk_text_iter_backward_to_tag_toggle (GtkTextIter *iter,
239 typedef gboolean (* GtkTextCharPredicate) (gunichar ch, gpointer user_data);
241 gboolean gtk_text_iter_forward_find_char (GtkTextIter *iter,
242 GtkTextCharPredicate pred,
244 const GtkTextIter *limit);
245 gboolean gtk_text_iter_backward_find_char (GtkTextIter *iter,
246 GtkTextCharPredicate pred,
248 const GtkTextIter *limit);
250 gboolean gtk_text_iter_forward_search (const GtkTextIter *iter,
252 GtkTextSearchFlags flags,
253 GtkTextIter *match_start,
254 GtkTextIter *match_end,
255 const GtkTextIter *limit);
257 gboolean gtk_text_iter_backward_search (const GtkTextIter *iter,
259 GtkTextSearchFlags flags,
260 GtkTextIter *match_start,
261 GtkTextIter *match_end,
262 const GtkTextIter *limit);
268 gboolean gtk_text_iter_equal (const GtkTextIter *lhs,
269 const GtkTextIter *rhs);
270 gint gtk_text_iter_compare (const GtkTextIter *lhs,
271 const GtkTextIter *rhs);
272 gboolean gtk_text_iter_in_range (const GtkTextIter *iter,
273 const GtkTextIter *start,
274 const GtkTextIter *end);
276 /* Put these two in ascending order */
277 void gtk_text_iter_order (GtkTextIter *first,
278 GtkTextIter *second);
282 #endif /* __cplusplus */