Gtk.TextBuffer¶

class — extends GObject.Object

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.

GtkTextBuffer can support undoing changes to the buffer content, see TextBuffer.set_enable_undo.

Constructors¶

new¶

@classmethod
def new(cls, table: TextTagTable | None = ...) -> TextBuffer

Creates a new text buffer.

Parameters:

table — a tag table, or None to create a new one

Methods¶

add_commit_notify¶

def add_commit_notify(self, flags: TextBufferNotifyFlags | int, commit_notify: TextBufferCommitNotify) -> int

Adds a TextBufferCommitNotify to be called when a change is to be made to the TextBuffer.

Functions are explicitly forbidden from making changes to the TextBuffer from this callback. It is intended for tracking changes to the buffer only.

It may be advantageous to use TextBufferCommitNotify over connecting to the TextBuffer.insert-text or TextBuffer.delete-range signals to avoid ordering issues with other signal handlers which may further modify the TextBuffer.

Parameters:

flags — which notifications should be dispatched to callback
commit_notify — a TextBufferCommitNotify to call for commit notifications

add_mark¶

def add_mark(self, mark: TextMark, where: TextIter) -> None

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 TextBuffer.mark-set signal as notification of the mark's initial placement.

Parameters:

mark — the mark to add
where — location to place mark

add_selection_clipboard¶

def add_selection_clipboard(self, clipboard: Gdk.Clipboard) -> None

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

In most cases, clipboard will be the GdkClipboard returned by Widget.get_primary_clipboard for a view of buffer.

Parameters:

clipboard — a GdkClipboard

apply_tag¶

def apply_tag(self, tag: TextTag, start: TextIter, end: TextIter) -> None

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.

Parameters:

tag — a GtkTextTag
start — one bound of range to be tagged
end — other bound of range to be tagged

apply_tag_by_name¶

def apply_tag_by_name(self, name: str, start: TextIter, end: TextIter) -> None

Emits the “apply-tag” signal on buffer.

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

Parameters:

name — name of a named GtkTextTag
start — one bound of range to be tagged
end — other bound of range to be tagged

backspace¶

def backspace(self, iter: TextIter, interactive: bool, default_editable: bool) -> 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.

Parameters:

iter — a position in buffer
interactive — whether the deletion is caused by user interaction
default_editable — whether the buffer is editable by default

begin_irreversible_action¶

def begin_irreversible_action(self) -> None

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 TextBuffer.end_irreversible_action after the irreversible action has completed.

You may nest calls to TextBuffer.begin_irreversible_action and TextBuffer.end_irreversible_action pairs.

begin_user_action¶

def begin_user_action(self) -> None

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

The operations between TextBuffer.begin_user_action and TextBuffer.end_user_action can then be grouped when creating an undo stack. GtkTextBuffer maintains a count of calls to TextBuffer.begin_user_action that have not been closed with a call to 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 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¶

def copy_clipboard(self, clipboard: Gdk.Clipboard) -> None

Copies the currently-selected text to a clipboard.

Parameters:

clipboard — the GdkClipboard object to copy to

create_child_anchor¶

def create_child_anchor(self, iter: TextIter) -> TextChildAnchor

Creates and inserts a child anchor.

This is a convenience function which simply creates a child anchor with TextChildAnchor.new and inserts it into the buffer with TextBuffer.insert_child_anchor.

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

Parameters:

iter — location in the buffer

create_mark¶

def create_mark(self, mark_name: str | None, where: TextIter, left_gravity: bool) -> 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 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 TextBuffer.mark-set signal as notification of the mark's initial placement.

Parameters:

mark_name — name for mark
where — location to place mark
left_gravity — whether the mark has left gravity

cut_clipboard¶

def cut_clipboard(self, clipboard: Gdk.Clipboard, default_editable: bool) -> None

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

Parameters:

clipboard — the GdkClipboard object to cut to
default_editable — default editability of the buffer

delete¶

def delete(self, start: TextIter, end: TextIter) -> None

Deletes text between start and end.

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

Parameters:

