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