gtktextbuffer.h 17.2 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 48
typedef struct _GtkTextLogAttrCache GtkTextLogAttrCache;

49
#define GTK_TYPE_TEXT_BUFFER            (gtk_text_buffer_get_type ())
50 51 52 53 54
#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))
55 56 57

typedef struct _GtkTextBufferClass GtkTextBufferClass;

58 59
struct _GtkTextBuffer
{
60
  GObject parent_instance;
61 62

  GtkTextTagTable *tag_table;
63
  GtkTextBTree *btree;
64

65
  GtkTextBuffer *clipboard_contents;
66 67

  GtkTextLogAttrCache *log_attr_cache;
68 69

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

75 76
struct _GtkTextBufferClass
{
77
  GObjectClass parent_class;
78 79 80 81

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

84 85 86
  void (* insert_pixbuf)   (GtkTextBuffer *buffer,
                            GtkTextIter   *pos,
                            GdkPixbuf     *pixbuf);
87

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

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

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

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

123 124 125
  /* Called at the start and end of an atomic user action */
  void (* begin_user_action)  (GtkTextBuffer *buffer);
  void (* end_user_action)    (GtkTextBuffer *buffer);
126 127
};

128
GType        gtk_text_buffer_get_type       (void) G_GNUC_CONST;
129 130 131 132 133 134 135 136 137



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


138
GtkTextTagTable* gtk_text_buffer_get_tag_table (GtkTextBuffer  *buffer);
139

140 141 142 143 144
/* Delete whole buffer, then insert */
void gtk_text_buffer_set_text          (GtkTextBuffer *buffer,
                                        const gchar   *text,
                                        gint           len);

145 146 147 148 149 150 151 152 153
/* 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);

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

164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
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,
                                                   ...);
187 188

/* Delete from the buffer */
189
void     gtk_text_buffer_delete             (GtkTextBuffer *buffer,
190 191
                                             GtkTextIter   *start,
                                             GtkTextIter   *end);
192 193 194 195 196 197
gboolean gtk_text_buffer_delete_interactive (GtkTextBuffer *buffer,
                                             GtkTextIter   *start_iter,
                                             GtkTextIter   *end_iter,
                                             gboolean       default_editable);


198 199 200

/* Obtain strings from the buffer */
gchar          *gtk_text_buffer_get_text            (GtkTextBuffer     *buffer,
201 202
                                                     const GtkTextIter *start,
                                                     const GtkTextIter *end,
203
                                                     gboolean           include_hidden_chars);
204

205
gchar          *gtk_text_buffer_get_slice           (GtkTextBuffer     *buffer,
206 207
                                                     const GtkTextIter *start,
                                                     const GtkTextIter *end,
208 209
                                                     gboolean           include_hidden_chars);

Havoc Pennington's avatar
Havoc Pennington committed
210 211
/* Insert a pixbuf */
void gtk_text_buffer_insert_pixbuf         (GtkTextBuffer *buffer,
212
                                            GtkTextIter   *iter,
Havoc Pennington's avatar
Havoc Pennington committed
213
                                            GdkPixbuf     *pixbuf);
214

215 216 217 218 219 220
/* Insert a child anchor */
void               gtk_text_buffer_insert_child_anchor (GtkTextBuffer      *buffer,
                                                        GtkTextIter        *iter,
                                                        GtkTextChildAnchor *anchor);

/* Convenience, create and insert a child anchor */
221 222 223
GtkTextChildAnchor *gtk_text_buffer_create_child_anchor (GtkTextBuffer *buffer,
                                                         GtkTextIter   *iter);

224 225 226 227 228 229
/* 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,
230
                                            GtkTextMark       *mark,
231 232
                                            const GtkTextIter *where);
void           gtk_text_buffer_delete_mark (GtkTextBuffer     *buffer,
233
                                            GtkTextMark       *mark);
Havoc Pennington's avatar
Havoc Pennington committed
234
GtkTextMark*   gtk_text_buffer_get_mark    (GtkTextBuffer     *buffer,
235 236
                                            const gchar       *name);

237 238 239 240 241 242
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
243 244 245
GtkTextMark* gtk_text_buffer_get_insert          (GtkTextBuffer *buffer);
GtkTextMark* gtk_text_buffer_get_selection_bound (GtkTextBuffer *buffer);

246 247 248 249 250 251 252 253
/* 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,
254
                                            GtkTextTag        *tag,
255 256
                                            const GtkTextIter *start,
                                            const GtkTextIter *end);
257
void gtk_text_buffer_remove_tag            (GtkTextBuffer     *buffer,
258
                                            GtkTextTag        *tag,
259 260
                                            const GtkTextIter *start,
                                            const GtkTextIter *end);
261 262
void gtk_text_buffer_apply_tag_by_name     (GtkTextBuffer     *buffer,
                                            const gchar       *name,
263 264
                                            const GtkTextIter *start,
                                            const GtkTextIter *end);
265
void gtk_text_buffer_remove_tag_by_name    (GtkTextBuffer     *buffer,
266
                                            const gchar       *name,
267 268
                                            const GtkTextIter *start,
                                            const GtkTextIter *end);
Havoc Pennington's avatar
Havoc Pennington committed
269 270 271
void gtk_text_buffer_remove_all_tags       (GtkTextBuffer     *buffer,
                                            const GtkTextIter *start,
                                            const GtkTextIter *end);
272 273 274


/* You can either ignore the return value, or use it to
275 276
 * set the attributes of the tag. tag_name can be NULL
 */
277
GtkTextTag    *gtk_text_buffer_create_tag (GtkTextBuffer *buffer,
278 279 280
                                           const gchar   *tag_name,
                                           const gchar   *first_property_name,
                                           ...);
281 282

/* Obtain iterators pointed at various places, then you can move the
283 284
 * iterator around using the GtkTextIter operators
 */
285 286 287 288
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
289 290 291 292
void gtk_text_buffer_get_iter_at_line_index  (GtkTextBuffer *buffer,
                                              GtkTextIter   *iter,
                                              gint           line_number,
                                              gint           byte_index);
293 294 295 296 297 298
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);
299
void gtk_text_buffer_get_end_iter            (GtkTextBuffer *buffer,
300 301 302 303 304 305 306
                                              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);
