a quick UI hint to show short messages More...

#include <ZFUIHint.h>

Inheritance diagram for ZFUIHint:

Public Types
enum

Public Types inherited from ZFObject
enum

Public Member Functions
virtual const ZFClass *	classData (void)
	get instance's class info

virtual ZFUIWindow *	window ()
	the window to hold the content

virtual zfanyT< ZFUIView > const &	content ()
	the actual hint view

virtual void	content (zfanyT< ZFUIView > const &propertyValue)
	see content

virtual zftimet &	duration ()
	hint duration in miliseconds, 0 to use ZFUIHintDuration, 0 by default

virtual void	duration (zftimet const &propertyValue)
	see duration

virtual zftimet	durationFixed ()
	util method to duration

virtual zfanyT< ZFAnimation > const &	aniShow ()
	the animation to show the hint, null by default

virtual void	aniShow (zfanyT< ZFAnimation > const &propertyValue)
	see aniShow

virtual zfanyT< ZFAnimation > const &	aniHide ()
	the animation to hide the hint, null by default

virtual void	aniHide (zfanyT< ZFAnimation > const &propertyValue)
	see aniHide

virtual zfbool &	windowAutoResize ()
	whether automatically fix frame according to ZFUIOnScreenKeyboardAutoResizeStart, true by default

virtual void	windowAutoResize (zfbool const &propertyValue)
	see windowAutoResize

virtual void	show ()
	show the hint with animation, do nothing if showing

virtual void	hide ()
	hide the hint with animation, do nothing if not showing, cancel show task if delaying

virtual zfbool	showing ()
	whether the hint is showing or delaying, see delaying

virtual zfbool	delaying ()
	whether the hint is delaying, see showing

virtual ZFAnimation *	started ()
	return the animation if animating, or null if not

Public Member Functions inherited from ZFObject
zfindex	objectRetainCount (void)
	return the object's retain count

void	objectInfoOfInstanceT (zfstring &ret)
	see objectInfoOfInstance

zfstring	objectInfoOfInstance (void)
	return a short string describe the object instance

void	objectInfoT (zfstring &ret)
	see objectInfo

zfstring	objectInfo (void)
	return object info

zfidentity	objectHash (void)
	get hash of this object

ZFCompareResult	objectCompare (ZFObject *anotherObj)
	compare with anotherObj

ZFCompareResult	objectCompareValue (ZFObject *anotherObj)
	explicitly compare object by logical value, see objectCompare

virtual zfauto	invoke (const zfstring &methodName)
	util method to perform ZFDI_invoke, do nothing if fail

virtual zfauto	invoke (const zfstring &methodName, ZFObject param0, ZFObject param1=((ZFObject const &) _ZFP_ZFMP_DEF), ZFObject param2=((ZFObject const &) _ZFP_ZFMP_DEF), ZFObject param3=((ZFObject const &) _ZFP_ZFMP_DEF), ZFObject param4=((ZFObject const &) _ZFP_ZFMP_DEF), ZFObject param5=((ZFObject const &) _ZFP_ZFMP_DEF), ZFObject param6=((ZFObject const &) _ZFP_ZFMP_DEF), ZFObject param7=((ZFObject *const &) _ZFP_ZFMP_DEF))
	util method to perform ZFDI_invoke, do nothing if fail

virtual zfbool	invokeT (zfauto &ret, zfstring errorHint, const zfstring &methodName, ZFObject param0=((ZFObject const &) _ZFP_ZFMP_DEF), ZFObject param1=((ZFObject const &) _ZFP_ZFMP_DEF), ZFObject param2=((ZFObject const &) _ZFP_ZFMP_DEF), ZFObject param3=((ZFObject const &) _ZFP_ZFMP_DEF), ZFObject param4=((ZFObject const &) _ZFP_ZFMP_DEF), ZFObject param5=((ZFObject const &) _ZFP_ZFMP_DEF), ZFObject param6=((ZFObject const &) _ZFP_ZFMP_DEF), ZFObject param7=((ZFObject *const &) _ZFP_ZFMP_DEF))
	util method to perform ZFDI_invoke, do nothing if fail

virtual zfauto	invokeDetail (const zfstring &methodName, const ZFCoreArray< zfauto > &params, zfbool success=zft_zfnull, zfstring errorHint=zft_zfnull)
	util method to perform ZFDI_invoke, do nothing if fail

