|
override void | deleteCptr () |
|
virtual bool | DerivedClassHasMethod (string methodName, System.Type[] methodTypes) |
|
override IntPtr | GetNonDirectorClassID () |
|
virtual bool | IsUserDerived () |
|
|
static Dictionary< IntPtr, Dictionary< IntPtr, HashSet< EventHandler > > > | cachedObjects = new Dictionary<IntPtr, Dictionary<IntPtr, HashSet<EventHandler>>>() |
|
static ReaderWriterLockSlim | mapLock = new ReaderWriterLockSlim(LockRecursionPolicy.SupportsRecursion) |
|
|
static IntPtr | ClassID< T > () |
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The EventHandler class is the base class for any event handler that can be created. All custom event handlers should inherit from this.
◆ HandleResult
Enumeration of the values the EventHandler uses to indicate if it handled an event.
Enumerator |
---|
Handled | The event was handled by this EventHandler. Consume the event if possible.
|
NotHandled | The event was not handled by this EventHandler. Pass to the next handler if any or if possible.
|
◆ EventHandler() [1/2]
HPS.EventHandler.EventHandler |
( |
| ) |
|
|
inline |
The default constructor creates an EventHandler object not subscribed to any event.
◆ EventHandler() [2/2]
The copy constructor creates a new EventHandler object that points to the same underlying impl as the source EventHandler.
- Parameters
-
◆ Handle()
Function that gets triggered if this EventHandler receives an event it is subscribed to. This should be overridden by subclasses of EventHandler to perform any custom behavior.
- Parameters
-
in_event | Event which was triggered. |
- Returns
- Handled if the event was handled, NotHandled otherwise.
◆ ObjectType()
override HPS.Type HPS.EventHandler.ObjectType |
( |
| ) |
|
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Object.
◆ Reset()
override void HPS.EventHandler.Reset |
( |
| ) |
|
|
inlinevirtual |
Resets this object to its initial, uninitialized state.
Reimplemented from HPS.Object.
◆ Shutdown()
void HPS.EventHandler.Shutdown |
( |
| ) |
|
|
inline |
Notifies the EventDispatcher that this handler is being invalidated and no further events should be dispatched to it. This method must be called in any derived class destructors.
◆ Subscribe()
Add this EventHandler object to the list of subscribers for events of the specified type on the specified EventDispatcher.
- Parameters
-
in_dispatcher | Dispatcher from which to receive events of the given type. |
in_type | Type of event to receive from the dispatcher. |
- Returns
- true if the subscription was successful, false otherwise.
◆ UnSubscribe() [1/2]
Remove this EventHandler object from the list of subscribers for events of the specified type on the specified EventDispatcher.
- Parameters
-
in_dispatcher | Dispatcher from which to no longer receive events of the given type. |
in_type | Type of event to no longer receive from the dispatcher. |
- Returns
- true if the unsubscription was successful, false otherwise.
◆ UnSubscribe() [2/2]
Remove this EventHandler object from the list of subscribers for all events on the specified EventDispatcher.
- Parameters
-
in_dispatcher | Dispatcher from which to no longer receive events. |
- Returns
- true if the unsubscription was successful, false otherwise.
◆ UnSubscribeEverything()
void HPS.EventHandler.UnSubscribeEverything |
( |
| ) |
|
|
inline |
Remove this EventHandler object from all events on all EventDispatchers.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.EventHandler.cs