The EventHandler class is the base class for any event handler that can be created. All custom event handlers should inherit from this. More...

Public Types | |
enum | HandleResult : uint { HandleResult.Handled = 0x00000000, HandleResult.NotHandled = 0x00000001 } |
Enumeration of the values the EventHandler uses to indicate if it handled an event. More... | |
Public Member Functions | |
override void | Dispose () |
delegate void | DtorDelegate (IntPtr cPtr) |
EventHandler () | |
The default constructor creates an EventHandler object not subscribed to any event. More... | |
EventHandler (HPS.EventHandler in_that) | |
The copy constructor creates a new EventHandler object that points to the same underlying impl as the source EventHandler. More... | |
delegate HPS.Type | EventHandlerDelegate_0 (IntPtr cPtr) |
delegate void | EventHandlerDelegate_1 (IntPtr cPtr) |
delegate HPS.EventHandler.HandleResult | EventHandlerDelegate_2 (IntPtr cPtr, IntPtr in_event) |
delegate HPS.Type | EventHandlerDelegate_3 (IntPtr cPtr) |
delegate bool | EventHandlerDelegate_4 (IntPtr cPtr) |
virtual HPS.EventHandler.HandleResult | Handle (HPS.Event in_event) |
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. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
override void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
void | Shutdown () |
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. More... | |
bool | Subscribe (HPS.EventDispatcher in_dispatcher, IntPtr in_type) |
Add this EventHandler object to the list of subscribers for events of the specified type on the specified EventDispatcher. More... | |
bool | UnSubscribe (HPS.EventDispatcher in_dispatcher, IntPtr in_type) |
Remove this EventHandler object from the list of subscribers for events of the specified type on the specified EventDispatcher. More... | |
bool | UnSubscribe (HPS.EventDispatcher in_dispatcher) |
Remove this EventHandler object from the list of subscribers for all events on the specified EventDispatcher. More... | |
void | UnSubscribeEverything () |
Remove this EventHandler object from all events on all EventDispatchers. More... | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
Static Protected Attributes | |
static Dictionary< IntPtr, Dictionary< IntPtr, HashSet < EventHandler > > > | cachedObjects = new Dictionary<IntPtr, Dictionary<IntPtr, HashSet<EventHandler>>>() |
static ReaderWriterLockSlim | mapLock = new ReaderWriterLockSlim(LockRecursionPolicy.SupportsRecursion) |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The EventHandler class is the base class for any event handler that can be created. All custom event handlers should inherit from this.
Member Enumeration Documentation
enum HPS.EventHandler.HandleResult : uint |
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. |
Constructor & Destructor Documentation
|
inline |
The default constructor creates an EventHandler object not subscribed to any event.
|
inline |
The copy constructor creates a new EventHandler object that points to the same underlying impl as the source EventHandler.
- Parameters
-
in_that The source EventHandler to point to.
Member Function Documentation
|
inlinevirtual |
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.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Object.
|
inlinevirtual |
Resets this object to its initial, uninitialized state.
Reimplemented from HPS.Object.
|
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.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
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