zfbool	objectTagExist (void)
	see objectTag, true if this object has tag, and tag can be checked by objectTagGetAllKeyValue

void	objectTag (const zfstring &key, ZFObject *tag)
	used to hold a object for app's use, auto retained

zfany	objectTag (const zfstring &key)
	see objectTag

void	objectTagGetAllKeyValue (ZFCoreArray< zfstring > &allKey, ZFCoreArray< zfauto > &allValue)
	get all key value

void	objectTagRemove (const zfstring &key)
	remove tag, same as set tag to null

zfauto	objectTagRemoveAndGet (const zfstring &key)
	remove tag, return removed tag or null if not exist

void	objectTagRemoveAll (void)
	remove all tag

void	observerAdd (zfidentity eventId, const ZFListener &observer, ZFLevel observerLevel=ZFLevelAppNormal)
	see observerNotify

void	observerAddForOnce (zfidentity eventId, const ZFListener &observer, ZFLevel observerLevel=ZFLevelAppNormal)
	see observerNotify

void	observerRemove (zfidentity eventId, const ZFListener &callback)
	see observerNotify

void	observerRemoveAll (zfidentity eventId)
	see observerNotify

void	observerRemoveAll (void)
	see observerNotify

zfbool	observerHasAdd (void)
	true if any observer has been added

zfbool	observerHasAdd (zfidentity eventId)
	true if any observer with eventId has been added

void	observerNotify (zfidentity eventId, ZFObject param0=zft_zfnull, ZFObject param1=zft_zfnull)
	notify the observer with eventId

void	observerNotifyWithSender (ZFObject customSender, zfidentity eventId, ZFObject param0=zft_zfnull, ZFObject *param1=zft_zfnull)
	see observerNotify

void	observerNotifyReversely (zfidentity eventId, ZFObject param0=zft_zfnull, ZFObject param1=zft_zfnull)
	see observerNotify

void	observerNotifyReverselyWithSender (ZFObject customSender, zfidentity eventId, ZFObject param0=zft_zfnull, ZFObject *param1=zft_zfnull)
	see observerNotify

ZFObserver &	observerHolder (void)
	access the internal observer holder

void	on (const zfstring &eventName, const ZFListener &observer, ZFLevel observerLevel=ZFLevelAppNormal)
	util to observerAdd

void	on (zfidentity eventId, const ZFListener &observer, ZFLevel observerLevel=ZFLevelAppNormal)
	util to observerAdd

void	onInit (const ZFListener &impl)
	util for script to achieve chained call

void	onDealloc (const ZFListener &impl)
	util for script to achieve chained call

zfbool	objectInstanceStateCheck (ZFObjectInstanceState state)
	object instance's state

zfbool	objectInitRunning (void)
	util method to check whether ZFObjectInstanceStateOnInit or ZFObjectInstanceStateOnInitFinish running

zfbool	objectDeallocRunning (void)
	util method to check whether ZFObjectInstanceStateOnDeallocPrepare or ZFObjectInstanceStateOnDealloc running

virtual zfbool	objectIsInternal (void)
	whether this object is internal object or its class is ZFClass::classIsInternal

virtual zfbool	objectIsInternalPrivate (void)
	whether this object is internal private object or its class is ZFClass::classIsInternalPrivate

Static Public Member Functions
static const ZFClass *	ClassData (void)
	get class info

static zfidentity	E_HintOnInit (void)
	see ZFObject::observerNotify

static zfidentity	E_HintOnUpdate (void)
	see ZFObject::observerNotify

static zfidentity	E_HintOnShow (void)
	see ZFObject::observerNotify

static zfidentity	E_HintOnHide (void)
	see ZFObject::observerNotify

static ZFCoreArray< zfautoT< ZFUIHint > >	hintList (ZFUISysWindow *inSysWindow=(zft_zfnull))
	get hint list in specified ZFUISysWindow

Static Public Member Functions inherited from ZFObject
static const ZFClass *	ClassData (void)
	get class info

static zfidentity	E_ObjectBeforeAlloc (void)
	see ZFObject::observerNotify

static zfidentity	E_ObjectAfterAlloc (void)
	see ZFObject::observerNotify

static zfidentity	E_ObjectBeforeDealloc (void)
	see ZFObject::observerNotify

