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
  92 GType        gtk_text_iter_get_type (void) G_GNUC_CONST;
  93
  94 /*
  95  * Convert to different kinds of index
  96  */
  97
  98 gint gtk_text_iter_get_offset      (const GtkTextIter *iter);
  99 gint gtk_text_iter_get_line        (const GtkTextIter *iter);
 100 gint gtk_text_iter_get_line_offset (const GtkTextIter *iter);
 101 gint gtk_text_iter_get_line_index  (const GtkTextIter *iter);
 102
 103 gint gtk_text_iter_get_visible_line_offset (const GtkTextIter *iter);
 104 gint gtk_text_iter_get_visible_line_index (const GtkTextIter *iter);
 105
 106
 107 /*
 108  * "Dereference" operators
 109  */
 110 gunichar gtk_text_iter_get_char          (const GtkTextIter  *iter);
 111
 112 /* includes the 0xFFFC char for pixmaps/widgets, so char offsets
 113  * into the returned string map properly into buffer char offsets
 114  */
 115 gchar   *gtk_text_iter_get_slice         (const GtkTextIter  *start,
 116                                           const GtkTextIter  *end);
 117
 118 /* includes only text, no 0xFFFC */
 119 gchar   *gtk_text_iter_get_text          (const GtkTextIter  *start,
 120                                           const GtkTextIter  *end);
 121 /* exclude invisible chars */
 122 gchar   *gtk_text_iter_get_visible_slice (const GtkTextIter  *start,
 123                                           const GtkTextIter  *end);
 124 gchar   *gtk_text_iter_get_visible_text  (const GtkTextIter  *start,
 125                                           const GtkTextIter  *end);
 126
 127 GdkPixbuf* gtk_text_iter_get_pixbuf (const GtkTextIter *iter);
 128 GSList  *  gtk_text_iter_get_marks  (const GtkTextIter *iter);
 129
 130 GtkTextChildAnchor* gtk_text_iter_get_child_anchor (const GtkTextIter *iter);
 131
 132 /* Return list of tags toggled at this point (toggled_on determines
 133  * whether the list is of on-toggles or off-toggles)
 134  */
 135 GSList  *gtk_text_iter_get_toggled_tags  (const GtkTextIter  *iter,
 136                                           gboolean            toggled_on);
 137
 138 gboolean gtk_text_iter_begins_tag        (const GtkTextIter  *iter,
 139                                           GtkTextTag         *tag);
 140
 141 gboolean gtk_text_iter_ends_tag          (const GtkTextIter  *iter,
 142                                           GtkTextTag         *tag);
 143
 144 gboolean gtk_text_iter_toggles_tag       (const GtkTextIter  *iter,
 145                                           GtkTextTag         *tag);
 146
 147 gboolean gtk_text_iter_has_tag           (const GtkTextIter   *iter,
 148                                           GtkTextTag          *tag);
 149 GSList  *gtk_text_iter_get_tags          (const GtkTextIter   *iter);
 150
 151 gboolean gtk_text_iter_editable          (const GtkTextIter   *iter,
 152                                           gboolean             default_setting);
 153 gboolean gtk_text_iter_can_insert        (const GtkTextIter   *iter,
 154                                           gboolean             default_editability);
 155
 156 gboolean gtk_text_iter_starts_word        (const GtkTextIter   *iter);
 157 gboolean gtk_text_iter_ends_word          (const GtkTextIter   *iter);
 158 gboolean gtk_text_iter_inside_word        (const GtkTextIter   *iter);
 159 gboolean gtk_text_iter_starts_sentence    (const GtkTextIter   *iter);
 160 gboolean gtk_text_iter_ends_sentence      (const GtkTextIter   *iter);
 161 gboolean gtk_text_iter_inside_sentence    (const GtkTextIter   *iter);
 162 gboolean gtk_text_iter_starts_line        (const GtkTextIter   *iter);
 163 gboolean gtk_text_iter_ends_line          (const GtkTextIter   *iter);
 164 gboolean gtk_text_iter_is_cursor_position (const GtkTextIter   *iter);
 165
 166 gint     gtk_text_iter_get_chars_in_line (const GtkTextIter   *iter);
 167 gint     gtk_text_iter_get_bytes_in_line (const GtkTextIter   *iter);
 168
 169 gboolean       gtk_text_iter_get_attributes (const GtkTextIter *iter,
 170                                              GtkTextAttributes *values);
 171 PangoLanguage* gtk_text_iter_get_language   (const GtkTextIter *iter);
 172 gboolean       gtk_text_iter_is_end         (const GtkTextIter *iter);
 173 gboolean       gtk_text_iter_is_start       (const GtkTextIter *iter);
 174
 175 /*
 176  * Moving around the buffer
 177  */
 178
 179 gboolean gtk_text_iter_forward_char         (GtkTextIter *iter);
 180 gboolean gtk_text_iter_backward_char        (GtkTextIter *iter);
 181 gboolean gtk_text_iter_forward_chars        (GtkTextIter *iter,
 182                                              gint         count);
 183 gboolean gtk_text_iter_backward_chars       (GtkTextIter *iter,
 184                                              gint         count);
 185 gboolean gtk_text_iter_forward_line         (GtkTextIter *iter);
 186 gboolean gtk_text_iter_backward_line        (GtkTextIter *iter);
 187 gboolean gtk_text_iter_forward_lines        (GtkTextIter *iter,
 188                                              gint         count);
 189 gboolean gtk_text_iter_backward_lines       (GtkTextIter *iter,
 190                                              gint         count);
 191 gboolean gtk_text_iter_forward_word_end     (GtkTextIter *iter);
 192 gboolean gtk_text_iter_backward_word_start  (GtkTextIter *iter);
 193 gboolean gtk_text_iter_forward_word_ends    (GtkTextIter *iter,
 194                                              gint         count);
 195 gboolean gtk_text_iter_backward_word_starts (GtkTextIter *iter,
 196                                              gint         count);
 197
 198 gboolean gtk_text_iter_forward_visible_line   (GtkTextIter *iter);
 199 gboolean gtk_text_iter_backward_visible_line  (GtkTextIter *iter);
 200 gboolean gtk_text_iter_forward_visible_lines  (GtkTextIter *iter,
 201                                                gint         count);
 202 gboolean gtk_text_iter_backward_visible_lines (GtkTextIter *iter,
 203                                                gint         count);
 204
 205 gboolean gtk_text_iter_forward_visible_word_end     (GtkTextIter *iter);
 206 gboolean gtk_text_iter_backward_visible_word_start  (GtkTextIter *iter);
 207 gboolean gtk_text_iter_forward_visible_word_ends    (GtkTextIter *iter,
 208                                              gint         count);
 209 gboolean gtk_text_iter_backward_visible_word_starts (GtkTextIter *iter,
 210                                              gint         count);
 211
 212 gboolean gtk_text_iter_forward_sentence_end     (GtkTextIter *iter);
 213 gboolean gtk_text_iter_backward_sentence_start  (GtkTextIter *iter);
 214 gboolean gtk_text_iter_forward_sentence_ends    (GtkTextIter *iter,
 215                                                  gint         count);
 216 gboolean gtk_text_iter_backward_sentence_starts (GtkTextIter *iter,
 217                                                  gint         count);
 218 /* cursor positions are almost equivalent to chars, but not quite;
 219  * in some languages, you can't put the cursor between certain
 220  * chars. Also, you can't put the cursor between \r\n at the end
 221  * of a line.
 222  */
 223 gboolean gtk_text_iter_forward_cursor_position   (GtkTextIter *iter);
 224 gboolean gtk_text_iter_backward_cursor_position  (GtkTextIter *iter);
 225 gboolean gtk_text_iter_forward_cursor_positions  (GtkTextIter *iter,
 226                                                   gint         count);
 227 gboolean gtk_text_iter_backward_cursor_positions (GtkTextIter *iter,
 228                                                   gint         count);
 229
 230 gboolean gtk_text_iter_forward_visible_cursor_position   (GtkTextIter *iter);
 231 gboolean gtk_text_iter_backward_visible_cursor_position  (GtkTextIter *iter);
 232 gboolean gtk_text_iter_forward_visible_cursor_positions  (GtkTextIter *iter,
 233                                                           gint         count);
 234 gboolean gtk_text_iter_backward_visible_cursor_positions (GtkTextIter *iter,
 235                                                           gint         count);
 236
 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 /*
 291  * Comparisons
 292  */
 293 gboolean gtk_text_iter_equal           (const GtkTextIter *lhs,
 294                                         const GtkTextIter *rhs);
 295 gint     gtk_text_iter_compare         (const GtkTextIter *lhs,
 296                                         const GtkTextIter *rhs);
 297 gboolean gtk_text_iter_in_range        (const GtkTextIter *iter,
 298                                         const GtkTextIter *start,
 299                                         const GtkTextIter *end);
 300
 301 /* Put these two in ascending order */
 302 void     gtk_text_iter_order           (GtkTextIter *first,
 303                                         GtkTextIter *second);
 304
 305 G_END_DECLS
 306
 307 #endif
 308
 309