Gtk.TextBuffer¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` (table)
	`add_mark` (mark, where)
	`add_selection_clipboard` (clipboard)
	`apply_tag` (tag, start, end)
	`apply_tag_by_name` (name, start, end)
	`backspace` (iter, interactive, default_editable)
	`begin_irreversible_action` ()
	`begin_user_action` ()
	`copy_clipboard` (clipboard)
	`create_child_anchor` (iter)
	`create_mark` (mark_name, where, left_gravity)
	`create_tag` (tag_name=None, **properties)
	`cut_clipboard` (clipboard, default_editable)
	`delete` (start, end)
	`delete_interactive` (start_iter, end_iter, default_editable)
	`delete_mark` (mark)
	`delete_mark_by_name` (name)
	`delete_selection` (interactive, default_editable)
	`end_irreversible_action` ()
	`end_user_action` ()
	`get_bounds` ()
	`get_can_redo` ()
	`get_can_undo` ()
	`get_char_count` ()
	`get_enable_undo` ()
	`get_end_iter` ()
	`get_has_selection` ()
	`get_insert` ()
	`get_iter_at_child_anchor` (anchor)
	`get_iter_at_line` (line_number)
	`get_iter_at_line_index` (line_number, byte_index)
	`get_iter_at_line_offset` (line_number, char_offset)
	`get_iter_at_mark` (mark)
	`get_iter_at_offset` (char_offset)
	`get_line_count` ()
	`get_mark` (name)
	`get_max_undo_levels` ()
	`get_modified` ()
	`get_selection_bound` ()
	`get_selection_bounds` ()
	`get_selection_content` ()
	`get_slice` (start, end, include_hidden_chars)
	`get_start_iter` ()
	`get_tag_table` ()
	`get_text` (start, end, include_hidden_chars)
	`insert` (iter, text, length=-1)
	`insert_at_cursor` (text, len)
	`insert_child_anchor` (iter, anchor)
	`insert_interactive` (iter, text, len, default_editable)
	`insert_interactive_at_cursor` (text, len, default_editable)
	`insert_markup` (iter, markup, len)
	`insert_paintable` (iter, paintable)
	`insert_range` (iter, start, end)
	`insert_range_interactive` (iter, start, end, default_editable)
	`insert_with_tags` (iter, text, *tags)
	`insert_with_tags_by_name` (iter, text, *tags)
	`move_mark` (mark, where)
	`move_mark_by_name` (name, where)
	`paste_clipboard` (clipboard, override_location, default_editable)
	`place_cursor` (where)
	`redo` ()
	`remove_all_tags` (start, end)
	`remove_selection_clipboard` (clipboard)
	`remove_tag` (tag, start, end)
	`remove_tag_by_name` (name, start, end)
	`select_range` (ins, bound)
	`set_enable_undo` (enable_undo)
	`set_max_undo_levels` (max_undo_levels)
	`set_modified` (setting)
	`set_text` (text, length=-1)
	`undo` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

	`do_apply_tag` (tag, start, end)
	`do_begin_user_action` ()
	`do_changed` ()
	`do_delete_range` (start, end)
	`do_end_user_action` ()
	`do_insert_child_anchor` (iter, anchor)
	`do_insert_paintable` (iter, paintable)
	`do_insert_text` (pos, new_text, new_text_length)
	`do_mark_deleted` (mark)
	`do_mark_set` (location, mark)
	`do_modified_changed` ()
	`do_paste_done` (clipboard)
	`do_redo` ()
	`do_remove_tag` (tag, start, end)
	`do_undo` ()

Properties¶

Name	Type	Flags
`can-redo`	`bool`	r
`can-undo`	`bool`	r
`cursor-position`	`int`	r
`enable-undo`	`bool`	r/w/en
`has-selection`	`bool`	r
`tag-table`	`Gtk.TextTagTable`	r/w/co
`text`	`str`	r/w

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`apply-tag`	Emitted to apply a tag to a range of text in a `GtkTextBuffer`.
`begin-user-action`	Emitted at the beginning of a single user-visible operation on a `GtkTextBuffer`.
`changed`	Emitted when the content of a `GtkTextBuffer` has changed.
`delete-range`	Emitted to delete a range from a `GtkTextBuffer`.
`end-user-action`	Emitted at the end of a single user-visible operation on the `GtkTextBuffer`.
`insert-child-anchor`	Emitted to insert a `GtkTextChildAnchor` in a `GtkTextBuffer`.
`insert-paintable`	Emitted to insert a `GdkPaintable` in a `GtkTextBuffer`.
`insert-text`	Emitted to insert text in a `GtkTextBuffer`.
`mark-deleted`	Emitted as notification after a `GtkTextMark` is deleted.
`mark-set`	Emitted as notification after a `GtkTextMark` is set.
`modified-changed`	Emitted when the modified bit of a `GtkTextBuffer` flips.
`paste-done`	Emitted after paste operation has been completed.
`redo`	Emitted when a request has been made to redo the previously undone operation.
`remove-tag`	Emitted to remove all occurrences of tag from a range of text in a `GtkTextBuffer`.
`undo`	Emitted when a request has been made to undo the previous operation or set of operations that have been grouped together.

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`GObject.Object`	r

Class Details¶

class Gtk.TextBuffer(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Gtk.TextBufferClass

Stores text and attributes for display in a GtkTextView.

You may wish to begin by reading the text widget conceptual overview, which gives an overview of all the objects and data types related to the text widget and how they work together.

Gtk.TextBuffer can support undoing changes to the buffer content, see [method`Gtk`.TextBuffer.set_enable_undo].

classmethod new(table)[source]¶

Parameters:: table (Gtk.TextTagTable or None) – a tag table, or None to create a new one
Returns:: a new text buffer
Return type:: Gtk.TextBuffer

Creates a new text buffer.

add_mark(mark, where)[source]¶

Parameters:

mark (Gtk.TextMark) – the mark to add
where (Gtk.TextIter) – location to place mark

Adds the mark at position where.

The mark must not be added to another buffer, and if its name is not None then there must not be another mark in the buffer with the same name.

Emits the [signal`Gtk`.TextBuffer::mark-set] signal as notification of the mark’s initial placement.

add_selection_clipboard(clipboard)[source]¶

Parameters:: clipboard (Gdk.Clipboard) – a GdkClipboard

Adds clipboard to the list of clipboards in which the selection contents of self are available.

In most cases, clipboard will be the GdkClipboard returned by [method`Gtk`.Widget.get_primary_clipboard] for a view of self.

apply_tag(tag, start, end)[source]¶

Parameters:

tag (Gtk.TextTag) – a GtkTextTag
start (Gtk.TextIter) – one bound of range to be tagged
end (Gtk.TextIter) – other bound of range to be tagged

Emits the “apply-tag” signal on self.

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

apply_tag_by_name(name, start, end)[source]¶

Parameters:

name (str) – name of a named GtkTextTag
start (Gtk.TextIter) – one bound of range to be tagged
end (Gtk.TextIter) – other bound of range to be tagged

Emits the “apply-tag” signal on self.

Calls [method`Gtk`.TextTagTable.lookup] on the buffer’s tag table to get a GtkTextTag, then calls [method`Gtk`.TextBuffer.apply_tag].

backspace(iter, interactive, default_editable)[source]¶

Parameters:

iter (Gtk.TextIter) – a position in self
interactive (bool) – whether the deletion is caused by user interaction
default_editable (bool) – whether the buffer is editable by default

Returns:

True if the buffer was modified

Return type:

bool

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.

begin_irreversible_action()[source]¶

Denotes the beginning of an action that may not be undone.

This will cause any previous operations in the undo/redo queue to be cleared.

This should be paired with a call to [method`Gtk`.TextBuffer.end_irreversible_action] after the irreversible action has completed.

You may nest calls to Gtk.TextBuffer.begin_irreversible_action() and Gtk.TextBuffer.end_irreversible_action() pairs.

begin_user_action()[source]¶

Called to indicate that the buffer operations between here and a call to Gtk.TextBuffer.end_user_action() are part of a single user-visible operation.

The operations between Gtk.TextBuffer.begin_user_action() and Gtk.TextBuffer.end_user_action() can then be grouped when creating an undo stack. GtkTextBuffer maintains a count of calls to Gtk.TextBuffer.begin_user_action() that have not been closed with a call to Gtk.TextBuffer.end_user_action(), and emits the “begin-user-action” and “end-user-action” signals only for the outermost pair of calls. This allows you to build user actions from other user actions.

The “interactive” buffer mutation functions, such as [method`Gtk`.TextBuffer.insert_interactive], automatically call begin/end user action around the buffer operations they perform, so there’s no need to add extra calls if you user action consists solely of a single call to one of those functions.

copy_clipboard(clipboard)[source]¶

Parameters:: clipboard (Gdk.Clipboard) – the GdkClipboard object to copy to

Copies the currently-selected text to a clipboard.

create_child_anchor(iter)[source]¶

Parameters:: iter (Gtk.TextIter) – location in the buffer
Returns:: the created child anchor
Return type:: Gtk.TextChildAnchor

Creates and inserts a child anchor.

This is a convenience function which simply creates a child anchor with [ctor`Gtk`.TextChildAnchor.new] and inserts it into the buffer with [method`Gtk`.TextBuffer.insert_child_anchor].

The new anchor is owned by the buffer; no reference count is returned to the caller of this function.

create_mark(mark_name, where, left_gravity)[source]¶

Parameters:

mark_name (str or None) – name for mark
where (Gtk.TextIter) – location to place mark
left_gravity (bool) – whether the mark has left gravity

Returns:

the new GtkTextMark object

Return type:

Gtk.TextMark

Creates a mark at position where.

If mark_name is None, the mark is anonymous; otherwise, the mark can be retrieved by name using [method`Gtk`.TextBuffer.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 [signal`Gtk`.TextBuffer::mark-set] signal as notification of the mark’s initial placement.

create_tag(tag_name=None, **properties)[source]¶

Creates a tag and adds it to the tag table of the TextBuffer.

Parameters:

tag_name (str) – Name of the new tag, or None
**properties –
Keyword list of properties and their values

Returns:

A new tag.

This is equivalent to creating a Gtk.TextTag and then adding the tag to the buffer’s tag table. The returned tag is owned by the buffer’s tag table.

If tag_name is None, the tag is anonymous.

If tag_name is not None, a tag called tag_name must not already exist in the tag table for this buffer.

Properties are passed as a keyword list of names and values (e.g. foreground=’DodgerBlue’, weight=Pango.Weight.BOLD)

cut_clipboard(clipboard, default_editable)[source]¶

Parameters:

clipboard (Gdk.Clipboard) – the GdkClipboard object to cut to
default_editable (bool) – default editability of the buffer

Copies the currently-selected text to a clipboard, then deletes said text if it’s editable.

delete(start, end)[source]¶

Parameters:

start (Gtk.TextIter) – a position in self
end (Gtk.TextIter) – another position in self

Deletes text between start and end.

The order of start and end is not actually relevant; Gtk.TextBuffer.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.

delete_interactive(start_iter, end_iter, default_editable)[source]¶

Parameters:

start_iter (Gtk.TextIter) – start of range to delete
end_iter (Gtk.TextIter) – end of range
default_editable (bool) – whether the buffer is editable by default

Returns:

whether some text was actually deleted

Return type:

bool

Deletes all editable text in the given range.

Calls [method`Gtk`.TextBuffer.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.

delete_mark(mark)[source]¶

Parameters:: mark (Gtk.TextMark) – a GtkTextMark in self

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 GObject.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 [method`Gtk`.TextBuffer.add_mark]. Use [method`Gtk`.TextMark.get_deleted] to find out if a mark has been removed from its buffer.

The [signal`Gtk`.TextBuffer::mark-deleted] signal will be emitted as notification after the mark is deleted.

delete_mark_by_name(name)[source]¶

Parameters:: name (str) – name of a mark in self

Deletes the mark named name; the mark must exist.

See [method`Gtk`.TextBuffer.delete_mark] for details.

delete_selection(interactive, default_editable)[source]¶

Parameters:

interactive (bool) – whether the deletion is caused by user interaction
default_editable (bool) – whether the buffer is editable by default

Returns:

whether there was a non-empty selection to delete

Return type:

bool

Deletes the range between the “insert” and “selection_bound” marks, that is, the currently-selected text.

If interactive is True, the editability of the selection will be considered (users can’t delete uneditable text).

end_irreversible_action()[source]¶

Denotes the end of an action that may not be undone.

This will cause any previous operations in the undo/redo queue to be cleared.

This should be called after completing modifications to the text buffer after [method`Gtk`.TextBuffer.begin_irreversible_action] was called.

You may nest calls to Gtk.TextBuffer.begin_irreversible_action() and Gtk.TextBuffer.end_irreversible_action() pairs.

end_user_action()[source]¶

Ends a user-visible operation.

Should be paired with a call to [method`Gtk`.TextBuffer.begin_user_action]. See that function for a full explanation.

get_bounds()[source]¶

Returns:

start:: iterator to initialize with first position in the buffer
end:: iterator to initialize with the end iterator

Return type:

(start: Gtk.TextIter, end: Gtk.TextIter)

Retrieves the first and last iterators in the buffer, i.e. the entire buffer lies within the range [start,`end`).

get_can_redo()[source]¶

Returns:: True if there is a redoable action
Return type:: bool

Gets whether there is a redoable action in the history.

get_can_undo()[source]¶

Returns:: True if there is an undoable action
Return type:: bool

Gets whether there is an undoable action in the history.

get_char_count()[source]¶

Returns:: number of characters in the buffer
Return type:: int

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.

get_enable_undo()[source]¶

Returns:: True if undoing and redoing changes to the buffer is allowed.
Return type:: bool

Gets whether the buffer is saving modifications to the buffer to allow for undo and redo actions.

See [method`Gtk`.TextBuffer.begin_irreversible_action] and [method`Gtk`.TextBuffer.end_irreversible_action] to create changes to the buffer that cannot be undone.

get_end_iter()[source]¶

Returns:: iterator to initialize
Return type:: iter: Gtk.TextIter

Initializes iter with the “end iterator,” one past the last valid character in the text buffer.

If dereferenced with [method`Gtk`.TextIter.get_char], the end iterator has a character value of 0. The entire buffer lies in the range from the first position in the buffer (call [method`Gtk`.TextBuffer.get_start_iter] to get character position 0) to the end iterator.

get_has_selection()[source]¶

Returns:: True if the there is text selected
Return type:: bool

Indicates whether the buffer has some text currently selected.

get_insert()[source]¶

Returns:: insertion point mark
Return type:: Gtk.TextMark

Returns the mark that represents the cursor (insertion point).

Equivalent to calling [method`Gtk`.TextBuffer.get_mark] to get the mark named “insert”, but very slightly more efficient, and involves less typing.

get_iter_at_child_anchor(anchor)[source]¶

Parameters:: anchor (Gtk.TextChildAnchor) – a child anchor that appears in self
Returns:: an iterator to be initialized
Return type:: iter: Gtk.TextIter

Obtains the location of anchor within self.

get_iter_at_line(line_number)[source]¶

Parameters:

line_number (int) – line number counting from 0

Returns:

whether the exact position has been found

iter:: iterator to initialize

Return type:

(bool, iter: Gtk.TextIter)

Initializes iter to the start of the given line.

If line_number is greater than or equal to the number of lines in the self, the end iterator is returned.

get_iter_at_line_index(line_number, byte_index)[source]¶

Parameters:

line_number (int) – line number counting from 0
byte_index (int) – byte index from start of line

Returns:

whether the exact position has been found

iter:: iterator to initialize

Return type:

(bool, iter: Gtk.TextIter)

Obtains an iterator pointing to byte_index within the given line.

byte_index must be the start of a UTF-8 character. Note bytes, not characters; UTF-8 may encode one character as multiple bytes.

If line_number is greater than or equal to the number of lines in the self, the end iterator is returned. And if byte_index is off the end of the line, the iterator at the end of the line is returned.

get_iter_at_line_offset(line_number, char_offset)[source]¶

Parameters:

line_number (int) – line number counting from 0
char_offset (int) – str offset from start of line

Returns:

whether the exact position has been found

iter:: iterator to initialize

Return type:

(bool, iter: Gtk.TextIter)

Obtains an iterator pointing to char_offset within the given line.

Note characters, not bytes; UTF-8 may encode one character as multiple bytes.

If line_number is greater than or equal to the number of lines in the self, the end iterator is returned. And if char_offset is off the end of the line, the iterator at the end of the line is returned.

get_iter_at_mark(mark)[source]¶

Parameters:: mark (Gtk.TextMark) – a GtkTextMark in self
Returns:: iterator to initialize
Return type:: iter: Gtk.TextIter

Initializes iter with the current position of mark.

get_iter_at_offset(char_offset)[source]¶

Parameters:: char_offset (int) – str offset from start of buffer, counting from 0, or -1
Returns:: iterator to initialize
Return type:: iter: Gtk.TextIter

Initializes iter to a position char_offset chars from the start of the entire buffer.

If char_offset is -1 or greater than the number of characters in the buffer, iter is initialized to the end iterator, the iterator one past the last valid character in the buffer.

get_line_count()[source]¶

Returns:: number of lines in the buffer
Return type:: int

Obtains the number of lines in the buffer.

This value is cached, so the function is very fast.

get_mark(name)[source]¶

Parameters:: name (str) – a mark name
Returns:: a GtkTextMark
Return type:: Gtk.TextMark or None

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

get_max_undo_levels()[source]¶

Returns:: The max number of undo levels allowed (0 indicates unlimited).
Return type:: int

Gets the maximum number of undo levels to perform.

If 0, unlimited undo actions may be performed. Note that this may have a memory usage impact as it requires storing an additional copy of the inserted or removed text within the text buffer.

get_modified()[source]¶

Returns:: True if the buffer has been modified
Return type:: bool

Indicates whether the buffer has been modified since the last call to [method`Gtk`.TextBuffer.set_modified] set the modification flag to False.

Used for example to enable a “save” function in a text editor.

get_selection_bound()[source]¶

Returns:: selection bound mark
Return type:: Gtk.TextMark

Returns the mark that represents the selection bound.

Equivalent to calling [method`Gtk`.TextBuffer.get_mark] to get the mark named “selection_bound”, but very slightly more efficient, and involves less typing.

The currently-selected text in self 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. [method`Gtk`.TextBuffer.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.

get_selection_bounds()[source]¶

Returns:

If there is no selection returns an empty tuple otherwise a tuple containing:

start:: selection start
end:: selection end

Return type:

(start: Gtk.TextIter, end: Gtk.TextIter) or None

Returns True if some text is selected; places the bounds of the selection in start and end.

If the selection has length 0, then start and end are filled in with the same value. start and end will be in ascending order. If start and end are None, then they are not filled in, but the return value still indicates whether text is selected.

get_selection_content()[source]¶

Returns:: a new GdkContentProvider.
Return type:: Gdk.ContentProvider

Get a content provider for this buffer.

It can be used to make the content of self available in a GdkClipboard, see [method`Gdk`.Clipboard.set_content].

get_slice(start, end, include_hidden_chars)[source]¶

Parameters:

start (Gtk.TextIter) – start of a range
end (Gtk.TextIter) – end of a range
include_hidden_chars (bool) – whether to include invisible text

Returns:

an allocated UTF-8 string

Return type:

str

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 [method`Gtk`.TextBuffer.get_text]. Note that 0xFFFC can occur in normal text as well, so it is not a reliable indicator that a paintable or widget is in the buffer.

get_start_iter()[source]¶

Returns:: iterator to initialize
Return type:: iter: Gtk.TextIter

Initialized iter with the first position in the text buffer.

This is the same as using [method`Gtk`.TextBuffer.get_iter_at_offset] to get the iter at character offset 0.

get_tag_table()[source]¶

Returns:: the buffer’s tag table
Return type:: Gtk.TextTagTable

Get the GtkTextTagTable associated with this buffer.

get_text(start, end, include_hidden_chars)[source]¶

Parameters:

start (Gtk.TextIter) – start of a range
end (Gtk.TextIter) – end of a range
include_hidden_chars (bool) – whether to include invisible text

Returns:

an allocated UTF-8 string

Return type:

str

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 [method`Gtk`.TextBuffer.get_slice].

insert(iter, text, length=-1)[source]¶

Parameters:

iter (Gtk.TextIter) – a position in the buffer
text (str) – text in UTF-8 format
len (int) – length of text in bytes, or -1

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.

insert_at_cursor(text, len)[source]¶

Parameters:

text (str) – text in UTF-8 format
len (int) – length of text, in bytes

Inserts text in self.

Simply calls [method`Gtk`.TextBuffer.insert], using the current cursor position as the insertion point.

insert_child_anchor(iter, anchor)[source]¶

Parameters:

iter (Gtk.TextIter) – location to insert the anchor
anchor (Gtk.TextChildAnchor) – a GtkTextChildAnchor

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 [method`Gtk`.TextBuffer.get_slice] and [method`Gtk`.TextBuffer.get_text].

Consider [method`Gtk`.TextBuffer.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.

insert_interactive(iter, text, len, default_editable)[source]¶

Parameters:

iter (Gtk.TextIter) – a position in self
text (str) – some UTF-8 text
len (int) – length of text in bytes, or -1
default_editable (bool) – default editability of buffer

Returns:

whether text was actually inserted

Return type:

bool

Inserts text in self.

Like [method`Gtk`.TextBuffer.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 [method`Gtk`.TextView.get_editable] is appropriate here.

insert_interactive_at_cursor(text, len, default_editable)[source]¶

Parameters:

text (str) – text in UTF-8 format
len (int) – length of text in bytes, or -1
default_editable (bool) – default editability of buffer

Returns:

whether text was actually inserted

Return type:

bool

Inserts text in self.

Calls [method`Gtk`.TextBuffer.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 [method`Gtk`.TextView.get_editable] is appropriate here.

insert_markup(iter, markup, len)[source]¶

Parameters:

iter (Gtk.TextIter) – location to insert the markup
markup (str) – a nul-terminated UTF-8 string containing Pango markup
len (int) – length of markup in bytes, or -1

Inserts the text in markup at position iter.

markup will be inserted in its entirety and must be nul-terminated and valid UTF-8. Emits the [signal`Gtk`.TextBuffer::insert-text] signal, possibly multiple times; insertion actually occurs in the default handler for the signal. iter will point to the end of the inserted text on return.

insert_paintable(iter, paintable)[source]¶

Parameters:

iter (Gtk.TextIter) – location to insert the paintable
paintable (Gdk.Paintable) – a GdkPaintable

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 paintable, but the “text” variants do not. e.g. see [method`Gtk`.TextBuffer.get_slice] and [method`Gtk`.TextBuffer.get_text].

insert_range(iter, start, end)[source]¶

Parameters:

iter (Gtk.TextIter) – a position in self
start (Gtk.TextIter) – a position in a GtkTextBuffer
end (Gtk.TextIter) – another position in the same buffer as start

Copies text, tags, and paintables between start and end and inserts the copy at iter.

The order of start and end doesn’t matter.

Used instead of simply getting/inserting text because it preserves images and tags. If start and end are in a different buffer from self, the two buffers must share the same tag table.

Implemented via emissions of the ::insert-text and ::apply-tag signals, so expect those.

insert_range_interactive(iter, start, end, default_editable)[source]¶

Parameters:

iter (Gtk.TextIter) – a position in self
start (Gtk.TextIter) – a position in a GtkTextBuffer
end (Gtk.TextIter) – another position in the same buffer as start
default_editable (bool) – default editability of the buffer

Returns:

whether an insertion was possible at iter

Return type:

bool

Copies text, tags, and paintables between start and end and inserts the copy at iter.

Same as [method`Gtk`.TextBuffer.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 [method`Gtk`.TextView.get_editable] is appropriate here.

insert_with_tags(iter, text, *tags)[source]¶

Inserts text into self at iter, applying the list of tags to the newly-inserted text.

The last tag specified must be None to terminate the list. Equivalent to calling [method`Gtk`.TextBuffer.insert], then [method`Gtk`.TextBuffer.apply_tag] on the inserted text; this is just a convenience function.

insert_with_tags_by_name(iter, text, *tags)[source]¶

Inserts text into self at iter, applying the list of tags to the newly-inserted text.

Same as [method`Gtk`.TextBuffer.insert_with_tags], but allows you to pass in tag names instead of tag objects.

move_mark(mark, where)[source]¶

Parameters:

mark (Gtk.TextMark) – a GtkTextMark
where (Gtk.TextIter) – new location for mark in self

Moves mark to the new location where.

Emits the [signal`Gtk`.TextBuffer::mark-set] signal as notification of the move.

move_mark_by_name(name, where)[source]¶

Parameters:

name (str) – name of a mark
where (Gtk.TextIter) – new location for mark

Moves the mark named name (which must exist) to location where.

See [method`Gtk`.TextBuffer.move_mark] for details.

paste_clipboard(clipboard, override_location, default_editable)[source]¶

Parameters:

clipboard (Gdk.Clipboard) – the GdkClipboard to paste from
override_location (Gtk.TextIter or None) – location to insert pasted text
default_editable (bool) – whether the buffer is editable by default

Pastes the contents of a clipboard.

If override_location is None, the pasted text will be inserted at the cursor position, or the buffer selection will be replaced if the selection is non-empty.

Note: pasting is asynchronous, that is, we’ll ask for the paste data and return, and at some point later after the main loop runs, the paste data will be inserted.

place_cursor(where)[source]¶

Parameters:: where (Gtk.TextIter) – where to put the cursor

This function moves the “insert” and “selection_bound” marks simultaneously.

If you move them to the same place in two steps with [method`Gtk`.TextBuffer.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.

redo()[source]¶: Redoes the next redoable action on the buffer, if there is one.

remove_all_tags(start, end)[source]¶

Parameters:

start (Gtk.TextIter) – one bound of range to be untagged
end (Gtk.TextIter) – other bound of range to be untagged

Removes all tags in the range between start and end.

Be careful with this function; it could remove tags added in code unrelated to the code you’re currently writing. That is, using this function is probably a bad idea if you have two or more unrelated code sections that add tags.

remove_selection_clipboard(clipboard)[source]¶

Parameters:: clipboard (Gdk.Clipboard) – a GdkClipboard added to self by [method`Gtk`.TextBuffer.add_selection_clipboard]

Removes a GdkClipboard added with [method`Gtk`.TextBuffer.add_selection_clipboard]

remove_tag(tag, start, end)[source]¶

Parameters:

tag (Gtk.TextTag) – a GtkTextTag
start (Gtk.TextIter) – one bound of range to be untagged
end (Gtk.TextIter) – other bound of range to be untagged

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.

remove_tag_by_name(name, start, end)[source]¶

Parameters:

name (str) – name of a GtkTextTag
start (Gtk.TextIter) – one bound of range to be untagged
end (Gtk.TextIter) – other bound of range to be untagged

Emits the “remove-tag” signal.

Calls [method`Gtk`.TextTagTable.lookup] on the buffer’s tag table to get a GtkTextTag, then calls [method`Gtk`.TextBuffer.remove_tag].

select_range(ins, bound)[source]¶

Parameters:

ins (Gtk.TextIter) – where to put the “insert” mark
bound (Gtk.TextIter) – where to put the “selection_bound” mark

This function moves the “insert” and “selection_bound” marks simultaneously.

If you move them in two steps with [method`Gtk`.TextBuffer.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.

set_enable_undo(enable_undo)[source]¶

Parameters:: enable_undo (bool) – True to enable undo

Sets whether or not to enable undoable actions in the text buffer.

Undoable actions in this context are changes to the text content of the buffer. Changes to tags and marks are not tracked.

If enabled, the user will be able to undo the last number of actions up to [method`Gtk`.TextBuffer.get_max_undo_levels].

See [method`Gtk`.TextBuffer.begin_irreversible_action] and [method`Gtk`.TextBuffer.end_irreversible_action] to create changes to the buffer that cannot be undone.

set_max_undo_levels(max_undo_levels)[source]¶

Parameters:: max_undo_levels (int) – the maximum number of undo actions to perform

Sets the maximum number of undo levels to perform.

If 0, unlimited undo actions may be performed. Note that this may have a memory usage impact as it requires storing an additional copy of the inserted or removed text within the text buffer.

set_modified(setting)[source]¶

Parameters:: setting (bool) – modification flag setting

Used to keep track of whether the buffer has been modified since the last time it was saved.

Whenever the buffer is saved to disk, call gtk_text_buffer_set_modified (@buffer, FALSE). When the buffer is modified, it will automatically toggle on the modified bit again. When the modified bit flips, the buffer emits the [signal`Gtk`.TextBuffer::modified-changed] signal.

set_text(text, length=-1)[source]¶

Parameters:

text (str) – UTF-8 text to insert
len (int) – length of text in bytes

Deletes current contents of self, and inserts text instead. This is automatically marked as an irreversible action in the undo stack. If you wish to mark this action as part of a larger undo operation, call [method`TextBuffer`.delete] and [method`TextBuffer`.insert] directly instead.

If len is -1, text must be nul-terminated. text must be valid UTF-8.

undo()[source]¶: Undoes the last undoable action on the buffer, if there is one.

do_apply_tag(tag, start, end) virtual¶

Parameters:

tag (Gtk.TextTag) – a GtkTextTag
start (Gtk.TextIter) – one bound of range to be tagged
end (Gtk.TextIter) – other bound of range to be tagged

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.

do_begin_user_action() virtual¶

Called to indicate that the buffer operations between here and a call to Gtk.TextBuffer.end_user_action() are part of a single user-visible operation.

The operations between Gtk.TextBuffer.begin_user_action() and Gtk.TextBuffer.end_user_action() can then be grouped when creating an undo stack. GtkTextBuffer maintains a count of calls to Gtk.TextBuffer.begin_user_action() that have not been closed with a call to Gtk.TextBuffer.end_user_action(), and emits the “begin-user-action” and “end-user-action” signals only for the outermost pair of calls. This allows you to build user actions from other user actions.

The “interactive” buffer mutation functions, such as [method`Gtk`.TextBuffer.insert_interactive], automatically call begin/end user action around the buffer operations they perform, so there’s no need to add extra calls if you user action consists solely of a single call to one of those functions.

do_changed() virtual¶: The class handler for the GtkTextBuffer::changed signal.

do_delete_range(start, end) virtual¶

Parameters:

start (Gtk.TextIter) –
end (Gtk.TextIter) –

The class handler for the GtkTextBuffer::delete-range signal.

do_end_user_action() virtual¶

Ends a user-visible operation.

Should be paired with a call to [method`Gtk`.TextBuffer.begin_user_action]. See that function for a full explanation.

do_insert_child_anchor(iter, anchor) virtual¶

Parameters:

iter (Gtk.TextIter) – location to insert the anchor
anchor (Gtk.TextChildAnchor) – a GtkTextChildAnchor

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 [method`Gtk`.TextBuffer.get_slice] and [method`Gtk`.TextBuffer.get_text].

Consider [method`Gtk`.TextBuffer.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.

do_insert_paintable(iter, paintable) virtual¶

Parameters:

iter (Gtk.TextIter) – location to insert the paintable
paintable (Gdk.Paintable) – a GdkPaintable

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 paintable, but the “text” variants do not. e.g. see [method`Gtk`.TextBuffer.get_slice] and [method`Gtk`.TextBuffer.get_text].

do_insert_text(pos, new_text, new_text_length) virtual¶

Parameters:

pos (Gtk.TextIter) –
new_text (str) –
new_text_length (int) –

The class handler for the GtkTextBuffer::insert-text signal.

do_mark_deleted(mark) virtual¶

Parameters:: mark (Gtk.TextMark) –

The class handler for the GtkTextBuffer::mark-deleted signal.

do_mark_set(location, mark) virtual¶

Parameters:

location (Gtk.TextIter) –
mark (Gtk.TextMark) –

The class handler for the GtkTextBuffer::mark-set signal.

do_modified_changed() virtual¶: The class handler for the GtkTextBuffer::modified-changed signal.

do_paste_done(clipboard) virtual¶

Parameters:: clipboard (Gdk.Clipboard) –

The class handler for the GtkTextBuffer::paste-done signal.

do_redo() virtual¶: Redoes the next redoable action on the buffer, if there is one.

do_remove_tag(tag, start, end) virtual¶

Parameters:

tag (Gtk.TextTag) – a GtkTextTag
start (Gtk.TextIter) – one bound of range to be untagged
end (Gtk.TextIter) – other bound of range to be untagged

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.

do_undo() virtual¶: Undoes the last undoable action on the buffer, if there is one.

Signal Details¶

Gtk.TextBuffer.signals.apply_tag(text_buffer, tag, start, end)¶

Signal Name:

apply-tag

Flags:

RUN_LAST

Parameters:

text_buffer (Gtk.TextBuffer) – The object which received the signal
tag (Gtk.TextTag) – the applied tag
start (Gtk.TextIter) – the start of the range the tag is applied to
end (Gtk.TextIter) – the end of the range the tag is applied to

Emitted to apply a tag to a range of text in a GtkTextBuffer.

Applying actually occurs in the default handler.

Note that if your handler runs before the default handler it must not invalidate the start and end iters (or has to revalidate them).

See also: [method`Gtk`.TextBuffer.apply_tag], [method`Gtk`.TextBuffer.insert_with_tags], [method`Gtk`.TextBuffer.insert_range].

Gtk.TextBuffer.signals.begin_user_action(text_buffer)¶

Signal Name:: begin-user-action
Flags:: RUN_LAST
Parameters:: text_buffer (Gtk.TextBuffer) – The object which received the signal

Emitted at the beginning of a single user-visible operation on a GtkTextBuffer.

See also: [method`Gtk`.TextBuffer.begin_user_action], [method`Gtk`.TextBuffer.insert_interactive], [method`Gtk`.TextBuffer.insert_range_interactive], [method`Gtk`.TextBuffer.delete_interactive], [method`Gtk`.TextBuffer.backspace], [method`Gtk`.TextBuffer.delete_selection].

Gtk.TextBuffer.signals.changed(text_buffer)¶

Signal Name:: changed
Flags:: RUN_LAST
Parameters:: text_buffer (Gtk.TextBuffer) – The object which received the signal

Emitted when the content of a GtkTextBuffer has changed.

Gtk.TextBuffer.signals.delete_range(text_buffer, start, end)¶

Signal Name:

delete-range

Flags:

RUN_LAST

Parameters:

text_buffer (Gtk.TextBuffer) – The object which received the signal
start (Gtk.TextIter) – the start of the range to be deleted
end (Gtk.TextIter) – the end of the range to be deleted

Emitted to delete a range from a GtkTextBuffer.

Note that if your handler runs before the default handler it must not invalidate the start and end iters (or has to revalidate them). The default signal handler revalidates the start and end iters to both point to the location where text was deleted. Handlers which run after the default handler (see g_signal_connect_after()) do not have access to the deleted text.

See also: [method`Gtk`.TextBuffer.delete].

Gtk.TextBuffer.signals.end_user_action(text_buffer)¶

Signal Name:: end-user-action
Flags:: RUN_LAST
Parameters:: text_buffer (Gtk.TextBuffer) – The object which received the signal

Emitted at the end of a single user-visible operation on the GtkTextBuffer.

See also: [method`Gtk`.TextBuffer.end_user_action], [method`Gtk`.TextBuffer.insert_interactive], [method`Gtk`.TextBuffer.insert_range_interactive], [method`Gtk`.TextBuffer.delete_interactive], [method`Gtk`.TextBuffer.backspace], [method`Gtk`.TextBuffer.delete_selection], [method`Gtk`.TextBuffer.backspace].

Gtk.TextBuffer.signals.insert_child_anchor(text_buffer, location, anchor)¶

Signal Name:

insert-child-anchor

Flags:

RUN_LAST

Parameters:

text_buffer (Gtk.TextBuffer) – The object which received the signal
location (Gtk.TextIter) – position to insert anchor in textbuffer
anchor (Gtk.TextChildAnchor) – the GtkTextChildAnchor to be inserted

Emitted to insert a GtkTextChildAnchor in a GtkTextBuffer.

Insertion actually occurs in the default handler.

Note that if your handler runs before the default handler it must not invalidate the location iter (or has to revalidate it). The default signal handler revalidates it to be placed after the inserted anchor.

See also: [method`Gtk`.TextBuffer.insert_child_anchor].

Gtk.TextBuffer.signals.insert_paintable(text_buffer, location, paintable)¶

Signal Name:

insert-paintable

Flags:

RUN_LAST

Parameters:

text_buffer (Gtk.TextBuffer) – The object which received the signal
location (Gtk.TextIter) – position to insert paintable in textbuffer
paintable (Gdk.Paintable) – the GdkPaintable to be inserted

Emitted to insert a GdkPaintable in a GtkTextBuffer.

Insertion actually occurs in the default handler.

Note that if your handler runs before the default handler it must not invalidate the location iter (or has to revalidate it). The default signal handler revalidates it to be placed after the inserted paintable.

See also: [method`Gtk`.TextBuffer.insert_paintable].

Gtk.TextBuffer.signals.insert_text(text_buffer, location, text, len)¶

Signal Name:

insert-text

Flags:

RUN_LAST

Parameters:

text_buffer (Gtk.TextBuffer) – The object which received the signal
location (Gtk.TextIter) – position to insert text in textbuffer
text (str) – the UTF-8 text to be inserted
len (int) – length of the inserted text in bytes

Emitted to insert text in a GtkTextBuffer.

Insertion actually occurs in the default handler.

Note that if your handler runs before the default handler it must not invalidate the location iter (or has to revalidate it). The default signal handler revalidates it to point to the end of the inserted text.

See also: [method`Gtk`.TextBuffer.insert], [method`Gtk`.TextBuffer.insert_range].

Gtk.TextBuffer.signals.mark_deleted(text_buffer, mark)¶

Signal Name:

mark-deleted

Flags:

RUN_LAST

Parameters:

text_buffer (Gtk.TextBuffer) – The object which received the signal
mark (Gtk.TextMark) – The mark that was deleted

Emitted as notification after a GtkTextMark is deleted.

See also: [method`Gtk`.TextBuffer.delete_mark].

Gtk.TextBuffer.signals.mark_set(text_buffer, location, mark)¶

Signal Name:

mark-set

Flags:

RUN_LAST

Parameters:

text_buffer (Gtk.TextBuffer) – The object which received the signal
location (Gtk.TextIter) – The location of mark in textbuffer
mark (Gtk.TextMark) – The mark that is set

Emitted as notification after a GtkTextMark is set.

See also: [method`Gtk`.TextBuffer.create_mark], [method`Gtk`.TextBuffer.move_mark].

Gtk.TextBuffer.signals.modified_changed(text_buffer)¶

Signal Name:: modified-changed
Flags:: RUN_LAST
Parameters:: text_buffer (Gtk.TextBuffer) – The object which received the signal

Emitted when the modified bit of a GtkTextBuffer flips.

See also: [method`Gtk`.TextBuffer.set_modified].

Gtk.TextBuffer.signals.paste_done(text_buffer, clipboard)¶

Signal Name:

paste-done

Flags:

RUN_LAST

Parameters:

text_buffer (Gtk.TextBuffer) – The object which received the signal
clipboard (Gdk.Clipboard) – the GdkClipboard pasted from

Emitted after paste operation has been completed.

This is useful to properly scroll the view to the end of the pasted text. See [method`Gtk`.TextBuffer.paste_clipboard] for more details.

Gtk.TextBuffer.signals.redo(text_buffer)¶

Signal Name:: redo
Flags:: RUN_LAST
Parameters:: text_buffer (Gtk.TextBuffer) – The object which received the signal

Emitted when a request has been made to redo the previously undone operation.

Gtk.TextBuffer.signals.remove_tag(text_buffer, tag, start, end)¶

Signal Name:

remove-tag

Flags:

RUN_LAST

Parameters:

text_buffer (Gtk.TextBuffer) – The object which received the signal
tag (Gtk.TextTag) – the tag to be removed
start (Gtk.TextIter) – the start of the range the tag is removed from
end (Gtk.TextIter) – the end of the range the tag is removed from

Emitted to remove all occurrences of tag from a range of text in a GtkTextBuffer.

Removal actually occurs in the default handler.

Note that if your handler runs before the default handler it must not invalidate the start and end iters (or has to revalidate them).

See also: [method`Gtk`.TextBuffer.remove_tag].

Gtk.TextBuffer.signals.undo(text_buffer)¶

Signal Name:: undo
Flags:: RUN_LAST
Parameters:: text_buffer (Gtk.TextBuffer) – The object which received the signal

Emitted when a request has been made to undo the previous operation or set of operations that have been grouped together.

Property Details¶

Gtk.TextBuffer.props.can_redo¶

Name:: can-redo
Type:: bool
Default Value:: False
Flags:: READABLE

Denotes that the buffer can reapply the last undone action.

Gtk.TextBuffer.props.can_undo¶

Name:: can-undo
Type:: bool
Default Value:: False
Flags:: READABLE

Denotes that the buffer can undo the last applied action.

Gtk.TextBuffer.props.cursor_position¶

Name:: cursor-position
Type:: int
Default Value:: 0
Flags:: READABLE

The position of the insert mark.

This is an offset from the beginning of the buffer. It is useful for getting notified when the cursor moves.

Gtk.TextBuffer.props.enable_undo¶

Name:: enable-undo
Type:: bool
Default Value:: True
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Denotes if support for undoing and redoing changes to the buffer is allowed.

Gtk.TextBuffer.props.has_selection¶

Name:: has-selection
Type:: bool
Default Value:: False
Flags:: READABLE

Whether the buffer has some text currently selected.

Gtk.TextBuffer.props.tag_table¶

Name:: tag-table
Type:: Gtk.TextTagTable
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The Gtk.TextTagTable for the buffer.

Gtk.TextBuffer.props.text¶

Name:: text
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE

The text content of the buffer.

Without child widgets and images, see [method`Gtk`.TextBuffer.get_text] for more information.