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

Public Types | |
enum | Action : uint { None = 0x00000000, Highlight = 0x00000001, Unhighlight = 0x00000002 } |
![]() | |
enum | Status : uint { Status.InProgress = 0x00000000, Status.Completed = 0x00000001, Status.Failed = 0x00000002 } |
Public Member Functions | |
override HPS.Event | Clone () |
override void | Dispose () |
HighlightEvent () | |
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) | |
HighlightEvent (HPS.HighlightEvent in_that) | |
![]() | |
virtual bool | Drop (HPS.Event in_that_event) |
delegate void | DtorDelegate (IntPtr cPtr) |
Event (IntPtr in_channel) | |
Event () | |
Event (HPS.Event in_that) | |
virtual IntPtr | Freshen () |
IntPtr | GetChannel () |
IntPtr | GetClassID () |
double | GetTimeStamp () |
bool | IsConsumable () |
Properties | |
HPS.HighlightEvent.Action | action [get, set] |
HPS.HighlightOptionsKit | options [get, set] |
HPS.SelectionResults | results [get, set] |
Additional Inherited Members | |
![]() | |
static void | DtorCallback (IntPtr p) |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
![]() | |
static Dictionary< IntPtr, Event > | cachedObjects = new Dictionary<IntPtr, Event>() |
static ReaderWriterLockSlim | mapLock = new ReaderWriterLockSlim(LockRecursionPolicy.SupportsRecursion) |
Detailed Description
The HighlightEvent class is the event that will be triggered for each highlight or unhighlight call.
Constructor & Destructor Documentation
◆ HighlightEvent() [1/2]
|
inline |
The default constructor creates an empty HighlightEvent object.
◆ HighlightEvent() [2/2]
|
inline |
This constructor converts an EventObject to a HighlightEvent object.
- Parameters
-
in_event The EventObject to be converted.
Member Function Documentation
◆ 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:
- internals/hps_core/source/cs/HPS.HighlightEvent.cs