MouseButton

class MouseButton

This class is just used as a convenient namespace for grouping all of these handy functions that return buttons which map to standard mouse buttons.

Inheritance diagram

Inheritance diagram of MouseButton

MouseButton(void) = default
MouseButton(MouseButton const&) = default
static ButtonHandle button(int button_number)

Returns the ButtonHandle associated with the particular numbered mouse button (zero-based), if there is one, or ButtonHandle::none() if there is not.

static ButtonHandle five(void)

Returns the ButtonHandle associated with the fifth mouse button.

static ButtonHandle four(void)

Returns the ButtonHandle associated with the fourth mouse button.

static bool is_mouse_button(ButtonHandle button)

Returns true if the indicated ButtonHandle is a mouse button, false if it is some other kind of button.

static ButtonHandle one(void)

Returns the ButtonHandle associated with the first mouse button.

static ButtonHandle three(void)

Returns the ButtonHandle associated with the third mouse button.

static ButtonHandle two(void)

Returns the ButtonHandle associated with the second mouse button.

static ButtonHandle wheel_down(void)

Returns the ButtonHandle generated when the mouse wheel is rolled one notch downwards.

static ButtonHandle wheel_left(void)

Returns the ButtonHandle generated when the mouse is scrolled to the left. Usually, you’ll only find the horizontal scroll on laptops.

static ButtonHandle wheel_right(void)

Returns the ButtonHandle generated when the mouse is scrolled to the right. Usually, you’ll only find the horizontal scroll on laptops.

static ButtonHandle wheel_up(void)

Returns the ButtonHandle generated when the mouse wheel is rolled one notch upwards.