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
  82 /*
  83  * "Dereference" operators
  84  */
  85 gunichar gtk_text_iter_get_char          (const GtkTextIter  *iter);
  86
  87 /* includes the 0xFFFC char for pixmaps/widgets, so char offsets
  88  * into the returned string map properly into buffer char offsets
  89  */
  90 gchar   *gtk_text_iter_get_slice         (const GtkTextIter  *start,
  91                                           const GtkTextIter  *end);
  92
  93 /* includes only text, no 0xFFFC */
  94 gchar   *gtk_text_iter_get_text          (const GtkTextIter  *start,
  95                                           const GtkTextIter  *end);
  96 /* exclude invisible chars */
  97 gchar   *gtk_text_iter_get_visible_slice (const GtkTextIter  *start,
  98                                           const GtkTextIter  *end);
  99 gchar   *gtk_text_iter_get_visible_text  (const GtkTextIter  *start,
 100                                           const GtkTextIter  *end);
 101
 102 GdkPixbuf* gtk_text_iter_get_pixbuf (const GtkTextIter *iter);
 103 GSList  *  gtk_text_iter_get_marks  (const GtkTextIter *iter);
 104
 105 GtkTextChildAnchor* gtk_text_iter_get_child_anchor (const GtkTextIter *iter);
 106
 107 /* Return list of tags toggled at this point (toggled_on determines
 108    whether the list is of on-toggles or off-toggles) */
 109 GSList  *gtk_text_iter_get_toggled_tags  (const GtkTextIter  *iter,
 110                                           gboolean             toggled_on);
 111
 112 gboolean gtk_text_iter_begins_tag        (const GtkTextIter  *iter,
 113                                           GtkTextTag         *tag);
 114
 115 gboolean gtk_text_iter_ends_tag          (const GtkTextIter  *iter,
 116                                           GtkTextTag         *tag);
 117
 118 gboolean gtk_text_iter_toggles_tag       (const GtkTextIter  *iter,
 119                                           GtkTextTag         *tag);
 120
 121 gboolean gtk_text_iter_has_tag           (const GtkTextIter   *iter,
 122                                           GtkTextTag          *tag);
 123 GSList  *gtk_text_iter_get_tags          (const GtkTextIter   *iter);
 124
 125 gboolean gtk_text_iter_editable          (const GtkTextIter   *iter,
 126                                           gboolean             default_setting);
 127
 128 gboolean gtk_text_iter_starts_word        (const GtkTextIter   *iter);
 129 gboolean gtk_text_iter_ends_word          (const GtkTextIter   *iter);
 130 gboolean gtk_text_iter_inside_word        (const GtkTextIter   *iter);
 131 gboolean gtk_text_iter_starts_line        (const GtkTextIter   *iter);
 132 gboolean gtk_text_iter_ends_line          (const GtkTextIter   *iter);
 133 gboolean gtk_text_iter_is_cursor_position (const GtkTextIter   *iter);
 134
 135 gint     gtk_text_iter_get_chars_in_line (const GtkTextIter   *iter);
 136 gint     gtk_text_iter_get_bytes_in_line (const GtkTextIter   *iter);
 137
 138 gboolean gtk_text_iter_get_attributes    (const GtkTextIter    *iter,
 139                                           GtkTextAttributes    *values);
 140 gchar*   gtk_text_iter_get_language      (const GtkTextIter    *iter);
 141 gboolean gtk_text_iter_is_last           (const GtkTextIter    *iter);
 142 gboolean gtk_text_iter_is_first          (const GtkTextIter    *iter);
 143
 144 /*
 145  * Moving around the buffer
 146  */
 147
 148 gboolean gtk_text_iter_forward_char         (GtkTextIter *iter);
 149 gboolean gtk_text_iter_backward_char        (GtkTextIter *iter);
 150 gboolean gtk_text_iter_forward_chars        (GtkTextIter *iter,
 151                                              gint         count);
 152 gboolean gtk_text_iter_backward_chars       (GtkTextIter *iter,
 153                                              gint         count);
 154 gboolean gtk_text_iter_forward_line         (GtkTextIter *iter);
 155 gboolean gtk_text_iter_backward_line        (GtkTextIter *iter);
 156 gboolean gtk_text_iter_forward_lines        (GtkTextIter *iter,
 157                                              gint         count);
 158 gboolean gtk_text_iter_backward_lines       (GtkTextIter *iter,
 159                                              gint         count);
 160 gboolean gtk_text_iter_forward_word_end     (GtkTextIter *iter);
 161 gboolean gtk_text_iter_backward_word_start  (GtkTextIter *iter);
 162 gboolean gtk_text_iter_forward_word_ends    (GtkTextIter *iter,
 163                                              gint         count);
 164 gboolean gtk_text_iter_backward_word_starts (GtkTextIter *iter,
 165                                              gint         count);
 166 /* cursor positions are almost equivalent to chars, but not quite;
 167  * in some languages, you can't put the cursor between certain
 168  * chars. Also, you can't put the cursor between \r\n at the end
 169  * of a line.
 170  */
 171 gboolean gtk_text_iter_forward_cursor_position   (GtkTextIter *iter);
 172 gboolean gtk_text_iter_backward_cursor_position  (GtkTextIter *iter);
 173 gboolean gtk_text_iter_forward_cursor_positions  (GtkTextIter *iter,
 174                                                   gint         count);
 175 gboolean gtk_text_iter_backward_cursor_positions (GtkTextIter *iter,
 176                                                   gint         count);
 177
 178
 179 void     gtk_text_iter_set_offset         (GtkTextIter *iter,
 180                                            gint         char_offset);
 181 void     gtk_text_iter_set_line           (GtkTextIter *iter,
 182                                            gint         line_number);
 183 void     gtk_text_iter_set_line_offset    (GtkTextIter *iter,
 184                                            gint         char_on_line);
 185 void     gtk_text_iter_set_line_index     (GtkTextIter *iter,
 186                                            gint         byte_on_line);
 187 void     gtk_text_iter_forward_to_end     (GtkTextIter *iter);
 188 gboolean gtk_text_iter_forward_to_delimiters (GtkTextIter *iter);
 189
 190
 191 /* returns TRUE if a toggle was found; NULL for the tag pointer
 192  * means "any tag toggle", otherwise the next toggle of the
 193  * specified tag is located.
 194  */
 195 gboolean gtk_text_iter_forward_to_tag_toggle (GtkTextIter *iter,
 196                                               GtkTextTag  *tag);
 197
 198 gboolean gtk_text_iter_backward_to_tag_toggle (GtkTextIter *iter,
 199                                                GtkTextTag  *tag);
 200
 201 typedef gboolean (* GtkTextCharPredicate) (gunichar ch, gpointer user_data);
 202
 203 gboolean gtk_text_iter_forward_find_char  (GtkTextIter          *iter,
 204                                            GtkTextCharPredicate  pred,
 205                                            gpointer              user_data,
 206                                            const GtkTextIter    *limit);
 207 gboolean gtk_text_iter_backward_find_char (GtkTextIter          *iter,
 208                                            GtkTextCharPredicate  pred,
 209                                            gpointer              user_data,
 210                                            const GtkTextIter    *limit);
 211
 212 gboolean gtk_text_iter_forward_search  (const GtkTextIter *iter,
 213                                         const gchar       *str,
 214                                         gboolean           visible_only,
 215                                         gboolean           slice,
 216                                         GtkTextIter       *match_start,
 217                                         GtkTextIter       *match_end,
 218                                         const GtkTextIter *limit);
 219
 220 gboolean gtk_text_iter_backward_search (const GtkTextIter *iter,
 221                                         const gchar       *str,
 222                                         gboolean           visible_only,
 223                                         gboolean           slice,
 224                                         GtkTextIter       *match_start,
 225                                         GtkTextIter       *match_end,
 226                                         const GtkTextIter *limit);
 227
 228
 229 /*
 230  * Comparisons
 231  */
 232 gboolean gtk_text_iter_equal           (const GtkTextIter *lhs,
 233                                         const GtkTextIter *rhs);
 234 gint     gtk_text_iter_compare         (const GtkTextIter *lhs,
 235                                         const GtkTextIter *rhs);
 236 gboolean gtk_text_iter_in_range        (const GtkTextIter *iter,
 237                                         const GtkTextIter *start,
 238                                         const GtkTextIter *end);
 239
 240 /* Put these two in ascending order */
 241 void     gtk_text_iter_reorder         (GtkTextIter *first,
 242                                         GtkTextIter *second);
 243
 244 /* Debug */
 245 void     gtk_text_iter_spew            (const GtkTextIter *iter,
 246                                         const gchar *desc);
 247
 248 #ifdef __cplusplus
 249 }
 250 #endif /* __cplusplus */
 251
 252 #endif
 253
 254