ZFUIAlign Class Reference

align types for UI in ZFFramework More...

#include <ZFUITypeDef.h>

Inheritance diagram for ZFUIAlign:

Public Types
enum
enum	ZFEnumType {   e_Center , e_Left , e_Top , e_Right ,   e_Bottom , e_LeftEdge , e_TopEdge , e_RightEdge ,   e_BottomEdge , ZFEnumCount , _ZFP_ZFEnumMax }
	see ZFUIAlign More...
Public Types inherited from ZFStyleableObject
enum
Public Types inherited from ZFObject
enum

Public Member Functions
virtual const ZFClass *	classData (void)
	get instance's class info
virtual zfidentity	objectHash (void)
	get hash of this object
virtual const zfchar *	wrappedValueTypeId (void)
	type id for this wrapper type
Public Member Functions inherited from ZFEnum
virtual void	objectInfoT (zfstring &ret)
	see objectInfo
virtual ZFCompareResult	objectCompare (ZFObject *anotherObj)
	compare result of two enum values as int, or return ZFCompareUncomparable if any of them are ZFEnumInvalid
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
virtual void *	wrappedValue (void)
	access the value's address
virtual void	wrappedValue (const void *v)
	set the value, no type safe check
virtual void	wrappedValueCopy (void *v)
	get the value, no type safe check
virtual void	wrappedValueReset (void)
	reset the value to it's init value
virtual zfbool	wrappedValueIsInit (void)
	true if the value is in init value state
virtual zfbool	wrappedValueFromData (const ZFSerializableData &serializableData, zfstring *outErrorHint=0, ZFSerializableData *outErrorPos=0)
	convert from serializable data
virtual zfbool	wrappedValueToData (ZFSerializableData &serializableData, zfstring *outErrorHint=0)
	convert to serializable data
virtual zfbool	wrappedValueFromString (const zfchar *src, zfindex srcLen=((zfindex) -1), zfstring *errorHint=0)
	convert from string
virtual zfbool	wrappedValueToString (zfstring &s, zfstring *errorHint=0)
	convert to string
virtual zfindex	enumCount (void)=0
	get value num
virtual zfindex	enumIndexForValue (zfuint value)=0
	get the index of enum value, or zfindexMax() if no such enum value
virtual zfuint	enumValueAt (zfindex index)=0
	get the value at index, or ZFEnumInvalid if not exist
virtual const zfchar *	enumNameAt (zfindex index)=0
	get the name at index, or ZFEnumNameInvalid if not exist
virtual zfbool	enumContainValue (zfuint value)=0
	return true if contain the specified value
virtual zfuint	enumValueForName (const zfchar *name)=0
	get the value with specified name, or ZFEnumInvalid if not exist
virtual const zfchar *	enumNameForValue (zfuint value)=0
	get the name with specified value, or ZFEnumNameInvalid if not exist
virtual zfbool	enumIsFlags (void)=0
	true if this enum type is flags type (which support bit operation)
virtual zfuint	enumDefault (void)=0
	default value of this enum
virtual zfuint const &	enumValue (void)
	get the enum value, or ZFEnumInvalid if invalid
template<typename T_EnumType >
T_EnumType	enumValue (void)
	get the enum value and cast to desired type, you must ensure it's not ZFEnumInvalid
virtual const zfchar *	enumName (void)
	get current value's name, or ZFEnumNameInvalid if invalid
virtual void	enumValue (zfuint const &value)
	set the enum value
virtual void	wrappedValueOnAssign (ZFTypeIdWrapper *ref)
	see wrappedValueAssign
Public Member Functions inherited from ZFTypeIdWrapper
ZFTypeIdWrapper *	wrappedValueAssign (ZFTypeIdWrapper *ref)
	copy internal value, assert fail if wrappedValueIsConst
virtual zfbool	wrappedValuePreferStringConverter (void)
	whether prefer string converter during serialization, which would result much shorter result
