ZFFramework
Loading...
Searching...
No Matches
ZFArgs Class Reference

listener data used by ZFListener More...

#include <ZFArgs.h>

Public Member Functions

zfany const & sender (void) const
 owner object or event sender, may be null
ZFArgssender (zfany const &v)
 see sender
zfautoresult (void) const
 the result
ZFArgs const & result (zfauto const &v) const
 see result
ZFArgsresult (zfauto const &v)
 see result
zfautoparam0 (void) const
 params, may be null
ZFArgs const & param0 (zfauto const &v) const
 see param0
ZFArgsparam0 (zfauto const &v)
 see param0
zfautoparam1 (void) const
 see param0
ZFArgs const & param1 (zfauto const &v) const
 see param0
ZFArgsparam1 (zfauto const &v)
 see param0
zfautoparam2 (void) const
 see param0
ZFArgs const & param2 (zfauto const &v) const
 see param0
ZFArgsparam2 (zfauto const &v)
 see param0
zfautoparam3 (void) const
 see param0
ZFArgs const & param3 (zfauto const &v) const
 see param0
ZFArgsparam3 (zfauto const &v)
 see param0
zfautoparam4 (void) const
 see param0
ZFArgs const & param4 (zfauto const &v) const
 see param0
ZFArgsparam4 (zfauto const &v)
 see param0
zfautoparam5 (void) const
 see param0
ZFArgs const & param5 (zfauto const &v) const
 see param0
ZFArgsparam5 (zfauto const &v)
 see param0
zfautoparam6 (void) const
 see param0
ZFArgs const & param6 (zfauto const &v) const
 see param0
ZFArgsparam6 (zfauto const &v)
 see param0
zfautoparam7 (void) const
 see param0
ZFArgs const & param7 (zfauto const &v) const
 see param0
ZFArgsparam7 (zfauto const &v)
 see param0
zfbool success (void) const
 whether invoke success
ZFArgs const & success (zfbool v) const
 see success
ZFArgssuccess (zfbool v)
 see success
zfstring const & errorHint (void) const
 error hint
ZFArgs const & errorHint (zfstring const &v) const
 see errorHint
ZFArgserrorHint (zfstring const &v)
 see errorHint
zfbool ignoreError (void) const
 a hint flag that tell impl to ignore error, no errorHint would be stored for performance
ZFArgsignoreError (zfbool v)
 see ignoreError
zfbool ignoreErrorEvent (void) const
 a hint flag that tell impl do not fire error event, while errorHint would still be stored
ZFArgsignoreErrorEvent (zfbool v)
 see ignoreErrorEvent
const ZFMethodownerMethod (void) const
 owner method
ZFArgsownerMethod (const ZFMethod *v)
 see ownerMethod
const ZFPropertyownerProperty (void) const
 owner property
ZFArgsownerProperty (const ZFProperty *v)
 see ownerProperty
zfidentity const & eventId (void) const
 event id, may be zfidentityInvalid
ZFArgseventId (zfidentity const &v)
 see eventId
zfbool eventFiltered (void) const
 used to achieve event filter logic
ZFArgs const & eventFiltered (zfbool v) const
 see eventFiltered
ZFArgseventFiltered (zfbool v)
 see eventFiltered
zfauto callSuper (void) const
 util method for dynamic registered method to call parent's method
void callOrigMethod (void) const
 util to call original method from ZFMethodImplReplace
ZFArgsparamInit (void)
 util for impl to init all params with ZFMP_DEF
ZFArgsparamInit (ZFObject *param0, ZFObject *param1, ZFObject *param2, ZFObject *param3, ZFObject *param4, ZFObject *param5, ZFObject *param6, ZFObject *param7)
 util for impl to init all params
ZFArgsparamInit (const ZFCoreArray< zfauto > &params)
 util for impl to init all params
zfautoparamAt (zfindex index) const
 get param at index
ZFArgs const & param (zfindex index, zfauto const &v) const
 set param at index
ZFArgsparam (zfindex index, zfauto const &v)
 set param at index
zfautopropValue (void) const
 get property value
ZFArgs const & propValue (zfauto const &v) const
 set property value
ZFArgspropValue (zfauto const &v)
 set property value
zfautopropValueOld (void) const
 get old property value
ZFArgspropValueOld (zfauto const &v)
 set old property value
zfany const & o (void) const
 short form to access sender
zfauto p (const zfstring &paramName) const
 short form to access param by name
 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

Member Function Documentation

◆ sender()

zfany const & ZFArgs::sender ( void ) const

owner object or event sender, may be null

Note
the sender won't be retained

◆ result()

zfauto & ZFArgs::result ( void ) const

the result

Note
the result would be retained

◆ param0()

zfauto & ZFArgs::param0 ( void ) const

params, may be null

Note
the param would be retained
params would be init as null for performance, but since null is also a valid param value, when used in ZFMethodGenericInvoker or ZFDI_invoke, generally you should set param as ZFMP_DEF to make param count detect logic work, use paramInit for short

◆ eventFiltered()

zfbool ZFArgs::eventFiltered ( void ) const

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 documentation for this class was generated from the following file: