Mir
Public Member Functions | Protected Member Functions | List of all members
mir::input::InputRegion Class Referenceabstract

Interface to the region of valid input coordinates. More...

#include <input_region.h>

Inheritance diagram for mir::input::InputRegion:
[legend]

Public Member Functions

virtual ~InputRegion ()=default
 
virtual geometry::Rectangle bounding_rectangle ()=0
 The bounding rectangle of the input region. More...
 
virtual void confine (geometry::Point &point)=0
 Confines a point to the input region. More...
 

Protected Member Functions

 InputRegion ()=default
 
 InputRegion (InputRegion const &)=delete
 
InputRegionoperator= (InputRegion const &)=delete
 

Detailed Description

Interface to the region of valid input coordinates.

Constructor & Destructor Documentation

virtual mir::input::InputRegion::~InputRegion ( )
virtualdefault
mir::input::InputRegion::InputRegion ( )
protecteddefault
mir::input::InputRegion::InputRegion ( InputRegion const &  )
protecteddelete

Member Function Documentation

virtual geometry::Rectangle mir::input::InputRegion::bounding_rectangle ( )
pure virtual

The bounding rectangle of the input region.

Implemented in mir::input::DisplayInputRegion.

virtual void mir::input::InputRegion::confine ( geometry::Point point)
pure virtual

Confines a point to the input region.

If the point is within input region it remains unchanged, otherwise it is replaced by the region point that is closest to it.

Parameters
[in,out]pointthe point to confine

Implemented in mir::input::DisplayInputRegion.

InputRegion& mir::input::InputRegion::operator= ( InputRegion const &  )
protecteddelete

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

Copyright © 2012,2013 Canonical Ltd.
Generated on Tue Mar 24 16:15:19 UTC 2015