Class: Gtk::TextMark

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

Instance Method Summary collapse

Instance Method Details

#bufferGtk::TextBuffer

Gets the buffer this mark is located inside, or nil if the mark is deleted.

Returns:

#deletedTrueClass

Returns true if the mark has been removed from its buffer with gtk_text_buffer_delete_mark(). See gtk_text_buffer_add_mark() for a way to add it to a buffer again.

Returns:

  • (TrueClass)

    whether the mark is deleted

#left_gravityTrueClass

Determines whether the mark has left gravity.

Returns:

  • (TrueClass)

    true if the mark has left gravity, false otherwise

#left_gravity=(left_gravity) ⇒ TrueClass

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 (TrueClass)

Returns:

  • (TrueClass)

    left-gravity

  • (TrueClass)

    left-gravity

#left_gravity?TrueClass

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:

  • (TrueClass)

    left-gravity

#nameString

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

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

Creates 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).

Parameters:

  • name (String)

    mark name or nil

  • left_gravity (TrueClass)

    whether the mark should have left gravity

Returns:

#visibleTrueClass

Returns true if the mark is visible (i.e. a cursor is displayed for it).

Returns:

  • (TrueClass)

    true if visible

#visible=(setting) ⇒ nil

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 (TrueClass)

    visibility of mark

Returns:

  • (nil)