callback.h File Reference

Include dependency graph for callback.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	CallBack
	CallBacks object-oriented (object + method). More...
class	CallBackSet
	TypeSet of CallBacks with a few extras. More...
class	CallBacker
	Inherit from this class to be able to send and/or receive CallBacks. More...
class	CBCapsule< PLT >
	Capsule class to wrap any class into a CallBacker. More...

Macros
#define	mCBFn(fn)   (static_cast<CallBackFunction>(&fn))
#define	mCB(obj, clss, fn)   CallBack( static_cast<clss*>(obj), mCBFn(clss::fn))
	To make your CallBack. Used in many places, especially the UI. More...
#define	mSCB(fn)   CallBack( (static_cast<StaticCallBackFunction>(&fn)) )
#define	mMainThreadCall(func)   CallBack::callInMainThread( CallBack( this, mCBFn(func) ), 0)
#define	mEnsureExecutedInMainThread(func)
#define	mEnsureExecutedInMainThreadWithCapsule(func, caps)
#define	mCBCapsuleGet(PayLoadType, var, cb)   CBCapsule<PayLoadType>* var = dynamic_cast< CBCapsule<PayLoadType>* >( cb );
#define	mCBCapsuleUnpack(PayLoadType, var, cb)
#define	mCBCapsuleUnpackWithCaller(PayLoadType, var, cber, cb)

Typedefs
typedef void(CallBacker::*	CallBackFunction) (CallBacker *)
typedef void(*	StaticCallBackFunction) (CallBacker *)

Macro Definition Documentation

#define mCB	(		obj,
			clss,
			fn
	)		CallBack( static_cast<clss*>(obj), mCBFn(clss::fn))

To make your CallBack. Used in many places, especially the UI.

#define mCBCapsuleUnpack	(		PayLoadType,
			var,
			cb
	)

Value:

mCBCapsuleGet(PayLoadType,cb##caps,cb) \
PayLoadType var = cb##caps->data

#define mCBCapsuleUnpackWithCaller	(		PayLoadType,
			var,
			cber,
			cb
	)

Value:

mCBCapsuleGet(PayLoadType,cb##caps,cb) \
PayLoadType var = cb##caps->data; \
CallBacker* cber = cb##caps->caller

#define mCBFn

(

fn

)

(static_cast<CallBackFunction>(&fn))

#define mEnsureExecutedInMainThread

(

func

)

Value:

if ( CallBack::queueIfNotInMainThread( \
        CallBack( this, mCBFn(func) ), 0 ) )  \
        return

#define mEnsureExecutedInMainThreadWithCapsule	(		func,
			caps
	)

Value:

CallBack cb( this, mCBFn(func) ); \
    if ( CallBack::queueIfNotInMainThread(cb,caps->clone()) ) \
        return;

#define mMainThreadCall

(

func

)

CallBack::callInMainThread( CallBack( this, mCBFn(func) ), 0)

#define mSCB

(

fn

)

CallBack( (static_cast<StaticCallBackFunction>(&fn)) )

Typedef Documentation

typedef void(CallBacker::* CallBackFunction) (CallBacker *)

typedef void(* StaticCallBackFunction) (CallBacker *)