Enum ButtonId 

pub enum ButtonId {
    LeftClick,
    RightClick,
    MiddleClick,
    Back,
    Forward,
    DpiToggle,
    Thumbwheel,
    ThumbwheelScrollUp,
    ThumbwheelScrollDown,
    GestureButton,
    HapticPanel,
    WheelTiltLeft,
    WheelTiltRight,
    Control(Cid),
}

One of the user-rebindable controls on a Logi device: a mouse hotspot, or a keyboard key addressed by its HID++ 0x1b04 control ID.

The mouse variants are declared in physical front-to-side order; ButtonId::ALL is consumed by the default-binding generator and the popover trigger list. Keyboard keys are ButtonId::Control and stay out of that list: they seed no default and are never diverted until bound.

Serialization

Persisted as a string — the variant name for a mouse button ("MiddleClick"), the catalog name for a known control ("KeyScreenCapture") or "control:0x0141" for any other — so a ButtonId can key a TOML table. See FromStr.

Variants

LeftClick

The primary button. Rebindable in the config schema, but the OS hook never suppresses it — see ButtonId::is_os_hook_button.

RightClick

The secondary button. Like ButtonId::LeftClick, it always passes through the OS hook.

MiddleClick

The wheel click — one of the three buttons the OS hook remaps.

Back

The thumb-side “back” button (mouse button 4), remapped by the OS hook.

Forward

The thumb-side “forward” button (mouse button 5), remapped by the OS hook.

DpiToggle

The “ModeShift” button under the wheel — typically used for SmartShift / DPI cycle. Named DpiToggle for historical reasons.

Thumbwheel

The horizontal thumb wheel’s click. Kept in ButtonId::ALL so its default still seeds and dispatches when the wheel is diverted, even though the mouse model surfaces one paired rotation control instead of the click (see mouse_model::geometry).

ThumbwheelScrollUp

Rotating the thumb wheel “up” (positive rotation). Bound, by default, to continuous horizontal scroll; see the agent-core watchers-side dispatch.

ThumbwheelScrollDown

Rotating the thumb wheel “down” (negative rotation).

GestureButton

The HID++ gesture button on MX-line devices. The press itself fires the bound action; swipe directions are P1.5 territory.

HapticPanel

The MX Master 4 Haptic Sense Panel — the touch-sensitive thumb rest (Logi metadata slot ASSIGNMENT_NAME_SHOW_RADIAL_MENU, HID++ CID 0x01a0). A separate physical control from ButtonId::GestureButton; captured over HID++ like it, and eligible as the gesture owner.

WheelTiltLeft

Tilting the main wheel left — 0x1b04 CID 0x005b (“Left Scroll”), Logi metadata slot SLOT_NAME_LEFT_SCROLL_BUTTON. A distinct control from the thumb wheel: it is a plain divertable button, not a rotation, and it lives on the main wheel of mice like the MX Anywhere 2S.

WheelTiltRight

Tilting the main wheel right — 0x1b04 CID 0x005d (“Right Scroll”), Logi metadata slot SLOT_NAME_RIGHT_SCROLL_BUTTON. Counterpart to ButtonId::WheelTiltLeft.

Control(Cid)

A keyboard key, by the HID++ 0x1b04 control it reports as. Diverted over HID++ while bound (the OS hook never sees these keys); left on its native firmware function otherwise.

Declared last so the derived ordering keeps every mouse button ahead of the keys; among keys the order is by control ID, so a GUI that wants physical F-row order sorts by catalog position instead.

Implementations

impl ButtonId

pub const ALL: [ButtonId; 13]

Every rebindable mouse button in declaration (physical front-to-side) order — the iteration source for default-binding seeding and the popover trigger list. Keyboard controls are deliberately absent: an unbound key is never diverted, so there is nothing to seed.

pub const fn control(cid: u16) -> ButtonId

The keyboard key bound to 0x1b04 control cid.

pub const fn cid(self) -> Option<Cid>

The 0x1b04 control this button diverts as, for a keyboard key.

pub fn is_os_hook_button(self) -> bool

Whether this button is one the OS hook (macOS CGEventTap / Linux evdev) remaps: Middle, Back, or Forward. The primary L/R clicks always pass through (suppressing them would brick the mouse), and the DPI / thumb / dedicated gesture controls aren’t visible to the OS hook at all (they’re captured over HID++). Stored gesture bindings also project through this set so Middle Click configurations written by v0.8.0 keep working; Self::supports_gesture_mode separately controls which buttons may be newly promoted by the UI.

pub fn is_os_hook_gesture_source(self) -> bool

Whether this button may use the OS hook’s hold-and-swipe gesture path. Back and Forward are the only eligible controls: Middle Click belongs to the main wheel, whose controls intentionally remain single-action.

pub fn is_hidpp_gesture_source(self) -> bool

Whether this button is a HID++ gesture source — a control that is captured over HID++ raw-XY diversion (never the OS hook) and can therefore own the gesture role with swipe directions: DPI/ModeShift, the dedicated gesture button, or the MX Master 4 haptic panel. The capture layer maps each to its control ID and checks the device’s advertised raw-XY capability before arming it.

pub fn supports_gesture_mode(self) -> bool

Whether OpenLogi offers gesture mode for this logical control. Wheel controls, the primary clicks and keyboard keys stay single-action by product policy; device-specific HID++ capability checks may further narrow this set at capture time.

pub fn config_name(self) -> Cow<'static, str>

The name this button is written with in config.toml.

pub fn label(self) -> Cow<'static, str>

Human-readable label for popovers and tooltips.

pub fn translation_key(self) -> &'static str

Stable catalog key for the localized button label.

Trait Implementations

impl Clone for ButtonId

fn clone(&self) -> ButtonId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ButtonId

impl Debug for ButtonId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ButtonId

fn deserialize<D>( deserializer: D, ) -> Result<ButtonId, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ButtonId

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

Formats the value using the given formatter.

impl Eq for ButtonId

impl FromStr for ButtonId

fn from_str(name: &str) -> Result<ButtonId, <ButtonId as FromStr>::Err>

The inverse of ButtonId::config_name: a mouse button’s variant name, a known control’s catalog name, or control:0x….

type Err = ParseButtonIdError

The associated error which can be returned from parsing.

impl Hash for ButtonId

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

where __H: Hasher,

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 ButtonId

fn cmp(&self, other: &ButtonId) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for ButtonId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ButtonId

fn partial_cmp(&self, other: &ButtonId) -> 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 Serialize for ButtonId

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ButtonId