Trait gdk4::prelude::DisplayExtManual

source ·

pub trait DisplayExtManual: 'static {
    // Required methods
    fn translate_key(
        &self,
        keycode: u32,
        state: ModifierType,
        group: i32
    ) -> Option<(Key, i32, i32, ModifierType)>;
    fn get_setting(&self, name: impl IntoGStr) -> Option<Value>;
    fn map_keyval(&self, keyval: Key) -> Option<Vec<KeymapKey>>;
    fn map_keycode(&self, keycode: u32) -> Option<Vec<(KeymapKey, Key)>>;
    fn backend(&self) -> Backend;
}

Expand description

Trait containing manually implemented methods of Display.

Required Methods§

source

fn translate_key( &self, keycode: u32, state: ModifierType, group: i32 ) -> Option<(Key, i32, i32, ModifierType)>

Translates the contents of a GdkEventKey into a keyval, effective group, and level.

Modifiers that affected the translation and are thus unavailable for application use are returned in @consumed_modifiers.

The @effective_group is the group that was actually used for the translation; some keys such as Enter are not affected by the active keyboard group. The @level is derived from @state.

@consumed_modifiers gives modifiers that should be masked out from @state when comparing this key press to a keyboard shortcut. For instance, on a US keyboard, the plus symbol is shifted, so when comparing a key press to a <Control>plus accelerator <Shift> should be masked out.

This function should rarely be needed, since GdkEventKey already contains the translated keyval. It is exported for the benefit of virtualized test environments.