gtktextbuffer.h 15.5 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
/* GTK - The GIMP Toolkit
 * gtktextbuffer.h Copyright (C) 2000 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12 13 14 15 16 17 18 19 20 21 22 23
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

/*
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
24
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
25 26
 */

27 28 29
#ifndef GTK_TEXT_BUFFER_H
#define GTK_TEXT_BUFFER_H

30 31 32 33
#include <gtk/gtkwidget.h>
#include <gtk/gtktexttagtable.h>
#include <gtk/gtktextiter.h>
#include <gtk/gtktextmark.h>
34
#include <gtk/gtktextchild.h>
35

36 37 38 39 40 41 42 43 44 45 46
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

/*
 * This is the PUBLIC representation of a text buffer.
 * GtkTextBTree is the PRIVATE internal representation of it.
 */

typedef struct _GtkTextBTree GtkTextBTree;

47
#define GTK_TYPE_TEXT_BUFFER            (gtk_text_buffer_get_type ())
48 49 50 51 52 53 54 55
#define GTK_TEXT_BUFFER(obj)            (GTK_CHECK_CAST ((obj), GTK_TYPE_TEXT_BUFFER, GtkTextBuffer))
#define GTK_TEXT_BUFFER_CLASS(klass)    (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_TEXT_BUFFER, GtkTextBufferClass))
#define GTK_IS_TEXT_BUFFER(obj)         (GTK_CHECK_TYPE ((obj), GTK_TYPE_TEXT_BUFFER))
#define GTK_IS_TEXT_BUFFER_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TEXT_BUFFER))
#define GTK_TEXT_BUFFER_GET_CLASS(obj)  (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_TEXT_BUFFER, GtkTextBufferClass))

typedef struct _GtkTextBufferClass GtkTextBufferClass;

56 57
struct _GtkTextBuffer
{
58 59 60
  GtkObject parent_instance;

  GtkTextTagTable *tag_table;
61
  GtkTextBTree *btree;
62

63 64
  GtkTextBuffer *clipboard_contents;
  
65
  /* Whether the buffer has been modified since last save */
66
  guint modified : 1;
67 68
};

69 70
struct _GtkTextBufferClass
{
71 72 73 74 75
  GtkObjectClass parent_class;

  void (* insert_text)     (GtkTextBuffer *buffer,
                            GtkTextIter *pos,
                            const gchar *text,
76 77
                            gint length,
                            gboolean interactive);
78 79 80 81


  void (* delete_text)     (GtkTextBuffer *buffer,
                            GtkTextIter *start,
82 83
                            GtkTextIter *end,
                            gboolean interactive);
84

85 86 87
  /* Only for text/widgets/pixbuf changed, marks/tags don't cause this
   * to be emitted
   */
88 89 90 91 92 93 94 95 96
  void (* changed)         (GtkTextBuffer *buffer);


  /* New value for the modified flag */
  void (* modified_changed)   (GtkTextBuffer *buffer);

  /* Mark moved or created */
  void (* mark_set)           (GtkTextBuffer *buffer,
                               const GtkTextIter *location,
97
                               GtkTextMark *mark);
98 99

  void (* mark_deleted)       (GtkTextBuffer *buffer,
100
                               GtkTextMark *mark);
101 102 103 104 105 106 107 108 109 110 111 112 113

  void (* apply_tag)          (GtkTextBuffer *buffer,
                               GtkTextTag *tag,
                               const GtkTextIter *start_char,
                               const GtkTextIter *end_char);

  void (* remove_tag)         (GtkTextBuffer *buffer,
                               GtkTextTag *tag,
                               const GtkTextIter *start_char,
                               const GtkTextIter *end_char);

};

Elliot Lee's avatar
Elliot Lee committed
114
GtkType        gtk_text_buffer_get_type       (void) G_GNUC_CONST;
115 116 117 118 119 120 121 122 123



/* table is NULL to create a new one */
GtkTextBuffer *gtk_text_buffer_new            (GtkTextTagTable *table);
gint           gtk_text_buffer_get_line_count (GtkTextBuffer   *buffer);
gint           gtk_text_buffer_get_char_count (GtkTextBuffer   *buffer);


124
GtkTextTagTable* gtk_text_buffer_get_tag_table (GtkTextBuffer  *buffer);
125

126 127 128 129 130
/* Delete whole buffer, then insert */
void gtk_text_buffer_set_text          (GtkTextBuffer *buffer,
                                        const gchar   *text,
                                        gint           len);

131 132 133 134 135 136 137 138 139
/* Insert into the buffer */
void gtk_text_buffer_insert            (GtkTextBuffer *buffer,
                                        GtkTextIter   *iter,
                                        const gchar   *text,
                                        gint           len);
