#include <hps.h>
|
enum | Buttons {
_button_none = 0x0000,
_button_left = 0x0001,
_button_right = 0x0002,
_button_middle = 0x0004,
_button_x1 = 0x0008,
_button_x2 = 0x0010
} |
|
Mouse buttons that could be active for a MouseEvent.
Mouse button bitfield constants.
HPS::MouseButtons::MouseButtons |
( |
| ) |
|
|
inline |
The default constructor creates a MouseButtons object with no modifiers active.
Creates a new MouseButtons object with the left button active.
- Returns
- A new MouseButtons object with the left button active.
Creates a new MouseButtons object with the middle button active.
- Returns
- A new MouseButtons object with the middle button active.
Creates a new MouseButtons object with the right button active.
- Returns
- A new MouseButtons object with the right button active.
Creates a new MouseButtons object with the X1 button active.
- Returns
- A new MouseButtons object with the X1 button active.
Creates a new MouseButtons object with the X2 button active.
- Returns
- A new MouseButtons object with the X2 button active.
bool HPS::MouseButtons::Equals |
( |
MouseButtons const & |
in_that | ) |
const |
|
inline |
Check if the source object is equivalent to this object.
- Parameters
-
in_kit | The source object to compare to this object. |
- Returns
- true if the objects are equivalent, false otherwise.
bool HPS::MouseButtons::HasAll |
( |
MouseButtons const & |
in_buttons | ) |
const |
|
inline |
Indicates whether all buttons of the input parameter are present in this object.
- Parameters
-
in_buttons | A collection of mouse buttons to check against this object. |
- Returns
- true if all of the input buttons are active, false otherwise.
bool HPS::MouseButtons::HasAny |
( |
MouseButtons const & |
in_buttons | ) |
const |
|
inline |
Indicates whether any buttons of the input parameter are present in this object.
- Parameters
-
in_buttons | A collection of mouse buttons to check against this object. |
- Returns
- true if any of the input buttons are active, false otherwise.
bool HPS::MouseButtons::Left |
( |
| ) |
const |
|
inline |
Indicates whether the left button is down.
- Returns
- true if the left button is down, false otherwise.
void HPS::MouseButtons::Left |
( |
bool |
in_state | ) |
|
|
inline |
Sets the state of the left button.
- Parameters
-
in_state | true if the button is down, false otherwise. |
bool HPS::MouseButtons::Middle |
( |
| ) |
const |
|
inline |
Indicates whether the middle button is down.
- Returns
- true if the middle button is down, false otherwise.
void HPS::MouseButtons::Middle |
( |
bool |
in_state | ) |
|
|
inline |
Sets the state of the middle button.
- Parameters
-
in_state | true if the button is down, false otherwise. |
bool HPS::MouseButtons::None |
( |
| ) |
const |
|
inline |
Indicates whether no buttons are active.
- Returns
- true if no mouse buttons are active, false otherwise.
bool HPS::MouseButtons::operator!= |
( |
MouseButtons const & |
in_that | ) |
const |
|
inline |
Check if the source object is not equivalent to this object.
- Parameters
-
in_kit | The source object to compare to this object. |
- Returns
- true if the objects are not equivalent, false otherwise.
Merges the buttons from two MouseButtons objects.
- Parameters
-
in_buttons_to_merge | A collection of mouse buttons to merge with the buttons of this object. |
- Returns
- A new MouseButtons object.
Merges the buttons from another MouseButtons object into this one.
- Parameters
-
in_buttons_to_merge | A collection of mouse buttons to merge with the buttons of this object. |
- Returns
- A reference to this object.
Creates a new MouseButtons object representing the removal of the buttons of another MouseButtons object from this object.
- Parameters
-
in_buttons_to_remove | A collection of mouse buttons to remove from those of this object. |
- Returns
- A new MouseButtons object.
Removes the buttons of another MouseButtons object from this one.
- Parameters
-
in_buttons_to_remove | A collection of mouse buttons to remove from those of this object. |
- Returns
- A reference to this object.
bool HPS::MouseButtons::operator== |
( |
MouseButtons const & |
in_that | ) |
const |
|
inline |
Check if the source object is equivalent to this object.
- Parameters
-
in_kit | The source object to compare to this object. |
- Returns
- true if the objects are equivalent, false otherwise.
bool HPS::MouseButtons::Right |
( |
| ) |
const |
|
inline |
Indicates whether the right button is down.
- Returns
- true if the right button is down, false otherwise.
void HPS::MouseButtons::Right |
( |
bool |
in_state | ) |
|
|
inline |
Sets the state of the right button.
- Parameters
-
in_state | true if the button is down, false otherwise. |
bool HPS::MouseButtons::X1 |
( |
| ) |
const |
|
inline |
Indicates whether the X1 button is down.
- Returns
- true if the X1 button is down, false otherwise.
void HPS::MouseButtons::X1 |
( |
bool |
in_state | ) |
|
|
inline |
Sets the state of the X1 button.
- Parameters
-
in_state | true if the button is down, false otherwise. |
bool HPS::MouseButtons::X2 |
( |
| ) |
const |
|
inline |
Indicates whether the X2 button is down.
- Returns
- true if the X2 button is down, false otherwise.
void HPS::MouseButtons::X2 |
( |
bool |
in_state | ) |
|
|
inline |
Sets the state of the X2 button.
- Parameters
-
in_state | true if the button is down, false otherwise. |
The documentation for this class was generated from the following file:
- C:/git/visualize/hps/include/hps.h