Public Types | Public Member Functions | Protected Member Functions | Properties | List of all members
HPS.HighlightEvent Class Reference

The HighlightEvent class is the event that will be triggered for each highlight or unhighlight call. More...

Inheritance diagram for HPS.HighlightEvent:
HPS.Event

Public Types

enum  Action { None = 0, Highlight = 1, Unhighlight = 2 }
 
- 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 void Dispose ()
 
 HighlightEvent ()
 The default constructor creates an empty HighlightEvent object. More...
 
 HighlightEvent (HPS.HighlightEvent.Action in_action, HPS.SelectionResults in_results, HPS.HighlightOptionsKit in_options)
 
 HighlightEvent (HPS.HighlightEvent.Action in_action, HPS.SelectionResults in_results)
 
 HighlightEvent (HPS.HighlightEvent.Action in_action)
 
 HighlightEvent (HPS.Event in_event)
 This constructor converts an EventObject to a HighlightEvent object. More...
 
 HighlightEvent (HPS.HighlightEvent in_that)
 
override HPS.Event Clone ()
 Allocates and returns a copy of this HighlightEvent. More...
 
- Public Member Functions inherited from HPS.Event
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)
 
virtual bool Drop (HPS.Event in_that_event)
 This optional function is used to determine if the current event can be dropped based on the following event in the queue. More...
 
virtual 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...
 
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)
 

Protected Member Functions

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

Properties

HPS.HighlightEvent.Action action [get, set]
 
HPS.SelectionResults results [get, set]
 
HPS.HighlightOptionsKit options [get, set]
 

Additional Inherited Members

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

Detailed Description

The HighlightEvent class is the event that will be triggered for each highlight or unhighlight call.

Constructor & Destructor Documentation

HPS.HighlightEvent.HighlightEvent ( )
inline

The default constructor creates an empty HighlightEvent object.

HPS.HighlightEvent.HighlightEvent ( HPS.Event  in_event)
inline

This constructor converts an EventObject to a HighlightEvent object.

Parameters
in_eventThe EventObject to be converted.

Member Function Documentation

override HPS.Event HPS.HighlightEvent.Clone ( )
inlinevirtual

Allocates and returns a copy of this HighlightEvent.

Returns
A copy of this HighlightEvent.

Implements HPS.Event.


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