start — a position in buffer
end — another position in buffer

delete_interactive¶

def delete_interactive(self, start_iter: TextIter, end_iter: TextIter, default_editable: bool) -> bool

Deletes all editable text in the given range.

Calls 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.

Parameters:

start_iter — start of range to delete
end_iter — end of range
default_editable — whether the buffer is editable by default

delete_mark¶

def delete_mark(self, mark: TextMark) -> None

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

The TextBuffer.mark-deleted signal will be emitted as notification after the mark is deleted.

Parameters:

mark — a GtkTextMark in buffer

delete_mark_by_name¶

def delete_mark_by_name(self, name: str) -> None

Deletes the mark named name; the mark must exist.

See TextBuffer.delete_mark for details.

Parameters:

name — name of a mark in buffer

delete_selection¶

def delete_selection(self, interactive: bool, default_editable: bool) -> 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).

Parameters:

interactive — whether the deletion is caused by user interaction
default_editable — whether the buffer is editable by default

end_irreversible_action¶

def end_irreversible_action(self) -> None

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 TextBuffer.begin_irreversible_action was called.

You may nest calls to TextBuffer.begin_irreversible_action and TextBuffer.end_irreversible_action pairs.

end_user_action¶

def end_user_action(self) -> None

Ends a user-visible operation.

Should be paired with a call to TextBuffer.begin_user_action. See that function for a full explanation.

get_bounds¶

def get_bounds(self) -> tuple[TextIter, TextIter]

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

get_can_redo¶

def get_can_redo(self) -> bool

Gets whether there is a redoable action in the history.

get_can_undo¶

def get_can_undo(self) -> bool

Gets whether there is an undoable action in the history.

get_char_count¶

def get_char_count(self) -> 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¶

def get_enable_undo(self) -> bool

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

See TextBuffer.begin_irreversible_action and TextBuffer.end_irreversible_action to create changes to the buffer that cannot be undone.

get_end_iter¶

def get_end_iter(self) -> TextIter

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

If dereferenced with 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 TextBuffer.get_start_iter to get character position 0) to the end iterator.

get_has_selection¶

def get_has_selection(self) -> bool

Indicates whether the buffer has some text currently selected.

get_insert¶

def get_insert(self) -> TextMark

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

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

get_iter_at_child_anchor¶

def get_iter_at_child_anchor(self, anchor: TextChildAnchor) -> TextIter

Obtains the location of anchor within buffer.

Parameters:

anchor — a child anchor that appears in buffer

get_iter_at_line¶