virtual zfbool	progressUpdate (ZFProgressable *from, ZFProgressable *to, zffloat progress)
	see ZFProgressable
Public Member Functions inherited from ZFObject
zfindex	objectRetainCount (void)
	return the object's retain count
ZFObjectHolder *	objectHolder (void)
	return an object holder that hold this object without affecting retain count
virtual void	objectInfoOfInstanceT (zfstring &ret)
	see objectInfoOfInstance
virtual zfstring	objectInfoOfInstance (void)
	return a short string describe the object instance
virtual zfstring	objectInfo (void)
	return object info
virtual zfbool	equalTo (ZFObject *anotherObj)
	util to objectCompare
virtual zfauto	invoke (const zfchar *methodName)
	util method to perform ZFDI_invoke, do nothing if fail
virtual zfauto	invoke (const zfchar *methodName, ZFObject *param0, ZFObject *param1=((ZFObject *const &) _ZFP_ZFMethodGenericInvokerDefaultParamRef), ZFObject *param2=((ZFObject *const &) _ZFP_ZFMethodGenericInvokerDefaultParamRef), ZFObject *param3=((ZFObject *const &) _ZFP_ZFMethodGenericInvokerDefaultParamRef), ZFObject *param4=((ZFObject *const &) _ZFP_ZFMethodGenericInvokerDefaultParamRef), ZFObject *param5=((ZFObject *const &) _ZFP_ZFMethodGenericInvokerDefaultParamRef), ZFObject *param6=((ZFObject *const &) _ZFP_ZFMethodGenericInvokerDefaultParamRef), ZFObject *param7=((ZFObject *const &) _ZFP_ZFMethodGenericInvokerDefaultParamRef))
	util method to perform ZFDI_invoke, do nothing if fail
virtual zfauto	invokeDetail (const zfchar *methodName, const ZFCoreArray< zfauto > &params, zfbool *success=0, zfstring *errorHint=0)
	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 zfchar *key, ZFObject *tag)
	used to hold a object for app's use, auto retained
zfany	objectTag (const zfchar *key)
	see objectTag
void	objectTagGetAllKeyValue (ZFCoreArray< zfstring > &allKey, ZFCoreArray< zfauto > &allValue)
	get all key value
void	objectTagRemove (const zfchar *key)
	remove tag, same as set tag to null
zfauto	objectTagRemoveAndGet (const zfchar *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=0, ZFObject *param1=0)
	notify the observer with eventId
void	observerNotifyWithSender (ZFObject *customSender, zfidentity eventId, ZFObject *param0=0, ZFObject *param1=0)
	see observerNotify
ZFObserver &	observerHolder (void)
	access the internal observer holder
ZFObjectInstanceState	objectInstanceState (void)
	object instance's state
ZFV	zfv (void)
	see ZFV
Public Member Functions inherited from ZFStyleable
virtual zfanyT< ZFStyleable >	defaultStyle (void)
	return default style of this instance
void	styleableCopyFrom (ZFStyleable *anotherStyleable)
	copy style from another styleable, see ZFStyleable
virtual zfbool	styleableIsDefaultStyle (void)
	true if this object is defaultStyle
void	styleKey (const zfchar *styleKey)
	see ZFStyleSet
const zfchar *	styleKey (void)
	see ZFStyleSet
void	styleKeyForProperty (const zfchar *propertyName, const zfchar *styleKey)
	see ZFStyleSet
const zfchar *	styleKeyForProperty (const zfchar *propertyName)
	see ZFStyleSet
void	styleKeyForProperty (const ZFProperty *property, const zfchar *styleKey)
	see ZFStyleSet
const zfchar *	styleKeyForProperty (const ZFProperty *property)
	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=0, ZFSerializableData *outErrorPos=0)
	serialize from data, see ZFSerializable
zfbool	serializeToData (ZFSerializableData &serializableData, zfstring *outErrorHint=0, ZFSerializable *referencedOwnerOrNull=0)
	serialize to data, see ZFSerializable
zfbool	serializeFromString (const zfchar *src, zfindex srcLen=((zfindex) -1), zfstring *errorHint=0)
	serialize from string, return false by default
zfbool	serializeToString (zfstring &ret, zfstring *errorHint=0)
	see serializeFromString
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 zfindex	EnumCount (void)
	get the count of enum value
static zfindex	EnumIndexForValue (zfuint value)
	get the index of enum value, or zfindexMax() if no such enum value
static zfuint	EnumValueAt (zfindex index)
	get the value at index, or ZFEnumInvalid if not exist
static const zfchar *	EnumNameAt (zfindex index)
	get the name at index, or ZFEnumNameInvalid if not exist
static zfbool	EnumContainValue (zfuint value)
	return true if contain the specified value
static zfuint	EnumValueForName (const zfchar *name)
	get value with name, or ZFEnumInvalid if not exist
static const zfchar *	EnumNameForValue (zfuint value)
	get name with value, or ZFEnumNameInvalid if not exist
static zfbool	EnumIsFlags (void)
	see ZFEnum::enumIsFlags
static ZFUIAlign::ZFEnumType	EnumDefault (void)
	default value for ZFUIAlign
Static Public Member Functions inherited from ZFEnum
static const ZFClass *	ClassData (void)
	get class info
Static Public Member Functions inherited from ZFTypeIdWrapper
static const ZFClass *	ClassData (void)
	get class info
static void	markConst (ZFObject *obj)
	util to mark wrappedValueIsConst
Static Public Member Functions inherited from ZFStyleableObject
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	EventObjectBeforeAlloc (void)
	see ZFObject::observerNotify
static zfidentity	EventObjectAfterAlloc (void)
	see ZFObject::observerNotify
static zfidentity	EventObjectBeforeDealloc (void)
	see ZFObject::observerNotify
static zfidentity	EventObjectPropertyValueOnUpdate (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
Static Public Member Functions inherited from ZFProgressable
static const ZFClass *	ClassData (void)
	get class info

Protected Types
typedef ZFEnum	zfsuper
	class ref to super
typedef ZFUIAlign	zfself
	class ref to self
Protected Types inherited from ZFEnum
typedef ZFTypeIdWrapper	zfsuper
	class ref to super
typedef ZFEnum	zfself
	class ref to self
Protected Types inherited from ZFTypeIdWrapper
typedef ZFStyleableObject	zfsuper
	class ref to super
typedef ZFTypeIdWrapper	zfself
	class ref to self
Protected Types inherited from ZFStyleableObject
typedef ZFObject	zfsuper
	class ref to super
typedef ZFStyleableObject	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
enum	PropertyType { PropertyTypeNotStyleable , PropertyTypeNormal , PropertyTypeStyleable , PropertyTypeCopyable }
	see ZFStyleable::styleableOnCheckPropertyType More...
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
Protected Types inherited from ZFProgressable
typedef ZFInterface	zfsuper
	typedef for super (always ZFInterface for an interface type)
typedef ZFProgressable	zfself
	typedef for self

Additional Inherited Members
Public Attributes inherited from ZFTypeIdWrapper
zfbool	wrappedValueIsConst
	whether the holded value should not be changed
Protected Member Functions inherited from ZFEnum
virtual zfbool	serializableOnSerializeFromData (const ZFSerializableData &serializableData, zfstring *outErrorHint=0, ZFSerializableData *outErrorPos=0)
	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, ZFSerializable *referencedOwnerOrNull, zfstring *outErrorHint=0)
	corresponding to serializableOnSerializeFromData, return whether the task is success, see ZFSerializable
virtual void	copyableOnCopyFrom (ZFObject *anotherObj)
	called by copy to copy contents from anotherObj
virtual void	objectOnInit (zfuint value)
	init with value or ZFEnumInvalid if invalid
virtual void	objectOnInit (ZFEnum *another)
	init with ZFEnum
