Package ch.bailu.gtk.gtk

Class TextMark

java.lang.Object
ch.bailu.gtk.type.Type
ch.bailu.gtk.type.Pointer
ch.bailu.gtk.gobject.Object
ch.bailu.gtk.gtk.TextMark
All Implemented Interfaces:
PointerInterface
public class TextMark extends Object
A `GtkTextMark` is a position in a `GtkTextbuffer` that is preserved
across modifications.

You may wish to begin by reading the
[text widget conceptual overview](section-text-widget.html),
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.

https://docs.gtk.org/gtk4/class.TextMark.html

  • Constructor Details

    • TextMark

      public TextMark(PointerContainer pointer)

    • TextMark

      public TextMark(@Nullable Str name, boolean left_gravity)
      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).
      Parameters:
      name - mark name
      left_gravity - whether the mark should have left gravity

    • TextMark

      public TextMark(String name, boolean left_gravity)
      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).
      Parameters:
      name - mark name
      left_gravity - whether the mark should have left gravity

  • Method Details

    • getClassHandler

      public static ClassHandler getClassHandler()

    • getBuffer

      public TextBuffer getBuffer()
      Gets the buffer this mark is located inside.

      Returns %NULL if the mark is deleted.
      Returns:
      the mark’s `GtkTextBuffer`

    • getDeleted

      public boolean getDeleted()
      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.
      Returns:
      whether the mark is deleted

    • getLeftGravity

      public boolean getLeftGravity()
      Determines whether the mark has left gravity.
      Returns:
      %TRUE if the mark has left gravity, %FALSE otherwise

    • getName

      public Str getName()
      Returns the mark name.

      Returns %NULL for anonymous marks.
      Returns:
      mark name

    • getVisible

      public boolean getVisible()
      Returns %TRUE if the mark is visible.

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

    • setVisible

      public void setVisible(boolean setting)
      Parameters:
      setting -

    • getTypeID

      public static long getTypeID()

    • getParentTypeID

      public static long getParentTypeID()

    • getTypeSize

      public static TypeSystem.TypeSize getTypeSize()

    • getParentTypeSize

      public static TypeSystem.TypeSize getParentTypeSize()

    • getInstanceSize

      public static int getInstanceSize()