Trait sourceview5::prelude::IndenterExt[−][src]

pub trait IndenterExt: 'static {
    fn is_trigger<P: IsA<View>>(
        &self, 
        view: &P, 
        location: &TextIter, 
        state: ModifierType, 
        keyval: u32
    ) -> bool;
}

Trait containing all Indenter methods.

Feature: v5_0

Implementors

Indenter

Required methods

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

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::ShiftMask 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.

Feature: v5_0

view

a View

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.

Loading content...

Implementors

impl<O: IsA<Indenter>> IndenterExt for O[src]

Loading content...