Mir
Public Member Functions | List of all members
MirTouchpadConfig Struct Reference

#include <mir_touchpad_config.h>

Public Member Functions

 MirTouchpadConfig ()
 
 MirTouchpadConfig (MirTouchpadConfig &&other)
 
 MirTouchpadConfig (MirTouchpadConfig const &other)
 
MirTouchpadConfigoperator= (MirTouchpadConfig const &other)
 
 ~MirTouchpadConfig ()
 
 MirTouchpadConfig (MirTouchpadClickModes click_mode, MirTouchpadScrollModes scroll_mode, int button_down_scroll_button, bool tap_to_click, bool disable_while_typing, bool disable_with_mouse, bool middle_mouse_button_emulation)
 
MirTouchpadClickModes click_mode () const
 
void click_mode (MirTouchpadClickModes)
 
MirTouchpadScrollModes scroll_mode () const
 
void scroll_mode (MirTouchpadScrollModes)
 
int button_down_scroll_button () const
 
void button_down_scroll_button (int)
 
bool tap_to_click () const
 
void tap_to_click (bool)
 
bool middle_mouse_button_emulation () const
 
void middle_mouse_button_emulation (bool)
 
bool disable_with_mouse () const
 
void disable_with_mouse (bool)
 
bool disable_while_typing () const
 
void disable_while_typing (bool)
 
bool operator== (MirTouchpadConfig const &rhs) const
 
bool operator!= (MirTouchpadConfig const &rhs) const
 

Constructor & Destructor Documentation

◆ MirTouchpadConfig() [1/4]

MirTouchpadConfig::MirTouchpadConfig ( )

◆ MirTouchpadConfig() [2/4]

MirTouchpadConfig::MirTouchpadConfig ( MirTouchpadConfig &&  other)

◆ MirTouchpadConfig() [3/4]

MirTouchpadConfig::MirTouchpadConfig ( MirTouchpadConfig const &  other)

◆ ~MirTouchpadConfig()

MirTouchpadConfig::~MirTouchpadConfig ( )

◆ MirTouchpadConfig() [4/4]

MirTouchpadConfig::MirTouchpadConfig ( MirTouchpadClickModes  click_mode,
MirTouchpadScrollModes  scroll_mode,
int  button_down_scroll_button,
bool  tap_to_click,
bool  disable_while_typing,
bool  disable_with_mouse,
bool  middle_mouse_button_emulation 
)

Member Function Documentation

◆ button_down_scroll_button() [1/2]

int MirTouchpadConfig::button_down_scroll_button ( ) const

Configures the button used for the on-button-down scroll mode

◆ button_down_scroll_button() [2/2]

void MirTouchpadConfig::button_down_scroll_button ( int  )

◆ click_mode() [1/2]

MirTouchpadClickModes MirTouchpadConfig::click_mode ( ) const

The click mode defines when the touchpad generates software emulated button events.

◆ click_mode() [2/2]

void MirTouchpadConfig::click_mode ( MirTouchpadClickModes  )

◆ disable_while_typing() [1/2]

bool MirTouchpadConfig::disable_while_typing ( ) const

When disable-with-mouse is enabled the touchpad will stop to emit user input events when the user starts to use a keyboard and a short period after.

◆ disable_while_typing() [2/2]

void MirTouchpadConfig::disable_while_typing ( bool  )

◆ disable_with_mouse() [1/2]

bool MirTouchpadConfig::disable_with_mouse ( ) const

When disable-with-mouse is enabled the touchpad will stop to emit user input events when another pointing device is plugged in.

◆ disable_with_mouse() [2/2]

void MirTouchpadConfig::disable_with_mouse ( bool  )

◆ middle_mouse_button_emulation() [1/2]

bool MirTouchpadConfig::middle_mouse_button_emulation ( ) const

Emulates a middle mouse button press when the left and right buttons on a touchpad are pressed.

◆ middle_mouse_button_emulation() [2/2]

void MirTouchpadConfig::middle_mouse_button_emulation ( bool  )

◆ operator!=()

bool MirTouchpadConfig::operator!= ( MirTouchpadConfig const &  rhs) const

◆ operator=()

MirTouchpadConfig& MirTouchpadConfig::operator= ( MirTouchpadConfig const &  other)

◆ operator==()

bool MirTouchpadConfig::operator== ( MirTouchpadConfig const &  rhs) const

◆ scroll_mode() [1/2]

MirTouchpadScrollModes MirTouchpadConfig::scroll_mode ( ) const

The scroll mode defines when the touchpad generates scroll events instead of pointer motion events.

◆ scroll_mode() [2/2]

void MirTouchpadConfig::scroll_mode ( MirTouchpadScrollModes  )

◆ tap_to_click() [1/2]

bool MirTouchpadConfig::tap_to_click ( ) const

When tap to click is enabled the system will interpret short finger touch down/up sequences as button clicks.

◆ tap_to_click() [2/2]

void MirTouchpadConfig::tap_to_click ( bool  )

The documentation for this struct was generated from the following file:

Copyright © 2012-2018 Canonical Ltd.
Generated on Thu Apr 5 15:26:05 UTC 2018