void gtk_text_buffer_insert_at_cursor  (GtkTextBuffer *buffer,
                                        const gchar   *text,
                                        gint           len);

140 141 142 143 144 145 146 147 148
gboolean gtk_text_buffer_insert_interactive           (GtkTextBuffer *buffer,
                                                       GtkTextIter   *iter,
                                                       const gchar   *text,
                                                       gint           len,
                                                       gboolean       default_editable);
gboolean gtk_text_buffer_insert_interactive_at_cursor (GtkTextBuffer *buffer,
                                                       const gchar   *text,
                                                       gint           len,
                                                       gboolean       default_editable);
149

150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
void     gtk_text_buffer_insert_range             (GtkTextBuffer     *buffer,
                                                   GtkTextIter       *iter,
                                                   const GtkTextIter *start,
                                                   const GtkTextIter *end);
gboolean gtk_text_buffer_insert_range_interactive (GtkTextBuffer     *buffer,
                                                   GtkTextIter       *iter,
                                                   const GtkTextIter *start,
                                                   const GtkTextIter *end,
                                                   gboolean           default_editable);

void    gtk_text_buffer_insert_with_tags          (GtkTextBuffer     *buffer,
                                                   GtkTextIter       *iter,
                                                   const gchar       *text,
                                                   gint               len,
                                                   GtkTextTag        *first_tag,
                                                   ...);

void    gtk_text_buffer_insert_with_tags_by_name  (GtkTextBuffer     *buffer,
                                                   GtkTextIter       *iter,
                                                   const gchar       *text,
                                                   gint               len,
                                                   const gchar       *first_tag_name,
                                                   ...);
173 174

/* Delete from the buffer */
175
void     gtk_text_buffer_delete             (GtkTextBuffer *buffer,
176 177
                                             GtkTextIter   *start,
                                             GtkTextIter   *end);
178 179 180 181 182 183
gboolean gtk_text_buffer_delete_interactive (GtkTextBuffer *buffer,
                                             GtkTextIter   *start_iter,
                                             GtkTextIter   *end_iter,
                                             gboolean       default_editable);


184 185 186

/* Obtain strings from the buffer */
gchar          *gtk_text_buffer_get_text            (GtkTextBuffer     *buffer,
187 188
                                                     const GtkTextIter *start,
                                                     const GtkTextIter *end,
189
                                                     gboolean           include_hidden_chars);
190

191
gchar          *gtk_text_buffer_get_slice           (GtkTextBuffer     *buffer,
192 193
                                                     const GtkTextIter *start,
                                                     const GtkTextIter *end,
194 195
                                                     gboolean           include_hidden_chars);

Havoc Pennington's avatar
Havoc Pennington committed
196 197
/* Insert a pixbuf */
void gtk_text_buffer_insert_pixbuf         (GtkTextBuffer *buffer,
198
                                            GtkTextIter   *iter,
Havoc Pennington's avatar
Havoc Pennington committed
199
                                            GdkPixbuf     *pixbuf);
200

201 202 203 204
/* Create a child anchor */
GtkTextChildAnchor *gtk_text_buffer_create_child_anchor (GtkTextBuffer *buffer,
                                                         GtkTextIter   *iter);

205 206 207 208 209 210
/* Mark manipulation */
GtkTextMark   *gtk_text_buffer_create_mark (GtkTextBuffer     *buffer,
                                            const gchar       *mark_name,
                                            const GtkTextIter *where,
                                            gboolean           left_gravity);
void           gtk_text_buffer_move_mark   (GtkTextBuffer     *buffer,
211
                                            GtkTextMark       *mark,
212 213
                                            const GtkTextIter *where);
void           gtk_text_buffer_delete_mark (GtkTextBuffer     *buffer,
214
                                            GtkTextMark       *mark);
Havoc Pennington's avatar
Havoc Pennington committed
215
GtkTextMark*   gtk_text_buffer_get_mark    (GtkTextBuffer     *buffer,
216 217
                                            const gchar       *name);

218 219 220 221 222 223
void gtk_text_buffer_move_mark_by_name   (GtkTextBuffer     *buffer,
                                          const gchar       *name,
                                          const GtkTextIter *where);
void gtk_text_buffer_delete_mark_by_name (GtkTextBuffer     *buffer,
                                          const gchar       *name);

Havoc Pennington's avatar
Havoc Pennington committed
224 225 226
GtkTextMark* gtk_text_buffer_get_insert          (GtkTextBuffer *buffer);
GtkTextMark* gtk_text_buffer_get_selection_bound (GtkTextBuffer *buffer);

227 228 229 230 231 232 233 234
/* efficiently move insert and selection_bound to same location */
void gtk_text_buffer_place_cursor (GtkTextBuffer     *buffer,
                                   const GtkTextIter *where);



