EventHandler

class HPS.EventHandler : public HPS.Object

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

Public Types

enum HandleResult

Enumeration of the values the EventHandler uses to indicate if it handled an event.

Values:

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.

Public Functions

override void Dispose ()

delegate void DtorDelegate (IntPtr cPtr)

EventHandler ()

The default constructor creates an EventHandler object not subscribed to any event.

EventHandler (HPS.EventHandler in_that)

The copy constructor creates a new EventHandler object that points to the same underlying impl as the source EventHandler.

Param in_that

The source EventHandler to point to.

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.

Param in_event

Event which was triggered.

Return

Handled if the event was handled, NotHandled otherwise.

override HPS.Type ObjectType ()

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).

Return

The declared type of the object in question, which may differ from the true, underlying type.

override void Reset ()

Resets this object to its initial, uninitialized state.

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.

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.

Param in_dispatcher

Dispatcher from which to receive events of the given type.

Param in_type

Type of event to receive from the dispatcher.

Return

true if the subscription was successful, false otherwise.

bool UnSubscribe (HPS.EventDispatcher in_dispatcher)

Remove this EventHandler object from the list of subscribers for all events on the specified EventDispatcher.

Param in_dispatcher

Dispatcher from which to no longer receive events.

Return

true if the unsubscription was successful, false otherwise.

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.

Param in_dispatcher

Dispatcher from which to no longer receive events of the given type.

Param in_type

Type of event to no longer receive from the dispatcher.

Return

true if the unsubscription was successful, false otherwise.

void UnSubscribeEverything ()

Remove this EventHandler object from all events on all EventDispatchers.