gtk.text_mark

Module for [TextMark] class

Types 3

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 [gtk.text_buffer.TextBuffer.getIterAtMark]. 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.text_buffer.TextBuffer.deleteMark]. 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 [gtk.text_buffer.TextBuffer.createMark] function.

Methods
GType _gType() @property
TextMark self()Returns `this`, for use in `with` statements.
TextMarkGidBuilder builder()Get builder for [gtk.text_mark.TextMark] Returns: New builder object
bool leftGravity() @propertyGet `leftGravity` property. Returns: 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 newl...
string name() @propertyGet `name` property. Returns: The name of the mark or null if the mark is anonymous.
gtk.text_buffer.TextBuffer getBuffer()Gets the buffer this mark is located inside, or null if the mark is deleted. Returns: the mark’s #GtkTextBuffer
bool getDeleted()Returns true if the mark has been removed from its buffer with [gtk.textbuffer.TextBuffer.deleteMark]. See [gtk.textbuffer.TextBuffer.addMark] for a way to add it to a buffer again. Returns: whethe...
bool getLeftGravity()Determines whether the mark has left gravity. Returns: true if the mark has left gravity, false otherwise
string getName()Returns the mark name; returns NULL for anonymous marks. Returns: mark name
bool getVisible()Returns true if the mark is visible (i.e. a cursor is displayed for it). Returns: true if visible
void setVisible(bool setting)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 dragg...
Constructors
this(void * ptr, Flag!"Take" take)
this(string name, bool leftGravity)Creates a text mark. Add it to a buffer using [gtk.textbuffer.TextBuffer.addMark]. If name is null, the mark is anonymous; otherwise, the mark can be retrieved by name using [gtk.textbuffer.TextBuf...
Methods
T leftGravity(bool propval)Set `leftGravity` property. Params: propval = 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...
T name(string propval)Set `name` property. Params: propval = The name of the mark or null if the mark is anonymous. Returns: Builder instance for fluent chaining

Fluent builder for [gtk.text_mark.TextMark]

Methods