doc/_z_f_protocol_z_f_u_i_image_8h_source.html

#ifndef _ZFI_ZFProtocolZFUIImage_h_

#define _ZFI_ZFProtocolZFUIImage_h_


#include "ZFCore/ZFProtocol.h"

#include "ZFUIKit/ZFUIImage.h"

ZF_NAMESPACE_GLOBAL_BEGIN


ZFPROTOCOL_INTERFACE_BEGIN(ZFLIB_ZFUIKit, ZFUIImage)

public:

    virtual void *nativeImageFromInput(ZF_IN const ZFInput &inputCallback) zfpurevirtual;

    virtual zfbool nativeImageToOutput(

            ZF_IN void *nativeImage

            , ZF_OUT const ZFOutput &outputCallback

            ) zfpurevirtual;


    virtual void *nativeImageCopy(ZF_IN void *nativeImage) zfpurevirtual;


    virtual void *nativeImageRetain(ZF_IN void *nativeImage) zfpurevirtual;

    virtual void nativeImageRelease(ZF_IN void *nativeImage) zfpurevirtual;


    virtual ZFUISize nativeImageSize(ZF_IN void *nativeImage) zfpurevirtual;

ZFPROTOCOL_INTERFACE_END(ZFUIImage)


ZFENUM_BEGIN(ZFLIB_ZFUIKit, ZFUIImageImplNinePatchPos)

    ZFENUM_VALUE(TopLeft)

    ZFENUM_VALUE(TopCenter)

    ZFENUM_VALUE(TopRight)

    ZFENUM_VALUE(CenterLeft)

    ZFENUM_VALUE(CenterCenter)

    ZFENUM_VALUE(CenterRight)

    ZFENUM_VALUE(BottomLeft)

    ZFENUM_VALUE(BottomCenter)

    ZFENUM_VALUE(BottomRight)

ZFENUM_SEPARATOR()

    ZFENUM_VALUE_REGISTER(TopLeft)

    ZFENUM_VALUE_REGISTER(TopCenter)

    ZFENUM_VALUE_REGISTER(TopRight)

    ZFENUM_VALUE_REGISTER(CenterLeft)

    ZFENUM_VALUE_REGISTER(CenterCenter)

    ZFENUM_VALUE_REGISTER(CenterRight)

    ZFENUM_VALUE_REGISTER(BottomLeft)

    ZFENUM_VALUE_REGISTER(BottomCenter)

    ZFENUM_VALUE_REGISTER(BottomRight)

ZFENUM_END(ZFLIB_ZFUIKit, ZFUIImageImplNinePatchPos)

ZFENUM_REG(ZFLIB_ZFUIKit, ZFUIImageImplNinePatchPos)


zfclassPOD ZFLIB_ZFUIKit ZFUIImageImplNinePatchDrawData {

public:

    ZFUIImageImplNinePatchPos position;

    ZFUIRect src;

    ZFUIRect dst;

};


ZFCORE_POD_DECLARE(ZFUIImageImplNinePatchDrawData)

ZFOUTPUT_TYPE_DECLARE(ZFLIB_ZFUIKit, ZFUIImageImplNinePatchDrawData)


extern ZFLIB_ZFUIKit zfindex ZFUIImageImplNinePatchCalc(

        ZF_OUT ZFUIImageImplNinePatchDrawData *outBuf

        , ZF_IN const ZFUISize &srcSize

        , ZF_IN const ZFUIMargin &srcNinePatch

        , ZF_IN const ZFUISize &dstSize

        );


ZF_NAMESPACE_GLOBAL_END

#endif // #ifndef _ZFI_ZFProtocolZFUIImage_h_


zfpurevirtual
#define zfpurevirtual
dummy macro shows that a method is pure virtual method
Definition ZFCoreTypeDef_ClassType.h:68

ZF_IN
#define ZF_IN
dummy macro that shows the param used as required input
Definition ZFCoreTypeDef_ClassType.h:180

zfclassPOD
#define zfclassPOD
shows the class is a POD type
Definition ZFCoreTypeDef_ClassType.h:35

ZF_OUT
#define ZF_OUT
dummy macro that shows the param used as required output
Definition ZFCoreTypeDef_ClassType.h:188

zfbool
_ZFT_t_zfbool zfbool
bool type
Definition ZFCoreTypeDef_CoreType.h:103

zfindex
_ZFT_t_zfindex zfindex
similar to size_t, used for index and size only
Definition ZFCoreTypeDef_CoreType.h:154

ZFOUTPUT_TYPE_DECLARE
#define ZFOUTPUT_TYPE_DECLARE(ZFLIB_, T_Type)
see ZFOUTPUT_TYPE
Definition ZFCoreTypeDef_OtherType.h:244

ZFCORE_POD_DECLARE
#define ZFCORE_POD_DECLARE(Type)
explicitly declare as POD
Definition ZFCoreUtilTemplate.h:554

