#include <hps.h>
|
Event * | Clone () const |
|
virtual bool | Drop (Event const *in_that_event) const |
|
virtual bool | Equals (InputEvent const &in_that) 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 |
|
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 |
|
|
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 |
|
The MouseEvent class is the event generated for each mouse action.
Enumeration of various actions a mouse can undergo for a MouseEvent.
Enumerator |
---|
ButtonDown |
A mouse button has been released.
|
Move |
A mouse button has been pressed.
|
Scroll |
The mouse location has changed.
|
Enter |
The scroll wheel has been moved.
|
Leave |
The mouse cursor has moved into the active window.
The mouse cursor has moved out of the active window.
|
HPS::MouseEvent::MouseEvent |
( |
| ) |
|
|
inline |
The default constructor creates an uninitialized MouseEvent object.
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. |
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. |
HPS::MouseEvent::MouseEvent |
( |
Event const & |
in_event | ) |
|
|
inline |
Event* HPS::MouseEvent::Clone |
( |
| ) |
const |
|
inlinevirtual |
virtual bool HPS::MouseEvent::Drop |
( |
Event const * |
in_that_event | ) |
const |
|
inlinevirtual |
Determines if this MouseEvent can be dropped in favor of the following mouse event.
- Parameters
-
- Returns
- true if this event can be dropped, false otherwise.
Reimplemented from HPS::Event.
virtual bool HPS::MouseEvent::Equals |
( |
InputEvent const & |
in_that | ) |
const |
|
inlinevirtual |
Check if the source object is equivalent to this object.
- Parameters
-
in_that | The source object to compare to this object. |
- Returns
- true if the objects are equivalent, false otherwise.
Reimplemented from HPS::InputEvent.
virtual bool HPS::MouseEvent::Equals |
( |
MouseEvent const & |
in_that | ) |
const |
|
inlinevirtual |
Check if the source object is equivalent to this object.
- Parameters
-
in_that | The source object to compare to this object. |
- Returns
- true if the objects are equivalent, false otherwise.
virtual intptr_t HPS::MouseEvent::Freshen |
( |
| ) |
const |
|
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.
virtual bool HPS::MouseEvent::operator!= |
( |
MouseEvent const & |
in_that | ) |
const |
|
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.
virtual bool HPS::MouseEvent::operator== |
( |
MouseEvent const & |
in_that | ) |
const |
|
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: