Class

GtkTextMark

Description [src]

class Gtk.TextMark : GObject.Object
{
  /* No available fields */
}

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_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_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 GtkTextMark object around.

Marks are typically created using the gtk_text_buffer_create_mark() function.

Hierarchy

Ancestors

GObject

Constructors

gtk_text_mark_new

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

since: 2.12

Instance methods

gtk_text_mark_get_buffer

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

gtk_text_mark_get_deleted

Returns TRUE if the mark has been removed from its buffer with gtk_text_buffer_delete_mark(). See gtk_text_buffer_add_mark() for a way to add it to a buffer again.

gtk_text_mark_get_left_gravity

Determines whether the mark has left gravity.

gtk_text_mark_get_name

Returns the mark name; returns NULL for anonymous marks.

gtk_text_mark_get_visible

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

gtk_text_mark_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.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

Gtk.TextMark:left-gravity

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:name

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

Signals

Signals inherited from GObject (1)

GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct GtkTextMarkClass {
  GObjectClass parent_class;
  void (* _gtk_reserved1) (
void
  );
  void (* _gtk_reserved2) (
void
  );
  void (* _gtk_reserved3) (
void
  );
  void (* _gtk_reserved4) (
void
  );
  
}

No description available.

Class members

parent_class: GObjectClass: No description available.
_gtk_reserved1: void (* _gtk_reserved1) ( void ): No description available.
_gtk_reserved2: void (* _gtk_reserved2) ( void ): No description available.
_gtk_reserved3: void (* _gtk_reserved3) ( void ): No description available.
_gtk_reserved4: void (* _gtk_reserved4) ( void ): No description available.