The MouseEvent class is the event generated for each mouse action. More...
Public Types | |
enum | Action { ButtonUp = 0, Action.ButtonDown = 1, Action.Move = 2, Action.Scroll = 3, Action.Enter = 4, Action.Leave = 5 } |
Enumeration of various actions a mouse can undergo for a MouseEvent. More... | |
![]() | |
enum | Status { Status.InProgress = 0, Status.Completed = 1, Status.Failed = 2 } |
Event Status - returned from a notifier to give the status of the event. More... | |
Public Member Functions | |
override void | Dispose () |
MouseEvent () | |
The default constructor creates an uninitialized MouseEvent object. More... | |
MouseEvent (HPS.MouseEvent.Action in_action, HPS.WindowPoint in_location, HPS.MouseButtons in_button, HPS.ModifierKeys in_modifier, ulong in_click_count) | |
This constructor creates a MouseEvent object for a given action. More... | |
MouseEvent (HPS.MouseEvent.Action in_action, HPS.WindowPoint in_location, HPS.MouseButtons in_button, HPS.ModifierKeys in_modifier) | |
This constructor creates a MouseEvent object for a given action. More... | |
MouseEvent (HPS.MouseEvent.Action in_action, HPS.WindowPoint in_location, HPS.MouseButtons in_button) | |
This constructor creates a MouseEvent object for a given action. More... | |
MouseEvent (HPS.MouseEvent.Action in_action, HPS.WindowPoint in_location) | |
This constructor creates a MouseEvent object for a given action. More... | |
MouseEvent (HPS.MouseEvent.Action in_action, float in_wheel_delta, HPS.WindowPoint in_location, HPS.ModifierKeys in_modifier, ulong in_click_count) | |
This constructor creates a MouseEvent object, most useful for a wheel action. More... | |
MouseEvent (HPS.MouseEvent.Action in_action, float in_wheel_delta, HPS.WindowPoint in_location, HPS.ModifierKeys in_modifier) | |
This constructor creates a MouseEvent object, most useful for a wheel action. More... | |
MouseEvent (HPS.MouseEvent.Action in_action, float in_wheel_delta, HPS.WindowPoint in_location) | |
This constructor creates a MouseEvent object, most useful for a wheel action. More... | |
MouseEvent (HPS.MouseEvent.Action in_action, float in_wheel_delta) | |
This constructor creates a MouseEvent object, most useful for a wheel action. More... | |
MouseEvent (HPS.Event in_event) | |
This constructor converts an EventObject to a MouseEvent object. More... | |
MouseEvent (HPS.MouseEvent in_that) | |
override HPS.Event | Clone () |
Allocates and returns a copy of this MouseEvent. More... | |
override bool | Equals (System.Object obj) |
override int | GetHashCode () |
virtual bool | Equals (HPS.MouseEvent in_that) |
Check if the source object is equivalent to this object. More... | |
override bool | Drop (HPS.Event in_that_event) |
Determines if this MouseEvent can be dropped in favor of the following mouse event. More... | |
override IntPtr | Freshen () |
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. More... | |
![]() | |
InputEvent () | |
This constructor creates a default InputEvent object. More... | |
InputEvent (HPS.ModifierKeys in_modifiers) | |
This constructor creates a new InputEvent with the specified modifier keys initialized. More... | |
InputEvent (HPS.InputEvent in_that) | |
override bool | Equals (System.Object obj) |
override int | GetHashCode () |
virtual bool | Equals (HPS.InputEvent in_that) |
Check if the source object is equivalent to this object. More... | |
HPS.ModifierKeys | GetModifierKeys () |
Queries which modifier keys are active More... | |
![]() | |
IntPtr | GetClassID () |
Event (IntPtr in_channel) | |
A constructor for generating events from built-in or custom event ID's. More... | |
Event () | |
A constructor for generating events from built-in or custom event ID's. More... | |
Event (HPS.Event in_that) | |
IntPtr | GetChannel () |
Returns the channel ID assigned to an event. More... | |
double | GetTimeStamp () |
Returns the time an event was injected into the event queue. More... | |
bool | IsConsumable () |
Indicates whether an event will be consumed when it is handled or passed on to the next handler anyway. More... | |
delegate IntPtr | EventDelegate_0 () |
delegate bool | EventDelegate_1 (IntPtr in_that_event) |
delegate IntPtr | EventDelegate_2 () |
delegate void | DtorDelegate (IntPtr cPtr) |
Static Public Member Functions | |
static bool | operator== (HPS.MouseEvent a, HPS.MouseEvent b) |
static bool | operator!= (HPS.MouseEvent a, HPS.MouseEvent b) |
![]() | |
static bool | operator== (HPS.InputEvent a, HPS.InputEvent b) |
static bool | operator!= (HPS.InputEvent a, HPS.InputEvent b) |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
void | DtorCallback (IntPtr p) |
virtual IntPtr | GetNonDirectorClassID () |
Properties | |
HPS.MouseEvent.Action | CurrentAction [get, set] |
HPS.WindowPoint | Location [get, set] |
HPS.MouseButtons | CurrentButton [get, set] |
float | WheelDelta [get, set] |
ulong | ClickCount [get, set] |
![]() | |
HPS.ModifierKeys | ModifierKeyState [get, set] |
Additional Inherited Members | |
![]() | |
HandleRef | cptr |
HandleRef | scptr |
bool | cMemOwn |
The MouseEvent class is the event generated for each mouse action.
Enumeration of various actions a mouse can undergo for a MouseEvent.
|
inline |
The default constructor creates an uninitialized MouseEvent object.
|
inline |
This constructor creates a MouseEvent object for a given action.
in_action | Action of this <ref refid="class_h_p_s_1_1_mouse_event" kindref="compound">MouseEvent</ref>. |
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 <ref refid="class_h_p_s_1_1_mouse_event" kindref="compound">MouseEvent</ref>. |
in_click_count | The number of clicks received. |
|
inline |
This constructor creates a MouseEvent object for a given action.
in_action | Action of this <ref refid="class_h_p_s_1_1_mouse_event" kindref="compound">MouseEvent</ref>. |
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 <ref refid="class_h_p_s_1_1_mouse_event" kindref="compound">MouseEvent</ref>. |
|
inline |
This constructor creates a MouseEvent object for a given action.
in_action | Action of this <ref refid="class_h_p_s_1_1_mouse_event" kindref="compound">MouseEvent</ref>. |
in_location | The location in window space of the mouse cursor. |
in_button | If the action is a button event, this is the button. |
|
inline |
This constructor creates a MouseEvent object for a given action.
in_action | Action of this <ref refid="class_h_p_s_1_1_mouse_event" kindref="compound">MouseEvent</ref>. |
in_location | The location in window space of the mouse cursor. |
|
inline |
This constructor creates a MouseEvent object, most useful for a wheel action.
in_action | Action of the mouse for this <ref refid="class_h_p_s_1_1_mouse_event" kindref="compound">MouseEvent</ref>. |
in_location | The location in window space of the mouse cursor. |
in_modifier | The modifier keys for this <ref refid="class_h_p_s_1_1_mouse_event" kindref="compound">MouseEvent</ref>. |
in_click_count | The number of clicks received. |
|
inline |
This constructor creates a MouseEvent object, most useful for a wheel action.
in_action | Action of the mouse for this <ref refid="class_h_p_s_1_1_mouse_event" kindref="compound">MouseEvent</ref>. |
in_location | The location in window space of the mouse cursor. |
in_modifier | The modifier keys for this <ref refid="class_h_p_s_1_1_mouse_event" kindref="compound">MouseEvent</ref>. |
|
inline |
This constructor creates a MouseEvent object, most useful for a wheel action.
in_action | Action of the mouse for this <ref refid="class_h_p_s_1_1_mouse_event" kindref="compound">MouseEvent</ref>. |
in_location | The location in window space of the mouse cursor. |
|
inline |
This constructor creates a MouseEvent object, most useful for a wheel action.
in_action | Action of the mouse for this <ref refid="class_h_p_s_1_1_mouse_event" kindref="compound">MouseEvent</ref>. |
|
inline |
This constructor converts an EventObject to a MouseEvent object.
|
inlinevirtual |
Allocates and 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.
in_that_event | <ref refid="class_h_p_s_1_1_event" kindref="compound">Event</ref> to compare with this <ref refid="class_h_p_s_1_1_mouse_event" kindref="compound">MouseEvent</ref>. |
Reimplemented from HPS.Event.
|
inlinevirtual |
Check if the source object is equivalent to this object.
|
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.
Reimplemented from HPS.Event.