Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: TextMarkMeta

[206:14] static extends: object

Generated metadata helpers for TextMark class surfaces.

Methods

  • properties ()

    Returns property metadata for TextMark.

    • @r A list.

class: TextMark

[32:7] extends: object

Marks a position in a GtkTextbuffer that is preserved across modifications. 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 [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.

Members

  • handleObj
  • lib
  • retainedCallbacks
  • signalHandlerNames
  • signalSetterHandlers

Methods

  • TextMark (name = null, left_gravity = null)

    Creates a text mark. Add it to a buffer using [method@Gtk.TextBuffer.add_mark]. If @name is %NULL, the mark is anonymous; otherwise, the mark can be retrieved by name using [method@Gtk.TextBuffer.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).

    • @p name is mark name.
    • @p left_gravity is whether the mark should have left gravity.
  • toNativeHandle (Source)

    Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

    • @p Source is the raw handle, raw buffer, wrapper, or null.
    • @r A raw pointer carrier or null when no pointer is present.
  • getLib ()

    Returns the opened native library for this generated wrapper.

    • @r The opened native library.
  • handle ()

    Returns the wrapped NativeHandle.

    • @r The wrapped NativeHandle.
  • isNull ()

    Returns true when the wrapped handle is null.

    • @r A bool.
  • describe ()

    Returns a small string for debugging generated wrappers.

    • @r A string.
  • asObject ()

    Wraps this handle as Object.

    • @r A Object object.
  • get_buffer ()

    Gets the buffer this mark is located inside. Returns %NULL if the mark is deleted.

  • get_deleted ()

    Returns %TRUE if the mark has been removed from its buffer. See [method@Gtk.TextBuffer.add_mark] for a way to add it to a buffer again.

  • get_left_gravity ()

    Determines whether the mark has left gravity.

  • get_name ()

    Returns the mark name. Returns %NULL for anonymous marks.

  • get_visible ()

    Returns %TRUE if the mark is visible. A cursor is displayed for visible marks.

  • set_visible (bool 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.

    • @p setting is visibility of mark.
    • @r None.