/* Tag manipulation */
void gtk_text_buffer_apply_tag             (GtkTextBuffer     *buffer,
235
                                            GtkTextTag        *tag,
236 237 238
                                            const GtkTextIter *start_index,
                                            const GtkTextIter *end_index);
void gtk_text_buffer_remove_tag            (GtkTextBuffer     *buffer,
239 240 241 242 243 244 245 246
                                            GtkTextTag        *tag,
                                            const GtkTextIter *start_index,
                                            const GtkTextIter *end_index);
void gtk_text_buffer_apply_tag_by_name     (GtkTextBuffer     *buffer,
                                            const gchar       *name,
                                            const GtkTextIter *start_index,
                                            const GtkTextIter *end_index);
void gtk_text_buffer_remove_tag_by_name    (GtkTextBuffer     *buffer,
247 248 249 250 251 252
                                            const gchar       *name,
                                            const GtkTextIter *start_index,
                                            const GtkTextIter *end_index);


/* You can either ignore the return value, or use it to
253 254
 * set the attributes of the tag. tag_name can be NULL
 */
255
/* FIXME this should take a varargs list of tag attributes I think */
256 257 258 259 260
GtkTextTag    *gtk_text_buffer_create_tag (GtkTextBuffer *buffer,
                                           const gchar   *tag_name);

/* Obtain iterators pointed at various places, then you can move the
   iterator around using the GtkTextIter operators */
261 262 263 264
void gtk_text_buffer_get_iter_at_line_offset (GtkTextBuffer *buffer,
                                              GtkTextIter   *iter,
                                              gint           line_number,
                                              gint           char_offset);
Havoc Pennington's avatar
Havoc Pennington committed
265 266 267 268
void gtk_text_buffer_get_iter_at_line_index  (GtkTextBuffer *buffer,
                                              GtkTextIter   *iter,
                                              gint           line_number,
                                              gint           byte_index);
269 270 271 272 273 274 275 276 277 278 279 280 281 282
void gtk_text_buffer_get_iter_at_offset      (GtkTextBuffer *buffer,
                                              GtkTextIter   *iter,
                                              gint           char_offset);
void gtk_text_buffer_get_iter_at_line        (GtkTextBuffer *buffer,
                                              GtkTextIter   *iter,
                                              gint           line_number);
void gtk_text_buffer_get_last_iter           (GtkTextBuffer *buffer,
                                              GtkTextIter   *iter);
void gtk_text_buffer_get_bounds              (GtkTextBuffer *buffer,
                                              GtkTextIter   *start,
                                              GtkTextIter   *end);
void gtk_text_buffer_get_iter_at_mark        (GtkTextBuffer *buffer,
                                              GtkTextIter   *iter,
                                              GtkTextMark   *mark);
283

284 285 286
void gtk_text_buffer_get_iter_at_child_anchor (GtkTextBuffer      *buffer,
                                               GtkTextIter        *iter,
                                               GtkTextChildAnchor *anchor);
287 288 289 290 291 292 293 294 295 296 297 298 299

/* There's no get_first_iter because you just get the iter for
   line or char 0 */

/* Used to keep track of whether the buffer needs saving; anytime the
   buffer contents change, the modified flag is turned on. Whenever
   you save, turn it off. Tags and marks do not affect the modified
   flag, but if you would like them to you can connect a handler to
   the tag/mark signals and call set_modified in your handler */

gboolean        gtk_text_buffer_modified                (GtkTextBuffer *buffer);
void            gtk_text_buffer_set_modified            (GtkTextBuffer *buffer,
                                                         gboolean       setting);
300

301 302 303
void            gtk_text_buffer_paste_primary           (GtkTextBuffer       *buffer,
                                                         const GtkTextIter   *override_location,
                                                         gboolean             default_editable);
304
void            gtk_text_buffer_cut_clipboard           (GtkTextBuffer *buffer,
305
                                                         gboolean       default_editable);
306
void            gtk_text_buffer_copy_clipboard          (GtkTextBuffer *buffer);
307
void            gtk_text_buffer_paste_clipboard         (GtkTextBuffer *buffer,
308
                                                         gboolean       default_editable);
309

310 311 312
gboolean        gtk_text_buffer_get_selection_bounds    (GtkTextBuffer *buffer,
                                                         GtkTextIter   *start,
                                                         GtkTextIter   *end);
313 314 315
gboolean        gtk_text_buffer_delete_selection        (GtkTextBuffer *buffer,
                                                         gboolean       interactive,
                                                         gboolean       default_editable);
316 317

/* INTERNAL private stuff */
318
void            _gtk_text_buffer_spew                  (GtkTextBuffer      *buffer);
319

320 321
GtkTextBTree*   _gtk_text_buffer_get_btree             (GtkTextBuffer      *buffer);

322 323 324 325 326
#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif