GNOME Documentation Library

GtkTextBuffer

typedef struct _GtkTextBuffer GtkTextBuffer;

gtk_text_buffer_new ()

GtkTextBuffer*      gtk_text_buffer_new                 (GtkTextTagTable *table);

Creates a new text buffer.

gtk_text_buffer_get_line_count ()

gint                gtk_text_buffer_get_line_count      (GtkTextBuffer *buffer);

Obtains the number of lines in the buffer. This value is cached, so the function is very fast.

gtk_text_buffer_get_char_count ()

gint                gtk_text_buffer_get_char_count      (GtkTextBuffer *buffer);

Gets the number of characters in the buffer; note that characters and bytes are not the same, you can't e.g. expect the contents of the buffer in string form to be this many bytes long. The character count is cached, so this function is very fast.

gtk_text_buffer_get_tag_table ()

GtkTextTagTable*    gtk_text_buffer_get_tag_table       (GtkTextBuffer *buffer);

Get the GtkTextTagTable associated with this buffer.

gtk_text_buffer_insert ()

void                gtk_text_buffer_insert              (GtkTextBuffer *buffer,
                                                         GtkTextIter *iter,
                                                         const gchar *text,
                                                         gint len);

Inserts len bytes of text at position iter. If len is -1, text must be nul-terminated and will be inserted in its entirety. Emits the "insert_text" signal; insertion actually occurs in the default handler for the signal. iter is invalidated when insertion occurs (because the buffer contents change), but the default signal handler revalidates it to point to the end of the inserted text.

gtk_text_buffer_insert_at_cursor ()

void                gtk_text_buffer_insert_at_cursor    (GtkTextBuffer *buffer,
                                                         const gchar *text,
                                                         gint len);

Simply calls gtk_text_buffer_insert(), using the current cursor position as the insertion point.

gtk_text_buffer_insert_interactive ()

gboolean            gtk_text_buffer_insert_interactive  (GtkTextBuffer *buffer,
                                                         GtkTextIter *iter,
                                                         const gchar *text,
                                                         gint len,
                                                         gboolean default_editable);

Like gtk_text_buffer_insert(), but the insertion will not occur if iter is at a non-editable location in the buffer. Usually you want to prevent insertions at ineditable locations if the insertion results from a user action (is interactive).

default_editable indicates the editability of text that doesn't have a tag affecting editability applied to it. Typically the result of gtk_text_view_get_editable() is appropriate here.

gtk_text_buffer_insert_interactive_at_cursor ()

gboolean            gtk_text_buffer_insert_interactive_at_cursor
                                                        (GtkTextBuffer *buffer,
                                                         const gchar *text,
                                                         gint len,
                                                         gboolean default_editable);

Calls gtk_text_buffer_insert_interactive() at the cursor position.

default_editable indicates the editability of text that doesn't have a tag affecting editability applied to it. Typically the result of gtk_text_view_get_editable() is appropriate here.

gtk_text_buffer_insert_range ()

void                gtk_text_buffer_insert_range        (GtkTextBuffer *buffer,
                                                         GtkTextIter *iter,
                                                         const GtkTextIter *start,
                                                         const GtkTextIter *end);

Copies text, tags, and pixbufs between start and end (the order of start and end doesn't matter) and inserts the copy at iter. Used instead of simply getting/inserting text because it preserves images and tags. If start and end are in a different buffer from buffer, the two buffers must share the same tag table.

Implemented via emissions of the insert_text and apply_tag signals, so expect those.

gtk_text_buffer_insert_range_interactive ()

gboolean            gtk_text_buffer_insert_range_interactive
                                                        (GtkTextBuffer *buffer,
                                                         GtkTextIter *iter,
                                                         const GtkTextIter *start,
                                                         const GtkTextIter *end,
                                                         gboolean default_editable);

Same as gtk_text_buffer_insert_range(), but does nothing if the insertion point isn't editable. The default_editable parameter indicates whether the text is editable at iter if no tags enclosing iter affect editability. Typically the result of gtk_text_view_get_editable() is appropriate here.

gtk_text_buffer_insert_with_tags ()

void                gtk_text_buffer_insert_with_tags    (GtkTextBuffer *buffer,
                                                         GtkTextIter *iter,
                                                         const gchar *text,
                                                         gint len,
                                                         GtkTextTag *first_tag,
                                                         ...);

Inserts text into buffer at iter, applying the list of tags to the newly-inserted text. The last tag specified must be NULL to terminate the list. Equivalent to calling gtk_text_buffer_insert(), then gtk_text_buffer_apply_tag() on the inserted text; gtk_text_buffer_insert_with_tags() is just a convenience function.

gtk_text_buffer_insert_with_tags_by_name ()

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

Same as gtk_text_buffer_insert_with_tags(), but allows you to pass in tag names instead of tag objects.

gtk_text_buffer_delete ()

void                gtk_text_buffer_delete              (GtkTextBuffer *buffer,
                                                         GtkTextIter *start,
                                                         GtkTextIter *end);

Deletes text between start and end. The order of start and end is not actually relevant; gtk_text_buffer_delete() will reorder them. This function actually emits the "delete_range" signal, and the default handler of that signal deletes the text. Because the buffer is modified, all outstanding iterators become invalid after calling this function; however, the start and end will be re-initialized to point to the location where text was deleted.

gtk_text_buffer_delete_interactive ()

gboolean            gtk_text_buffer_delete_interactive  (GtkTextBuffer *buffer,
                                                         GtkTextIter *start_iter,
                                                         GtkTextIter *end_iter,
                                                         gboolean default_editable);

Deletes all editable text in the given range. Calls gtk_text_buffer_delete() for each editable sub-range of [start,end). start and end are revalidated to point to the location of the last deleted range, or left untouched if no text was deleted.

gtk_text_buffer_backspace ()

gboolean            gtk_text_buffer_backspace           (GtkTextBuffer *buffer,
                                                         GtkTextIter *iter,
                                                         gboolean interactive,
                                                         gboolean default_editable);

Performs the appropriate action as if the user hit the delete key with the cursor at the position specified by iter. In the normal case a single character will be deleted, but when combining accents are involved, more than one character can be deleted, and when precomposed character and accent combinations are involved, less than one character will be deleted.

Because the buffer is modified, all outstanding iterators become invalid after calling this function; however, the iter will be re-initialized to point to the location where text was deleted.

Since 2.6

gtk_text_buffer_set_text ()

void                gtk_text_buffer_set_text            (GtkTextBuffer *buffer,
                                                         const gchar *text,
                                                         gint len);

Deletes current contents of buffer, and inserts text instead. If len is -1, text must be nul-terminated. text must be valid UTF-8.

gtk_text_buffer_get_text ()

gchar*              gtk_text_buffer_get_text            (GtkTextBuffer *buffer,
                                                         const GtkTextIter *start,
                                                         const GtkTextIter *end,
                                                         gboolean include_hidden_chars);

Returns the text in the range [start,end). Excludes undisplayed text (text marked with tags that set the invisibility attribute) if include_hidden_chars is FALSE. Does not include characters representing embedded images, so byte and character indexes into the returned string do not correspond to byte and character indexes into the buffer. Contrast with gtk_text_buffer_get_slice().

gtk_text_buffer_get_slice ()

gchar*              gtk_text_buffer_get_slice           (GtkTextBuffer *buffer,
                                                         const GtkTextIter *start,
                                                         const GtkTextIter *end,
                                                         gboolean include_hidden_chars);

Returns the text in the range [start,end). Excludes undisplayed text (text marked with tags that set the invisibility attribute) if include_hidden_chars is FALSE. The returned string includes a 0xFFFC character whenever the buffer contains embedded images, so byte and character indexes into the returned string do correspond to byte and character indexes into the buffer. Contrast with gtk_text_buffer_get_text(). Note that 0xFFFC can occur in normal text as well, so it is not a reliable indicator that a pixbuf or widget is in the buffer.

gtk_text_buffer_insert_pixbuf ()

void                gtk_text_buffer_insert_pixbuf       (GtkTextBuffer *buffer,
                                                         GtkTextIter *iter,
                                                         GdkPixbuf *pixbuf);

Inserts an image into the text buffer at iter. The image will be counted as one character in character counts, and when obtaining the buffer contents as a string, will be represented by the Unicode "object replacement character" 0xFFFC. Note that the "slice" variants for obtaining portions of the buffer as a string include this character for pixbufs, but the "text" variants do not. e.g. see gtk_text_buffer_get_slice() and gtk_text_buffer_get_text().

gtk_text_buffer_insert_child_anchor ()

void                gtk_text_buffer_insert_child_anchor (GtkTextBuffer *buffer,
                                                         GtkTextIter *iter,
                                                         GtkTextChildAnchor *anchor);

Inserts a child widget anchor into the text buffer at iter. The anchor will be counted as one character in character counts, and when obtaining the buffer contents as a string, will be represented by the Unicode "object replacement character" 0xFFFC. Note that the "slice" variants for obtaining portions of the buffer as a string include this character for child anchors, but the "text" variants do not. E.g. see gtk_text_buffer_get_slice() and gtk_text_buffer_get_text(). Consider gtk_text_buffer_create_child_anchor() as a more convenient alternative to this function. The buffer will add a reference to the anchor, so you can unref it after insertion.

gtk_text_buffer_create_child_anchor ()

GtkTextChildAnchor* gtk_text_buffer_create_child_anchor (GtkTextBuffer *buffer,
                                                         GtkTextIter *iter);

This is a convenience function which simply creates a child anchor with gtk_text_child_anchor_new() and inserts it into the buffer with gtk_text_buffer_insert_child_anchor(). The new anchor is owned by the buffer; no reference count is returned to the caller of gtk_text_buffer_create_child_anchor().

gtk_text_buffer_create_mark ()

GtkTextMark*        gtk_text_buffer_create_mark         (GtkTextBuffer *buffer,
                                                         const gchar *mark_name,
                                                         const GtkTextIter *where,
                                                         gboolean left_gravity);

Creates a mark at position where. If mark_name is NULL, the mark is anonymous; otherwise, the mark can be retrieved by name using gtk_text_buffer_get_mark(). If a mark has left gravity, and text is inserted at the mark's current location, the mark will be moved to the left of the newly-inserted text. If the mark has right gravity (left_gravity = FALSE), the mark will end up on the right of newly-inserted text. The standard left-to-right cursor is a mark with right gravity (when you type, the cursor stays on the right side of the text you're typing).

