gtktextbuffer.h 19.1 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
2 3 4 5 6 7 8 9 10
 * 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
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
28 29 30
#error "Only <gtk/gtk.h> can be included directly."
#endif

31 32
#ifndef __GTK_TEXT_BUFFER_H__
#define __GTK_TEXT_BUFFER_H__
33

34
#include <gtk/gtkwidget.h>
35
#include <gtk/gtkclipboard.h>
36 37 38
#include <gtk/gtktexttagtable.h>
#include <gtk/gtktextiter.h>
#include <gtk/gtktextmark.h>
39
#include <gtk/gtktextchild.h>
40

41
G_BEGIN_DECLS
42 43 44 45 46 47

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

48 49
/* these values are used as "info" for the targets contained in the
 * lists returned by gtk_text_buffer_get_copy,paste_target_list()
50 51 52
 *
 * the enum counts down from G_MAXUINT to avoid clashes with application
 * added drag destinations which usually start at 0.
53 54 55
 */
typedef enum
{
56 57 58
  GTK_TEXT_BUFFER_TARGET_INFO_BUFFER_CONTENTS = - 1,
  GTK_TEXT_BUFFER_TARGET_INFO_RICH_TEXT       = - 2,
  GTK_TEXT_BUFFER_TARGET_INFO_TEXT            = - 3
59 60
} GtkTextBufferTargetInfo;

61 62
typedef struct _GtkTextBTree GtkTextBTree;

63 64
typedef struct _GtkTextLogAttrCache GtkTextLogAttrCache;

65
#define GTK_TYPE_TEXT_BUFFER            (gtk_text_buffer_get_type ())
66 67 68 69 70
#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))
71 72 73

typedef struct _GtkTextBufferClass GtkTextBufferClass;

74 75
struct _GtkTextBuffer
{
76
  GObject parent_instance;
77

Tim Janik's avatar
Tim Janik committed
78 79
  GtkTextTagTable *GSEAL (tag_table);
  GtkTextBTree *GSEAL (btree);
80

Tim Janik's avatar
Tim Janik committed
81 82
  GSList *GSEAL (clipboard_contents_buffers);
  GSList *GSEAL (selection_clipboards);
83

Tim Janik's avatar
Tim Janik committed
84
  GtkTextLogAttrCache *GSEAL (log_attr_cache);
85

Tim Janik's avatar
Tim Janik committed
86
  guint GSEAL (user_action_count);
87

88
  /* Whether the buffer has been modified since last save */
89
  guint GSEAL (modified) : 1;
90

91
  guint GSEAL (has_selection) : 1;
92 93
};

94 95
struct _GtkTextBufferClass
{
96
  GObjectClass parent_class;
97 98 99 100

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

103 104 105
  void (* insert_pixbuf)   (GtkTextBuffer *buffer,
                            GtkTextIter   *pos,
                            GdkPixbuf     *pixbuf);
106

107 108
  void (* insert_child_anchor)   (GtkTextBuffer      *buffer,
                                  GtkTextIter        *pos,
109
                                  GtkTextChildAnchor *anchor);
110

111 112 113
  void (* delete_range)     (GtkTextBuffer *buffer,
                             GtkTextIter   *start,
                             GtkTextIter   *end);
114

115 116 117
  /* Only for text/widgets/pixbuf changed, marks/tags don't cause this
   * to be emitted
   */
118 119 120 121 122 123 124 125 126
  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,
127
                               GtkTextMark *mark);
128 129

  void (* mark_deleted)       (GtkTextBuffer *buffer,
130
                               GtkTextMark *mark);
131 132 133 134 135 136 137 138 139 140 141

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

142 143 144
  /* Called at the start and end of an atomic user action */
  void (* begin_user_action)  (GtkTextBuffer *buffer);
  void (* end_user_action)    (GtkTextBuffer *buffer);
145

146 147 148
  void (* paste_done)         (GtkTextBuffer *buffer,
                               GtkClipboard  *clipboard);

149 150 151 152 153 154
  /* Padding for future expansion */
  void (*_gtk_reserved1) (void);
  void (*_gtk_reserved2) (void);
  void (*_gtk_reserved3) (void);
  void (*_gtk_reserved4) (void);
  void (*_gtk_reserved5) (void);
155 156
};

157
GType        gtk_text_buffer_get_type       (void) G_GNUC_CONST;
158 159 160 161 162 163 164 165 166



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


167
GtkTextTagTable* gtk_text_buffer_get_tag_table (GtkTextBuffer  *buffer);
168