307

308 309 310
void gtk_text_buffer_get_iter_at_child_anchor (GtkTextBuffer      *buffer,
                                               GtkTextIter        *iter,
                                               GtkTextChildAnchor *anchor);
311 312 313 314 315 316 317 318 319 320

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

321
gboolean        gtk_text_buffer_get_modified            (GtkTextBuffer *buffer);
322 323
void            gtk_text_buffer_set_modified            (GtkTextBuffer *buffer,
                                                         gboolean       setting);
324

325 326 327
void            gtk_text_buffer_paste_primary           (GtkTextBuffer       *buffer,
                                                         const GtkTextIter   *override_location,
                                                         gboolean             default_editable);
328
void            gtk_text_buffer_cut_clipboard           (GtkTextBuffer *buffer,
329
                                                         gboolean       default_editable);
330
void            gtk_text_buffer_copy_clipboard          (GtkTextBuffer *buffer);
331
void            gtk_text_buffer_paste_clipboard         (GtkTextBuffer *buffer,
332
                                                         gboolean       default_editable);
333

334 335 336
gboolean        gtk_text_buffer_get_selection_bounds    (GtkTextBuffer *buffer,
                                                         GtkTextIter   *start,
                                                         GtkTextIter   *end);
337 338
gboolean        gtk_text_buffer_delete_selection        (GtkTextBuffer *buffer,
                                                         gboolean       interactive,
339
                                                         gboolean       default_editable);                                                    
340 341 342 343 344

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

345
/* INTERNAL private stuff */
346
void            _gtk_text_buffer_spew                  (GtkTextBuffer      *buffer);
347

348 349
GtkTextBTree*   _gtk_text_buffer_get_btree             (GtkTextBuffer      *buffer);

350 351 352 353
const PangoLogAttr* _gtk_text_buffer_get_line_log_attrs (GtkTextBuffer     *buffer,
                                                         const GtkTextIter *anywhere_in_line,
                                                         gint              *char_len);

354 355 356 357 358
#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif