Gtk.TextMark

g GObject.Object GObject.Object Gtk.TextMark Gtk.TextMark GObject.Object->Gtk.TextMark

Subclasses:None

Methods

Inherited:GObject.Object (37)
Structs:GObject.ObjectClass (5)
class new (name, left_gravity)
  get_buffer ()
  get_deleted ()
  get_left_gravity ()
  get_name ()
  get_visible ()
  set_visible (setting)

Virtual Methods

Inherited:GObject.Object (7)

Properties

Name Type Flags Short Description
left-gravity bool r/w/co Whether the mark has left gravity
name str r/w/co Mark name

Signals

Inherited:GObject.Object (1)

Fields

Inherited:GObject.Object (1)
Name Type Access Description
parent_instance GObject.Object r  
segment object r  

Class Details

class Gtk.TextMark(**kwargs)
Bases:GObject.Object
Abstract:No
Structure:Gtk.TextMarkClass

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 Gtk.TextMark is like a bookmark in a text buffer; it preserves a position in the text. You can convert the mark to an iterator using Gtk.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 Gtk.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 Gtk.TextMark object around.

Marks are typically created using the Gtk.TextBuffer.create_mark() function.

classmethod new(name, left_gravity)[source]
Parameters:
  • name (str or None) – mark name or None
  • left_gravity (bool) – whether the mark should have left gravity
Returns:

new Gtk.TextMark

Return type:

Gtk.TextMark

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

New in version 2.12.

get_buffer()[source]
Returns:the mark’s Gtk.TextBuffer
Return type:Gtk.TextBuffer

Gets the buffer this mark is located inside, or None if the mark is deleted.

get_deleted()[source]
Returns:whether the mark is deleted
Return type:bool

Returns True if the mark has been removed from its buffer with Gtk.TextBuffer.delete_mark(). See Gtk.TextBuffer.add_mark() for a way to add it to a buffer again.

get_left_gravity()[source]
Returns:True if the mark has left gravity, False otherwise
Return type:bool

Determines whether the mark has left gravity.

get_name()[source]
Returns:mark name
Return type:str or None

Returns the mark name; returns None for anonymous marks.

get_visible()[source]
Returns:True if visible
Return type:bool

Returns True if the mark is visible (i.e. a cursor is displayed for it).

set_visible(setting)[source]
Parameters:setting (bool) – visibility of mark

Sets the visibility of self; 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.

Property Details

Gtk.TextMark.props.left_gravity
Name:left-gravity
Type:bool
Default Value:False
Flags:READABLE, WRITABLE, CONSTRUCT_ONLY

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.

Gtk.TextMark.props.name
Name:name
Type:str
Default Value:None
Flags:READABLE, WRITABLE, CONSTRUCT_ONLY

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