GblIEventReceiverClass Struct Reference

#include <gimbal_ievent_receiver.h>

Inheritance diagram for GblIEventReceiverClass:

Collaboration diagram for GblIEventReceiverClass:

Data Fields
GblInterface	base
GBL_RESULT(*	pFnReceiveEvent )(GblIEventReceiver *pSelf, GblIEventReceiver *pDest, GblEvent *pEvent)
Data Fields inherited from GblInterface
GblClass	base
size_t	outerClassOffset_
Data Fields inherited from GblClass
struct {
uintptr_t   metaClassInfo
}	private_

Additional Inherited Members
Related Symbols inherited from GblInterface
#define	GBL_INTERFACE(klass)
#define	GBL_INTERFACE_TRY(klass)
#define	GBL_INTERFACE_OUTER_CLASS(iface)
#define	GBL_INTERFACE_OUTER_MOST_CLASS(iface)
	GblInterface_outerClass (GblInterface *pSelf)
GblClass *	GblInterface_outerMostClass (GblInterface *pSelf)
Related Symbols inherited from GblClass
	GBL_CLASS_SUPER (klass)
	GBL_CLASS_DEFAULT (klass)
	GBL_CLASS_PRIVATE (klass, type)
	GBL_CLASS_PUBLIC (klassPrivate, type)
	GBL_CLASS_TYPECHECK (klass, toType)
	GBL_CLASS_TYPECHECK_PREFIX (klass, typePrefix)
	GBL_CLASS_CAST (klass, toType, cType)
	GBL_CLASS_CAST_PREFIX (klass, typePrefix)
	GBL_CLASS_TRY (klass, toType, cType)
	GBL_CLASS_TRY_PREFIX (klass, typePrefix)
GblClass *	GblClass_refDefault (GblType type)
GblRefCount	GblClass_unrefDefault (GblClass *pSelf)
GblClass *	GblClass_weakRefDefault (GblType type)
GblClass *	GblClass_createFloating (GblType type)
GBL_RESULT	GblClass_destroyFloating (GblClass *pSelf)
GBL_RESULT	GblClass_constructFloating (GblClass *pSelf, GblType type)
GBL_RESULT	GblClass_destructFloating (GblClass *pSelf)
#define	GBL_CLASS(klass)
#define	GBL_CLASS_TYPEOF(klass)
#define	GBL_CLASS_PRIVATE(cType, klass)
#define	GBL_CLASS_PUBLIC(cType, priv)
#define	GBL_CLASS_TYPECHECK(cType, klass)
#define	GBL_CLASS_CAST(cType, klass)
#define	GBL_CLASS_AS(cType, klass)
GblBool	GblClass_check (const GblClass *pSelf, GblType toType)
GblClass *	GblClass_cast (GblClass *pSelf, GblType toType)
GblClass *	GblClass_as (GblClass *pSelf, GblType toType)
void *	GblClass_private (const GblClass *pSelf, GblType base)
GblClass *	GblClass_public (const void *pPrivate, GblType base)
GblType	GblClass_typeOf (const GblClass *pSelf)
size_t	GblClass_size (const GblClass *pSelf)
size_t	GblClass_privateSize (const GblClass *pSelf)
size_t	GblClass_totalSize (const GblClass *pSelf)
GblBool	GblClass_isDefault (const GblClass *pSelf)
GblBool	GblClass_isOverridden (const GblClass *pSelf)
GblBool	GblClass_isInterface (const GblClass *pSelf)
GblBool	GblClass_isInterfaceImpl (const GblClass *pSelf)
GblBool	GblClass_isFloating (const GblClass *pSelf)
GblBool	GblClass_isOwned (const GblClass *pSelf)
GblBool	GblClass_isInPlace (const GblClass *pSelf)
GblClass *	GblClass_super (const GblClass *pSelf)
GblClass *	GblClass_default (const GblClass *pSelf)

Detailed Description

GblClass structure for GblIEventReceiver.

A GblIEventReceiver is a type implementing the basic interface required for event processing. There are typically two different types of receivers:

• Handlers: intended recipients of a GblEvent
• Filters: observers which can intercept events not directly sent to them.

The same interface can be used to implement both types of receivers, depending on whether the self parameter is the same instance which is the destination receiver of GblIEventReceiverClass::pFnReceiveEvent().

Once received, a GblEvent may either be ignored, allowing to potentially propagate onward through other chained receivers, or it may be "accepted," which terminates its propagation and marks it as handled.

See also

GblEvent, GblObject

Definition at line 52 of file gimbal_ievent_receiver.h.

Field Documentation

base

GblInterface GblIEventReceiverClass::base

Inherited base class GblIEventReceiver.

Definition at line 52 of file gimbal_ievent_receiver.h.

pFnReceiveEvent

GBL_RESULT(* GblIEventReceiverClass::pFnReceiveEvent) (GblIEventReceiver *pSelf, GblIEventReceiver *pDest, GblEvent *pEvent)

Invoked any time an event is received or intercepted by the given instance.

Definition at line 54 of file gimbal_ievent_receiver.h.

---

The documentation for this struct was generated from the following file:

• gimbal_ievent_receiver.h