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

#include <mir_pointer_config.h>

Public Member Functions

 MirPointerConfig ()
 
 ~MirPointerConfig ()
 
 MirPointerConfig (MirPointerConfig const &cp)
 
 MirPointerConfig (MirPointerConfig &&cp)
 
MirPointerConfigoperator= (MirPointerConfig const &cp)
 
 MirPointerConfig (MirPointerHandedness handedness, MirPointerAcceleration acceleration, double acceleration_bias, double horizontal_scroll_scale, double vertical_scroll_scale)
 
MirPointerHandedness handedness () const
 
void handedness (MirPointerHandedness)
 
MirPointerAcceleration acceleration () const
 
void acceleration (MirPointerAcceleration)
 
double cursor_acceleration_bias () const
 
void cursor_acceleration_bias (double)
 
double horizontal_scroll_scale () const
 
void horizontal_scroll_scale (double)
 
double vertical_scroll_scale () const
 
void vertical_scroll_scale (double)
 
bool operator== (MirPointerConfig const &rhs) const
 
bool operator!= (MirPointerConfig const &rhs) const
 

Detailed Description

Examples:
server_example_input_device_config.cpp.

Constructor & Destructor Documentation

MirPointerConfig::MirPointerConfig ( )
MirPointerConfig::~MirPointerConfig ( )
MirPointerConfig::MirPointerConfig ( MirPointerConfig const &  cp)
MirPointerConfig::MirPointerConfig ( MirPointerConfig &&  cp)
MirPointerConfig::MirPointerConfig ( MirPointerHandedness  handedness,
MirPointerAcceleration  acceleration,
double  acceleration_bias,
double  horizontal_scroll_scale,
double  vertical_scroll_scale 
)

Member Function Documentation

MirPointerAcceleration MirPointerConfig::acceleration ( ) const

Configure cursor acceleration profile

Examples:
server_example_input_device_config.cpp.
void MirPointerConfig::acceleration ( MirPointerAcceleration  )
double MirPointerConfig::cursor_acceleration_bias ( ) const

Configures the intensity of the cursor acceleration. Values within the range of [-1, 1] are allowed.

  • 0: default acceleration
  • [-1, 0): reduced acceleration
  • (0, 1]: increased acceleration
Examples:
server_example_input_device_config.cpp.
void MirPointerConfig::cursor_acceleration_bias ( double  )
MirPointerHandedness MirPointerConfig::handedness ( ) const

Configure which button shall be used as primary button. That way the input device is configured to be either right or left handed.

void MirPointerConfig::handedness ( MirPointerHandedness  )
double MirPointerConfig::horizontal_scroll_scale ( ) const

Configures a signed scale of the horizontal scrolling. Use negative values to configure 'natural scrolling'

void MirPointerConfig::horizontal_scroll_scale ( double  )
bool MirPointerConfig::operator!= ( MirPointerConfig const &  rhs) const
MirPointerConfig& MirPointerConfig::operator= ( MirPointerConfig const &  cp)
bool MirPointerConfig::operator== ( MirPointerConfig const &  rhs) const
double MirPointerConfig::vertical_scroll_scale ( ) const

Configures a signed scale of the vertical scrolling. Use negative values to configure 'natural scrolling'

void MirPointerConfig::vertical_scroll_scale ( double  )

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

Copyright © 2012-2016 Canonical Ltd.
Generated on Tue Oct 31 05:57:28 UTC 2017