TextMark

open class TextMark(pointer: <Error class: unknown class><<Error class: unknown class>>)

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

You may wish to begin by reading the section-text-widget.html, 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 method@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 method@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 GtkTextMark object around.

Marks are typically created using the method@Gtk.TextBuffer.create_mark function.

Constructors

Link copied to clipboard
constructor(name: String? = null, leftGravity: Boolean)

Creates a text mark.

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val gtkTextMarkPointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard

Whether the mark has left gravity.

Link copied to clipboard
open val name: String?

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

Functions

Link copied to clipboard
open fun getBuffer(): TextBuffer?

Gets the buffer this mark is located inside.

Link copied to clipboard
open fun getDeleted(): Boolean

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

Link copied to clipboard
open fun getVisible(): Boolean

Returns true if the mark is visible.

Link copied to clipboard
open fun setVisible(setting: Boolean)

Sets the visibility of @mark.