fpdf_layer_r.h

Go to the documentation of this file.

#ifndef _FSPDF_LAYER_R_H_
#define _FSPDF_LAYER_R_H_

#ifdef __cplusplus
extern "C" {
#endif

#ifndef _FSPDF_DEF_HANDLE_LAYER_
#define _FSPDF_DEF_HANDLE_LAYER_

FSCRT_DEFINEHANDLE(FSPDF_LAYER);
#endif // _FSPDF_DEF_HANDLE_LAYER_

/*******************************************************************************/
/* PDF Layer's properties definitions                                          */
/*******************************************************************************/

#ifndef _FSPDF_DEF_MACRO_LAYERUSAGETYPE_
#define _FSPDF_DEF_MACRO_LAYERUSAGETYPE_

#define FSPDF_LAYERUSAGETYPE_VIEW               0 

#define FSPDF_LAYERUSAGETYPE_DESIGN             1 

#define FSPDF_LAYERUSAGETYPE_PRINT              2 

#define FSPDF_LAYERUSAGETYPE_EXPORT             3 

#define FSPDF_LAYERUSAGETYPE_ZOOM               4

#endif //_FSPDF_DEF_MACRO_LAYERUSAGETYPE_

#ifndef _FSPDF_DEF_MACRO_LAYERBASESTATE_
#define _FSPDF_DEF_MACRO_LAYERBASESTATE_

#define FSPDF_LAYER_BASESTATE_ON                0 

#define FSPDF_LAYER_BASESTATE_OFF               1 

#define FSPDF_LAYER_BASESTATE_UNCHANGED 2 

#endif //_FSPDF_DEF_MACRO_LAYERBASESTATE_

/*******************************************************************************/
/* PDF Layer Node for enumerate the layers.                                    */
/*******************************************************************************/
#ifndef _FSCRT_DEF_STRUCTURE_LAYERNODE_
#define _FSCRT_DEF_STRUCTURE_LAYERNODE_

typedef struct _FSPDF_LAYERNODE
{
        FSCRT_BSTR                              name;
        FSPDF_LAYER                             layer;
        struct _FSPDF_LAYERNODE*                children;
        FS_INT32                                count;
} FSPDF_LAYERNODE;
#endif //_FSCRT_DEF_STRUCTURE_LAYERNODE_


#ifndef _FSCRT_DEF_STRUCTURE_LAYE_USAGE_PARAM_
#define _FSCRT_DEF_STRUCTURE_LAYE_USAGE_PARAM_

typedef struct _FSPDF_LAYERUSAGE_ZOOMDATA
{
        FS_FLOAT                                minFactor;
        FS_FLOAT                                maxFactor;
} FSPDF_LAYERUSAGE_ZOOMDATA;

typedef struct _FSPDF_LAYERUSAGE_PRINTDATA
{
        FSCRT_BSTR                              subtype;
        FS_BOOL                                 printState;
} FSPDF_LAYERUSAGE_PRINTDATA;

#endif //_FSCRT_DEF_STRUCTURE_LAYE_USAGE_PARAM_

FS_RESULT       FSPDF_LayerNode_Init(FSPDF_LAYERNODE* layers);

FS_RESULT       FSPDF_LayerNode_Clear(FSPDF_LAYERNODE* layers);

FS_RESULT       FSPDF_Doc_EnumLayers(FSCRT_DOCUMENT document, FSPDF_LAYERNODE* layers);

/*******************************************************************************/
/* Access PDF Layer Properties                                                 */
/*******************************************************************************/
FS_RESULT       FSPDF_Layer_GetName(FSPDF_LAYER layer, FSCRT_BSTR* name);

FS_RESULT       FSPDF_Layer_IsInPage(FSCRT_PAGE page, FSPDF_LAYER layer, FS_BOOL* isInPage);

FS_RESULT       FSPDF_Layer_HasIntent(FSPDF_LAYER layer,const FSCRT_BSTR* intent, FS_BOOL* hasIntent);

FS_RESULT       FSPDF_Layer_GetApplicationUsage(FSPDF_LAYER layer, FS_INT32 usageType, FS_LPVOID param);


FS_RESULT       FSPDF_Layer_EnumeratePageObject(FSPDF_LAYER layer, FSCRT_PAGE page, FSCRT_POSITION* position, FSPDF_PAGEOBJECT* pageObj);


/*******************************************************************************/
/* Definition and Functions for PDF Layer Context                              */
/*******************************************************************************/

FS_RESULT       FSPDF_LayerContext_Create(FSCRT_DOCUMENT document, FS_INT32 usType, FSPDF_LAYERCONTEXT* context);

FS_RESULT       FSPDF_LayerContext_Release(FSPDF_LAYERCONTEXT context);

FS_RESULT       FSPDF_LayerContext_GetDocument(FSPDF_LAYERCONTEXT context, FSCRT_DOCUMENT* document);

FS_RESULT       FSPDF_LayerContext_GetUsageType(FSPDF_LAYERCONTEXT context, FS_INT32* usType);

FS_RESULT       FSPDF_LayerContext_Reset(FSPDF_LAYERCONTEXT context);

FS_RESULT       FSPDF_LayerContext_CopyStates(FSPDF_LAYERCONTEXT destContext,  FSPDF_LAYERCONTEXT srcContext);

FS_RESULT       FSPDF_LayerContext_MergeStates(FSPDF_LAYERCONTEXT destContext, FSPDF_LAYERCONTEXT srcContext);

FS_RESULT       FSPDF_LayerContext_IsVisible(FSPDF_LAYERCONTEXT context, FSPDF_LAYER layer, FS_BOOL* visible);

FS_RESULT       FSPDF_LayerContext_SetVisible(FSPDF_LAYERCONTEXT context, FSPDF_LAYER layer, FS_BOOL visible);

#ifdef __cplusplus
};
#endif
 /* group FPDLAYER */

#endif /* _FSPDF_LAYER_R_H_ */