169 170 171 172 173
/* Delete whole buffer, then insert */
void gtk_text_buffer_set_text          (GtkTextBuffer *buffer,
                                        const gchar   *text,
                                        gint           len);

174 175 176 177 178 179 180 181 182
/* 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);

183 184 185 186 187 188 189 190 191
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);
192

193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
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,
208
                                                   ...) G_GNUC_NULL_TERMINATED;
209 210 211 212 213 214

void    gtk_text_buffer_insert_with_tags_by_name  (GtkTextBuffer     *buffer,
                                                   GtkTextIter       *iter,
                                                   const gchar       *text,
                                                   gint               len,
                                                   const gchar       *first_tag_name,
215
                                                   ...) G_GNUC_NULL_TERMINATED;
216 217

/* Delete from the buffer */
218
void     gtk_text_buffer_delete             (GtkTextBuffer *buffer,
Owen Taylor's avatar
Owen Taylor committed
219 220
					     GtkTextIter   *start,
					     GtkTextIter   *end);
221
gboolean gtk_text_buffer_delete_interactive (GtkTextBuffer *buffer,
Owen Taylor's avatar
Owen Taylor committed
222 223 224 225 226 227 228
					     GtkTextIter   *start_iter,
					     GtkTextIter   *end_iter,
					     gboolean       default_editable);
gboolean gtk_text_buffer_backspace          (GtkTextBuffer *buffer,
					     GtkTextIter   *iter,
					     gboolean       interactive,
					     gboolean       default_editable);
229 230 231

/* Obtain strings from the buffer */
gchar          *gtk_text_buffer_get_text            (GtkTextBuffer     *buffer,
232 233
                                                     const GtkTextIter *start,
                                                     const GtkTextIter *end,
234
                                                     gboolean           include_hidden_chars);
235

236
gchar          *gtk_text_buffer_get_slice           (GtkTextBuffer     *buffer,
237 238
                                                     const GtkTextIter *start,
                                                     const GtkTextIter *end,
239 240
                                                     gboolean           include_hidden_chars);

Havoc Pennington's avatar
Havoc Pennington committed
241 242
/* Insert a pixbuf */
void gtk_text_buffer_insert_pixbuf         (GtkTextBuffer *buffer,
243
                                            GtkTextIter   *iter,
Havoc Pennington's avatar
Havoc Pennington committed
244
                                            GdkPixbuf     *pixbuf);
245

246 247 248 249 250 251
/* Insert a child anchor */
void               gtk_text_buffer_insert_child_anchor (GtkTextBuffer      *buffer,
                                                        GtkTextIter        *iter,
                                                        GtkTextChildAnchor *anchor);

/* Convenience, create and insert a child anchor */
252 253 254
GtkTextChildAnchor *gtk_text_buffer_create_child_anchor (GtkTextBuffer *buffer,
                                                         GtkTextIter   *iter);

255
/* Mark manipulation */
256 257 258
void           gtk_text_buffer_add_mark    (GtkTextBuffer     *buffer,
                                            GtkTextMark       *mark,
                                            const GtkTextIter *where);
259 260 261 262 263
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,
264
                                            GtkTextMark       *mark,
265 266
                                            const GtkTextIter *where);
void           gtk_text_buffer_delete_mark (GtkTextBuffer     *buffer,
267
                                            GtkTextMark       *mark);
Havoc Pennington's avatar
Havoc Pennington committed
268
GtkTextMark*   gtk_text_buffer_get_mark    (GtkTextBuffer     *buffer,
269 270
                                            const gchar       *name);

271 272 273 274 275 276
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
277 278 279
GtkTextMark* gtk_text_buffer_get_insert          (GtkTextBuffer *buffer);
GtkTextMark* gtk_text_buffer_get_selection_bound (GtkTextBuffer *buffer);

280
/* efficiently move insert and selection_bound at the same time */
281 282
void gtk_text_buffer_place_cursor (GtkTextBuffer     *buffer,
                                   const GtkTextIter *where);
283 284 285
void gtk_text_buffer_select_range (GtkTextBuffer     *buffer,
                                   const GtkTextIter *ins,
				   const GtkTextIter *bound);
286 287 288 289 290



/* Tag manipulation */
void gtk_text_buffer_apply_tag             (GtkTextBuffer     *buffer,
291
                                            GtkTextTag        *tag,
292 293
                                            const GtkTextIter *start,
                                            const GtkTextIter *end);
294
void gtk_text_buffer_remove_tag            (GtkTextBuffer     *buffer,
295
                                            GtkTextTag        *tag,
296 297
                                            const GtkTextIter *start,
                                            const GtkTextIter *end);