ZFENUM_SEPARATOR
#define ZFENUM_SEPARATOR()
see ZFENUM_BEGIN
Definition ZFEnumDeclare.h:158

ZFENUM_VALUE_REGISTER
#define ZFENUM_VALUE_REGISTER(Value)
see ZFENUM_BEGIN
Definition ZFEnumDeclare.h:168

ZFENUM_REG
#define ZFENUM_REG(ZFLIB_, EnumName,...)
see ZFENUM_BEGIN
Definition ZFEnumDeclare.h:186

ZFENUM_VALUE
#define ZFENUM_VALUE(Value)
see ZFENUM_BEGIN
Definition ZFEnumDeclare.h:151

ZFENUM_BEGIN
#define ZFENUM_BEGIN(ZFLIB_, EnumName)
macros to define reflectable enum type
Definition ZFEnumDeclare.h:147

ZFENUM_END
#define ZFENUM_END(ZFLIB_, EnumName)
see ZFENUM_BEGIN
Definition ZFEnumDeclare.h:172

ZF_NAMESPACE_GLOBAL_BEGIN
#define ZF_NAMESPACE_GLOBAL_BEGIN
begin namespace ZFFramework
Definition ZFNamespace.h:97

ZF_NAMESPACE_GLOBAL_END
#define ZF_NAMESPACE_GLOBAL_END
end namespace ZFFramework
Definition ZFNamespace.h:98

ZFProtocol.h
protocol definitions for ZFFramework

ZFPROTOCOL_INTERFACE_END
#define ZFPROTOCOL_INTERFACE_END(ModuleName)
for more information, please refer to ZFPROTOCOL_INTERFACE_BEGIN
Definition ZFProtocol.h:414

ZFPROTOCOL_INTERFACE_BEGIN
#define ZFPROTOCOL_INTERFACE_BEGIN(ZFLIB_, ModuleName)
declare a protocol interface for ZFFramework
Definition ZFProtocol.h:408

ZFUIImageImplNinePatchCalc
zfindex ZFUIImageImplNinePatchCalc(ZFUIImageImplNinePatchDrawData *outBuf, const ZFUISize &srcSize, const ZFUIMargin &srcNinePatch, const ZFUISize &dstSize)
util method for implementation to calculate nine patch areas

ZFUIImageImplNinePatchPos
v_ZFUIImageImplNinePatchPos::ZFEnumType ZFUIImageImplNinePatchPos
see v_ZFUIImageImplNinePatchPos
Definition ZFProtocolZFUIImage.h:78

ZFUIImage.h
image

ZFLIB_ZFUIKit
#define ZFLIB_ZFUIKit
used to export symbols
Definition ZFUIKitDef.h:16

ZFInput
general input callback
Definition ZFIOCallback_input.h:37

ZFOutput
general output callback
Definition ZFIOCallback_output.h:37

ZFPInterface_ZFUIImage::nativeImageRelease
virtual void nativeImageRelease(void *nativeImage)=0
release the image

ZFPInterface_ZFUIImage::nativeImageCopy
virtual void * nativeImageCopy(void *nativeImage)=0
copy the nativeImage and return the copied one, copied image would be released by nativeImageRelease

ZFPInterface_ZFUIImage::nativeImageFromInput
virtual void * nativeImageFromInput(const ZFInput &inputCallback)=0
load image from input as binary data, created image would be released by nativeImageRelease

ZFPInterface_ZFUIImage::nativeImageSize
virtual ZFUISize nativeImageSize(void *nativeImage)=0
get size of the image (in pixel)

ZFPInterface_ZFUIImage::nativeImageRetain
virtual void * nativeImageRetain(void *nativeImage)=0
retain the image, you may return a different one

ZFPInterface_ZFUIImage::nativeImageToOutput
virtual zfbool nativeImageToOutput(void *nativeImage, const ZFOutput &outputCallback)=0
save image to output as binary data

ZFUIImage
image storage
Definition ZFUIImage.h:30

ZFUIImageImplNinePatchDrawData
see ZFUIImageImplNinePatchCalc
Definition ZFProtocolZFUIImage.h:84

ZFUIImageImplNinePatchDrawData::src
ZFUIRect src
src rect to draw bitmap from, ensured valid
Definition ZFProtocolZFUIImage.h:87

ZFUIImageImplNinePatchDrawData::dst
ZFUIRect dst
dst rect to draw bitmapt to, ensured valid
Definition ZFProtocolZFUIImage.h:88

ZFUIImageImplNinePatchDrawData::position
ZFUIImageImplNinePatchPos position
position of the nine patch piece
Definition ZFProtocolZFUIImage.h:86

ZFUIMargin
margin
Definition ZFUITypeDef.h:147

ZFUIRect
2D rectangle
Definition ZFUITypeDef.h:636

ZFUISize
2D size
Definition ZFUITypeDef.h:397