Skip to main content

Action

Enum Action 

Source
pub enum Action {
Show 42 variants None, LeftClick, RightClick, MiddleClick, Copy, Paste, Cut, Undo, Redo, SelectAll, Find, Save, BrowserBack, BrowserForward, NewTab, CloseTab, ReopenTab, NextTab, PrevTab, ReloadPage, MissionControl, AppExpose, PreviousDesktop, NextDesktop, ShowDesktop, LaunchpadShow, LockScreen, Screenshot, PlayPause, NextTrack, PrevTrack, VolumeUp, VolumeDown, MuteVolume, CycleDpiPresets, SetDpiPreset(u8), ToggleSmartShift, ScrollUp, ScrollDown, HorizontalScrollLeft, HorizontalScrollRight, CustomShortcut(KeyCombo),
}
Expand description

What pressing a ButtonId should do.

Serialization uses serde’s default external tagging: unit variants serialize as a bare string ("BrowserBack") and the tuple variant serializes as a single-key table ({ CustomShortcut = "my chord" }).

Stability contract: existing variant names are frozen — they form the on-disk config.toml schema. New variants may be appended freely; removing or renaming a variant requires a schema_version bump and a migration.

Action::execute synthesizes the OS-level event for each variant. On macOS it posts the event via CGEventPost(kCGHIDEventTap, …). On other platforms it logs a warning and returns immediately — the binary compiles on all targets.

§Manual verification

execute is intentionally excluded from the automated test suite because it would need to intercept the OS event queue. Smoke-test it manually: bind a button to any action in the GUI and confirm the expected system event fires when the button is pressed.

Variants§

§

None

Suppress the input entirely — the button or wheel direction is captured but no OS event is synthesised, so the physical input does nothing.

§

LeftClick

Primary mouse button.

§

RightClick

Secondary mouse button.

§

MiddleClick

Middle mouse button (wheel click).

§

Copy

Copy the current selection (⌘C / Ctrl+C).

§

Paste

Paste from the clipboard (⌘V / Ctrl+V).

§

Cut

Cut the current selection (⌘X / Ctrl+X).

§

Undo

Undo the last action (⌘Z / Ctrl+Z).

§

Redo

Redo the last undone action (⌘⇧Z on macOS / Ctrl+Shift+Z on Linux).

Note: Ctrl+Y is the dominant redo shortcut in LibreOffice and many GTK apps. Ctrl+Shift+Z is used here because it mirrors the macOS convention and works in GNOME text fields, browsers, and Electron apps. If Ctrl+Y coverage is needed, a CustomShortcut binding is the escape hatch.

§

SelectAll

Select all content (⌘A / Ctrl+A).

§

Find

Open the find / search bar (⌘F / Ctrl+F).

§

Save

Save the current document (⌘S / Ctrl+S).

§

BrowserBack

Navigate backward in browser history.

§

BrowserForward

Navigate forward in browser history.

§

NewTab

Open a new tab (⌘T / Ctrl+T).

§

CloseTab

Close the current tab (⌘W / Ctrl+W).

§

ReopenTab

Reopen the last closed tab (⌘⇧T / Ctrl+Shift+T).

§

NextTab

Switch to the next tab (⌃⇥ / Ctrl+Tab).

§

PrevTab

Switch to the previous tab (⌃⇧⇥ / Ctrl+Shift+Tab).

§

ReloadPage

Reload the current page (⌘R / Ctrl+R).

§

MissionControl

macOS Mission Control (⌃↑).

§

AppExpose

macOS App Exposé — all windows for the current app (⌃↓).

§

PreviousDesktop

Switch to the previous desktop / Space.

§

NextDesktop

Switch to the next desktop / Space.

§

ShowDesktop

Show the desktop (hide all windows).

§

LaunchpadShow

Open Launchpad.

§

LockScreen

Lock the screen (⌘⌃Q on macOS).

On Linux, calls org.freedesktop.login1.Manager.LockSession($XDG_SESSION_ID) on the system bus (current session only). Falls back to Super+L when $XDG_SESSION_ID is unset or on non-systemd systems.

§

Screenshot

Capture a screenshot.

§

PlayPause

Toggle media play/pause.

§

NextTrack

Skip to the next track.

§

PrevTrack

Go back to the previous track.

§

VolumeUp

Increase system volume.

§

VolumeDown

Decrease system volume.

§

MuteVolume

Toggle system mute.

§

CycleDpiPresets

Step through the configured DPI preset list (P1.7).

§

SetDpiPreset(u8)

Jump to a specific zero-based preset in the device’s DPI preset list. Out-of-range indices clamp to the list length at fire time (P1.7).

§

ToggleSmartShift

Toggle the HID++ SmartShift ratchet/free-spin wheel mode (P1.1).

§

ScrollUp

Synthesise a vertical scroll-up tick.

§

ScrollDown

Synthesise a vertical scroll-down tick.

§

HorizontalScrollLeft

Synthesise a horizontal scroll-left tick.

§

HorizontalScrollRight

Synthesise a horizontal scroll-right tick.

§

CustomShortcut(KeyCombo)

Replay an arbitrary recorded key chord (P1.3).

Holds the structured chord data so execute can post the real keystroke (macOS: CGEventPost with the encoded modifier flags). The display field is used by Action::label so the popover shows the user-friendly chord name.

Implementations§

Source§

impl Action

Source

pub fn label(&self) -> String

Display label for the popover row.

Returns String rather than &str so parameterized variants (e.g. SetDpiPreset(i), CustomShortcut(s)) can build a label that includes their payload.

Source

pub fn category(&self) -> Category

Which Category this action belongs to, used for popover grouping.

Source

pub fn catalog() -> Vec<Action>

All pickable actions in a deterministic order.

Action::CustomShortcut is intentionally excluded — it is opened via “Record shortcut…” (P1.3), not selected from the catalog.

Source

pub fn execute(&self)

Synthesise the OS-level event for this action.

On macOS, key events are posted via CGEventPost(kCGHIDEventTap, …) using virtual key codes from the standard US keyboard layout, and the LeftClick/RightClick/MiddleClick variants synthesise a mouse click at the current cursor location. The WindowServer actions (MissionControl, AppExpose, ShowDesktop, LaunchpadShow) are posted straight to the Dock via CoreDockSendNotification. Device-side actions (CycleDpiPresets, SetDpiPreset, ToggleSmartShift) have no CGEvent equivalent and are handled at the hook/HID layer, logging a trace here.

On Linux, key and scroll events are injected via a lazily-created uinput virtual device. Mouse clicks inject BTN_* events. macOS-only window manager actions (MissionControl, AppExpose, ShowDesktop, LaunchpadShow) have no universal Linux equivalent and are silently skipped (debug-logged). CustomShortcut maps macOS kVK_* codes to Linux key codes; macOS Cmd maps to Ctrl.

On other platforms a warning is logged and the function returns immediately — the binary compiles clean on all targets.

Trait Implementations§

Source§

impl Clone for Action

Source§

fn clone(&self) -> Action

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Action

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Action

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for Action

Source§

impl Hash for Action

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Action

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Action

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Action

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more