gtktextbuffer.h 18 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 135
  /* Padding for future expansion */
  void (*_gtk_reserved1) (void);
  void (*_gtk_reserved2) (void);
  void (*_gtk_reserved3) (void);
  void (*_gtk_reserved4) (void);
  void (*_gtk_reserved5) (void);
  void (*_gtk_reserved6) (void);
136 137
};

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



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


148
GtkTextTagTable* gtk_text_buffer_get_tag_table (GtkTextBuffer  *buffer);
149

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

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

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

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

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


208 209 210

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

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

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

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

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

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

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

256
/* efficiently move insert and selection_bound at the same time */
257 258
void gtk_text_buffer_place_cursor (GtkTextBuffer     *buffer,
                                   const GtkTextIter *where);
259 260 261
void gtk_text_buffer_select_range (GtkTextBuffer     *buffer,
                                   const GtkTextIter *ins,
				   const GtkTextIter *bound);
262 263 264 265 266



/* Tag manipulation */
void gtk_text_buffer_apply_tag             (GtkTextBuffer     *buffer,
267
                                            GtkTextTag        *tag,
268 269
                                            const GtkTextIter *start,
                                            const GtkTextIter *end);
270
void gtk_text_buffer_remove_tag            (GtkTextBuffer     *buffer,
271
                                            GtkTextTag        *tag,
272 273
                                            const GtkTextIter *start,
                                            const GtkTextIter *end);
274 275
void gtk_text_buffer_apply_tag_by_name     (GtkTextBuffer     *buffer,
                                            const gchar       *name,
276 277
                                            const GtkTextIter *start,
                                            const GtkTextIter *end);
278
void gtk_text_buffer_remove_tag_by_name    (GtkTextBuffer     *buffer,
279
                                            const gchar       *name,
280 281
                                            const GtkTextIter *start,
                                            const GtkTextIter *end);
Havoc Pennington's avatar
Havoc Pennington committed
282 283 284
void gtk_text_buffer_remove_all_tags       (GtkTextBuffer     *buffer,
                                            const GtkTextIter *start,
                                            const GtkTextIter *end);
285 286 287


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

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

323 324 325
void gtk_text_buffer_get_iter_at_child_anchor (GtkTextBuffer      *buffer,
                                               GtkTextIter        *iter,
                                               GtkTextChildAnchor *anchor);
326 327 328 329 330 331 332 333 334 335

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

336
gboolean        gtk_text_buffer_get_modified            (GtkTextBuffer *buffer);
337 338
void            gtk_text_buffer_set_modified            (GtkTextBuffer *buffer,
                                                         gboolean       setting);
339

340 341 342 343 344
void gtk_text_buffer_add_selection_clipboard    (GtkTextBuffer     *buffer,
						 GtkClipboard      *clipboard);
void gtk_text_buffer_remove_selection_clipboard (GtkTextBuffer     *buffer,
						 GtkClipboard      *clipboard);

345
void            gtk_text_buffer_cut_clipboard           (GtkTextBuffer *buffer,
346
							 GtkClipboard  *clipboard,
347
                                                         gboolean       default_editable);
348 349
void            gtk_text_buffer_copy_clipboard          (GtkTextBuffer *buffer,
							 GtkClipboard  *clipboard);
350
void            gtk_text_buffer_paste_clipboard         (GtkTextBuffer *buffer,
351 352
							 GtkClipboard  *clipboard,
							 GtkTextIter   *override_location,
353
                                                         gboolean       default_editable);
354

355 356 357
gboolean        gtk_text_buffer_get_selection_bounds    (GtkTextBuffer *buffer,
                                                         GtkTextIter   *start,
                                                         GtkTextIter   *end);
358 359
gboolean        gtk_text_buffer_delete_selection        (GtkTextBuffer *buffer,
                                                         gboolean       interactive,
360
                                                         gboolean       default_editable);                                                    
361 362 363 364 365

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

366
/* INTERNAL private stuff */
367
void            _gtk_text_buffer_spew                  (GtkTextBuffer      *buffer);
368

369 370
GtkTextBTree*   _gtk_text_buffer_get_btree             (GtkTextBuffer      *buffer);

371 372 373 374
const PangoLogAttr* _gtk_text_buffer_get_line_log_attrs (GtkTextBuffer     *buffer,
                                                         const GtkTextIter *anywhere_in_line,
                                                         gint              *char_len);

375 376 377
void _gtk_text_buffer_notify_will_remove_tag (GtkTextBuffer *buffer,
                                              GtkTextTag    *tag);

378 379 380 381 382
#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif