Next: , Previous: GtkTextIter, Up: Top

27 GtkTextMark

A position in the buffer preserved across buffer modifications

27.1 Overview

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-text-mark> 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-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.

"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-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-text-mark> object around.

Marks are typically created using the gtk-text-buffer-create-mark function.

27.2 Usage

— Class: <gtk-text-mark>

Derives from <gobject>.

This class defines the following slots:

Mark name
Whether the mark has left gravity
— Function: gtk-text-mark-set-visible (self <gtk-text-mark>) (setting bool)
— Method: set-visible

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.

a <gtk-text-mark>
visibility of mark
— Function: gtk-text-mark-get-visible (self <gtk-text-mark>) ⇒  (ret bool)
— Method: get-visible

Returns ‘#t’ if the mark is visible (i.e. a cursor is displayed for it)

a <gtk-text-mark>
#t’ if visible
— Function: gtk-text-mark-get-deleted (self <gtk-text-mark>) ⇒  (ret bool)
— Method: get-deleted

Returns ‘#t’ if the mark has been removed from its buffer with gtk-text-buffer-delete-mark. Marks can't be used once deleted.

a <gtk-text-mark>
whether the mark is deleted
— Function: gtk-text-mark-get-name (self <gtk-text-mark>) ⇒  (ret mchars)
— Method: get-name

Returns the mark name; returns NULL for anonymous marks.

a <gtk-text-mark>
mark name
— Function: gtk-text-mark-get-buffer (self <gtk-text-mark>) ⇒  (ret <gtk-text-buffer>)
— Method: get-buffer

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

a <gtk-text-mark>
the mark's <gtk-text-buffer>
— Function: gtk-text-mark-get-left-gravity (self <gtk-text-mark>) ⇒  (ret bool)
— Method: get-left-gravity

Determines whether the mark has left gravity.

a <gtk-text-mark>
#t’ if the mark has left gravity, ‘#f’ otherwise