Struct KeyboardShortcut

pub struct KeyboardShortcut { /* private fields */ }

Implementations

impl KeyboardShortcut

pub fn new(key: impl AsRef<str>) -> Self

pub fn builder(key: impl AsRef<str>) -> KeyboardShortcutBuilder

Initialize a new keyboard shortcut builder with the specified key.

pub fn with_modifiers(key: impl AsRef<str>, modifiers: &[ModifierKey]) -> Self

Create a new keyboard shortcut with the specified key and modifiers.

pub fn with_alt(key: impl AsRef<str>) -> Self

Create a new keyboard shortcut with the specified key and the AltKey modifier.

Example

use tauri_plugin_prevent_default::KeyboardShortcut;
use tauri_plugin_prevent_default::ModifierKey::AltKey;

// Both of these are equivalent.
tauri_plugin_prevent_default::Builder::new()
  .shortcut(KeyboardShortcut::with_alt("A"))
  .shortcut(KeyboardShortcut::with_modifiers("A", &[AltKey]))
  .build();

pub fn with_ctrl(key: impl AsRef<str>) -> Self

Create a new keyboard shortcut with the specified key and the CtrlKey modifier.

pub fn with_ctrl_meta(key: impl AsRef<str>) -> Self

Create a new keyboard shortcut with the specified key and the CtrlKey and MetaKey modifiers.

pub fn with_ctrl_shift(key: impl AsRef<str>) -> Self

Create a new keyboard shortcut with the specified key and the CtrlKey and ShiftKey modifiers.

pub fn with_meta(key: impl AsRef<str>) -> Self

Create a new keyboard shortcut with the specified key and the MetaKey modifier.

pub fn with_shift(key: impl AsRef<str>) -> Self

Create a new keyboard shortcut with the specified key and the ShiftKey modifier.

pub fn with_shift_alt(key: impl AsRef<str>) -> Self

Create a new keyboard shortcut with the specified key and the ShiftKey and AltKey modifiers.

pub fn with_shift_meta(key: impl AsRef<str>) -> Self

Create a new keyboard shortcut with the specified key and the ShiftKey and MetaKey modifiers.

pub fn key(&self) -> &str

The key of the shortcut.

pub fn modifiers(&self) -> &[ModifierKey]

The modifiers of the shortcut.

Trait Implementations

impl Debug for KeyboardShortcut

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

Formats the value using the given formatter.

impl Display for KeyboardShortcut

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

Formats the value using the given formatter.

impl Shortcut for KeyboardShortcut

fn kind(&self) -> ShortcutKind<'_>