Trait sourceview5::prelude::IndenterExt

pub trait IndenterExt: IsA<Indenter> + Sealed + 'static {
    // Provided method
    fn is_trigger(
        &self,
        view: &impl IsA<View>,
        location: &TextIter,
        state: ModifierType,
        keyval: u32,
    ) -> bool { ... }
}

Trait containing all Indenter methods.

Implementors

Indenter

Provided Methods

fn is_trigger( &self, view: &impl IsA<View>, location: &TextIter, state: ModifierType, keyval: u32, ) -> bool

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 Gdk::KEY_Return or Gdk::KEY_KP_Enter and @state does not have [gdk::ModifierType::SHIFT_MASK][crate::gdk::ModifierType::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.

view

a #GtkSourceView

location

the location where @ch is to be inserted

state

modifier state for the insertion

keyval

the keyval pressed such as Gdk::KEY_Return

Returns

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

Object Safety

This trait is not object safe.

Implementors

impl<O: IsA<Indenter>> IndenterExt for O