fpdf_layer_r.h File Reference

Header file for PDF Page Objects module of Foxit PDF SDK. More...

Go to the source code of this file.

Classes

struct  FSPDF_LAYER
 Handle type to PDF layer. More...
 
struct  FSPDF_LAYERNODE
 Structure for PDF layer nodes. More...
 
struct  FSPDF_LAYERUSAGE_ZOOMDATA
 Param structure for PDF layer zoom usage. More...
 
struct  FSPDF_LAYERUSAGE_PRINTDATA
 Param structure for PDF layer print usage. More...
 

Macros

Macro definitions of Layer Usage Types.
#define FSPDF_LAYERUSAGETYPE_VIEW   0
 Use for a viewer.
 
#define FSPDF_LAYERUSAGETYPE_DESIGN   1
 Use to represent a document designer's structural organization of artwork.
 
#define FSPDF_LAYERUSAGETYPE_PRINT   2
 Use for printing.
 
#define FSPDF_LAYERUSAGETYPE_EXPORT   3
 Use for exporting.
 
#define FSPDF_LAYERUSAGETYPE_ZOOM   4
 Use for zooming.
 
Macro definitions of Layer base state.
#define FSPDF_LAYER_BASESTATE_ON   0
 The states of all groups are turned ON.
 
#define FSPDF_LAYER_BASESTATE_OFF   1
 The states of all groups are turned OFF.
 
#define FSPDF_LAYER_BASESTATE_UNCHANGED   2
 The states of all groups are left unchanged.
 

Functions

FS_RESULT FSPDF_LayerNode_Init (FSPDF_LAYERNODE *layers)
 Helper function to initialize a PDF layer node. More...
 
FS_RESULT FSPDF_LayerNode_Clear (FSPDF_LAYERNODE *layers)
 Helper function to clear a PDF layer node. More...
 
FS_RESULT FSPDF_Doc_EnumLayers (FSCRT_DOCUMENT document, FSPDF_LAYERNODE *layers)
 Enum all PDF Layers. More...
 
FS_RESULT FSPDF_Layer_GetName (FSPDF_LAYER layer, FSCRT_BSTR *name)
 Get the name of a PDF layer. More...
 
FS_RESULT FSPDF_Layer_IsInPage (FSCRT_PAGE page, FSPDF_LAYER layer, FS_BOOL *isInPage)
 Check whether a PDF layer is in a given page or not. More...
 
FS_RESULT FSPDF_Layer_HasIntent (FSPDF_LAYER layer, const FSCRT_BSTR *intent, FS_BOOL *hasIntent)
 Check whether a PDF layer has a specific intent. More...
 
FS_RESULT FSPDF_Layer_GetApplicationUsage (FSPDF_LAYER layer, FS_INT32 usageType, FS_LPVOID param)
 Get the application usage and its parameter of a PDF layer. More...
 
FS_RESULT FSPDF_Layer_EnumeratePageObject (FSPDF_LAYER layer, FSCRT_PAGE page, FSCRT_POSITION *position, FSPDF_PAGEOBJECT *pageObj)
 Enumerate page objects and retrieve a page object which is related with a specific layer. More...
 
FS_RESULT FSPDF_LayerContext_Create (FSCRT_DOCUMENT document, FS_INT32 usType, FSPDF_LAYERCONTEXT *context)
 Create a PDF layer context with a given type. More...
 
FS_RESULT FSPDF_LayerContext_Release (FSPDF_LAYERCONTEXT context)
 Release a PDF layer context. More...
 
FS_RESULT FSPDF_LayerContext_GetDocument (FSPDF_LAYERCONTEXT context, FSCRT_DOCUMENT *document)
 Retrieve a PDF document which owns a PDF layer context. More...
 
FS_RESULT FSPDF_LayerContext_GetUsageType (FSPDF_LAYERCONTEXT context, FS_INT32 *usType)
 Get usage type of a PDF layer context. More...
 
FS_RESULT FSPDF_LayerContext_Reset (FSPDF_LAYERCONTEXT context)
 Reset a PDF layer context. More...
 
FS_RESULT FSPDF_LayerContext_CopyStates (FSPDF_LAYERCONTEXT destContext, FSPDF_LAYERCONTEXT srcContext)
 Copy a PDF layer context state from another PDF layer context. More...
 
FS_RESULT FSPDF_LayerContext_MergeStates (FSPDF_LAYERCONTEXT destContext, FSPDF_LAYERCONTEXT srcContext)
 Merge state from source PDF layer context to destination. More...
 
FS_RESULT FSPDF_LayerContext_IsVisible (FSPDF_LAYERCONTEXT context, FSPDF_LAYER layer, FS_BOOL *visible)
 Check whether a PDF layer is visible or not. More...
 
FS_RESULT FSPDF_LayerContext_SetVisible (FSPDF_LAYERCONTEXT context, FSPDF_LAYER layer, FS_BOOL visible)
 Change the visibility state of a PDF layer. More...
 

Detailed Description

Header file for PDF Page Objects module of Foxit PDF SDK.

Copyright (C) 2003-2016, Foxit Software Inc.. All Rights Reserved.

http://www.foxitsoftware.com

The following code is copyrighted and contains proprietary information and trade secrets of Foxit Software Inc.. You cannot distribute any part of Foxit PDF SDK to any third party or general public, unless there is a separate license agreement with Foxit Software Inc. which explicitly grants you such rights.

This header file defines PDF layer related functionalities.
It contains:

  • 1. Create and release PDF layer context.
  • 2. Retrieve document and layer context type.
  • 3. Reset, copy and merge layer context.
  • 4. Get and set visibility of layer context.
  • 5. Enumerate all layers.
  • 6. Get properties of a layer.
Note
If you want to purchase Foxit PDF SDK license and use ANY of the following functions, please request for enabling Standard module explicitly.

Foxit Corporation