global style for ui elements More...

#include <ZFUIGlobalStyle.h>

Inheritance diagram for ZFUIGlobalStyle:

Public Types
enum

Public Types inherited from ZFStyle
enum

Public Types inherited from ZFObject
enum

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

virtual zffloat &	imageScale ()
	resource image's base scale, 2 by default to suit most case, see ZFUIImage::imageScale for more info

virtual void	imageScale (zffloat const &propertyValue)
	see imageScale

virtual zffloat &	itemSpace ()
	space between inner items

virtual void	itemSpace (zffloat const &propertyValue)
	see itemSpace

virtual zffloat &	itemMargin ()
	space to outer containers

virtual void	itemMargin (zffloat const &propertyValue)
	see itemMargin

virtual zffloat &	itemSizeText ()
	text item size hint

virtual void	itemSizeText (zffloat const &propertyValue)
	see itemSizeText

virtual zffloat &	itemSizeControl ()
	small control item size hint

virtual void	itemSizeControl (zffloat const &propertyValue)
	see itemSizeControl

virtual zffloat &	itemSizeButton ()
	button size hint

virtual void	itemSizeButton (zffloat const &propertyValue)
	see itemSizeButton

virtual zffloat &	itemSizeButtonWidth ()
	button size hint

virtual void	itemSizeButtonWidth (zffloat const &propertyValue)
	see itemSizeButtonWidth

virtual zffloat &	itemSizeIcon ()
	icon size hint

virtual void	itemSizeIcon (zffloat const &propertyValue)
	see itemSizeIcon

virtual zffloat &	itemSizeIconSmall ()
	icon size hint

virtual void	itemSizeIconSmall (zffloat const &propertyValue)
	see itemSizeIconSmall

virtual zffloat &	itemSizeCell ()
	list cell size hint

virtual void	itemSizeCell (zffloat const &propertyValue)
	see itemSizeCell

virtual zffloat &	itemSizeDialog ()
	dialog item size hint

virtual void	itemSizeDialog (zffloat const &propertyValue)
	see itemSizeDialog

virtual zffloat &	itemSizeDialogWidth ()
	dialog item size hint

virtual void	itemSizeDialogWidth (zffloat const &propertyValue)
	see itemSizeDialogWidth

virtual zffloat &	textSizeExtraTiny ()
	extra tiny text size hint

virtual void	textSizeExtraTiny (zffloat const &propertyValue)
	see textSizeExtraTiny

virtual zffloat &	textSizeTiny ()
	tiny text size hint

virtual void	textSizeTiny (zffloat const &propertyValue)
	see textSizeTiny

virtual zffloat &	textSizeSmall ()
	small text size hint

virtual void	textSizeSmall (zffloat const &propertyValue)
	see textSizeSmall

virtual zffloat &	textSizeNormal ()
	normal text size hint

virtual void	textSizeNormal (zffloat const &propertyValue)
	see textSizeNormal

virtual zffloat &	textSizeBig ()
	big text size hint

virtual void	textSizeBig (zffloat const &propertyValue)
	see textSizeBig

virtual zffloat &	textSizeLarge ()
	large text size hint

virtual void	textSizeLarge (zffloat const &propertyValue)
	see textSizeLarge

virtual zffloat &	textSizeExtraLarge ()
	extra large text size hint

virtual void	textSizeExtraLarge (zffloat const &propertyValue)
	see textSizeExtraLarge

virtual ZFUITextAppearance &	textAppearance ()
	default text appearance

virtual void	textAppearance (ZFUITextAppearance const &propertyValue)
	see textAppearance

virtual ZFUIAlignFlags &	textAlign ()
	default text align

virtual void	textAlign (ZFUIAlignFlags const &propertyValue)
	see textAlign

virtual ZFUITextTruncateMode &	textTruncateMode ()
	default text truncate mode

virtual void	textTruncateMode (ZFUITextTruncateMode const &propertyValue)
	see textTruncateMode

virtual ZFUIColor &	colorBgDefault ()
	default background color

virtual void	colorBgDefault (ZFUIColor const &propertyValue)
	see colorBgDefault

virtual ZFUIColor &	colorBgItem ()
	item background color

virtual void	colorBgItem (ZFUIColor const &propertyValue)
	see colorBgItem

virtual ZFUIColor &	colorSeparator ()
	separator color

virtual void	colorSeparator (ZFUIColor const &propertyValue)
	see colorSeparator

virtual ZFUIColor &	colorShadow ()
	shadow color

virtual void	colorShadow (ZFUIColor const &propertyValue)
	see colorShadow

virtual ZFUIColor &	colorMask ()
	mask color

virtual void	colorMask (ZFUIColor const &propertyValue)
	see colorMask

virtual ZFUIColor &	colorTint ()
	tint color

virtual void	colorTint (ZFUIColor const &propertyValue)
	see colorTint

virtual ZFUIColor &	textColorDefault ()
	default text color

