Struct Modifiers 

pub struct Modifiers { /* private fields */ }

Keyboard modifier state.

Implementations

impl Modifiers

pub const NONE: Modifiers

pub const CTRL: Modifiers

pub const SHIFT: Modifiers

pub const ALT: Modifiers

pub const SUPER: Modifiers

pub const COMMAND: Modifiers

The primary accelerator modifier for this platform: SUPER (Command, ⌘) on macOS, CTRL everywhere else.

Desktop platforms disagree about which physical key carries application accelerators, and on macOS the disagreement is not cosmetic: Control is reserved there for the text system and for the secondary click, while ⌘ is what a user presses for Save, Copy or Find. Code that hard-codes CTRL to mean “the accelerator” therefore listens to the wrong key on one of the three desktop platforms.

Compare against this constant (or call Modifiers::command) and the same code means Ctrl+A on Windows and Linux and ⌘A on macOS. This mirrors Qt’s Qt::CTRL, which likewise resolves to ⌘ on macOS, and the convention the native menu bar already applies when it turns a declared chord into an NSMenuItem key equivalent.

pub fn empty() -> Self

pub fn ctrl(self) -> bool

pub fn shift(self) -> bool

pub fn alt(self) -> bool

pub fn super_key(self) -> bool

pub fn command(self) -> bool

Whether the platform’s primary accelerator modifier (Modifiers::COMMAND) is held: Command (⌘) on macOS, Control everywhere else.

Use this instead of ctrl wherever the chord means “the accelerator” — select-all, the discontiguous-selection click, jump to the end of a list. Keep ctrl for the chords that really are Control on every platform, macOS included: Ctrl+Tab cycles tabs there too (⌘Tab belongs to the application switcher and never reaches an app).

pub fn contains(self, other: Modifiers) -> bool

Whether every modifier in other is held.

pub fn without(self, other: Modifiers) -> Modifiers

These modifiers with other removed.

pub fn with_command_convention(self) -> Modifiers

These modifiers with a declared CTRL reinterpreted as the platform’s primary accelerator — see Modifiers::COMMAND and KeyStroke::with_command_convention, which is where this is applied.

A no-op off macOS (where COMMAND is CTRL), and a no-op for a chord that already names SUPER explicitly: Ctrl+Super stays ⌃⌘, a genuine two-modifier chord, rather than collapsing to one.

Trait Implementations

impl BitOr for Modifiers

type Output = Modifiers

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self

Performs the | operation.

impl Clone for Modifiers

fn clone(&self) -> Modifiers

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Modifiers

impl Debug for Modifiers

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

Formats the value using the given formatter.

impl Default for Modifiers

fn default() -> Modifiers

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Modifiers

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Modifiers

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

Formats the value using the given formatter.

impl Eq for Modifiers

impl Hash for Modifiers

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 PartialEq for Modifiers

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Modifiers

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Modifiers