HPS.ComponentHiddenEvent Class Reference

More...

Inheritance diagram for HPS.ComponentHiddenEvent:
HPS.Event

Public Member Functions

override HPS.Event Clone ()
 This function is used to copy custom events classes. Users that create custom event classes must override this function to provide the proper copying behavior. More...
 
 ComponentHiddenEvent (HPS.ComponentPath in_path, HPS.Canvas in_canvas, ulong in_layer)
 
 ComponentHiddenEvent (HPS.ComponentPath in_path, HPS.Canvas in_canvas)
 
 ComponentHiddenEvent (HPS.Event in_event)
 
 ComponentHiddenEvent (HPS.ComponentHiddenEvent in_that)
 
delegate IntPtr ComponentHiddenEventDelegate_0 (IntPtr cPtr)
 
delegate bool ComponentHiddenEventDelegate_1 (IntPtr cPtr, IntPtr in_that_event)
 
delegate IntPtr ComponentHiddenEventDelegate_2 (IntPtr cPtr)
 
override void Dispose ()
 
- Public Member Functions inherited from HPS.Event
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 (IntPtr cPtr)
 
delegate bool EventDelegate_1 (IntPtr cPtr, IntPtr in_that_event)
 
delegate IntPtr EventDelegate_2 (IntPtr cPtr)
 
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 ()
 
override bool DerivedClassHasMethod (string methodName, System.Type[] methodTypes)
 
override IntPtr GetNonDirectorClassID ()
 
override bool IsUserDerived ()
 

Properties

HPS.Canvas canvas [get, set]
 
ulong layer [get, set]
 
HPS.ComponentPath path [get, set]
 

Additional Inherited Members

- Public Types inherited from HPS.Event
enum  Status : uint { Status.InProgress = 0x00000000, Status.Completed = 0x00000001, Status.Failed = 0x00000002 }
 Event Status - returned from a notifier to give the status of the event. More...
 
- Static Protected Member Functions inherited from HPS.Event
static void DtorCallback (IntPtr p)
 
- Protected Attributes inherited from HPS.Event
bool cMemOwn
 
HandleRef cptr
 
- Static Protected Attributes inherited from HPS.Event
static Dictionary< IntPtr, EventcachedObjects = new Dictionary<IntPtr, Event>()
 
static ReaderWriterLockSlim mapLock = new ReaderWriterLockSlim(LockRecursionPolicy.SupportsRecursion)
 

Detailed Description

The ComponentHiddenEvent class is the event that will be triggered for each Hide call.

Member Function Documentation

◆ Clone()

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

This function is used to copy custom events classes. Users that create custom event classes must override this function to provide the proper copying behavior.

Implements HPS.Event.


The documentation for this class was generated from the following file:
  • internals/hps_sprk/source/cs/HPS.ComponentHiddenEvent.cs