Module: GtkSource::Indenter

Defined in:

(unknown)

Overview

Auto-indentation interface.

By default, [classView] can auto-indent as you type when
[propertyView:auto-indent] is enabled. The indentation simply copies the
previous lines indentation.

This can be changed by implementing GtkSourceIndenter and setting the
[propertyView:indenter] property.

Implementors of this interface should implement both
[vfuncIndenter.is_trigger] and [vfuncIndenter.indent].

[vfuncIndenter.is_trigger] is called upon key-press to
determine of the key press should trigger an indentation. The default
implementation of the interface checks to see if the key was
[constGdk.KEY_Return] or [constGdk.KEY_KP_Enter] without %GDK_SHIFT_MASK set.

[vfuncIndenter.indent] is called after text has been
inserted into [classBuffer] when
[vfuncIndenter.is_trigger] returned true. The [structGtk.TextIter]
is placed directly after the inserted character or characters.

It may be beneficial to move the insertion mark using
[methodGtk.TextBuffer.select_range] depending on how the indenter changes
the indentation.

All changes are encapsulated within a single user action so that the
user may undo them using standard undo/redo accelerators.

Instance Method Summary

• #indent(view, iter) ⇒ nil

  This function should be implemented to alter the indentation of text within the view.

• #is_trigger(view, location, state, keyval) ⇒ Boolean

  This function is used to determine if a key pressed should cause the indenter to automatically indent.

Instance Method Details

#indent(view, iter) ⇒ nil

This function should be implemented to alter the indentation of text
within the view.

view is provided so that the indenter may retrieve settings such as indentation and tab widths.

iter is the location where the indentation was requested. This typically
is after having just inserted a newline (\n) character but can be other
situations such as a manually requested indentation or reformatting.

See [ifaceIndenter.is_trigger] for how to trigger indentation on
various characters inserted into the buffer.

The implementor of this function is expected to keep iter valid across
calls to the function and should contain the location of the insert mark
after calling this function.

The default implementation for this virtual function will copy the
indentation of the previous line.

Parameters:

• view (GtkSource::View) —

  a Gtk::SourceView

• iter (Gtk::TextIter) —

  the location of the indentation request

Returns:

• (nil)

#is_trigger(view, location, state, keyval) ⇒ Boolean

This function is used to determine if a key pressed should cause the
indenter to automatically indent.

The default implementation of this virtual method will check to see
if keyval is [constGdk.KEY_Return] or [constGdk.KEY_KP_Enter] and state does
not have %GDK_SHIFT_MASK set. This is to allow the user to avoid
indentation when Shift+Return is pressed. Other indenters may want
to copy this behavior to provide a consistent experience to users.

Parameters:

• view (GtkSource::View) —

  a Gtk::SourceView

• location (Gtk::TextIter) —

  the location where ch is to be inserted

• state (Gdk::ModifierType) —

  modifier state for the insertion

• keyval (Integer) —

  the keyval pressed such as [constGdk.KEY_Return]

Returns:

• (Boolean) —

  true if indentation should be automatically triggered;
  otherwise false and no indentation will be performed.