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