fpdf_page_r.h File Reference

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

Go to the source code of this file.

Macros

Macro Definitions for PDF Page Parsing Flags
Note
There are two PDF page parsing modes: one is normal, and the other one is for text only. Non-text objects in page will be omitted.
#define FSPDF_PAGEPARSEFLAG_NORMAL   0
 PDF page parsing flag for normal mode.
 
#define FSPDF_PAGEPARSEFLAG_TEXTONLY   1
 PDF page parsing flag for text-only mode.
 
Macro Definitions for Page Margin
Note
Currently Foxit PDF SDK supports two modes to calculate page margin:
1) analyzing bounding box of all page contents. 2) detecting paths for background and images.
#define FSPDF_PAGEMARGIN_CONTENTSBBOX   0
 Calculate margin according to bounding box of all contents.
 
#define FSPDF_PAGEMARGIN_DETECTION   1
 Calculate margin by detecting paths or images.
 
Macro Definitions for PDF Page Render Flags
Note
There are two PDF page render modes: one is normal, and the other one is for quick draw page content.
#define FSPDF_PAGERENDERFLAG_NORMAL   0
 PDF page render flag for normal mode.
 
#define FSPDF_PAGERENDERFLAG_QUICKDRAW   1
 PDF page parsing flag for quick draw mode.
 

Functions

FS_RESULT FSPDF_Page_StartParse (FSCRT_PAGE page, FS_DWORD flag, FSCRT_PROGRESS *parseProgress)
 Start parsing a PDF page. More...
 
FS_RESULT FSPDF_Page_IsParsed (FSCRT_PAGE page, FS_BOOL *isParsed)
 Determine whether page has been parsed or not. More...
 
FS_RESULT FSPDF_Page_Clear (FSCRT_PAGE page)
 Release all page contents and related resources. More...
 
FS_RESULT FSPDF_Page_GetIndex (FSCRT_PAGE page, FS_INT32 *index)
 Get page index. More...
 
FS_RESULT FSPDF_Page_GetSize (FSCRT_PAGE page, FS_FLOAT *width, FS_FLOAT *height)
 Get page size. More...
 
FS_RESULT FSPDF_Page_GetRotation (FSCRT_PAGE page, FS_INT32 *rotation)
 Get page rotation. More...
 
FS_RESULT FSPDF_Page_GetBox (FSCRT_PAGE page, FS_INT32 boxType, FSCRT_RECTF *pageBox)
 Get page boundary which is a rectangle type value. More...
 
FS_RESULT FSPDF_Page_GetDict (FSCRT_PAGE page, FSPDF_OBJECT *dictionary)
 Get the PDF page dictionary object. More...
 
FS_RESULT FSPDF_Page_EstimateContentSize (FSCRT_PAGE page, FS_DWORD *contentSize)
 Estimate the size of PDF page content. More...
 
FS_RESULT FSPDF_Page_HasTransparency (FSCRT_PAGE page, FS_BOOL *hasTransparency)
 Check whether a PDF page has transparency. More...
 
FS_RESULT FSPDF_Page_CountActions (FSCRT_PAGE page, FS_INT32 trigger, FS_INT32 *count)
 Count trigger actions of a PDF page. More...
 
FS_RESULT FSPDF_Page_GetAction (FSCRT_PAGE page, FS_INT32 trigger, FS_INT32 index, FSPDF_ACTIONDATA *actionData)
 Get a trigger action of a PDF page. More...
 
FS_RESULT FSPDF_Page_DoJavaScriptAction (FSCRT_PAGE page, FS_INT32 trigger)
 Perform the page javascript which is specified by the trigger. More...
 
FS_RESULT FSPDF_Page_GetMatrix (FSCRT_PAGE page, FS_INT32 x, FS_INT32 y, FS_INT32 width, FS_INT32 height, FS_INT32 rotation, FSCRT_MATRIX *matrix)
 Get page transformation matrix. More...
 
FS_RESULT FSPDF_Matrix_TransformPageToDevice (FSCRT_MATRIX *matrix, const FSCRT_RECTF *srcRect, const FSCRT_RECT *dstRect, FS_INT32 rotation)
 Get a transformation matrix from PDF page coordinate to device coordinate. More...
 
FS_RESULT FSPDF_Matrix_TransformDeviceToPage (FSCRT_MATRIX *matrix, const FSCRT_RECT *srcRect, const FSCRT_RECTF *dstRect, FS_INT32 rotation)
 Get a transformation matrix from device coordinate to PDF page coordinate. More...
 
FS_RESULT FSPDF_Page_CalcContentBBox (FSCRT_PAGE page, FS_INT32 mode, FSCRT_RECTF *rectBBox)
 Calculate content box rectangle in PDF page. More...
 
FS_RESULT FSPDF_Page_GetThumbnail (FSCRT_PAGE page, FSCRT_BITMAP *thumbnail)
 Get the thumbnail bitmap from a page. More...
 
FS_RESULT FSPDF_RenderContext_StartPage (FSPDF_RENDERCONTEXT pdfRenderContext, FSCRT_RENDERER renderer, FSCRT_PAGE page, FS_INT32 flag, FSCRT_PROGRESS *renderProgress)
 Start rendering a PDF page in a renderer with a PDF rendering context. More...
 

Detailed Description

Header file for PDF Page 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 provides direct access to PDF page.
It contains:

  • 1. Parse PDF page contents.
  • 2. Access PDF page attributes.
  • 3. Supports for page trigger actions.
  • 4. PDF page matrix process.
  • 5. Calculate page margin and render PDF page.
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