virtual void	textColorDefault (ZFUIColor const &propertyValue)
	see textColorDefault

virtual ZFUIColor &	textColorSecondary ()
	secondary default text color

virtual void	textColorSecondary (ZFUIColor const &propertyValue)
	see textColorSecondary

virtual ZFUIColor &	textColorHint ()
	hint text color

virtual void	textColorHint (ZFUIColor const &propertyValue)
	see textColorHint

virtual ZFUIColor &	controlColorNormal ()
	normal control color

virtual void	controlColorNormal (ZFUIColor const &propertyValue)
	see controlColorNormal

virtual ZFUIColor &	controlColorHighlighted ()
	highlighted control color

virtual void	controlColorHighlighted (ZFUIColor const &propertyValue)
	see controlColorHighlighted

virtual ZFUIColor &	controlColorChecked ()
	checked control color

virtual void	controlColorChecked (ZFUIColor const &propertyValue)
	see controlColorChecked

virtual ZFUIColor &	controlColorCheckedHighlighted ()
	checked highlighted control color

virtual void	controlColorCheckedHighlighted (ZFUIColor const &propertyValue)
	see controlColorCheckedHighlighted

virtual ZFUIColor &	controlColorDisabled ()
	disabled control color

virtual void	controlColorDisabled (ZFUIColor const &propertyValue)
	see controlColorDisabled

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

Public Member Functions inherited from ZFStyleable
virtual zfanyT< ZFStyleable >	defaultStyle (void)
	return default style of this instance

void	styleableCopyFrom (ZFObject *anotherStyleable)
	copy style from another styleable, see ZFStyleable

virtual zfbool	styleableIsDefaultStyle (void)
	true if this object is defaultStyle

void	styleablePropertyGetAllT (ZFCoreArray< const ZFProperty * > &ret)
	return a list of styleable property, for debug use only

ZFCoreArray< const ZFProperty * >	styleablePropertyGetAll (void)
	return a list of styleable property, for debug use only

void	styleKey (const zfstring &styleKey)
	see ZFStyleSet

const zfstring &	styleKey (void)
	see ZFStyleSet

void	propStyle (const zfstring &propertyName, const zfstring &styleKey)
	see ZFStyleSet

const zfstring &	propStyle (const zfstring &propertyName)
	see ZFStyleSet

Public Member Functions inherited from ZFInterface
virtual ZFObject *	toObject (void)=0
	convert to ZFObject type

Public Member Functions inherited from ZFSerializable
zfbool	serializable (void)
	true if object is currently serializable, see ZFSerializable

zfbool	serializeFromData (const ZFSerializableData &serializableData, zfstring outErrorHint=zft_zfnull, ZFSerializableData outErrorPos=zft_zfnull)
	serialize from data, see ZFSerializable

zfbool	serializeToData (ZFSerializableData &serializableData, zfstring outErrorHint=zft_zfnull, ZFSerializable refOwner=zft_zfnull)
	serialize to data, see ZFSerializable

zfbool	serializeFromString (const zfchar src, zfindex srcLen=((zfindex) -1), zfstring errorHint=zft_zfnull)
	serialize from string, return false by default

zfbool	serializeToString (zfstring &ret, zfstring *errorHint=zft_zfnull)
	see serializeFromString

void	serializablePropertyTypeGetAll (ZFCoreArray< const ZFProperty * > &notSerializableProperty, ZFCoreArray< const ZFProperty * > &serializableProperty, ZFCoreArray< const ZFProperty * > &embededProperty)
	return a list of each type of property, for debug use only

zfstring	serializablePropertyTypeInfo (void)
	return info of serializablePropertyTypeGetAll, for debug use only

void	serializableGetAllSerializablePropertyT (ZFCoreArray< const ZFProperty * > &ret)
	see serializableGetAllSerializableProperty

ZFCoreArray< const ZFProperty * >	serializableGetAllSerializableProperty (void)
	get all serializable property, usually for debug only, see serializableOnCheckPropertyType

void	serializableGetAllSerializableEmbededPropertyT (ZFCoreArray< const ZFProperty * > &ret)
	see serializableGetAllSerializableEmbededProperty

ZFCoreArray< const ZFProperty * >	serializableGetAllSerializableEmbededProperty (void)
	get all serializable embeded property, usually for debug only, see serializableOnCheckPropertyType

virtual void	serializableInfoT (zfstring &ret)
	get info as a serializable

virtual zfstring	serializableInfo (void)
	see serializableInfoT

Public Member Functions inherited from ZFCopyable
zfautoT< ZFCopyable >	copy (void)
	return a copy of this object

void	copyFrom (ZFObject *anotherObj)
	see copy, anotherObj must be same type as this object (by classData), otherwise, do nothing

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

static zfanyT< ZFUIGlobalStyle >	DefaultStyle (void)

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

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

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

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

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

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

Protected Types
typedef ZFStyle	zfsuper
	class ref to super

