< Home

< Table of Contents

REFERENCE MANUAL

HPS.MouseEvent Class Reference

The MouseEvent class is the event generated for each mouse action. More...

Inheritance diagram for HPS.MouseEvent:
HPS.InputEvent HPS.Event

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...
 
- Public Types inherited from HPS.Event
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 HPS.Event Clone ()
 Allocates and returns a copy of this MouseEvent. More...
 
override void Dispose ()
 
override bool Drop (HPS.Event in_that_event)
 Determines if this MouseEvent can be dropped in favor of the following mouse event. More...
 
override bool Equals (System.Object obj)
 
virtual bool Equals (HPS.MouseEvent in_that)
 Check if the source object is equivalent to this object. 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...
 
override int GetHashCode ()
 
 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)
 
- Public Member Functions inherited from HPS.InputEvent
override bool Equals (System.Object obj)
 
virtual bool Equals (HPS.InputEvent in_that)
 Check if the source object is equivalent to this object. More...
 
override int GetHashCode ()
 
HPS.ModifierKeys GetModifierKeys ()
 Query whether a particular modifier key is active for this InputEvent. 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)
 
- Public Member Functions inherited from HPS.Event
delegate void DtorDelegate (IntPtr cPtr)
 
 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)
 
delegate IntPtr EventDelegate_0 ()
 
delegate bool EventDelegate_1 (IntPtr in_that_event)
 
delegate IntPtr EventDelegate_2 ()
 
IntPtr GetChannel ()
 Returns the channel ID assigned to an event. More...
 
IntPtr GetClassID ()
 
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...
 

Static Public Member Functions

static bool operator!= (HPS.MouseEvent a, HPS.MouseEvent b)
 
static bool operator== (HPS.MouseEvent a, HPS.MouseEvent b)
 
- Static Public Member Functions inherited from HPS.InputEvent
static bool operator!= (HPS.InputEvent a, HPS.InputEvent b)
 
static bool operator== (HPS.InputEvent a, HPS.InputEvent b)
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Event
void DtorCallback (IntPtr p)
 
virtual IntPtr GetNonDirectorClassID ()
 

Properties

ulong ClickCount [get, set]
 
HPS.MouseEvent.Action CurrentAction [get, set]
 
HPS.MouseButtons CurrentButton [get, set]
 
HPS.WindowPoint Location [get, set]
 
float WheelDelta [get, set]
 
- Properties inherited from HPS.InputEvent
HPS.ModifierKeys ModifierKeyState [get, set]
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Event
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The MouseEvent class is the event generated for each mouse action.

Member Enumeration Documentation

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.

Constructor & Destructor Documentation

HPS.MouseEvent.MouseEvent ( )

The default constructor creates an uninitialized MouseEvent object.

HPS.MouseEvent.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.

Parameters
in_actionAction of this <ref refid="class_h_p_s_1_1_mouse_event" kindref="compound">MouseEvent</ref>.
in_locationThe location in window space of the mouse cursor.
in_buttonIf the action is a button event, this is the button.
in_modifierThe modifier keys for this <ref refid="class_h_p_s_1_1_mouse_event" kindref="compound">MouseEvent</ref>.
in_click_countThe number of clicks received.
HPS.MouseEvent.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.

Parameters
in_actionAction of this <ref refid="class_h_p_s_1_1_mouse_event" kindref="compound">MouseEvent</ref>.
in_locationThe location in window space of the mouse cursor.
in_buttonIf the action is a button event, this is the button.
in_modifierThe modifier keys for this <ref refid="class_h_p_s_1_1_mouse_event" kindref="compound">MouseEvent</ref>.
HPS.MouseEvent.MouseEvent ( HPS.MouseEvent.Action  in_action,
HPS.WindowPoint  in_location,
HPS.MouseButtons  in_button 
)

This constructor creates a MouseEvent object for a given action.

Parameters
in_actionAction of this <ref refid="class_h_p_s_1_1_mouse_event" kindref="compound">MouseEvent</ref>.
in_locationThe location in window space of the mouse cursor.
in_buttonIf the action is a button event, this is the button.
HPS.MouseEvent.MouseEvent ( HPS.MouseEvent.Action  in_action,
HPS.WindowPoint  in_location 
)

This constructor creates a MouseEvent object for a given action.

Parameters
in_actionAction of this <ref refid="class_h_p_s_1_1_mouse_event" kindref="compound">MouseEvent</ref>.
in_locationThe location in window space of the mouse cursor.
HPS.MouseEvent.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.

Parameters
in_actionAction of the mouse for this <ref refid="class_h_p_s_1_1_mouse_event" kindref="compound">MouseEvent</ref>.
in_locationThe location in window space of the mouse cursor.
in_modifierThe modifier keys for this <ref refid="class_h_p_s_1_1_mouse_event" kindref="compound">MouseEvent</ref>.
in_click_countThe number of clicks received.
HPS.MouseEvent.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.

Parameters
in_actionAction of the mouse for this <ref refid="class_h_p_s_1_1_mouse_event" kindref="compound">MouseEvent</ref>.
in_locationThe location in window space of the mouse cursor.
in_modifierThe modifier keys for this <ref refid="class_h_p_s_1_1_mouse_event" kindref="compound">MouseEvent</ref>.
HPS.MouseEvent.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.

Parameters
in_actionAction of the mouse for this <ref refid="class_h_p_s_1_1_mouse_event" kindref="compound">MouseEvent</ref>.
in_locationThe location in window space of the mouse cursor.
HPS.MouseEvent.MouseEvent ( HPS.MouseEvent.Action  in_action,
float  in_wheel_delta 
)

This constructor creates a MouseEvent object, most useful for a wheel action.

Parameters
in_actionAction of the mouse for this <ref refid="class_h_p_s_1_1_mouse_event" kindref="compound">MouseEvent</ref>.
HPS.MouseEvent.MouseEvent ( HPS.Event  in_event)

This constructor converts an EventObject to a MouseEvent object.

Parameters
in_eventThe <ref refid="class_h_p_s_1_1_event" kindref="compound">Event</ref><ref refid="class_h_p_s_1_1_object" kindref="compound">Object</ref> to be converted.

Member Function Documentation

override HPS.Event HPS.MouseEvent.Clone ( )
virtual

Allocates and returns a copy of this MouseEvent.

Returns
A copy of this MouseEvent.

Reimplemented from HPS.InputEvent.

override bool HPS.MouseEvent.Drop ( HPS.Event  in_that_event)
virtual

Determines if this MouseEvent can be dropped in favor of the following mouse event.

Parameters
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>.
Returns
true is this event can be dropped.

Reimplemented from HPS.Event.

virtual bool HPS.MouseEvent.Equals ( HPS.MouseEvent  in_that)
virtual

Check if the source object is equivalent to this object.

Returns
true if the objects are equivalent, false otherwise.
override IntPtr HPS.MouseEvent.Freshen ( )
virtual

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.


The documentation for this class was generated from the following file: