ZFUIImage.h File Reference

image More...

#include "ZFUIGlobalStyle.h"

Go to the source code of this file.

Classes
class	ZFUIImage
	image storage More...
class	v_ZFUIImageStateImplAction
	see ZFUIImage::imageStateImpl More...

Macros
#define	ZFUIIMAGE_SERIALIZE_TYPE_DEFINE(registerSig, typeName)
	register a serializable logic for ZFUIImage
#define	ZFSerializableKeyword_ZFUIImage_imageType
	keyword for serialize
#define	ZFSerializableKeyword_ZFUIImage_imageBin
	keyword for serialize

Typedefs
typedef v_ZFUIImageStateImplAction::ZFEnumType	ZFUIImageStateImplAction
	see v_ZFUIImageStateImplAction

Functions
void	ZFUIImageSerializeTypeGetAllT (ZFCoreArray< zfstring > &ret)
	see ZFUIImageSerializeTypeGetAll
ZFCoreArray< zfstring >	ZFUIImageSerializeTypeGetAll (void)
	usually for debug use only
zfbool	ZFUIImageStateImplActionFromStringT (zfauto &ret, const zfchar *src, zfindex srcLen=((zfindex) -1), zfstring *errorHint=zft_zfnull)
	see v_ZFUIImageStateImplAction, return enum object if success
zfbool	ZFUIImageStateImplActionToStringT (zfstring &ret, v_ZFUIImageStateImplAction *const &value, zfstring *errorHint=zft_zfnull)
	see ZFUIImageStateImplAction, return empty string if error
zfstring	ZFUIImageStateImplActionToString (v_ZFUIImageStateImplAction *const &value, zfstring *errorHint=zft_zfnull)
	see v_ZFUIImageStateImplAction, return empty string if error
const zfstring &	ZFTypeId_ZFUIImageStateImplAction (void)
zfbool	ZFUIImageStateImplActionFromDataT (_ZFP_PropTypeW_ZFUIImageStateImplAction &v, const ZFSerializableData &serializableData, zfstring *outErrorHint=zft_zfnull, ZFSerializableData *outErrorPos=zft_zfnull)
	see ZFTYPEID_DECLARE
_ZFP_PropTypeW_ZFUIImageStateImplAction	ZFUIImageStateImplActionFromData (const ZFSerializableData &serializableData, zfstring *outErrorHint=zft_zfnull, ZFSerializableData *outErrorPos=zft_zfnull)
	see ZFTYPEID_DECLARE
zfbool	ZFUIImageStateImplActionToDataT (ZFSerializableData &serializableData, _ZFP_PropTypeW_ZFUIImageStateImplAction const &v, zfstring *outErrorHint=zft_zfnull)
	see ZFTYPEID_DECLARE
ZFSerializableData	ZFUIImageStateImplActionToData (_ZFP_PropTypeW_ZFUIImageStateImplAction const &v, zfstring *outErrorHint=zft_zfnull)
	see ZFTYPEID_DECLARE
zfbool	ZFUIImageStateImplActionFromStringT (_ZFP_PropTypeW_ZFUIImageStateImplAction &v, const zfchar *src, zfindex srcLen=((zfindex) -1), zfstring *errorHint=zft_zfnull)
	util method to convert ZFUIImageStateImplAction from string
_ZFP_PropTypeW_ZFUIImageStateImplAction	ZFUIImageStateImplActionFromString (const zfchar *src, zfindex srcLen=((zfindex) -1), zfstring *errorHint=zft_zfnull)
	util method to convert ZFUIImageStateImplAction from string
zfbool	ZFUIImageStateImplActionToStringT (zfstring &s, _ZFP_PropTypeW_ZFUIImageStateImplAction const &v, zfstring *errorHint=zft_zfnull)
	util method to convert ZFUIImageStateImplAction to string
zfstring	ZFUIImageStateImplActionToString (_ZFP_PropTypeW_ZFUIImageStateImplAction const &v, zfstring *errorHint=zft_zfnull)
	util method to convert ZFUIImageStateImplAction to string

Detailed Description

image

Macro Definition Documentation

ZFUIIMAGE_SERIALIZE_TYPE_DEFINE

#define ZFUIIMAGE_SERIALIZE_TYPE_DEFINE	(		registerSig,
			typeName )

register a serializable logic for ZFUIImage

ZFUIImage can be loaded from many sources, so we supply a dynamic serializable logic depending on image's load logic, use this macro to register your own serialize logic, such as load from file or load from color

example

// in cpp file
ZFUIIMAGE_SERIALIZE_TYPE_DEFINE(registerSig, yourTypeName) {
    // serialize callback from data
    // proto type:
    //   zfbool action(
    //           ZF_IN_OUT ZFUIImage *ret
    //           , ZF_IN const ZFSerializableData &serializableData
    //           , ZF_OUT_OPT zfstring *outErrorHint
    //           , ZF_OUT_OPT ZFSerializableData *outErrorPos
    //           );
    return zftrue;
}

when image loaded or serialized successfully, impl may store these serializable datas to the image:

• ZFUIImage::imageSerializeType : the type registered by ZFUIIMAGE_SERIALIZE_TYPE_DEFINE
• ZFUIImage::imageSerializeData or ZFUIImage::imageSerializeDataGetter : actual serializable data, or a callback to obtain (store result to ZFArgs::result) the serializable data

Function Documentation

ZFTypeId_ZFUIImageStateImplAction()

const zfstring & ZFTypeId_ZFUIImageStateImplAction ( void )

inline