typedef ZFUIGlobalStyle	zfself
	class ref to self

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

typedef ZFStyle	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 Types inherited from ZFStyleable
typedef ZFInterface	zfsuper
	typedef for super (always ZFInterface for an interface type)

typedef ZFStyleable	zfself
	typedef for self

Protected Types inherited from ZFInterface
typedef _ZFP_ObjI_Base	zfsuper
	typedef for super (always ZFInterface for an interface type)

typedef ZFInterface	zfself
	typedef for self

Protected Types inherited from ZFSerializable
typedef ZFInterface	zfsuper
	typedef for super (always ZFInterface for an interface type)

typedef ZFSerializable	zfself
	typedef for self

Protected Types inherited from ZFCopyable
typedef ZFInterface	zfsuper
	typedef for super (always ZFInterface for an interface type)

typedef ZFCopyable	zfself
	typedef for self

Additional Inherited Members
Protected Member Functions inherited from ZFStyle
virtual void	copyableOnCopyFrom (ZFObject *anotherObj)
	called by copy to copy contents from anotherObj

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

virtual void	objectInfoImplAppend (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	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

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

Protected Member Functions inherited from ZFStyleable
virtual void	styleableOnCopyPropertyFrom (ZFObject anotherStyleable, const ZFProperty property)
	copy property with styleable logic

virtual void	styleableOnCopyFrom (ZFObject *anotherStyleable)
	for subclass to achieve custom style copy step, called by styleableCopyFrom, see ZFStyleable

Protected Member Functions inherited from ZFSerializable
virtual ZFSerializablePropertyType	serializableOnCheckPropertyType (const ZFProperty *property)
	check the property type that serializable should do what while serializing

virtual zfbool	serializableOnCheck (void)
	see serializable

virtual zfbool	serializableOnSerializeFromData (const ZFSerializableData &serializableData, zfstring outErrorHint=zft_zfnull, ZFSerializableData outErrorPos=zft_zfnull)
	for serializable data that has "category" attribute, ZFSerializable would ignore it and leave it to subclass to resolve, see ZFSerializable

virtual zfbool	serializableOnSerializeToData (ZFSerializableData &serializableData, zfstring outErrorHint=zft_zfnull, ZFSerializable refOwner=zft_zfnull)
	corresponding to serializableOnSerializeFromData, return whether the task is success, see ZFSerializable

virtual zfbool	serializableOnSerializePropertyFromData (const ZFSerializableData &propertyData, const ZFProperty property, zfstring outErrorHint=zft_zfnull, ZFSerializableData *outErrorPos=zft_zfnull)
	see serializableOnCheckPropertyType, usually you have no need to override this method, see ZFSerializable

virtual zfbool	serializableOnSerializePropertyToData (ZFSerializableData &ownerData, const ZFProperty property, zfstring outErrorHint=zft_zfnull, ZFSerializable *refOwner=zft_zfnull)
	see serializableOnCheckPropertyType, usually you have no need to override this method, see ZFSerializable

virtual zfbool	serializableOnSerializeEmbededPropertyFromData (const ZFSerializableData &propertyData, const ZFProperty property, zfstring outErrorHint=zft_zfnull, ZFSerializableData *outErrorPos=zft_zfnull)
	see serializableOnCheckPropertyType, usually you have no need to override this method, see ZFSerializable

virtual zfbool	serializableOnSerializeEmbededPropertyToData (ZFSerializableData &ownerData, const ZFProperty property, ZFSerializable refOwner, zfstring *outErrorHint=zft_zfnull)
	see serializableOnCheckPropertyType, usually you have no need to override this method, see ZFSerializable

virtual zfbool	serializableOnSerializeFromString (const zfchar src, zfindex srcLen=((zfindex) -1), zfstring errorHint=zft_zfnull)
	see serializeFromString

virtual zfbool	serializableOnSerializeToString (zfstring &ret, zfstring *errorHint=zft_zfnull)
	see serializeFromString

Detailed Description

global style for ui elements

Member Function Documentation

◆ classData()

virtual const ZFClass * ZFUIGlobalStyle::classData ( void )

inlinevirtual

get instance's class info

Reimplemented from ZFStyle.

◆ DefaultStyle()

static zfanyT< ZFUIGlobalStyle > ZFUIGlobalStyle::DefaultStyle ( void )

static

default style for ZFUIGlobalStyle

◆ imageScale()

virtual zffloat & ZFUIGlobalStyle::imageScale ( )

inlinevirtual

resource image's base scale, 2 by default to suit most case, see ZFUIImage::imageScale for more info

scale 2 means, 80 pixel size image would be treated as 40 size in ZFUIView tree, which should suit for most physical screen, if you want to support higher screen resolution, supply larger pixel image and increase this scale value

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

ZFUIGlobalStyle.h

ZFFramework

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ classData()

◆ DefaultStyle()

◆ imageScale()