virtual void	objectOnInit (void)
	override this to init your object
Protected Member Functions inherited from ZFTypeIdWrapper
virtual void	styleableOnCopyFrom (ZFStyleable *anotherStyleable)
	for subclass to achieve custom style copy step, called by styleableCopyFrom, see ZFStyleable
virtual zfbool	serializableOnSerializeFromString (const zfchar *src, zfindex srcLen=((zfindex) -1), zfstring *errorHint=0)
	see serializeFromString
virtual zfbool	serializableOnSerializeToString (zfstring &ret, zfstring *errorHint=0)
	see serializeFromString
Protected Member Functions inherited from ZFObject
virtual void	objectInfoOnAppend (zfstring &ret)
	called by objectInfoT to append object info as a chain
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	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 EventObjectPropertyValueOnUpdate
Protected Member Functions inherited from ZFStyleable
virtual ZFStyleable::PropertyType	styleableOnCheckPropertyType (const ZFProperty *property)
	check property type
virtual void	styleableOnCopyPropertyFrom (ZFStyleable *anotherStyleable, const ZFProperty *property, ZFStyleable::PropertyType propertyType)
	copy property with styleable logic
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	serializableOnSerializePropertyFromData (const ZFSerializableData &propertyData, const ZFProperty *property, zfstring *outErrorHint=0, ZFSerializableData *outErrorPos=0)
	see serializableOnCheckPropertyType, usually you have no need to override this method, see ZFSerializable
virtual zfbool	serializableOnSerializePropertyToData (ZFSerializableData &ownerData, const ZFProperty *property, ZFSerializable *referencedOwnerOrNull, zfstring *outErrorHint=0)
	see serializableOnCheckPropertyType, usually you have no need to override this method, see ZFSerializable
virtual zfbool	serializableOnSerializeEmbededPropertyFromData (const ZFSerializableData &propertyData, const ZFProperty *property, zfstring *outErrorHint=0, ZFSerializableData *outErrorPos=0)
	see serializableOnCheckPropertyType, usually you have no need to override this method, see ZFSerializable
virtual zfbool	serializableOnSerializeEmbededPropertyToData (ZFSerializableData &ownerData, const ZFProperty *property, ZFSerializable *referencedOwnerOrNull, zfstring *outErrorHint=0)
	see serializableOnCheckPropertyType, usually you have no need to override this method, see ZFSerializable

Detailed Description

align types for UI in ZFFramework

See also

ZFUIAlignFlags

Member Enumeration Documentation

ZFEnumType

enum ZFUIAlign::ZFEnumType

see ZFUIAlign

Enumerator
e_Center	Center ( 0 ) ensured 0
e_Left	Left ( 1 )
e_Top	Top ( 2 )
e_Right	Right ( 4 )
e_Bottom	Bottom ( 8 )
e_LeftEdge	LeftEdge ( 16 )
e_TopEdge	TopEdge ( 32 )
e_RightEdge	RightEdge ( 64 )
e_BottomEdge	BottomEdge ( 128 )
ZFEnumCount	max enum value

Member Function Documentation

classData()

virtual const ZFClass * ZFUIAlign::classData ( void )

inlinevirtual

get instance's class info

Reimplemented from ZFEnum.

Reimplemented in v_ZFUIAlignFlags.

objectHash()

virtual zfidentity ZFUIAlign::objectHash ( void )

inlinevirtual

get hash of this object

by default, this method would return a hash value of the instance's pointer

if you override this method, you must ensure two objects have same hash if they are regarded as same (i.e. objectCompare return ZFCompareTheSame)
this method may or may not be called frequently, you should always try to make the implementation have good performance

Reimplemented from ZFObject.

wrappedValueTypeId()

virtual const zfchar * ZFUIAlign::wrappedValueTypeId ( void )

virtual

type id for this wrapper type

Implements ZFTypeIdWrapper.

Reimplemented in v_ZFUIAlignFlags.

---

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

• ZFUITypeDef.h