static zfidentity	E_ObjectPropertyValueOnUpdate (void)
	see ZFObject::observerNotify

static zfidentity	E_ObjectPropertyValueOnReset (void)
	see ZFObject::observerNotify

Protected Types
typedef ZFObject	zfsuper
	class ref to super

typedef ZFUIHint	zfself
	class ref to self

Protected Types inherited from ZFObject
typedef _ZFP_Obj_Base	zfsuper
	class ref to super

typedef ZFObject	zfself
	class ref to self

Protected Member Functions
virtual void	hintOnInit (void)
	see ZFUIHint::E_HintOnInit

virtual void	hintOnUpdate (void)
	see ZFUIHint::E_HintOnUpdate

virtual void	hintOnShow (void)
	see ZFUIHint::E_HintOnShow

virtual void	hintOnHide (void)
	see ZFUIHint::E_HintOnHide

virtual void	objectInfoImplAppend (zfstring &ret)
	see objectInfo

virtual void	objectOnInit (void)
	override this to init your object

virtual void	objectOnInitFinish (void)
	called after objectOnInit, safe to call virtual functions here

virtual void	objectOnDeallocPrepare (void)
	called before objectOnDealloc, safe to call virtual functions here

virtual void	objectOnDealloc (void)
	override this to destroy your object

Protected Member Functions inherited from ZFObject
virtual void	objectInfoImpl (zfstring &ret)
	see objectInfo

virtual zfidentity	objectHashImpl (void)
	see objectHash

virtual ZFCompareResult	objectCompareImpl (ZFObject *anotherObj)
	see objectCompare

virtual ZFCompareResult	objectCompareValueImpl (ZFObject *anotherObj)
	see objectCompareValue

virtual void	observerOnAdd (zfidentity eventId)
	called when add first observer

virtual void	observerOnRemove (zfidentity eventId)
	called when remove last observer

virtual void	observerOnEvent (const ZFArgs &zfargs)
	notified when observerNotify

virtual void	objectOnRetain (void)
	called to retain object

virtual void	objectOnRelease (void)
	called to release object

virtual void	objectPropertyValueOnUpdate (const ZFProperty property, const void oldValue)
	see E_ObjectPropertyValueOnUpdate

virtual void	objectPropertyValueOnReset (const ZFProperty *property)
	see E_ObjectPropertyValueOnReset

Detailed Description

a quick UI hint to show short messages

Note: can only be created or show or hide in main thread

Member Function Documentation

◆ classData()

virtual const ZFClass * ZFUIHint::classData ( void )

inlinevirtual

get instance's class info

Reimplemented from ZFObject.

◆ E_HintOnInit()

static zfidentity ZFUIHint::E_HintOnInit ( void )

static

see ZFObject::observerNotify

called to init the hint object, typically used for one-time init for each hint object, to update app-wide default setting

◆ E_HintOnUpdate()

static zfidentity ZFUIHint::E_HintOnUpdate ( void )

static

see ZFObject::observerNotify

called to update the hint object before show (each time)

◆ E_HintOnShow()

static zfidentity ZFUIHint::E_HintOnShow ( void )

static

see ZFObject::observerNotify

called when the hint showed

◆ E_HintOnHide()

static zfidentity ZFUIHint::E_HintOnHide ( void )

static

see ZFObject::observerNotify

called when the hint hide

◆ window()

virtual ZFUIWindow * ZFUIHint::window ( )

virtual

the window to hold the content

by default, the window would:

have v_ZFUIWindowLevel::e_ZFFrameworkFgHighest as ZFUIWindow::windowLevel
have ZFUIView::viewUIEnableTree been disabled
have ZFUIGlobalStyle::itemSizeText as ZFUIView::viewSizeMin
have ZFUIWindow::windowLayoutParam as:

you should update the layout param of the hint window instead of the hint view, and the hint view would be layouted according the window's layout param

◆ duration()

virtual zftimet & ZFUIHint::duration ( )

inlinevirtual

hint duration in miliseconds, 0 to use ZFUIHintDuration, 0 by default

Note: show and hide animation won't be included in duration

◆ show()

virtual void ZFUIHint::show ( )

virtual

show the hint with animation, do nothing if showing

if there's another hint showing, this one would be wait until all previous hint hide
the hint object would be retained when show, and would be released automatically after hide

◆ objectInfoImplAppend()

