Class InputConfiguration¶

Defined in File input_configuration.h

Nested Relationships¶

Nested Types¶

Class Documentation¶

class InputConfiguration¶

Input configuration.

Allow servers to make input configuration changes at runtime

Remark

Since MirAL 5.1

Public Functions

InputConfiguration()¶

explicit InputConfiguration(live_config::Store &config_store)¶

Construct registering with a configuration store.

Remark

Since Miral 5.5

~InputConfiguration()¶

void operator()(mir::Server &server)¶

Mouse mouse()¶

void mouse(Mouse const &val)¶

Touchpad touchpad()¶

void touchpad(Touchpad const &val)¶

Keyboard keyboard()¶

void keyboard(Keyboard const &val)¶

class Mouse¶

Input configuration for mouse pointer devices.

Remark

Since MirAL 5.1

Public Functions

Mouse()¶

~Mouse()¶

Mouse(Mouse const &that)¶

Mouse &operator=(Mouse that)¶

std::optional<MirPointerHandedness> handedness() const¶

std::optional<MirPointerAcceleration> acceleration() const¶

std::optional<double> acceleration_bias() const¶

std::optional<double> vscroll_speed() const¶

std::optional<double> hscroll_speed() const¶

void handedness(std::optional<MirPointerHandedness> const &val)¶

void acceleration(std::optional<MirPointerAcceleration> const &val)¶

void acceleration_bias(std::optional<double> const &val)¶: Note

val will be clamped to the range [-1.0, 1.0]

void vscroll_speed(std::optional<double> const &val)¶

void hscroll_speed(std::optional<double> const &val)¶

void merge(InputConfiguration::Mouse const &other)¶

Copies the corresponding value from other for all unset fields.

Remark

Since MirAL 5.3

Friends

friend class InputConfiguration::Self

class Touchpad¶

Input configuration for touchpad devices.

Remark

Since MirAL 5.1

Public Functions

Touchpad()¶

~Touchpad()¶

Touchpad(Touchpad const &that)¶

Touchpad &operator=(Touchpad that)¶

std::optional<bool> disable_while_typing() const¶

std::optional<bool> disable_with_external_mouse() const¶

std::optional<MirPointerAcceleration> acceleration() const¶

std::optional<double> acceleration_bias() const¶

std::optional<double> vscroll_speed() const¶

std::optional<double> hscroll_speed() const¶

std::optional<MirTouchpadClickMode> click_mode() const¶

std::optional<MirTouchpadScrollMode> scroll_mode() const¶

std::optional<bool> tap_to_click() const¶

std::optional<bool> middle_mouse_button_emulation() const¶

Remark

Since MirAL 5.3

void disable_while_typing(std::optional<bool> const &val)¶

void disable_with_external_mouse(std::optional<bool> const &val)¶

void acceleration(std::optional<MirPointerAcceleration> const &val)¶

void acceleration_bias(std::optional<double> const &val)¶: Note

val will be clamped to the range [-1.0, 1.0]

void vscroll_speed(std::optional<double> const &val)¶

void hscroll_speed(std::optional<double> const &val)¶

void click_mode(std::optional<MirTouchpadClickMode> const &val)¶

void scroll_mode(std::optional<MirTouchpadScrollMode> const &val)¶

void tap_to_click(std::optional<bool> const &val)¶

void middle_mouse_button_emulation(std::optional<bool> const &val)¶

Remark

Since MirAL 5.3

void merge(InputConfiguration::Touchpad const &other)¶

Copies the corresponding value from other for all unset fields.

Remark

Since MirAL 5.3

Friends

friend class InputConfiguration::Self

class Keyboard¶

Input configuration for keyboard devices.

Remark

Since MirAL 5.3

Public Functions

Keyboard()¶

~Keyboard()¶

Keyboard(Keyboard const &that)¶

Keyboard &operator=(Keyboard that)¶

void set_repeat_rate(int new_rate)¶

void set_repeat_delay(int new_delay)¶

std::optional<int> repeat_rate() const¶

std::optional<int> repeat_delay() const¶

void merge(InputConfiguration::Keyboard const &other)¶

Friends

friend class InputConfiguration::Self