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