TextMark

class TextMark(**properties: Any)

Superclasses: Object

A GtkTextMark is a position in a GtkTextbuffer that is preserved across modifications.

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.

A GtkTextMark is like a bookmark in a text buffer; it preserves a position in the text. You can convert the mark to an iterator using get_iter_at_mark. Unlike iterators, marks remain valid across buffer mutations, because their behavior is defined when text is inserted or deleted. When text containing a mark is deleted, the mark remains in the position originally occupied by the deleted text. When text is inserted at a mark, a mark with “left gravity” will be moved to the beginning of the newly-inserted text, and a mark with “right gravity” will be moved to the end.

Note that “left” and “right” here refer to logical direction (left is the toward the start of the buffer); in some languages such as Hebrew the logically-leftmost text is not actually on the left when displayed.

Marks are reference counted, but the reference count only controls the validity of the memory; marks can be deleted from the buffer at any time with delete_mark. Once deleted from the buffer, a mark is essentially useless.

Marks optionally have names; these can be convenient to avoid passing the GtkTextMark object around.

Marks are typically created using the create_mark function.

Constructors

class TextMark

classmethod new(name: str | None, left_gravity: bool) → TextMark

Creates a text mark.

Add it to a buffer using add_mark. If name is None, the mark is anonymous; otherwise, the mark can be retrieved by name using 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).

Parameters:

• name – mark name

• left_gravity – whether the mark should have left gravity

Methods

class TextMark

get_buffer() → TextBuffer | None

Gets the buffer this mark is located inside.

Returns None if the mark is deleted.

get_deleted() → bool

Returns True if the mark has been removed from its buffer.

See add_mark for a way to add it to a buffer again.

get_left_gravity() → bool

Determines whether the mark has left gravity.

get_name() → str | None

Returns the mark name.

Returns None for anonymous marks.

get_visible() → bool

Returns True if the mark is visible.

A cursor is displayed for visible marks.

set_visible(setting: bool) → None

Parameters:

setting

Properties

class TextMark

props.left_gravity: bool

Whether the mark has left gravity.

When text is inserted at the mark’s current location, if the mark has left gravity it will be moved to the left of the newly-inserted text, otherwise to the right.

props.name: str

The name of the mark or None if the mark is anonymous.

Fields

class TextMark

parent_instance

segment