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