Class TextMark

java.lang.Object
org.javagi.base.ProxyInstance
org.gnome.gobject.TypeInstance
org.gnome.gobject.GObject
org.gnome.gtk.TextMark
All Implemented Interfaces:
Proxy
Direct Known Subclasses:
Mark
@Generated("org.javagi.JavaGI") public class TextMark extends GObject

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 TextBuffer.getIterAtMark(TextIter, TextMark). 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 TextBuffer.deleteMark(TextMark). 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 TextBuffer.createMark(String, TextIter, boolean) function.

  • Constructor Details

    • TextMark

      public TextMark(MemorySegment address)
      Create a TextMark instance for the provided memory address.
      Parameters:
      address - the memory address of the native object

    • TextMark

      public TextMark(@Nullable String name, boolean leftGravity)

      Creates a text mark.

      Add it to a buffer using TextBuffer.addMark(TextMark, TextIter). If name is null, the mark is anonymous; otherwise, the mark can be retrieved by name using TextBuffer.getMark(String). 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 (leftGravity = 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
      leftGravity - whether the mark should have left gravity

    • TextMark

      public TextMark()
      Create a new TextMark.

  • Method Details

    • getType

      public static @Nullable Type getType()
      Get the GType of the TextMark class.
      Returns:
      the GType

    • getMemoryLayout

      public static MemoryLayout getMemoryLayout()
      The memory layout of the native struct.
      Returns:
      the memory layout

    • asParent

      protected TextMark asParent()
      Return this instance as if it were its parent type. Comparable to the Java super keyword, but ensures the parent typeclass is also used in native code.
      Overrides:
      asParent in class GObject
      Returns:
      the instance as if it were its parent type

    • getBuffer

      public @Nullable 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 TextBuffer.addMark(TextMark, TextIter) 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 @Nullable String 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)

      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.

      Parameters:
      setting - visibility of mark

    • builder

      public static TextMark.Builder<? extends TextMark.Builder> builder()
      A TextMark.Builder object constructs a TextMark with the specified properties. Use the various set...() methods to set properties, and finish construction with TextMark.Builder.build().
      Returns:
      the builder object