TextBuffer
Superclasses: 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 set_enable_undo
.
Constructors
- class TextBuffer
- classmethod new(table: TextTagTable | None = None) TextBuffer
Creates a new text buffer.
- Parameters:
table – a tag table, or
None
to create a new one
Methods
- class TextBuffer
- add_mark(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
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(clipboard: Clipboard) None
Adds
clipboard
to the list of clipboards in which the selection contents ofbuffer
are available.In most cases,
clipboard
will be theGdkClipboard
returned byget_primary_clipboard
for a view ofbuffer
.- Parameters:
clipboard – a
GdkClipboard
- apply_tag(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
andend
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(name: str, start: TextIter, end: TextIter) None
Emits the “apply-tag” signal on
buffer
.Calls
lookup
on the buffer’s tag table to get aGtkTextTag
, then callsapply_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(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() 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
end_irreversible_action
after the irreversible action has completed.You may nest calls to
begin_irreversible_action()
andend_irreversible_action()
pairs.
- begin_user_action() None
Called to indicate that the buffer operations between here and a call to
end_user_action()
are part of a single user-visible operation.The operations between
begin_user_action()
andend_user_action()
can then be grouped when creating an undo stack.GtkTextBuffer
maintains a count of calls tobegin_user_action()
that have not been closed with a call toend_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
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.
- create_child_anchor(iter: TextIter) TextChildAnchor
Creates and inserts a child anchor.
This is a convenience function which simply creates a child anchor with
new
and inserts it into the buffer withinsert_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(mark_name, where, left_gravity=False)
Creates a mark at position
where
.If
mark_name
isNone
, the mark is anonymous; otherwise, the mark can be retrieved by name usingget_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.- Parameters:
mark_name – name for mark
where – location to place mark
left_gravity – whether the mark has left gravity
- create_tag(tag_name=None, **properties)
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
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 calledtag_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)
- Returns:
A new tag.
- cut_clipboard(clipboard: 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 todefault_editable – default editability of the buffer
- delete(start: TextIter, end: TextIter) None
Deletes text between
start
andend
.The order of
start
andend
is not actually relevant;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
andend
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(start_iter: TextIter, end_iter: TextIter, default_editable: bool) bool
Deletes all editable text in the given range.
Calls
delete
for each editable sub-range of [start
,``end``).start
andend
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(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
ref()
on the mark, it will be freed. Even if the mark isn’t freed, most operations onmark
become invalid, until it gets added to a buffer again withadd_mark
. Useget_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.- Parameters:
mark – a
GtkTextMark
inbuffer
- delete_mark_by_name(name: str) None
Deletes the mark named
name
; the mark must exist.See
delete_mark
for details.- Parameters:
name – name of a mark in
buffer
- delete_selection(interactive: bool, default_editable: bool) bool
Deletes the range between the “insert” and “selection_bound” marks, that is, the currently-selected text.
If
interactive
isTrue
, 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() 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
begin_irreversible_action
was called.You may nest calls to
begin_irreversible_action()
andend_irreversible_action()
pairs.
- end_user_action() None
Ends a user-visible operation.
Should be paired with a call to
begin_user_action
. See that function for a full explanation.
- get_bounds() tuple[TextIter, TextIter]
Retrieves the first and last iterators in the buffer, i.e. the entire buffer lies within the range [
start
,``end``).
- get_char_count() 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() bool
Gets whether the buffer is saving modifications to the buffer to allow for undo and redo actions.
See
begin_irreversible_action
andend_irreversible_action
to create changes to the buffer that cannot be undone.
- get_end_iter() TextIter
Initializes
iter
with the “end iterator,” one past the last valid character in the text buffer.If dereferenced with
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 (callget_start_iter
to get character position 0) to the end iterator.
- get_insert() TextMark
Returns the mark that represents the cursor (insertion point).
Equivalent to calling
get_mark
to get the mark named “insert”, but very slightly more efficient, and involves less typing.
- get_iter_at_child_anchor(anchor: TextChildAnchor) TextIter
Obtains the location of
anchor
withinbuffer
.- Parameters:
anchor – a child anchor that appears in
buffer
- get_iter_at_line(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 thebuffer
, the end iterator is returned.- Parameters:
line_number – line number counting from 0
- get_iter_at_line_index(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 thebuffer
, the end iterator is returned. And ifbyte_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(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 thebuffer
, the end iterator is returned. And ifchar_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(mark: TextMark) TextIter
Initializes
iter
with the current position ofmark
.- Parameters:
mark – a
GtkTextMark
inbuffer
- get_iter_at_offset(char_offset: int) TextIter
Initializes
iter
to a positionchar_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() int
Obtains the number of lines in the buffer.
This value is cached, so the function is very fast.
- get_mark(name: str) TextMark | None
Returns the mark named
name
in bufferbuffer
, orNone
if no such mark exists in the buffer.- Parameters:
name – a mark name
- get_max_undo_levels() 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() bool
Indicates whether the buffer has been modified since the last call to
set_modified
set the modification flag toFalse
.Used for example to enable a “save” function in a text editor.
- get_selection_bound() TextMark
Returns the mark that represents the selection bound.
Equivalent to calling
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.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() tuple[bool, TextIter, TextIter]
Returns
True
if some text is selected; places the bounds of the selection instart
andend
.If the selection has length 0, then
start
andend
are filled in with the same value.start
andend
will be in ascending order. Ifstart
andend
areNone
, then they are not filled in, but the return value still indicates whether text is selected.
- get_selection_content() ContentProvider
Get a content provider for this buffer.
It can be used to make the content of
buffer
available in aGdkClipboard
, seeset_content
.
- get_slice(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
isFalse
. 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 withget_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() TextIter
Initialized
iter
with the first position in the text buffer.This is the same as using
get_iter_at_offset
to get the iter at character offset 0.
- get_tag_table() TextTagTable
Get the
GtkTextTagTable
associated with this buffer.
- get_text(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
isFalse
. 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 withget_slice
.- Parameters:
start – start of a range
end – end of a range
include_hidden_chars – whether to include invisible text
- insert(iter, text, length=-1)
Inserts
len
bytes oftext
at positioniter
.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
length
- insert_at_cursor(text, length=-1)
Inserts
text
inbuffer
.Simply calls
insert
, using the current cursor position as the insertion point.- Parameters:
text – text in UTF-8 format
length
- insert_child_anchor(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
get_slice
andget_text
.Consider
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(iter: TextIter, text: str, len: int, default_editable: bool) bool
Inserts
text
inbuffer
.Like
insert
, but the insertion will not occur ifiter
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 ofget_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(text: str, len: int, default_editable: bool) bool
Inserts
text
inbuffer
.Calls
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 ofget_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(iter: TextIter, markup: str, len: int) None
Inserts the text in
markup
at positioniter
.markup
will be inserted in its entirety and must be nul-terminated and valid UTF-8. Emits theinsert_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(iter: TextIter, paintable: 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
get_slice
andget_text
.- Parameters:
iter – location to insert the paintable
paintable – a
GdkPaintable
- insert_range(iter: TextIter, start: TextIter, end: TextIter) None
Copies text, tags, and paintables between
start
andend
and inserts the copy atiter
.The order of
start
andend
doesn’t matter.Used instead of simply getting/inserting text because it preserves images and tags. If
start
andend
are in a different buffer frombuffer
, 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(iter: TextIter, start: TextIter, end: TextIter, default_editable: bool) bool
Copies text, tags, and paintables between
start
andend
and inserts the copy atiter
.Same as
insert_range
, but does nothing if the insertion point isn’t editable. Thedefault_editable
parameter indicates whether the text is editable atiter
if no tags enclosingiter
affect editability. Typically the result ofget_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
- insert_with_tags(iter, text, *tags)
Inserts
text
intobuffer
atiter
, applying the list of tags to the newly-inserted text.The last tag specified must be
None
to terminate the list. Equivalent to callinginsert
, thenapply_tag
on the inserted text; this is just a convenience function.- Parameters:
iter – an iterator in
buffer
text – UTF-8 text
tags
- insert_with_tags_by_name(iter, text, *tags)
Inserts
text
intobuffer
atiter
, applying the list of tags to the newly-inserted text.Same as
insert_with_tags
, but allows you to pass in tag names instead of tag objects.- Parameters:
iter – position in
buffer
text – UTF-8 text
tags
- move_mark(mark: TextMark, where: TextIter) None
Moves
mark
to the new locationwhere
.Emits the
mark_set
signal as notification of the move.- Parameters:
mark – a
GtkTextMark
where – new location for
mark
inbuffer
- move_mark_by_name(name: str, where: TextIter) None
Moves the mark named
name
(which must exist) to locationwhere
.See
move_mark
for details.- Parameters:
name – name of a mark
where – new location for mark
- paste_clipboard(clipboard: Clipboard, override_location: TextIter | None, default_editable: bool) None
Pastes the contents of a clipboard.
If
override_location
isNone
, 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 fromoverride_location – location to insert pasted text
default_editable – whether the buffer is editable by default
- place_cursor(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
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
- remove_all_tags(start: TextIter, end: TextIter) None
Removes all tags in the range between
start
andend
.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_selection_clipboard(clipboard: Clipboard) None
Removes a
GdkClipboard
added withadd_selection_clipboard
- Parameters:
clipboard – a
GdkClipboard
added tobuffer
byadd_selection_clipboard
- remove_tag(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
andend
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(name: str, start: TextIter, end: TextIter) None
Emits the “remove-tag” signal.
Calls
lookup
on the buffer’s tag table to get aGtkTextTag
, then callsremove_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(ins: TextIter, bound: TextIter) None
This function moves the “insert” and “selection_bound” marks simultaneously.
If you move them in two steps with
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(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
get_max_undo_levels
.See
begin_irreversible_action
andend_irreversible_action
to create changes to the buffer that cannot be undone.- Parameters:
enable_undo –
True
to enable undo
- set_max_undo_levels(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(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 themodified_changed
signal.- Parameters:
setting – modification flag setting
- set_text(text, length=-1)
Deletes current contents of
buffer
, and insertstext
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, calldelete
andinsert
directly instead.If
len
is -1,text
must be nul-terminated.text
must be valid UTF-8.- Parameters:
text – UTF-8 text to insert
length
Properties
- class TextBuffer
-
- props.cursor_position: int
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.
- props.enable_undo: bool
Denotes if support for undoing and redoing changes to the buffer is allowed.
- props.tag_table: TextTagTable
The GtkTextTagTable for the buffer.
Signals
- class TextBuffer.signals
- apply_tag(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
andend
iters (or has to revalidate them).See also:
apply_tag
,insert_with_tags
,insert_range
.- Parameters:
tag – the applied tag
start – the start of the range the tag is applied to
end – the end of the range the tag is applied to
- begin_user_action() None
Emitted at the beginning of a single user-visible operation on a
GtkTextBuffer
.See also:
begin_user_action
,insert_interactive
,insert_range_interactive
,delete_interactive
,backspace
,delete_selection
.
- delete_range(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
andend
iters (or has to revalidate them). The default signal handler revalidates thestart
andend
iters to both point to the location where text was deleted. Handlers which run after the default handler (seesignal_connect_after()
) do not have access to the deleted text.See also:
delete
.- Parameters:
start – the start of the range to be deleted
end – the end of the range to be deleted
- end_user_action() None
Emitted at the end of a single user-visible operation on the
GtkTextBuffer
.See also:
end_user_action
,insert_interactive
,insert_range_interactive
,delete_interactive
,backspace
,delete_selection
,backspace
.
- insert_child_anchor(location: TextIter, anchor: TextChildAnchor) None
Emitted to insert a
GtkTextChildAnchor
in aGtkTextBuffer
.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 insertedanchor
.See also:
insert_child_anchor
.- Parameters:
location – position to insert
anchor
intextbuffer
anchor – the
GtkTextChildAnchor
to be inserted
- insert_paintable(location: TextIter, paintable: Paintable) None
Emitted to insert a
GdkPaintable
in aGtkTextBuffer
.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 insertedpaintable
.See also:
insert_paintable
.- Parameters:
location – position to insert
paintable
intextbuffer
paintable – the
GdkPaintable
to be inserted
- insert_text(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.See also:
insert
,insert_range
.- Parameters:
location – position to insert
text
intextbuffer
text – the UTF-8 text to be inserted
len – length of the inserted text in bytes
- mark_deleted(mark: TextMark) None
Emitted as notification after a
GtkTextMark
is deleted.See also:
delete_mark
.- Parameters:
mark – The mark that was deleted
- mark_set(location: TextIter, mark: TextMark) None
Emitted as notification after a
GtkTextMark
is set.See also:
create_mark
,move_mark
.- Parameters:
location – The location of
mark
intextbuffer
mark – The mark that is set
- modified_changed() None
Emitted when the modified bit of a
GtkTextBuffer
flips.See also:
set_modified
.
- paste_done(clipboard: 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
paste_clipboard
for more details.- Parameters:
clipboard – the
GdkClipboard
pasted from
- remove_tag(tag: TextTag, start: TextIter, end: TextIter) None
Emitted to remove all occurrences of
tag
from a range of text in aGtkTextBuffer
.Removal actually occurs in the default handler.
Note that if your handler runs before the default handler it must not invalidate the
start
andend
iters (or has to revalidate them).See also:
remove_tag
.- Parameters:
tag – the tag to be removed
start – the start of the range the tag is removed from
end – the end of the range the tag is removed from
Virtual Methods
- class TextBuffer
- do_apply_tag(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
andend
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() None
Called to indicate that the buffer operations between here and a call to
end_user_action()
are part of a single user-visible operation.The operations between
begin_user_action()
andend_user_action()
can then be grouped when creating an undo stack.GtkTextBuffer
maintains a count of calls tobegin_user_action()
that have not been closed with a call toend_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
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_delete_range(start: TextIter, end: TextIter) None
The class handler for the
GtkTextBuffer::delete-range
signal.- Parameters:
start
end
- do_end_user_action() None
Ends a user-visible operation.
Should be paired with a call to
begin_user_action
. See that function for a full explanation.
- do_insert_child_anchor(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
get_slice
andget_text
.Consider
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(iter: TextIter, paintable: 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
get_slice
andget_text
.- Parameters:
iter – location to insert the paintable
paintable – a
GdkPaintable
- do_insert_text(pos: TextIter, new_text: str, new_text_length: int) None
The class handler for the
GtkTextBuffer::insert-text
signal.- Parameters:
pos
new_text
new_text_length
- do_mark_deleted(mark: TextMark) None
The class handler for the
GtkTextBuffer::mark-deleted
signal.- Parameters:
mark
- do_mark_set(location: TextIter, mark: TextMark) None
The class handler for the
GtkTextBuffer::mark-set
signal.- Parameters:
location
mark
- do_paste_done(clipboard: Clipboard) None
The class handler for the
GtkTextBuffer::paste-done
signal.- Parameters:
clipboard
- do_remove_tag(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
andend
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