GTK+ Reference Manual
<<< Previous Page | Home | Up | Next Page >>>

# GtkTextMark

## Name

GtkTextMark -- A position in the buffer preserved across buffer modifications

## Synopsis

    #include <gtk/gtk.h>

    struct      GtkTextMark;
    void        gtk_text_mark_set_visible       (GtkTextMark *mark,
                                                 gboolean setting);
    gboolean    gtk_text_mark_get_visible       (GtkTextMark *mark);
    gboolean    gtk_text_mark_get_deleted       (GtkTextMark *mark);
    G_CONST_RETURN gchar* gtk_text_mark_get_name
                                                (GtkTextMark *mark);
    GtkTextBuffer* gtk_text_mark_get_buffer     (GtkTextMark *mark);
    gboolean    gtk_text_mark_get_left_gravity  (GtkTextMark *mark);

## Object Hierarchy

      GObject
       +----GtkTextMark

## Description

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. [1]

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.

## Details

### struct GtkTextMark

    struct GtkTextMark;

### gtk_text_mark_set_visible ()

    void        gtk_text_mark_set_visible       (GtkTextMark *mark,
                                                 gboolean 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 dragging-and-dropping text. Most other marks are not visible. Marks are not visible by default.

`mark` : | a GtkTextMark
`setting` : | visibility of mark

### gtk_text_mark_get_visible ()

    gboolean    gtk_text_mark_get_visible       (GtkTextMark *mark);

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

`mark` : | a GtkTextMark
Returns : | `TRUE` if visible

### gtk_text_mark_get_deleted ()

    gboolean    gtk_text_mark_get_deleted       (GtkTextMark *mark);

Returns `TRUE` if the mark has been removed from its buffer with gtk_text_buffer_delete_mark(). Marks can't be used once deleted.

`mark` : | a GtkTextMark
Returns : | whether the mark is deleted

### gtk_text_mark_get_name ()

    G_CONST_RETURN gchar* gtk_text_mark_get_name
                                                (GtkTextMark *mark);

Returns the mark name; returns NULL for anonymous marks.

`mark` : | a GtkTextMark
Returns : | mark name

### gtk_text_mark_get_buffer ()

    GtkTextBuffer* gtk_text_mark_get_buffer     (GtkTextMark *mark);

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

`mark` : | a GtkTextMark
Returns : | the mark's GtkTextBuffer

### gtk_text_mark_get_left_gravity ()

    gboolean    gtk_text_mark_get_left_gravity  (GtkTextMark *mark);

Determines whether the mark has left gravity.

`mark` : | a GtkTextMark
Returns : | `TRUE` if the mark has left gravity, `FALSE` otherwise

## Notes

[1] | "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.

<<< Previous Page | Home | Up | Next Page >>>
GtkTextIter | GtkTextBuffer