ZFObjectObserver.h File Reference

observer types for ZFObject More...

#include "ZFCallback.h"
#include "ZFIdMap.h"
#include "ZFArgs.h"
#include "ZFListenerDeclare.h"

Go to the source code of this file.

Classes
class	ZFListener
	listener as ZFCallback, mostly used by ZFObject::observerNotify More...
class	ZFObserver
	holder object for observer logic, see ZFObject::observerNotify More...

Macros
#define	ZFEVENT(YourEvent)
	see ZFObject::observerNotify
#define	ZFEVENT_INLINE(YourEvent)
	see ZFEVENT
#define	ZFEVENT_REGISTER(YourClass, YourEvent)
	see ZFEVENT
#define	ZFEVENT_GLOBAL(YourEvent)
	declare a observer event in global scope, see ZFEVENT
#define	ZFEVENT_GLOBAL_REGISTER(YourEvent)
	see ZFEVENT

Functions
ZFObserver &	ZFGlobalObserver (void)
	all event notified by ZFObject::observerNotify would also be notified to the observers added by this method, see ZFObject::observerNotify
const zfchar *	ZFEventNameForId (zfidentity idValue)
	get id name from id value, or null if no such id, see ZFEventIdForName
zfidentity	ZFEventIdForName (const zfchar *idName)
	get id value from id name, or zfidentityInvalid if no such id name
zfidentity	ZFEventDynamicRegister (const zfchar *idName)
	dynamically register your own id
void	ZFEventDynamicUnregister (zfidentity idValue)
	unregister id that was registered by ZFEventDynamicRegister

Detailed Description

observer types for ZFObject

Macro Definition Documentation

ZFEVENT

#define ZFEVENT

(

YourEvent

)

see ZFObject::observerNotify

usage:

zfclass YourClass ... {
    ZFEVENT(YourEvent)
};
 
ZFEVENT_REGISTER(YourClass, YourEvent)

declare a event for ZFObject's observer logic, declared event name can be accessed by:

zfidentity eventId = YourClass::EventYourEvent();
const zfchar *eventName = ZFEventNameForId(eventId);

note that subclass may declare a event same as parent, while the final event name is different:
ParentClass::EventYourEvent() => "ParentClass.EventYourEvent"
ChildClass::EventYourEvent() => "ChildClass.EventYourEvent"

Note

we declare the event id as int types for performance, it's ensured each event has different event id, but it's only ensured while app is running, after relaunching the app, the event id is not ensured the same, you should use the name of the event to store or pass between apps, and you can use ZFEventIdForName or ZFEventNameForId to convert them easily

ZFEVENT_GLOBAL

#define ZFEVENT_GLOBAL

(

YourEvent

)

declare a observer event in global scope, see ZFEVENT

usage:

// in header files
ZF_NAMESPACE_BEGIN(YourNamespace)
/ ** @brief you can add doxygen docs here * /
ZFEVENT_GLOBAL(YourEvent)
ZF_NAMESPACE_END(YourNamespace)
 
ZFEVENT_GLOBAL_REGISTER(YourNamespace, YourEvent)
 
// use the event
zfidentity eventId = YourNamespace::EventYourEvent();

unlike ZFEVENT, this macro would declare event outside of class scope, typically you should use ZFEVENT_GLOBAL which have "ZFGlobalEvent" as namespace

Function Documentation

ZFGlobalObserver()

ZFObserver & ZFGlobalObserver ( void )

extern

all event notified by ZFObject::observerNotify would also be notified to the observers added by this method, see ZFObject::observerNotify

use only if necessary, which may cause performance issue

ZFEventIdForName()

zfidentity ZFEventIdForName ( const zfchar * idName )

inline

get id value from id name, or zfidentityInvalid if no such id name

the id name should looks like YourClass.EventYourIdName or YourNamespace.EventYourIdName

note: can be found only if:

• declared with ZFEVENT_INLINE
• registered by ZFEVENT_REGISTER series
• ever accessed

ZFEventDynamicRegister()

zfidentity ZFEventDynamicRegister ( const zfchar * idName )

inline

dynamically register your own id

assert fail if already registered

ZFEventDynamicUnregister()

void ZFEventDynamicUnregister ( zfidentity idValue )

inline

unregister id that was registered by ZFEventDynamicRegister

do nothing if no such id, assert fail if the id is not dynamically registered