gtktextbuffer.h 17.7 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
#include <gtk/gtkwidget.h>
31
#include <gtk/gtkclipboard.h>
32 33 34
#include <gtk/gtktexttagtable.h>
#include <gtk/gtktextiter.h>
#include <gtk/gtktextmark.h>
35
#include <gtk/gtktextchild.h>
36

37 38 39 40 41 42 43 44 45 46 47
#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;

48 49
typedef struct _GtkTextLogAttrCache GtkTextLogAttrCache;

50
#define GTK_TYPE_TEXT_BUFFER            (gtk_text_buffer_get_type ())
51 52 53 54 55
#define GTK_TEXT_BUFFER(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TEXT_BUFFER, GtkTextBuffer))
#define GTK_TEXT_BUFFER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TEXT_BUFFER, GtkTextBufferClass))
#define GTK_IS_TEXT_BUFFER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TEXT_BUFFER))
#define GTK_IS_TEXT_BUFFER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TEXT_BUFFER))
#define GTK_TEXT_BUFFER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TEXT_BUFFER, GtkTextBufferClass))
56 57 58

typedef struct _GtkTextBufferClass GtkTextBufferClass;

59 60
struct _GtkTextBuffer
{
61
  GObject parent_instance;
62 63

  GtkTextTagTable *tag_table;
64
  GtkTextBTree *btree;
65

66 67
  GSList *clipboard_contents_buffers;
  GSList *selection_clipboards;
68 69

  GtkTextLogAttrCache *log_attr_cache;
70 71

  guint user_action_count;
72
  
73
  /* Whether the buffer has been modified since last save */
74
  guint modified : 1;
75 76
};

77 78
struct _GtkTextBufferClass
{
79
  GObjectClass parent_class;
80 81 82 83

  void (* insert_text)     (GtkTextBuffer *buffer,
                            GtkTextIter *pos,
                            const gchar *text,
84
                            gint length);
85

86 87 88
  void (* insert_pixbuf)   (GtkTextBuffer *buffer,
                            GtkTextIter   *pos,
                            GdkPixbuf     *pixbuf);
89

90 91
  void (* insert_child_anchor)   (GtkTextBuffer      *buffer,
                                  GtkTextIter        *pos,
92 93 94 95 96
                                  GtkTextChildAnchor *anchor);
  
  void (* delete_range)     (GtkTextBuffer *buffer,
                             GtkTextIter   *start,
                             GtkTextIter   *end);
97

98 99 100
  /* Only for text/widgets/pixbuf changed, marks/tags don't cause this
   * to be emitted
   */
101 102 103 104 105 106 107 108 109
  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,
110
                               GtkTextMark *mark);
111 112

  void (* mark_deleted)       (GtkTextBuffer *buffer,
113
                               GtkTextMark *mark);
114 115 116 117 118 119 120 121 122 123 124

  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);

125 126 127
  /* Called at the start and end of an atomic user action */
  void (* begin_user_action)  (GtkTextBuffer *buffer);
  void (* end_user_action)    (GtkTextBuffer *buffer);
128 129 130 131 132 133 134

  GtkFunction pad1;
  GtkFunction pad2;
  GtkFunction pad3;
  GtkFunction pad4;
  GtkFunction pad5;
  GtkFunction pad6;
135 136
};

137
GType        gtk_text_buffer_get_type       (void) G_GNUC_CONST;
138 139 140 141 142 143 144 145 146



/* 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);


147
GtkTextTagTable* gtk_text_buffer_get_tag_table (GtkTextBuffer  *buffer);
148

149 150 151 152 153
/* Delete whole buffer, then insert */
void gtk_text_buffer_set_text          (GtkTextBuffer *buffer,
                                        const gchar   *text,
                                        gint           len);

154 155 156 157 158 159 160 161 162
/* 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);

163 164 165 166 167 168 169 170 171
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);
172

173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
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,
                                                   ...);
196 197

/* Delete from the buffer */
198
void     gtk_text_buffer_delete             (GtkTextBuffer *buffer,
199 200
                                             GtkTextIter   *start,
                                             GtkTextIter   *end);
201 202 203 204 205 206
gboolean gtk_text_buffer_delete_interactive (GtkTextBuffer *buffer,
                                             GtkTextIter   *start_iter,
                                             GtkTextIter   *end_iter,
                                             gboolean       default_editable);


207 208 209

/* Obtain strings from the buffer */
gchar          *gtk_text_buffer_get_text            (GtkTextBuffer     *buffer,
210 211
                                                     const GtkTextIter *start,
                                                     const GtkTextIter *end,
212
                                                     gboolean           include_hidden_chars);
213

214
gchar          *gtk_text_buffer_get_slice           (GtkTextBuffer     *buffer,
215 216
                                                     const GtkTextIter *start,
                                                     const GtkTextIter *end,
217 218
                                                     gboolean           include_hidden_chars);

Havoc Pennington's avatar
Havoc Pennington committed
219 220
/* Insert a pixbuf */
void gtk_text_buffer_insert_pixbuf         (GtkTextBuffer *buffer,
221
                                            GtkTextIter   *iter,
Havoc Pennington's avatar
Havoc Pennington committed
222
                                            GdkPixbuf     *pixbuf);
223

224 225 226 227 228 229
/* Insert a child anchor */
void               gtk_text_buffer_insert_child_anchor (GtkTextBuffer      *buffer,
                                                        GtkTextIter        *iter,
                                                        GtkTextChildAnchor *anchor);

/* Convenience, create and insert a child anchor */
230 231 232
GtkTextChildAnchor *gtk_text_buffer_create_child_anchor (GtkTextBuffer *buffer,
                                                         GtkTextIter   *iter);