virtual void ZFUIHint::objectInfoImplAppend ( zfstring & ret )

inlineprotectedvirtual

see objectInfo

Reimplemented from ZFObject.

◆ objectOnInit()

virtual void ZFUIHint::objectOnInit ( void )

protectedvirtual

override this to init your object

subclass must call superclass's objectOnInit before any other code if override
you may also declare objectOnInit with params like this:

zfclass Parent : ... {
    ...
protected:
    virtual void objectOnInit(void) {...};
};
zfclass Child : Parent {
protected:
    // override all parent's objectOnInit is also required,
    // because of function hiding of C++
    zfoverride
    virtual void objectOnInit(void) {
        zfsuper::objectOnInit();
    }
    // custom init entry
    virtual void objectOnInit(Params...) {
        // your extra init steps
        ...
    }
};

Warning: objectOnInit and objectOnDealloc is called as a virtual function, take good care of other virtual function call, use zfself::func() instead of this->func() if necessary, or use objectOnInitFinish/objectOnDeallocPrepare, or declare your own constructor with ZFOBJECT_DECLARE_WITH_CUSTOM_CTOR

Note: (ZFTAG_LIMITATION) due to limitations of C++, if your parent type declared objectOnInit with different params, and your child type want to override part of those objectOnInit, then your child type must also override all objectOnInit that parent declared, otherwise, some may be hidden; for objects that designed not to be allocated by user, you should use ZFOBJECT_PRIVATE_ALLOC, typically usage:
zfclass MyObject : zfextend ZFObject {

ZFOBJECT_DECLARE(MyObject, ZFObject)

ZFOBJECT_PRIVATE_ALLOC("should be created by MyObject::instanceForXxx only")

public:

static zfauto instanceForXxx(xxx) {

// can only be allocated by reflection

return zfself::ClassData()->newInstance();

}

};

static void func(void) {

// MyObject *obj = zfAlloc(MyObject); // would compile error

zfauto obj = MyObject::instanceForXxx(xxx); // OK

}

zfextend
#define zfextend
dummy macro shows class inherit from another
Definition ZFCoreTypeDef_ClassType.h:53

ZFOBJECT_DECLARE
#define ZFOBJECT_DECLARE(ChildClass, SuperClass,...)
necessary for every class inherit from ZFObject
Definition ZFObjectDeclare.h:126

ZFOBJECT_PRIVATE_ALLOC
#define ZFOBJECT_PRIVATE_ALLOC(...)
mark this object can not be allocated directly
Definition ZFObjectDeclare.h:245

ZFClass::newInstance
zfauto newInstance(void) const
make a new instance of ZFObject dynamically, which is described by ZFClass

ZFUIHint::ClassData
static const ZFClass * ClassData(void)
get class info
Definition ZFUIHint.h:25

zfauto
a ZFObject holder which would release content object automatically when destroyed
Definition zfautoFwd.h:34

Reimplemented from ZFObject.

◆ objectOnInitFinish()

virtual void ZFUIHint::objectOnInitFinish ( void )

protectedvirtual

called after objectOnInit, safe to call virtual functions here

usually used to initialize independent resources other than self's internal resources

Reimplemented from ZFObject.

◆ objectOnDeallocPrepare()

virtual void ZFUIHint::objectOnDeallocPrepare ( void )

protectedvirtual

called before objectOnDealloc, safe to call virtual functions here

usually used to cleanup resources attached to this object other than self's internal resources

Note: it's ensured safe to retain the object while deallocating, but it's not ensured objectOnDeallocPrepare would only called once for each instance

Reimplemented from ZFObject.

◆ objectOnDealloc()

virtual void ZFUIHint::objectOnDealloc ( void )

protectedvirtual

override this to destroy your object

subclass must call superclass's objectOnDealloc after any other code if override
see objectOnInit for more info

Reimplemented from ZFObject.

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

ZFUIHint.h

ZFFramework

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Detailed Description

Member Function Documentation

◆ classData()

◆ E_HintOnInit()

◆ E_HintOnUpdate()

◆ E_HintOnShow()

◆ E_HintOnHide()

◆ window()

◆ duration()

◆ show()

◆ objectInfoImplAppend()

◆ objectOnInit()

◆ objectOnInitFinish()

◆ objectOnDeallocPrepare()

◆ objectOnDealloc()