The caller of this function does not own a reference to the returned GtkTextMark, so you can ignore the return value if you like. Marks are owned by the buffer and go away when the buffer does.

Emits the "mark_set" signal as notification of the mark's initial placement.

gtk_text_buffer_move_mark ()

void                gtk_text_buffer_move_mark           (GtkTextBuffer *buffer,
                                                         GtkTextMark *mark,
                                                         const GtkTextIter *where);

Moves mark to the new location where. Emits the "mark_set" signal as notification of the move.

gtk_text_buffer_move_mark_by_name ()

void                gtk_text_buffer_move_mark_by_name   (GtkTextBuffer *buffer,
                                                         const gchar *name,
                                                         const GtkTextIter *where);

Moves the mark named name (which must exist) to location where. See gtk_text_buffer_move_mark() for details.

gtk_text_buffer_add_mark ()

void                gtk_text_buffer_add_mark            (GtkTextBuffer *buffer,
                                                         GtkTextMark *mark,
                                                         const GtkTextIter *where);

Adds the mark at position where. The mark must not be added to another buffer, and if its name is not NULL then there must not be another mark in the buffer with the same name.

Emits the "mark_set" signal as notification of the mark's initial placement.

Since 2.12

gtk_text_buffer_delete_mark ()

void                gtk_text_buffer_delete_mark         (GtkTextBuffer *buffer,
                                                         GtkTextMark *mark);