233 234 235 236 237 238
/* 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,
239
                                            GtkTextMark       *mark,
240 241
                                            const GtkTextIter *where);
void           gtk_text_buffer_delete_mark (GtkTextBuffer     *buffer,
242
                                            GtkTextMark       *mark);
Havoc Pennington's avatar
Havoc Pennington committed
243
GtkTextMark*   gtk_text_buffer_get_mark    (GtkTextBuffer     *buffer,
244 245
                                            const gchar       *name);

246 247 248 249 250 251
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
252 253 254
GtkTextMark* gtk_text_buffer_get_insert          (GtkTextBuffer *buffer);
GtkTextMark* gtk_text_buffer_get_selection_bound (GtkTextBuffer *buffer);

255 256 257 258 259 260 261 262
/* 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,
263
                                            GtkTextTag        *tag,
264 265
                                            const GtkTextIter *start,
                                            const GtkTextIter *end);
266
void gtk_text_buffer_remove_tag            (GtkTextBuffer     *buffer,
267
                                            GtkTextTag        *tag,
268 269
                                            const GtkTextIter *start,
                                            const GtkTextIter *end);
270 271
void gtk_text_buffer_apply_tag_by_name     (GtkTextBuffer     *buffer,
                                            const gchar       *name,
272 273
                                            const GtkTextIter *start,
                                            const GtkTextIter *end);
274
void gtk_text_buffer_remove_tag_by_name    (GtkTextBuffer     *buffer,
275
                                            const gchar       *name,
276 277
                                            const GtkTextIter *start,
                                            const GtkTextIter *end);
Havoc Pennington's avatar
Havoc Pennington committed
278 279 280
void gtk_text_buffer_remove_all_tags       (GtkTextBuffer     *buffer,
                                            const GtkTextIter *start,
                                            const GtkTextIter *end);
281 282 283


/* You can either ignore the return value, or use it to
284 285
 * set the attributes of the tag. tag_name can be NULL
 */
286
GtkTextTag    *gtk_text_buffer_create_tag (GtkTextBuffer *buffer,
287 288 289
                                           const gchar   *tag_name,
                                           const gchar   *first_property_name,
                                           ...);
290 291

/* Obtain iterators pointed at various places, then you can move the
292 293
 * iterator around using the GtkTextIter operators
 */
294 295 296 297
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
298 299 300 301
void gtk_text_buffer_get_iter_at_line_index  (GtkTextBuffer *buffer,
                                              GtkTextIter   *iter,
                                              gint           line_number,
                                              gint           byte_index);
302 303 304 305 306 307
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);
Havoc Pennington's avatar
Havoc Pennington committed
308 309
void gtk_text_buffer_get_start_iter          (GtkTextBuffer *buffer,
                                              GtkTextIter   *iter);
310
void gtk_text_buffer_get_end_iter            (GtkTextBuffer *buffer,
311 312 313 314 315 316 317
                                              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);
318

319 320 321
void gtk_text_buffer_get_iter_at_child_anchor (GtkTextBuffer      *buffer,
                                               GtkTextIter        *iter,
                                               GtkTextChildAnchor *anchor);
322 323 324 325 326 327 328 329 330 331

/* 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 */

332
gboolean        gtk_text_buffer_get_modified            (GtkTextBuffer *buffer);
333 334
void            gtk_text_buffer_set_modified            (GtkTextBuffer *buffer,
                                                         gboolean       setting);
335

336 337 338 339 340
void gtk_text_buffer_add_selection_clipboard    (GtkTextBuffer     *buffer,
						 GtkClipboard      *clipboard);
void gtk_text_buffer_remove_selection_clipboard (GtkTextBuffer     *buffer,
						 GtkClipboard      *clipboard);

341
void            gtk_text_buffer_cut_clipboard           (GtkTextBuffer *buffer,
342
							 GtkClipboard  *clipboard,
343
                                                         gboolean       default_editable);
344 345
void            gtk_text_buffer_copy_clipboard          (GtkTextBuffer *buffer,
							 GtkClipboard  *clipboard);
346
void            gtk_text_buffer_paste_clipboard         (GtkTextBuffer *buffer,
347 348
							 GtkClipboard  *clipboard,
							 GtkTextIter   *override_location,
349
                                                         gboolean       default_editable);
350

351 352 353
gboolean        gtk_text_buffer_get_selection_bounds    (GtkTextBuffer *buffer,
                                                         GtkTextIter   *start,
                                                         GtkTextIter   *end);
354 355
gboolean        gtk_text_buffer_delete_selection        (GtkTextBuffer *buffer,
                                                         gboolean       interactive,
356
                                                         gboolean       default_editable);                                                    
357 358 359 360 361

/* Called to specify atomic user actions, used to implement undo */
void            gtk_text_buffer_begin_user_action       (GtkTextBuffer *buffer);
void            gtk_text_buffer_end_user_action         (GtkTextBuffer *buffer);

362
/* INTERNAL private stuff */
363
void            _gtk_text_buffer_spew                  (GtkTextBuffer      *buffer);
364

365 366
GtkTextBTree*   _gtk_text_buffer_get_btree             (GtkTextBuffer      *buffer);

367 368 369 370
const PangoLogAttr* _gtk_text_buffer_get_line_log_attrs (GtkTextBuffer     *buffer,
                                                         const GtkTextIter *anywhere_in_line,
                                                         gint              *char_len);

371 372 373
void _gtk_text_buffer_notify_will_remove_tag (GtkTextBuffer *buffer,
                                              GtkTextTag    *tag);

374 375 376 377 378
#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif