gtktextbuffer.h 12.3 KB
Newer Older
1 2 3
#ifndef GTK_TEXT_BUFFER_H
#define GTK_TEXT_BUFFER_H

4 5 6 7 8
#include <gtk/gtkwidget.h>
#include <gtk/gtktexttagtable.h>
#include <gtk/gtktextiter.h>
#include <gtk/gtktextmark.h>

9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
#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;

#define GTK_TYPE_TEXT_BUFFER            (gtk_text_buffer_get_type())
#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;

struct _GtkTextBuffer {
  GtkObject parent_instance;

  GtkTextTagTable *tag_table;
33
  GtkTextBTree *btree;
34 35 36 37 38 39 40 41 42 43 44

  /* Whether the buffer has been modified since last save */
  gboolean modified;
};

struct _GtkTextBufferClass {
  GtkObjectClass parent_class;

  void (* insert_text)     (GtkTextBuffer *buffer,
                            GtkTextIter *pos,
                            const gchar *text,
45 46
                            gint length,
                            gboolean interactive);
47 48 49 50


  void (* delete_text)     (GtkTextBuffer *buffer,
                            GtkTextIter *start,
51 52
                            GtkTextIter *end,
                            gboolean interactive);
53 54 55 56 57 58 59 60 61 62 63 64

  /* Only for text changed, marks/tags don't cause this
     to be emitted */
  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,
65
                               GtkTextMark *mark);
66 67

  void (* mark_deleted)       (GtkTextBuffer *buffer,
68
                               GtkTextMark *mark);
69 70 71 72 73 74 75 76 77 78 79 80 81

  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
82
GtkType        gtk_text_buffer_get_type       (void) G_GNUC_CONST;
83 84 85 86 87 88 89 90 91



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


92
GtkTextTagTable* gtk_text_buffer_get_tag_table (GtkTextBuffer  *buffer);
93 94 95 96 97 98 99 100 101 102

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

103 104 105 106 107 108 109 110 111
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);
112 113 114


/* Delete from the buffer */
115
void     gtk_text_buffer_delete             (GtkTextBuffer *buffer,
116 117
                                             GtkTextIter   *start,
                                             GtkTextIter   *end);
118 119 120 121 122 123
gboolean gtk_text_buffer_delete_interactive (GtkTextBuffer *buffer,
                                             GtkTextIter   *start_iter,
                                             GtkTextIter   *end_iter,
                                             gboolean       default_editable);


124 125 126

/* Obtain strings from the buffer */
gchar          *gtk_text_buffer_get_text            (GtkTextBuffer     *buffer,
127 128
                                                     const GtkTextIter *start,
                                                     const GtkTextIter *end,
129
                                                     gboolean           include_hidden_chars);
130

131
gchar          *gtk_text_buffer_get_slice           (GtkTextBuffer     *buffer,
132 133
                                                     const GtkTextIter *start,
                                                     const GtkTextIter *end,
134 135
                                                     gboolean           include_hidden_chars);

Havoc Pennington's avatar
Havoc Pennington committed
136 137
/* Insert a pixbuf */
void gtk_text_buffer_insert_pixbuf         (GtkTextBuffer *buffer,
138
                                            GtkTextIter   *iter,
Havoc Pennington's avatar
Havoc Pennington committed
139
                                            GdkPixbuf     *pixbuf);
140 141 142 143 144 145 146

/* 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,
147
                                            GtkTextMark       *mark,
148 149
                                            const GtkTextIter *where);
void           gtk_text_buffer_delete_mark (GtkTextBuffer     *buffer,
150
                                            GtkTextMark       *mark);
Havoc Pennington's avatar
Havoc Pennington committed
151
GtkTextMark*   gtk_text_buffer_get_mark    (GtkTextBuffer     *buffer,
152 153
                                            const gchar       *name);

Havoc Pennington's avatar
Havoc Pennington committed
154 155 156
GtkTextMark* gtk_text_buffer_get_insert          (GtkTextBuffer *buffer);
GtkTextMark* gtk_text_buffer_get_selection_bound (GtkTextBuffer *buffer);

157 158 159 160 161 162 163 164 165

/* 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,
166
                                            GtkTextTag        *tag,
167 168 169
                                            const GtkTextIter *start_index,
                                            const GtkTextIter *end_index);
void gtk_text_buffer_remove_tag            (GtkTextBuffer     *buffer,
170 171 172 173 174 175 176 177
                                            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,
178 179 180 181 182 183
                                            const gchar       *name,
                                            const GtkTextIter *start_index,
                                            const GtkTextIter *end_index);


/* You can either ignore the return value, or use it to
184 185
 * set the attributes of the tag. tag_name can be NULL
 */
186 187 188 189 190
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 */
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
void gtk_text_buffer_get_iter_at_line_offset (GtkTextBuffer *buffer,
                                              GtkTextIter   *iter,
                                              gint           line_number,
                                              gint           char_offset);
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);
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227



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

GSList         *gtk_text_buffer_get_tags (GtkTextBuffer     *buffer,
                                          const GtkTextIter *iter);


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

229
void            gtk_text_buffer_paste_primary           (GtkTextBuffer *buffer,
230
                                                         GtkTextIter   *override_location,
231
                                                         gboolean       default_editable);
232
void            gtk_text_buffer_cut_clipboard           (GtkTextBuffer *buffer,
233
                                                         gboolean       default_editable);
234
void            gtk_text_buffer_copy_clipboard          (GtkTextBuffer *buffer);
235
void            gtk_text_buffer_paste_clipboard         (GtkTextBuffer *buffer,
236
                                                         gboolean       default_editable);
237

238 239 240
gboolean        gtk_text_buffer_get_selection_bounds    (GtkTextBuffer *buffer,
                                                         GtkTextIter   *start,
                                                         GtkTextIter   *end);
241 242 243
gboolean        gtk_text_buffer_delete_selection        (GtkTextBuffer *buffer,
                                                         gboolean       interactive,
                                                         gboolean       default_editable);
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262

/* This function is not implemented. */
gboolean gtk_text_buffer_find_string(GtkTextBuffer *buffer,
                                     GtkTextIter *iter,
                                     const gchar *str,
                                     const GtkTextIter *start,
                                     const GtkTextIter *end);

#if 0
/* Waiting on glib 1.4 regexp facility */
gboolean gtk_text_buffer_find_regexp(GtkTextBuffer *buffer,
                                     GRegexp *regexp,
                                     const GtkTextIter *start,
                                     const GtkTextIter *end);
#endif

/* INTERNAL private stuff */
void            gtk_text_buffer_spew                   (GtkTextBuffer      *buffer);

263 264
GtkTextBTree*   _gtk_text_buffer_get_btree             (GtkTextBuffer      *buffer);

265 266 267 268 269
#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif