Gtk.TextMark¶

class — extends GObject.Object

Marks 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 TextBuffer.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 TextBuffer.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 TextBuffer.create_mark function.

Constructors¶

new¶

@classmethod
def new(cls, name: str | None, left_gravity: bool) -> TextMark

Creates a text mark.

Add it to a buffer using TextBuffer.add_mark. If 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).

Parameters:

name — mark name
left_gravity — whether the mark should have left gravity

Methods¶

get_buffer¶

def get_buffer(self) -> TextBuffer | None

Gets the buffer this mark is located inside.

Returns None if the mark is deleted.

get_deleted¶

def get_deleted(self) -> bool

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

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

get_left_gravity¶

def get_left_gravity(self) -> bool

Determines whether the mark has left gravity.

get_name¶

def get_name(self) -> str | None

Returns the mark name.

Returns None for anonymous marks.

get_visible¶

def get_visible(self) -> bool

Returns True if the mark is visible.

A cursor is displayed for visible marks.

set_visible¶

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

Sets the visibility of mark.

The insertion point is normally visible, i.e. you can see it as a vertical bar. Also, the text widget uses a visible mark to indicate where a drop will occur when dragging-and-dropping text. Most other marks are not visible.

Marks are not visible by default.

Parameters:

setting — visibility of mark

Properties¶

left_gravity¶

left_gravity: bool  # read/write

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.

name¶

name: str  # read/write

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