Deletes mark, so that it's no longer located anywhere in the buffer. Removes the reference the buffer holds to the mark, so if you haven't called g_object_ref() on the mark, it will be freed. Even if the mark isn't freed, most operations on mark become invalid, until it gets added to a buffer again with gtk_text_buffer_add_mark(). Use gtk_text_mark_get_deleted() to find out if a mark has been removed from its buffer. The "mark_deleted" signal will be emitted as notification after the mark is deleted.

gtk_text_buffer_delete_mark_by_name ()

void                gtk_text_buffer_delete_mark_by_name (GtkTextBuffer *buffer,
                                                         const gchar *name);

Deletes the mark named name; the mark must exist. See gtk_text_buffer_delete_mark() for details.

gtk_text_buffer_get_mark ()

GtkTextMark*        gtk_text_buffer_get_mark            (GtkTextBuffer *buffer,
                                                         const gchar *name);

Returns the mark named name in buffer buffer, or NULL if no such mark exists in the buffer.

gtk_text_buffer_get_insert ()

GtkTextMark*        gtk_text_buffer_get_insert          (GtkTextBuffer *buffer);

Returns the mark that represents the cursor (insertion point). Equivalent to calling gtk_text_buffer_get_mark() to get the mark named "insert", but very slightly more efficient, and involves less typing.

gtk_text_buffer_get_selection_bound ()

GtkTextMark*        gtk_text_buffer_get_selection_bound (GtkTextBuffer *buffer);

Returns the mark that represents the selection bound. Equivalent to calling gtk_text_buffer_get_mark() to get the mark named "selection_bound", but very slightly more efficient, and involves less typing.

The currently-selected text in buffer is the region between the "selection_bound" and "insert" marks. If "selection_bound" and "insert" are in the same place, then there is no current selection. gtk_text_buffer_get_selection_bounds() is another convenient function for handling the selection, if you just want to know whether there's a selection and what its bounds are.

gtk_text_buffer_get_has_selection ()

gboolean            gtk_text_buffer_get_has_selection   (GtkTextBuffer *buffer);

Indicates whether the buffer has some text currently selected.

Since 2.10

gtk_text_buffer_place_cursor ()

void                gtk_text_buffer_place_cursor        (GtkTextBuffer *buffer,
                                                         const GtkTextIter *where);

This function moves the "insert" and "selection_bound" marks simultaneously. If you move them to the same place in two steps with gtk_text_buffer_move_mark(), you will temporarily select a region in between their old and new locations, which can be pretty inefficient since the temporarily-selected region will force stuff to be recalculated. This function moves them as a unit, which can be optimized.

gtk_text_buffer_select_range ()

void                gtk_text_buffer_select_range        (GtkTextBuffer *buffer,
                                                         const GtkTextIter *ins,
                                                         const GtkTextIter *bound);

This function moves the "insert" and "selection_bound" marks simultaneously. If you move them in two steps with gtk_text_buffer_move_mark(), you will temporarily select a region in between their old and new locations, which can be pretty inefficient since the temporarily-selected region will force stuff to be recalculated. This function moves them as a unit, which can be optimized.

Since 2.4

gtk_text_buffer_apply_tag ()

void                gtk_text_buffer_apply_tag           (GtkTextBuffer *buffer,
                                                         GtkTextTag *tag,
                                                         const GtkTextIter *start,
                                                         const GtkTextIter *end);

Emits the "apply_tag" signal on buffer. The default handler for the signal applies tag to the given range. start and end do not have to be in order.

gtk_text_buffer_remove_tag ()

void                gtk_text_buffer_remove_tag          (GtkTextBuffer *buffer,
                                                         GtkTextTag *tag,
                                                         const GtkTextIter *start,
                                                         const GtkTextIter *end);

Emits the "remove_tag" signal. The default handler for the signal removes all occurrences of tag from the given range. start and end don't have to be in order.

gtk_text_buffer_apply_tag_by_name ()

void                gtk_text_buffer_apply_tag_by_name   (GtkTextBuffer *buffer,
                                                         const gchar *name,
                                                         const GtkTextIter *start,
                                                         const GtkTextIter *end);

Calls gtk_text_tag_table_lookup() on the buffer's tag table to get a