fpdfview.h File Reference

Header file for the view module - to render PDF documents and obtain basic PDF information. More...

Go to the source code of this file.

Classes

struct  FPDF_FILEACCESS
struct  FPDF_GLYPHPROVIDER
 Define an interface for generating glyph bitmaps. This interface does not exist on desktop Windows system. But on alternative systems, including mobile system, this interface must be implemented in order to display non-embedded non-western fonts, like Chinese/Japanese/Korean characters. To make use of a glyph provider, call FPDF_SetGlyphProvider function. More...

Defines

#define DLLEXPORT
#define STDCALL
#define CDECL
#define FPDFERR_OUT_OF_MEMORY   1
#define FPDFERR_MISSING_FEATURE   2
Last error code
#define FPDF_ERR_SUCCESS   0
 No error.
#define FPDF_ERR_UNKNOWN   1
 Unknown error.
#define FPDF_ERR_FILE   2
 Unknown error.
#define FPDF_ERR_FORMAT   3
 File not found or could not be opened.
#define FPDF_ERR_PASSWORD   4
 Password required or incorrect password.
#define FPDF_ERR_SECURITY   5
 Unsupported security scheme.
#define FPDF_ERR_PAGE   6
 Page not found or content error.
The result of the process which check linearized to be rendered.
#define FPDF_ANNOT   0x01
#define FPDF_LCD_TEXT   0x02
#define FPDF_NO_NATIVETEXT   0x04
#define FPDF_GRAYSCALE   0x08
#define FPDF_DEBUG_INFO   0x80
#define FPDF_NO_CATCH   0x100
More DIB formats
#define FPDFBitmap_Gray   1
#define FPDFBitmap_BGR   2
#define FPDFBitmap_BGRx   3
#define FPDFBitmap_BGRA   4
Bookmark font styles
#define PDFBOOKMARK_NORMAL   0
 NORMAL.
#define PDFBOOKMARK_ITALIC   1
 ITALIC.
#define PDFBOOKMARK_BOLD   2
 BOLD.
#define PDFBOOKMARK_BOLDITALIC   3
 BOLD ITALIC.
Action styles
#define PDFACTION_UNSUPPORTED   0
 Unsupported action type.
#define PDFACTION_GOTO   1
 Go to a destination within current document.
#define PDFACTION_REMOTEGOTO   2
 Go to a destination within another document.
#define PDFACTION_URI   3
 Universal Resource Identifier, including web pages and other Internet based resources.
#define PDFACTION_LAUNCH   4
 Launch an application or open a file.
Zoom modes
#define PDFZOOM_XYZ   1
 Zoom level with specified offset.
#define PDFZOOM_FITPAGE   2
 Fit both the width and height of the page (whichever smaller).
#define PDFZOOM_FITHORZ   3
 Fit the page width.
#define PDFZOOM_FITVERT   4
 Fit the page height.
#define PDFZOOM_FITRECT   5
 Fit a specific rectangle area within the window.
#define PDFZOOM_FITBBOX   6
 Fit the bounding box entirely within the window both horizontally and vertically.
#define PDFZOOM_FITBHORZ   7
 The contents of the page magnified just enough to fit the entire width of its bounding box within the window.
#define PDFZOOM_FITBVERT   8
 The contents of the page magnified just enough to fit the entire height of its bounding box within the window.

Typedefs

typedef void * FPDF_MODULEMGR
typedef void * FPDF_DOCUMENT
typedef void * FPDF_PAGE
typedef void * FPDF_PAGEOBJECT
typedef void * FPDF_PATH
typedef void * FPDF_CLIPPATH
typedef void * FPDF_BITMAP
typedef void * FPDF_FONT
typedef void * FPDF_TEXTPAGE
typedef void * FPDF_SCHHANDLE
typedef void * FPDF_PAGELINK
typedef void * FPDF_HMODULE
typedef void * FPDF_DOCSCHHANDLE
typedef void * FPDF_BOOKMARK
typedef void * FPDF_DEST
typedef void * FPDF_ACTION
typedef void * FPDF_LINK
typedef int FPDF_BOOL
typedef int FPDF_ERROR
typedef unsigned long FPDF_DWORD
typedef unsigned short FPDF_WORD
typedef unsigned char FPDF_BYTE
typedef unsigned short FPDF_WCHAR
typedef unsigned char const * FPDF_LPCBYTE
typedef const char * FPDF_BYTESTRING
typedef const unsigned short * FPDF_WIDESTRING
typedef const char * FPDF_STRING
typedef void(* FPDF_ENUMPAGESIZEPROC )(int page_index, double width, double height)
typedef void(* FPDF_ErrorHandler )(int code, FPDF_BYTESTRING msg)

