Pileus Git - ~andy/gtk/blob - gtk/gtktextiter.h

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