Enum ModifierIntent 

#[non_exhaustive]
pub enum ModifierIntent {
    PrimaryAccelerator,
    ContextMenu,
    ExtendSelection,
    ModifySelection,
    NoTextInput,
    ShiftGroup,
    DefaultModMask,
}

This enum is used with Keymap::modifier_mask() in order to determine what modifiers the currently used windowing system backend uses for particular purposes. For example, on X11/Windows, the Control key is used for invoking menu shortcuts (accelerators), whereas on Apple computers it’s the Command key (which correspond to ModifierType::CONTROL_MASK and ModifierType::MOD2_MASK, respectively).

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

PrimaryAccelerator

the primary modifier used to invoke menu accelerators.

ContextMenu

the modifier used to invoke context menus. Note that mouse button 3 always triggers context menus. When this modifier is not 0, it additionally triggers context menus when used with mouse button 1.

ExtendSelection

the modifier used to extend selections using modifier-click or modifier-cursor-key

ModifySelection

the modifier used to modify selections, which in most cases means toggling the clicked item into or out of the selection.

NoTextInput

when any of these modifiers is pressed, the key event cannot produce a symbol directly. This is meant to be used for input methods, and for use cases like typeahead search.

ShiftGroup

the modifier that switches between keyboard groups (AltGr on X11/Windows and Option/Alt on OS X).

DefaultModMask

The set of modifier masks accepted as modifiers in accelerators. Needed because Command is mapped to MOD2 on OSX, which is widely used, but on X11 MOD2 is NumLock and using that for a mod key is problematic at best. Ref: https://bugzilla.gnome.org/show_bug.cgi?id=736125.

Trait Implementations

impl Clone for ModifierIntent

fn clone(&self) -> ModifierIntent

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for ModifierIntent

impl Debug for ModifierIntent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for ModifierIntent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for ModifierIntent

impl From<ModifierIntent> for Value

fn from(v: ModifierIntent) -> Self

Converts to this type from the input type.

impl<'a> FromValue<'a> for ModifierIntent

type Checker = GenericValueTypeChecker<ModifierIntent>

Value type checker.

unsafe fn from_value(value: &'a Value) -> Self

Get the contained value from a Value.

impl HasParamSpec for ModifierIntent

type ParamSpec = ParamSpecEnum

type SetValue = ModifierIntent

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(&str, ModifierIntent) -> ParamSpecEnumBuilder<'_, ModifierIntent>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for ModifierIntent

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ModifierIntent

fn cmp(&self, other: &ModifierIntent) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ModifierIntent

fn eq(&self, other: &ModifierIntent) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for ModifierIntent

fn partial_cmp(&self, other: &ModifierIntent) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for ModifierIntent

fn static_type() -> Type

Returns the type identifier of Self.

impl StructuralPartialEq for ModifierIntent

impl ToValue for ModifierIntent

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifer of self.

impl ValueType for ModifierIntent

type Type = ModifierIntent

Type to get the Type from.