Class: Gtk::TextMark

Inherits:
Object
  • Object
show all
Defined in:
(unknown)

Direct Known Subclasses

GtkSource::Mark

Instance Method Summary collapse

Constructor Details

#initialize(name, left_gravity) ⇒ Gtk::TextMark

Creates a text mark.

Add it to a buffer using [methodGtk.TextBuffer.add_mark].
If name is nil, the mark is anonymous; otherwise, the mark can be
retrieved by name using [methodGtk.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 (String) —

    mark name

  • left_gravity (Boolean) —

    whether the mark should have left gravity

Instance Method Details

#buffer ⇒ Gtk::TextBuffer

Gets the buffer this mark is located inside.

Returns nil if the mark is deleted.

Returns:

#deleted ⇒ Boolean

Returns true if the mark has been removed from its buffer.

See [methodGtk.TextBuffer.add_mark] for a way to add it
to a buffer again.

Returns:

  • (Boolean) —

    whether the mark is deleted

#left_gravity ⇒ Boolean

Determines whether the mark has left gravity.

Returns:

  • (Boolean) —

    true if the mark has left gravity, false otherwise

#left_gravity=(left_gravity) ⇒ Boolean

Whether the mark has left gravity.

When text is inserted at the mark’s current location, if the mark
has left gravity it will be moved to the left of the newly-inserted
text, otherwise to the right.

Parameters:

  • left_gravity (Boolean)

Returns:

  • (Boolean) —

    left-gravity

  • (Boolean) —

    left-gravity

#left_gravity? ⇒ Boolean

Whether the mark has left gravity.

When text is inserted at the mark’s current location, if the mark
has left gravity it will be moved to the left of the newly-inserted
text, otherwise to the right.

Returns:

  • (Boolean) —

    left-gravity

#name ⇒ String

The name of the mark or nil if the mark is anonymous.

Returns:

  • (String) —

    name

#name=(name) ⇒ String

The name of the mark or nil if the mark is anonymous.

Parameters:

  • name (String)

Returns:

  • (String) —

    name

  • (String) —

    name

#visible ⇒ Boolean

Returns true if the mark is visible.

A cursor is displayed for visible marks.

Returns:

  • (Boolean) —

    true if visible

#visible=(setting) ⇒ nil

Parameters:

  • setting (Boolean)

Returns:

  • (nil)