#include <hps.h>

Public Types | |
enum | Action { ButtonUp, Action::ButtonDown, Action::Move, Action::Scroll, Action::Enter, Action::Leave } |
![]() | |
enum | Status { Status::InProgress, Status::Completed, Status::Failed } |
Public Member Functions | |
Event * | Clone () const |
virtual bool | Drop (Event const *in_that_event) const |
virtual bool | Equals (MouseEvent const &in_that) const |
virtual intptr_t | Freshen () const |
MouseEvent () | |
MouseEvent (Action in_action, WindowPoint in_location, MouseButtons in_button=MouseButtons(), ModifierKeys in_modifier=ModifierKeys(), size_t in_click_count=0) | |
MouseEvent (Action in_action, float in_wheel_delta, WindowPoint in_location=WindowPoint(0, 0, 0), ModifierKeys in_modifier=ModifierKeys(), size_t in_click_count=0) | |
MouseEvent (Event const &in_event) | |
virtual bool | operator!= (MouseEvent const &in_that) const |
virtual bool | operator== (MouseEvent const &in_that) const |
![]() | |
virtual bool | Equals (InputEvent const &in_that) const |
ModifierKeys | GetModifierKeys () const |
InputEvent () | |
InputEvent (ModifierKeys const &in_modifiers) | |
virtual bool | operator!= (InputEvent const &in_that) const |
virtual bool | operator== (InputEvent const &in_that) const |
![]() | |
Event (intptr_t in_channel=0) | |
intptr_t | GetChannel () const |
intptr_t | GetClassID () const |
Time | GetTimeStamp () const |
bool | IsConsumable () const |
Public Attributes | |
size_t | ClickCount |
The number of clicks received. | |
HPS::MouseEvent::Action | CurrentAction |
The action for this MouseEvent. | |
HPS::MouseButtons | CurrentButton |
If the action involves a button, this is the button. | |
WindowPoint | Location |
Location in window space of the mouse cursor. | |
float | WheelDelta |
If the action involves the mouse wheel, this is the amount the wheel moved. It is positive if the mouse wheel is moved forward (away from the user) or negative if the mouse wheel is moved downward (toward the user). | |
![]() | |
ModifierKeys | ModifierKeyState |
The modifier keys which are active for this InputEvent. | |
Additional Inherited Members | |
![]() | |
static void | operator delete (void *in_ptr, size_t in_size) throw () |
static void * | operator new (size_t in_size) |
![]() | |
intptr_t | channel |
bool | consumable |
Detailed Description
The MouseEvent class is the event generated for each mouse action.
Member Enumeration Documentation
|
strong |
Enumeration of various actions a mouse can undergo for a MouseEvent.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an uninitialized MouseEvent object.
|
inline |
This constructor creates a MouseEvent object for a given action.
- Parameters
-
in_action Action of this MouseEvent. in_location The location in window space of the mouse cursor. in_button If the action is a button event, this is the button. in_modifier The modifier keys for this MouseEvent. in_click_count The number of clicks received.
|
inline |
This constructor creates a MouseEvent object, most useful for a wheel action.
- Parameters
-
in_action Action of the mouse for this MouseEvent. in_wheel_delta If the action involves the mouse wheel, this is the amount the wheel moved. It is positive if the mouse wheel is moved forward (away from the user) or negative if the mouse wheel is moved downward (toward the user). in_location The location in window space of the mouse cursor. in_modifier The modifier keys for this MouseEvent. in_click_count The number of clicks received.
|
inline |
This constructor converts an Event Object to a MouseEvent object.
Member Function Documentation
|
inlinevirtual |
Allocates and returns a copy of this MouseEvent.
- Returns
- A copy of this MouseEvent.
Reimplemented from HPS::InputEvent.
|
inlinevirtual |
Determines if this MouseEvent can be dropped in favor of the following mouse event.
- Parameters
-
in_that_event Event to compare with this MouseEvent.
- Returns
- true if this event can be dropped, false otherwise.
Reimplemented from HPS::Event.
|
inlinevirtual |
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.
|
inlinevirtual |
This optional function is used to determine if the current event can be dropped in favor of newer event of the same type if one is available.
- Returns
- A cookie representing the freshen category. Zero indicates a non-freshening event.
Reimplemented from HPS::Event.
|
inlinevirtual |
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.
|
inlinevirtual |
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.
The documentation for this class was generated from the following file:
- include/hps.h