A position in the buffer preserved across buffer modifications
Class GtkTextMark( [name],[left_gravity] )
| name | mark name or nil. |
| left_gravity | (boolean) whether the mark should have left gravity (default false) |
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.
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.
Note: Creating a text mark: Add it to a buffer using gtk_text_buffer_add_mark(). If name is nil, 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).
| Methods | |
| get_buffer | Gets the buffer this mark is located inside, or nil if the mark is deleted. |
| get_deleted | Returns true if the mark has been removed from its buffer with gtk_text_buffer_delete_mark(). |
| get_left_gravity | Determines whether the mark has left gravity. |
| get_name | Returns the mark name; returns nil for anonymous marks. |
| get_visible | Returns true if the mark is visible (i.e. a cursor is displayed for it). |
| set_visible | Sets the visibility of mark. |
Gets the buffer this mark is located inside, or nil if the mark is deleted.
GtkTextMark.get_buffer()
| Return | the mark's GtkTextBuffer. |
Returns true if the mark has been removed from its buffer with gtk_text_buffer_delete_mark().
GtkTextMark.get_deleted()
| Return | whether the mark is deleted |
See gtk_text_buffer_add_mark() for a way to add it to a buffer again.
Determines whether the mark has left gravity.
GtkTextMark.get_left_gravity()
| Return | true if the mark has left gravity, false otherwise |
Returns the mark name; returns nil for anonymous marks.
GtkTextMark.get_name()
| Return | mark name |
Returns true if the mark is visible (i.e. a cursor is displayed for it).
GtkTextMark.get_visible()
| Return | true if visible |
Sets the visibility of mark.
GtkTextMark.set_visible( setting )
| setting | 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. |