Functions

DLLEXPORT void STDCALL FPDF_InitLibrary (void *hInstance)
DLLEXPORT FPDF_MODULEMGR STDCALL FPDF_GetModuleMgr ()
DLLEXPORT void STDCALL FPDF_DestroyLibrary ()
DLLEXPORT void STDCALL FPDF_UnlockDLL (FPDF_BYTESTRING license_id, FPDF_BYTESTRING unlock_code)
DLLEXPORT FPDF_DOCUMENT STDCALL FPDF_LoadDocument (FPDF_STRING file_path, FPDF_BYTESTRING password)
DLLEXPORT FPDF_DOCUMENT STDCALL FPDF_LoadMemDocument (const void *data_buf, int size, FPDF_BYTESTRING password)
DLLEXPORT FPDF_DOCUMENT STDCALL FPDF_LoadCustomDocument (FPDF_FILEACCESS *pFileAccess, FPDF_BYTESTRING password)
DLLEXPORT unsigned long STDCALL FPDF_GetLastError ()
DLLEXPORT unsigned long STDCALL FPDF_GetDocPermissions (FPDF_DOCUMENT document)
DLLEXPORT int STDCALL FPDF_GetPageCount (FPDF_DOCUMENT document)
DLLEXPORT FPDF_PAGE STDCALL FPDF_LoadPage (FPDF_DOCUMENT document, int page_index)
DLLEXPORT double STDCALL FPDF_GetPageWidth (FPDF_PAGE page)
DLLEXPORT double STDCALL FPDF_GetPageHeight (FPDF_PAGE page)
DLLEXPORT int STDCALL FPDF_GetPageSizeByIndex (FPDF_DOCUMENT document, int page_index, double *width, double *height)
DLLEXPORT void STDCALL FPDF_EnumPageSize (FPDF_DOCUMENT document, FPDF_ENUMPAGESIZEPROC callback)
DLLEXPORT void STDCALL FPDF_RenderPageBitmap (FPDF_BITMAP bitmap, FPDF_PAGE page, int start_x, int start_y, int size_x, int size_y, int rotate, int flags)
DLLEXPORT void STDCALL FPDF_QuickDrawPage (FPDF_BITMAP bitmap, FPDF_PAGE page, int start_x, int start_y, int size_x, int size_y, int rotate, int flags)
DLLEXPORT void STDCALL FPDF_ClosePage (FPDF_PAGE page)
DLLEXPORT void STDCALL FPDF_CloseDocument (FPDF_DOCUMENT document)
DLLEXPORT void STDCALL FPDF_DeviceToPage (FPDF_PAGE page, int start_x, int start_y, int size_x, int size_y, int rotate, int device_x, int device_y, double *page_x, double *page_y)
DLLEXPORT void STDCALL FPDF_PageToDevice (FPDF_PAGE page, int start_x, int start_y, int size_x, int size_y, int rotate, double page_x, double page_y, int *device_x, int *device_y)
DLLEXPORT FPDF_BITMAP STDCALL FPDFBitmap_Create (int width, int height, int alpha)
DLLEXPORT FPDF_BITMAP STDCALL FPDFBitmap_CreateEx (int width, int height, int format, void *first_scan, int stride)
DLLEXPORT void STDCALL FPDFBitmap_FillRect (FPDF_BITMAP bitmap, int left, int top, int width, int height, int red, int green, int blue, int alpha)
DLLEXPORT void *STDCALL FPDFBitmap_GetBuffer (FPDF_BITMAP bitmap)
DLLEXPORT int STDCALL FPDFBitmap_GetWidth (FPDF_BITMAP bitmap)
DLLEXPORT int STDCALL FPDFBitmap_GetHeight (FPDF_BITMAP bitmap)
DLLEXPORT int STDCALL FPDFBitmap_GetStride (FPDF_BITMAP bitmap)
DLLEXPORT void STDCALL FPDFBitmap_Destroy (FPDF_BITMAP bitmap)
DLLEXPORT void *STDCALL FPDF_AllocMemory (unsigned long size)
DLLEXPORT void STDCALL FPDF_FreeMemory (void *p)
DLLEXPORT void STDCALL FPDF_SetErrorHandler (FPDF_ErrorHandler func)
DLLEXPORT void STDCALL FPDF_SetModulePath (FPDF_STRING module_name, FPDF_STRING folder_name)
DLLEXPORT void STDCALL FPDF_SetGlyphProvider (FPDF_GLYPHPROVIDER *pProvider)
DLLEXPORT int STDCALL FPDF_SetSystemFontFile (FPDF_BYTESTRING file_path)
DLLEXPORT FPDF_BOOKMARK STDCALL FPDFBookmark_GetFirstChild (FPDF_DOCUMENT document, FPDF_BOOKMARK bookmark)
DLLEXPORT FPDF_BOOKMARK STDCALL FPDFBookmark_GetNextSibling (FPDF_DOCUMENT document, FPDF_BOOKMARK bookmark)
DLLEXPORT FPDF_BOOKMARK STDCALL FPDFBookmark_Find (FPDF_DOCUMENT document, FPDF_WIDESTRING title)
DLLEXPORT unsigned long STDCALL FPDFBookmark_GetColorRef (FPDF_BOOKMARK bookmark)
DLLEXPORT unsigned long STDCALL FPDFBookmark_GetFontStyle (FPDF_BOOKMARK bookmark)
DLLEXPORT unsigned long STDCALL FPDFBookmark_GetTitle (FPDF_BOOKMARK bookmark, void *buffer, unsigned long buflen)
DLLEXPORT FPDF_ACTION STDCALL FPDFBookmark_GetAction (FPDF_BOOKMARK bookmark)
DLLEXPORT FPDF_DEST STDCALL FPDFBookmark_GetDest (FPDF_DOCUMENT document, FPDF_BOOKMARK bookmark)
DLLEXPORT int STDCALL FPDFBookmark_GetPageFirstLine (FPDF_PAGE page, void *buffer, int buflen)
DLLEXPORT unsigned long STDCALL FPDFAction_GetType (FPDF_ACTION action)
DLLEXPORT unsigned long STDCALL FPDFAction_GetFilePath (FPDF_ACTION action, void *buffer, unsigned long buflen)
DLLEXPORT FPDF_DEST STDCALL FPDFAction_GetDest (FPDF_DOCUMENT document, FPDF_ACTION action)
DLLEXPORT unsigned long STDCALL FPDFAction_GetURIPath (FPDF_DOCUMENT document, FPDF_ACTION action, void *buffer, unsigned long buflen)
DLLEXPORT unsigned long STDCALL FPDFDest_GetPageIndex (FPDF_DOCUMENT document, FPDF_DEST dest)
DLLEXPORT unsigned long STDCALL FPDFDest_GetZoomMode (FPDF_DEST dest)
DLLEXPORT double STDCALL FPDFDest_GetZoomParam (FPDF_DEST dest, int param)
DLLEXPORT FPDF_LINK STDCALL FPDFLink_GetLinkAtPoint (FPDF_PAGE page, double x, double y)
DLLEXPORT FPDF_DEST STDCALL FPDFLink_GetDest (FPDF_DOCUMENT document, FPDF_LINK link)
DLLEXPORT FPDF_ACTION STDCALL FPDFLink_GetAction (FPDF_LINK link)
DLLEXPORT unsigned long STDCALL FPDF_GetMetaText (FPDF_DOCUMENT doc, FPDF_BYTESTRING tag, void *buffer, unsigned long buflen)
 _WIN32_WCE

Detailed Description

Header file for the view module - to render PDF documents and obtain basic PDF information.

(C) 2011 Foxit Corporation. All Rights Reserved. The following code is copyrighted and contains proprietary information and trade secrets of Foxit Corporation. Functions in this header file, require "view" module to be enabled in your SDK license.

Author:
Foxit Corporation
Note:
If you want to purchase Foxit PDF SDK license and use ANY of the following functions, please request for enabling view module explicitly.
Version:
3.1.1