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