ZFFramework
Loading...
Searching...
No Matches
Public Member Functions | List of all members
ZFArgs Class Reference

listener data used by ZFListener More...

#include <ZFArgs.h>

Public Member Functions

ZFArgseventId (zfidentity const &v)
 event id, may be zfidentityInvalid
 
zfidentity const & eventId (void) const
 see eventId
 
ZFArgssender (zfany const &v)
 who notified the listener event, may be null
 
zfany const & sender (void) const
 see sender
 
ZFArgsparam0 (zfany const &v)
 params, may be null
 
zfany const & param0 (void) const
 see param0
 
ZFArgsparam1 (zfany const &v)
 params, may be null
 
zfany const & param1 (void) const
 see param1
 
zfany const & result (void) const
 result, must first enabled by resultEnable
 
ZFArgs const & result (zfany const &result) const
 see result
 
ZFArgsresult (zfany const &result)
 see result
 
ZFArgsresultEnable (zfbool enable)
 see result
 
zfbool resultEnabled (void) const
 see result
 
ZFArgs const & eventFiltered (zfbool eventFiltered) const
 used to achieve event filter logic
 
ZFArgseventFiltered (zfbool eventFiltered)
 see eventFiltered
 
zfbool eventFiltered (void) const
 see eventFiltered
 
ZFArgseventFilterEnable (zfbool enable)
 see eventFiltered
 
zfbool eventFilterEnabled (void) const
 see eventFiltered
 
 ZFArgs (void)
 main constructor
 
 ZFArgs (const ZFArgs &ref)
 construct with another data
 
void objectInfoT (zfstring &ret) const
 see objectInfo
 
zfstring objectInfo (void) const
 get a short info of this object
 

Detailed Description

listener data used by ZFListener

Note
this object only hold the necessary datas as pointer, without auto retain or release logic

Member Function Documentation

◆ sender()

ZFArgs & ZFArgs::sender ( zfany const & v)
inline

who notified the listener event, may be null

Note
the sneder has no auto retain

◆ param0()

ZFArgs & ZFArgs::param0 ( zfany const & v)
inline

params, may be null

Note
the param has no auto retain

◆ param1()

ZFArgs & ZFArgs::param1 ( zfany const & v)
inline

params, may be null

Note
the param has no auto retain

◆ result()

zfany const & ZFArgs::result ( void ) const

result, must first enabled by resultEnable

Note
the result would be retained

◆ eventFiltered()

ZFArgs const & ZFArgs::eventFiltered ( zfbool eventFiltered) const
inline

used to achieve event filter logic

to achieve event filter, you may attach an ZFObserver::observerAdd with higher ZFLevel, and set eventFiltered to true, then the event would not be further dispatched
the eventFilterEnable must be called to enable filter logic


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