MouseButtons
-
class MouseButtons
Mouse buttons that could be active for a MouseEvent.
Public Functions
-
inline bool Equals(MouseButtons const &in_that) const
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.
-
inline bool HasAll(MouseButtons const &in_buttons) const
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.
-
inline bool HasAny(MouseButtons const &in_buttons) const
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.
-
inline bool Left() const
Indicates whether the left button is down.
- Returns:
true if the left button is down, false otherwise.
-
inline void Left(bool in_state)
Sets the state of the left button.
- Parameters:
in_state – true if the button is down, false otherwise.
-
inline bool Middle() const
Indicates whether the middle button is down.
- Returns:
true if the middle button is down, false otherwise.
-
inline void Middle(bool in_state)
Sets the state of the middle button.
- Parameters:
in_state – true if the button is down, false otherwise.
-
inline MouseButtons()
The default constructor creates a MouseButtons object with no modifiers active.
-
inline bool None() const
Indicates whether no buttons are active.
- Returns:
true if no mouse buttons are active, false otherwise.
-
inline bool operator!=(MouseButtons const &in_that) const
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.
-
inline MouseButtons operator+(MouseButtons const &in_buttons_to_merge)
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.
-
inline MouseButtons &operator+=(MouseButtons const &in_buttons_to_merge)
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.
-
inline MouseButtons operator-(MouseButtons const &in_buttons_to_remove)
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.
-
inline MouseButtons &operator-=(MouseButtons const &in_buttons_to_remove)
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.
-
inline bool operator==(MouseButtons const &in_that) const
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.
-
inline bool Right() const
Indicates whether the right button is down.
- Returns:
true if the right button is down, false otherwise.
-
inline void Right(bool in_state)
Sets the state of the right button.
- Parameters:
in_state – true if the button is down, false otherwise.
-
inline bool X1() const
Indicates whether the X1 button is down.
- Returns:
true if the X1 button is down, false otherwise.
-
inline void X1(bool in_state)
Sets the state of the X1 button.
- Parameters:
in_state – true if the button is down, false otherwise.
-
inline bool X2() const
Indicates whether the X2 button is down.
- Returns:
true if the X2 button is down, false otherwise.
-
inline void X2(bool in_state)
Sets the state of the X2 button.
- Parameters:
in_state – true if the button is down, false otherwise.
Public Static Functions
-
static inline MouseButtons ButtonLeft()
Creates a new MouseButtons object with the left button active.
- Returns:
A new MouseButtons object with the left button active.
-
static inline MouseButtons ButtonMiddle()
Creates a new MouseButtons object with the middle button active.
- Returns:
A new MouseButtons object with the middle button active.
-
static inline MouseButtons ButtonRight()
Creates a new MouseButtons object with the right button active.
- Returns:
A new MouseButtons object with the right button active.
-
static inline MouseButtons ButtonX1()
Creates a new MouseButtons object with the X1 button active.
- Returns:
A new MouseButtons object with the X1 button active.
-
static inline MouseButtons ButtonX2()
Creates a new MouseButtons object with the X2 button active.
- Returns:
A new MouseButtons object with the X2 button active.
-
inline bool Equals(MouseButtons const &in_that) const