def get_iter_at_line(self, line_number: int) -> tuple[bool, 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 buffer, the end iterator is returned.

Parameters:

line_number — line number counting from 0

get_iter_at_line_index¶

def get_iter_at_line_index(self, line_number: int, byte_index: int) -> tuple[bool, 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 buffer, 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.

Parameters:

line_number — line number counting from 0
byte_index — byte index from start of line

get_iter_at_line_offset¶

def get_iter_at_line_offset(self, line_number: int, char_offset: int) -> tuple[bool, 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 buffer, 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.

Parameters:

line_number — line number counting from 0
char_offset — char offset from start of line

get_iter_at_mark¶

def get_iter_at_mark(self, mark: TextMark) -> TextIter

Initializes iter with the current position of mark.

Parameters:

mark — a GtkTextMark in buffer

get_iter_at_offset¶

def get_iter_at_offset(self, char_offset: int) -> 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.

Parameters:

char_offset — char offset from start of buffer, counting from 0, or -1

get_line_count¶

def get_line_count(self) -> int

Obtains the number of lines in the buffer.

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

get_mark¶

def get_mark(self, name: str) -> TextMark | None

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

Parameters:

name — a mark name

get_max_undo_levels¶

def get_max_undo_levels(self) -> 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¶

def get_modified(self) -> bool

Indicates whether the buffer has been modified since the last call to TextBuffer.set_modified set the modification flag to False.

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

get_selection_bound¶

def get_selection_bound(self) -> TextMark

Returns the mark that represents the selection bound.

Equivalent to calling TextBuffer.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. 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¶

def get_selection_bounds(self) -> tuple[bool, TextIter, TextIter]

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¶

def get_selection_content(self) -> Gdk.ContentProvider

Get a content provider for this buffer.

It can be used to make the content of buffer available in a GdkClipboard, see Gdk.Clipboard.set_content.

get_slice¶

def get_slice(self, start: TextIter, end: TextIter, include_hidden_chars: bool) -> 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 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.

Parameters:

start — start of a range
end — end of a range
include_hidden_chars — whether to include invisible text

get_start_iter¶

def get_start_iter(self) -> TextIter

Initialized iter with the first position in the text buffer.

This is the same as using TextBuffer.get_iter_at_offset to get the iter at character offset 0.

get_tag_table¶

def get_tag_table(self) -> TextTagTable

Get the GtkTextTagTable associated with this buffer.

get_text¶

def get_text(self, start: TextIter, end: TextIter, include_hidden_chars: bool) -> 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 TextBuffer.get_slice.

Parameters:

start — start of a range
end — end of a range
include_hidden_chars — whether to include invisible text

insert¶

def insert(self, iter: TextIter, text: str, len: int) -> None

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.

Parameters:

iter — a position in the buffer
text — text in UTF-8 format
len — length of text in bytes, or -1

insert_at_cursor¶

def insert_at_cursor(self, text: str, len: int) -> None

Inserts text in buffer.

Simply calls TextBuffer.insert, using the current cursor position as the insertion point.

Parameters:

text — text in UTF-8 format
len — length of text, in bytes

insert_child_anchor¶

def insert_child_anchor(self, iter: TextIter, anchor: TextChildAnchor) -> None

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 TextBuffer.get_slice and TextBuffer.get_text.

Consider 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.

Parameters:

iter — location to insert the anchor
anchor — a GtkTextChildAnchor

insert_interactive¶

def insert_interactive(self, iter: TextIter, text: str, len: int, default_editable: bool) -> bool

Inserts text in buffer.

Like 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 TextView.get_editable is appropriate here.

Parameters:

iter — a position in buffer
text — some UTF-8 text
len — length of text in bytes, or -1
default_editable — default editability of buffer

insert_interactive_at_cursor¶

def insert_interactive_at_cursor(self, text: str, len: int, default_editable: bool) -> bool

Inserts text in buffer.

Calls 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 TextView.get_editable is appropriate here.

Parameters:

text — text in UTF-8 format
len — length of text in bytes, or -1
default_editable — default editability of buffer

insert_markup¶

def insert_markup(self, iter: TextIter, markup: str, len: int) -> None

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 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.

Parameters:

iter — location to insert the markup
markup — a nul-terminated UTF-8 string containing Pango markup
len — length of markup in bytes, or -1

insert_paintable¶

def insert_paintable(self, iter: TextIter, paintable: Gdk.Paintable) -> None

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 TextBuffer.get_slice and TextBuffer.get_text.

Parameters:

iter — location to insert the paintable
paintable — a GdkPaintable

insert_range¶

def insert_range(self, iter: TextIter, start: TextIter, end: TextIter) -> None

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 buffer, the two buffers must share the same tag table.

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

Parameters:

iter — a position in buffer
start — a position in a GtkTextBuffer
end — another position in the same buffer as start

insert_range_interactive¶

def insert_range_interactive(self, iter: TextIter, start: TextIter, end: TextIter, default_editable: bool) -> bool

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

Same as 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 TextView.get_editable is appropriate here.

Parameters:

iter — a position in buffer
start — a position in a GtkTextBuffer
end — another position in the same buffer as start
default_editable — default editability of the buffer

move_mark¶

def move_mark(self, mark: TextMark, where: TextIter) -> None

Moves mark to the new location where.

Emits the TextBuffer.mark-set signal as notification of the move.

Parameters:

mark — a GtkTextMark
where — new location for mark in buffer

move_mark_by_name¶

def move_mark_by_name(self, name: str, where: TextIter) -> None

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

See TextBuffer.move_mark for details.

Parameters:

name — name of a mark
where — new location for mark

paste_clipboard¶

def paste_clipboard(self, clipboard: Gdk.Clipboard, override_location: TextIter | None, default_editable: bool) -> None

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.

Parameters:

clipboard — the GdkClipboard to paste from
override_location — location to insert pasted text
default_editable — whether the buffer is editable by default

place_cursor¶

def place_cursor(self, where: TextIter) -> None

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

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

Parameters:

where — where to put the cursor

redo¶

def redo(self) -> None

Redoes the next redoable action on the buffer, if there is one.

remove_all_tags¶

def remove_all_tags(self, start: TextIter, end: TextIter) -> None

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.

Parameters:

start — one bound of range to be untagged
end — other bound of range to be untagged

remove_commit_notify¶

def remove_commit_notify(self, commit_notify_handler: int) -> None

Removes the GtkTextBufferCommitNotify handler previously registered with TextBuffer.add_commit_notify.

This may result in the user_data_destroy being called that was passed when registering the commit notify functions.

Parameters:

commit_notify_handler — the notify handler identifier returned from TextBuffer.add_commit_notify.

remove_selection_clipboard¶

def remove_selection_clipboard(self, clipboard: Gdk.Clipboard) -> None

Removes a GdkClipboard added with TextBuffer.add_selection_clipboard

Parameters:

clipboard — a GdkClipboard added to buffer by TextBuffer.add_selection_clipboard

remove_tag¶

def remove_tag(self, tag: TextTag, start: TextIter, end: TextIter) -> None

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.

Parameters:

tag — a GtkTextTag
start — one bound of range to be untagged
end — other bound of range to be untagged

remove_tag_by_name¶

def remove_tag_by_name(self, name: str, start: TextIter, end: TextIter) -> None

Emits the “remove-tag” signal.

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

Parameters:

name — name of a GtkTextTag
start — one bound of range to be untagged
end — other bound of range to be untagged

select_range¶

def select_range(self, ins: TextIter, bound: TextIter) -> None

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

If you move them in two steps with 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.

Parameters:

ins — where to put the “insert” mark
bound — where to put the “selection_bound” mark

set_enable_undo¶

def set_enable_undo(self, enable_undo: bool) -> None

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 TextBuffer.get_max_undo_levels.

See TextBuffer.begin_irreversible_action and TextBuffer.end_irreversible_action to create changes to the buffer that cannot be undone.

Parameters:

enable_undo — True to enable undo

set_max_undo_levels¶

def set_max_undo_levels(self, max_undo_levels: int) -> None

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.

Parameters:

max_undo_levels — the maximum number of undo actions to perform

set_modified¶

def set_modified(self, setting: bool) -> None

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 TextBuffer.modified-changed signal.

Parameters:

setting — modification flag setting

set_text¶

def set_text(self, text: str, len: int) -> None

Deletes current contents of buffer, 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 TextBuffer.delete and TextBuffer.insert directly instead.

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

Parameters:

text — UTF-8 text to insert
len — length of text in bytes

undo¶

def undo(self) -> None

Undoes the last undoable action on the buffer, if there is one.

Virtual methods¶

do_apply_tag¶

def do_apply_tag(self, tag: TextTag, start: TextIter, end: TextIter) -> None

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.

Parameters:

tag — a GtkTextTag
start — one bound of range to be tagged
end — other bound of range to be tagged

do_begin_user_action¶

def do_begin_user_action(self) -> None

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

The operations between TextBuffer.begin_user_action and TextBuffer.end_user_action can then be grouped when creating an undo stack. GtkTextBuffer maintains a count of calls to TextBuffer.begin_user_action that have not been closed with a call to 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 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¶

def do_changed(self) -> None

The class handler for the GtkTextBuffer::changed signal.

do_delete_range¶

def do_delete_range(self, start: TextIter, end: TextIter) -> None

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

do_end_user_action¶

def do_end_user_action(self) -> None

Ends a user-visible operation.

Should be paired with a call to TextBuffer.begin_user_action. See that function for a full explanation.

do_insert_child_anchor¶

def do_insert_child_anchor(self, iter: TextIter, anchor: TextChildAnchor) -> None

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 TextBuffer.get_slice and TextBuffer.get_text.

Consider 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.

Parameters:

iter — location to insert the anchor
anchor — a GtkTextChildAnchor

do_insert_paintable¶

def do_insert_paintable(self, iter: TextIter, paintable: Gdk.Paintable) -> None

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 TextBuffer.get_slice and TextBuffer.get_text.

Parameters:

iter — location to insert the paintable
paintable — a GdkPaintable

do_insert_text¶

def do_insert_text(self, pos: TextIter, new_text: str, new_text_length: int) -> None

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

do_mark_deleted¶

def do_mark_deleted(self, mark: TextMark) -> None

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

do_mark_set¶

def do_mark_set(self, location: TextIter, mark: TextMark) -> None

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

do_modified_changed¶

def do_modified_changed(self) -> None

The class handler for the GtkTextBuffer::modified-changed signal.

do_paste_done¶

def do_paste_done(self, clipboard: Gdk.Clipboard) -> None

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

do_redo¶

def do_redo(self) -> None

Redoes the next redoable action on the buffer, if there is one.

do_remove_tag¶

def do_remove_tag(self, tag: TextTag, start: TextIter, end: TextIter) -> None

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.

Parameters:

tag — a GtkTextTag
start — one bound of range to be untagged
end — other bound of range to be untagged

do_undo¶

def do_undo(self) -> None

Undoes the last undoable action on the buffer, if there is one.

Properties¶

can_redo¶

can_redo: bool  # read-only

Denotes that the buffer can reapply the last undone action.

can_undo¶

can_undo: bool  # read-only

Denotes that the buffer can undo the last applied action.

cursor_position¶

cursor_position: int  # read-only

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.

enable_undo¶

enable_undo: bool  # read/write

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

has_selection¶

has_selection: bool  # read-only

Whether the buffer has some text currently selected.

tag_table¶

tag_table: TextTagTable  # read/write

The GtkTextTagTable for the buffer.

text¶

text: str  # read/write

The text content of the buffer.

Without child widgets and images, see TextBuffer.get_text for more information.

Signals¶

apply-tag¶

def on_apply_tag(self, tag: TextTag, start: TextIter, end: TextIter) -> None: ...

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

begin-user-action¶

def on_begin_user_action(self) -> None: ...

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

changed¶

def on_changed(self) -> None: ...

Emitted when the content of a GtkTextBuffer has changed.

delete-range¶

def on_delete_range(self, start: TextIter, end: TextIter) -> None: ...

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.

end-user-action¶

def on_end_user_action(self) -> None: ...

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

insert-child-anchor¶

def on_insert_child_anchor(self, location: TextIter, anchor: TextChildAnchor) -> None: ...

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.

insert-paintable¶

def on_insert_paintable(self, location: TextIter, paintable: Gdk.Paintable) -> None: ...

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.

insert-text¶

def on_insert_text(self, location: TextIter, text: str, len: int) -> None: ...

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.

mark-deleted¶

def on_mark_deleted(self, mark: TextMark) -> None: ...

Emitted as notification after a GtkTextMark is deleted.

mark-set¶

def on_mark_set(self, location: TextIter, mark: TextMark) -> None: ...

Emitted as notification after a GtkTextMark is set.

modified-changed¶

def on_modified_changed(self) -> None: ...

Emitted when the modified bit of a GtkTextBuffer flips.

paste-done¶

def on_paste_done(self, clipboard: Gdk.Clipboard) -> None: ...

Emitted after paste operation has been completed.

This is useful to properly scroll the view to the end of the pasted text. See TextBuffer.paste_clipboard for more details.

redo¶

def on_redo(self) -> None: ...

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

remove-tag¶

def on_remove_tag(self, tag: TextTag, start: TextIter, end: TextIter) -> None: ...

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

undo¶

def on_undo(self) -> None: ...

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