Class InputConfiguration

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()
~InputConfiguration()
void operator()(mir::Server &server)
auto mouse() -> Mouse
void mouse(Mouse const &val)
auto touchpad() -> Touchpad
void touchpad(Touchpad const &val)
class Mouse

Input configuration for mouse pointer devices.

Remark

Since MirAL 5.1

Public Functions

Mouse()
~Mouse()
Mouse(Mouse const &that)
auto operator=(Mouse that) -> Mouse&
auto handedness() const -> std::optional<MirPointerHandedness>
auto acceleration() const -> std::optional<MirPointerAcceleration>
auto acceleration_bias() const -> std::optional<double>
auto vscroll_speed() const -> std::optional<double>
auto hscroll_speed() const -> std::optional<double>
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)

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)
auto operator=(Touchpad that) -> Touchpad&
auto disable_while_typing() const -> std::optional<bool>
auto disable_with_external_mouse() const -> std::optional<bool>
auto acceleration() const -> std::optional<MirPointerAcceleration>
auto acceleration_bias() const -> std::optional<double>
auto vscroll_speed() const -> std::optional<double>
auto hscroll_speed() const -> std::optional<double>
auto click_mode() const -> std::optional<MirTouchpadClickMode>
auto scroll_mode() const -> std::optional<MirTouchpadScrollMode>
auto tap_to_click() const -> std::optional<bool>
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)

Friends

friend class InputConfiguration::Self