298 299
void gtk_text_buffer_apply_tag_by_name     (GtkTextBuffer     *buffer,
                                            const gchar       *name,
300 301
                                            const GtkTextIter *start,
                                            const GtkTextIter *end);
302
void gtk_text_buffer_remove_tag_by_name    (GtkTextBuffer     *buffer,
303
                                            const gchar       *name,
304 305
                                            const GtkTextIter *start,
                                            const GtkTextIter *end);
Havoc Pennington's avatar
Havoc Pennington committed
306 307 308
void gtk_text_buffer_remove_all_tags       (GtkTextBuffer     *buffer,
                                            const GtkTextIter *start,
                                            const GtkTextIter *end);
309 310 311


/* You can either ignore the return value, or use it to
312 313
 * set the attributes of the tag. tag_name can be NULL
 */
314
GtkTextTag    *gtk_text_buffer_create_tag (GtkTextBuffer *buffer,
315 316
                                           const gchar   *tag_name,
                                           const gchar   *first_property_name,
317
                                           ...);
318 319

/* Obtain iterators pointed at various places, then you can move the
320 321
 * iterator around using the GtkTextIter operators
 */
322 323 324 325
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
326 327 328 329
void gtk_text_buffer_get_iter_at_line_index  (GtkTextBuffer *buffer,
                                              GtkTextIter   *iter,
                                              gint           line_number,
                                              gint           byte_index);
330 331 332 333 334 335
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
336 337
void gtk_text_buffer_get_start_iter          (GtkTextBuffer *buffer,
                                              GtkTextIter   *iter);
338
void gtk_text_buffer_get_end_iter            (GtkTextBuffer *buffer,
339 340 341 342 343 344 345
                                              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);
346

347 348 349
void gtk_text_buffer_get_iter_at_child_anchor (GtkTextBuffer      *buffer,
                                               GtkTextIter        *iter,
                                               GtkTextChildAnchor *anchor);
350 351 352 353 354 355 356 357 358 359

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

360
gboolean        gtk_text_buffer_get_modified            (GtkTextBuffer *buffer);
361 362
void            gtk_text_buffer_set_modified            (GtkTextBuffer *buffer,
                                                         gboolean       setting);
363

364 365
gboolean        gtk_text_buffer_get_has_selection       (GtkTextBuffer *buffer);

366 367 368 369 370
void gtk_text_buffer_add_selection_clipboard    (GtkTextBuffer     *buffer,
						 GtkClipboard      *clipboard);
void gtk_text_buffer_remove_selection_clipboard (GtkTextBuffer     *buffer,
						 GtkClipboard      *clipboard);

371
void            gtk_text_buffer_cut_clipboard           (GtkTextBuffer *buffer,
372
							 GtkClipboard  *clipboard,
373
                                                         gboolean       default_editable);
374 375
void            gtk_text_buffer_copy_clipboard          (GtkTextBuffer *buffer,
							 GtkClipboard  *clipboard);
376
void            gtk_text_buffer_paste_clipboard         (GtkTextBuffer *buffer,
377 378
							 GtkClipboard  *clipboard,
							 GtkTextIter   *override_location,
379
                                                         gboolean       default_editable);
380

381 382 383
gboolean        gtk_text_buffer_get_selection_bounds    (GtkTextBuffer *buffer,
                                                         GtkTextIter   *start,
                                                         GtkTextIter   *end);
384 385
gboolean        gtk_text_buffer_delete_selection        (GtkTextBuffer *buffer,
                                                         gboolean       interactive,
386
                                                         gboolean       default_editable);
387 388 389 390 391

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

392 393 394
GtkTargetList * gtk_text_buffer_get_copy_target_list    (GtkTextBuffer *buffer);
GtkTargetList * gtk_text_buffer_get_paste_target_list   (GtkTextBuffer *buffer);

395
/* INTERNAL private stuff */
396
void            _gtk_text_buffer_spew                  (GtkTextBuffer      *buffer);
397

398 399
GtkTextBTree*   _gtk_text_buffer_get_btree             (GtkTextBuffer      *buffer);

400 401 402 403
const PangoLogAttr* _gtk_text_buffer_get_line_log_attrs (GtkTextBuffer     *buffer,
                                                         const GtkTextIter *anywhere_in_line,
                                                         gint              *char_len);

404 405 406
void _gtk_text_buffer_notify_will_remove_tag (GtkTextBuffer *buffer,
                                              GtkTextTag    *tag);

407
G_END_DECLS
408 409

#endif