Public Types |
Public Member Functions |
Protected Member Functions |
Properties |
List of all members
HPS.ComponentHighlightEvent Class Reference
The ComponentHighlightEvent class is the event that will be triggered for each highlight or unhighlight call. More...
Inheritance diagram for HPS.ComponentHighlightEvent:

Public Types | |
enum | Action { None = 0, Highlight = 1, Unhighlight = 2 } |
![]() | |
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 ComponentHighlightEvent. More... | |
ComponentHighlightEvent () | |
The default constructor creates an empty ComponentHighlightEvent object. More... | |
ComponentHighlightEvent (HPS.ComponentHighlightEvent.Action in_action, HPS.ComponentPath in_path, HPS.HighlightOptionsKit in_options) | |
ComponentHighlightEvent (HPS.ComponentHighlightEvent.Action in_action, HPS.ComponentPath in_path) | |
ComponentHighlightEvent (HPS.ComponentHighlightEvent.Action in_action) | |
ComponentHighlightEvent (HPS.Event in_event) | |
This constructor converts an Event Object to a ComponentHighlightEvent object. More... | |
ComponentHighlightEvent (HPS.ComponentHighlightEvent in_that) | |
override void | Dispose () |
![]() | |
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... | |
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 () |
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... | |
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... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
void | DtorCallback (IntPtr p) |
virtual IntPtr | GetNonDirectorClassID () |
Properties | |
HPS.ComponentHighlightEvent.Action | action [get, set] |
HPS.HighlightOptionsKit | options [get, set] |
HPS.ComponentPath | path [get, set] |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The ComponentHighlightEvent class is the event that will be triggered for each highlight or unhighlight call.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty ComponentHighlightEvent object.
|
inline |
This constructor converts an Event Object to a ComponentHighlightEvent object.
Member Function Documentation
|
inlinevirtual |
Allocates and returns a copy of this ComponentHighlightEvent.
- Returns
- A copy of this ComponentHighlightEvent.
Implements HPS.Event.
The documentation for this class was generated from the following file:
- internals/hps_sprk/source/cs/HPS.ComponentHighlightEvent.cs