Header file for the Ebase module - provides the base functions for document editing. More...
#include "fpdfview.h"Go to the source code of this file.
Classes | |
| struct | FPDF_FILEWRITE |
| Structure for custom file write. More... | |
Defines | |
| #define | DLLEXPORT |
| #define | STDCALL |
| #define | CDECL |
| #define | FPDF_ARGB(a, r, g, b) ((((FPDF_DWORD)(((FPDF_BYTE)(b)|((FPDF_WORD)((FPDF_BYTE)(g))<<8))|(((FPDF_DWORD)(FPDF_BYTE)(r))<<16)))) | (((FPDF_DWORD)(FPDF_BYTE)(a))<<24)) |
| #define | FPDF_GetBValue(argb) ((FPDF_BYTE)(argb)) |
| #define | FPDF_GetGValue(argb) ((FPDF_BYTE)(((FPDF_DWORD)(argb)) >> 8)) |
| #define | FPDF_GetRValue(argb) ((FPDF_BYTE)((argb)>>16)) |
| #define | FPDF_GetAValue(argb) ((FPDF_BYTE)((argb)>>24)) |
| #define | FPDF_SetMetaText FPDF_SetMetaTextA |
| #define | FPDF_VIEWERREF_SetUI FPDF_VIEWERREF_SetUIA |
| #define | FPDF_VIEWERREF_PrintScaling FPDF_VIEWERREF_PrintScalingA |
| #define | FPDFAction_SetFilePath FPDFAction_SetFilePathA |
| #define | FPDFBookmark_AddBookmark FPDFBookmark_AddBookmarkA |
| #define | FPDFBookmark_SetTitle FPDFBookmark_SetTitleA |
| #define | FPDF_INCREMENTAL 1 |
| Incremental. | |
| #define | FPDF_NO_INCREMENTAL 2 |
| No Incremental. | |
PDF document permissions, according to PDF Reference, Table 3.20 | |
| #define | FPDF_PERM_PRINT 0x0004 |
| bit 3. Print the document. | |
| #define | FPDF_PERM_MODIFY 0x0008 |
| bit 4. Modify the contents of the document by operations other than those controlled by bits 6, 9, and 11. | |
| #define | FPDF_PERM_EXTRACT 0x0010 |
| bit 5. Copy or otherwise extract text and graphics from the document by operations other than that is controlled by bit 10. | |
| #define | FPDF_PERM_ANNOT_FORM 0x0020 |
| bit 6. Add or modify text annotations and fill in interactive form fields.If bit 4 is also set, create or modify interactive form fields | |
| #define | FPDF_PERM_FILL_FORM 0x0100 |
| bit 9. Fill in existing interactive form fields (including signature fields), even if bit 6 is clear. | |
| #define | FPDF_PERM_EXTRACT_ACCESS 0x0200 |
| bit 10. Extract text and graphics. | |
| #define | FPDF_PERM_ASSEMBLE 0x0400 |
| bit 11. Assemble the document, even if bit 4 is clear. | |
| #define | FPDF_PERM_PRINT_HIGH 0x0800 |
| bit 12. Print the document to a representation, which a faithful digital copy of the PDF content could be generated. | |
Index values for getting boxes, used in xxx_GetRectangle and xxx_GetBBox functions. | |
| #define | FPDF_RECT_PAGE 0 |
| The visible rectangle. | |
| #define | FPDF_RECT_BOUNDING 1 |
| The bounding box of the all object in this page. | |
| #define | FPDF_RECT_MEDIABOX 2 |
| The boundaries of the physical medium on which the page is to be printed. | |
| #define | FPDF_RECT_CROPBOX 3 |
| The region to which the contents of the page are to be clipped (cropped) when displayed or printed. | |
| #define | FPDF_RECT_TRIMBOX 4 |
| The region to which the contents of the page should be clipped when output in a production environment. | |
| #define | FPDF_RECT_ARTBOX 5 |
| The intended dimensions of the finished page after trimming. | |
| #define | FPDF_RECT_BLEEDBOX 6 |
| The extent of the page's meaningful content (including potential white space) as intended by the page's creator. | |
| #define | FPDF_RECT_PAGE 0 |
| The visible rectangle. | |
| #define | FPDF_RECT_BOUNDING 1 |
| The bounding box of the all object in this page. | |
| #define | FPDF_RECT_MEDIABOX 2 |
| The boundaries of the physical medium on which the page is to be printed. | |
| #define | FPDF_RECT_CROPBOX 3 |
| The region to which the contents of the page are to be clipped (cropped) when displayed or printed. | |
| #define | FPDF_RECT_TRIMBOX 4 |
| The region to which the contents of the page should be clipped when output in a production environment. | |
| #define | FPDF_RECT_ARTBOX 5 |
| The intended dimensions of the finished page after trimming. | |
| #define | FPDF_RECT_BLEEDBOX 6 |
| The extent of the page's meaningful content (including potential white space) as intended by the page's creator. | |
Flags for Action type | |
| #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. | |
Flags for 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. | |
Flags for Bookmark Font Style | |
| #define | FONTNORMAL 0x00 |
| Normal typeface. | |
| #define | FONTITALIC 0x01 |
| Italic. | |
| #define | FONTBOLD 0x02 |
| Bold. | |
The page object constants. | |
| #define | FPDF_PAGEOBJ_TEXT 1 |
| Text object. | |
| #define | FPDF_PAGEOBJ_PATH 2 |
| Path object. | |
| #define | FPDF_PAGEOBJ_IMAGE 3 |
| Image object. | |
| #define | FPDF_PAGEOBJ_SHADING 4 |
| Shading object. | |
| #define | FPDF_PAGEOBJ_FORM 5 |
| From object. | |
Fill mode types | |
| #define | FPDF_FILL_NULL 0 |
| No fill color. | |
| #define | FPDF_FILL_ALTERNATE 1 |
| Represents a fill mode in which the system fills the area between odd-numbered and even-numbered polygon sides on each scan line. | |
| #define | FPDF_FILL_WINDING 2 |
| Represents a fill mode in which the system uses the direction in which a figure was drawn to determine whether to fill the area. | |
Line cap styles | |
| #define | FPDF_LINECAP_BUTT 0 |
| The stroke is squared off at the endpoint of the path. There is no projection beyond the end of the path. | |
| #define | FPDF_LINECAP_ROUND 1 |
| A semicircular arc with a diameter equal to the line width is drawn around the endpoint and filled in. | |
| #define | FPDF_LINECAP_PROJECT 2 |
| The stroke continues beyond the endpoint of the path for a distance equal to half the line width and is squared off. | |
Line join styles | |
| #define | FPDF_LINEJOIN_MITER 0 |
| The outer edges of the strokes for the two segments are extended until they meet at an angle. | |
| #define | FPDF_LINEJOIN_ROUND 1 |
| An arc of a circle with a diameter equal to the line width is drawn around the point where the two segments meet, connecting the outer edges of the strokes for the two segments. | |
| #define | FPDF_LINEJOIN_BEVEL 2 |
| The two segments are finished with butt caps and the resulting notch beyond the ends of the segments is filled with a triangle. | |
Functions | |
| DLLEXPORT FPDF_DOCUMENT STDCALL | FPDF_CreateNewDocument () |
| DLLEXPORT FPDF_BOOL STDCALL | FPDF_SaveAsFile (FPDF_DOCUMENT document, char *file_name, FPDF_DWORD permissions, FPDF_LPCBYTE UserPwd, long nUserPwdLen, FPDF_LPCBYTE OwnerPwd, long nOwnerPwdLen) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDF_SaveDocument (FPDF_DOCUMENT document, FPDF_FILEWRITE *pFileWrite, FPDF_DWORD permissions, FPDF_LPCBYTE UserPwd, long nUserPwdLen, FPDF_LPCBYTE OwnerPwd, long nOwnerPwdLen, FPDF_DWORD flags) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDF_SaveAsCopy (FPDF_DOCUMENT document, FPDF_FILEWRITE *pFileWrite, FPDF_DWORD flags) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDF_SetMetaTextA (FPDF_DOCUMENT document, FPDF_BYTESTRING tag, FPDF_BYTESTRING value) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDF_SetMetaTextW (FPDF_DOCUMENT document, FPDF_WIDESTRING tag, FPDF_WIDESTRING value) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDF_VIEWERREF_GetUIA (FPDF_DOCUMENT document, FPDF_BYTESTRING tag) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDF_VIEWERREF_GetUIW (FPDF_DOCUMENT document, FPDF_BYTESTRING tag) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDF_VIEWERREF_SetUIA (FPDF_DOCUMENT document, FPDF_BYTESTRING tag, FPDF_BOOL value) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDF_VIEWERREF_SetUIW (FPDF_DOCUMENT document, FPDF_WIDESTRING tag, FPDF_BOOL value) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDF_VIEWERREF_ViewArea (FPDF_DOCUMENT document, int nRectType) |
| DLLEXPORT void STDCALL | FPDF_VIEWERREF_GetPrintPageRange (FPDF_DOCUMENT document, int *from, int *to) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDF_VIEWERREF_SetPrintPageRange (FPDF_DOCUMENT document, int from, int to) |
| DLLEXPORT int STDCALL | FPDF_VIEWERREF_GetNumCoipes (FPDF_DOCUMENT document) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDF_VIEWERREF_SetNumCoipes (FPDF_DOCUMENT document, int value) |
| DLLEXPORT int STDCALL | FPDF_VIEWERREF_GetPrintClip (FPDF_DOCUMENT document) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDF_VIEWERREF_SetPrintClip (FPDF_DOCUMENT document, int nRectType) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDF_VIEWERREF_PrintScalingA (FPDF_DOCUMENT document, FPDF_BYTESTRING value) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDF_VIEWERREF_PrintScalingW (FPDF_DOCUMENT document, FPDF_WIDESTRING value) |
| DLLEXPORT int STDCALL | FPDF_VIEWERREF_GetPrintArea (FPDF_DOCUMENT document) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDF_VIEWERREF_SetPrintArea (FPDF_DOCUMENT document, int nRectType) |
| DLLEXPORT FPDF_ACTION STDCALL | FPDF_CreateAction (FPDF_DOCUMENT document, int actiontype) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDF_DeleteAction (FPDF_ACTION action) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDFAction_SetFilePathA (FPDF_ACTION action, FPDF_BYTESTRING pFilePath, FPDF_BOOL bURL) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDFAction_SetFilePathW (FPDF_ACTION action, FPDF_WIDESTRING pFilePath, FPDF_BOOL bURL) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDFAction_SetURI (FPDF_ACTION action, FPDF_BYTESTRING csURI) |
| DLLEXPORT unsigned long STDCALL | FPDFAction_GetURI (FPDF_DOCUMENT document, FPDF_ACTION action, void *buffer, unsigned long buflen) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDFAction_SetDest (FPDF_ACTION action, FPDF_DEST dest) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDFDest_SetPageIndex (FPDF_DOCUMENT document, FPDF_DEST dest, int page_index) |
| DLLEXPORT FPDF_DEST STDCALL | FPDF_CreateDest (int mode) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDF_DeleteDest (FPDF_DEST dest) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDFDest_SetZoomMode (FPDF_DEST dest, int mode) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDFDest_SetXYZParam (FPDF_DEST dest, double x, double y, double z) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDFDest_SetFITHORZParam (FPDF_DEST dest, double param) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDFDest_SetFITVERTParam (FPDF_DEST dest, double param) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDFDest_SetFitRectParam (FPDF_DEST dest, double left, double bottom, double right, double top) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDFDest_SetFitBHorzParam (FPDF_DEST dest, double param) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDFDest_SetFitBVertParam (FPDF_DEST dest, double param) |
| DLLEXPORT FPDF_BOOKMARK STDCALL | FPDFBookmark_AddBookmarkA (FPDF_DOCUMENT document, FPDF_BOOKMARK parent, FPDF_BOOKMARK InsterAfter, FPDF_BYTESTRING titlename) |
| DLLEXPORT FPDF_BOOKMARK STDCALL | FPDFBookmark_AddBookmarkW (FPDF_DOCUMENT document, FPDF_BOOKMARK parent, FPDF_BOOKMARK InsterAfter, FPDF_WIDESTRING titlename) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDFBookmark_DeleteBookmark (FPDF_DOCUMENT document, FPDF_BOOKMARK bookmark) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDFBookmark_SetTitleA (FPDF_BOOKMARK bookmark, FPDF_BYTESTRING titlename) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDFBookmark_SetTitleW (FPDF_BOOKMARK bookmark, FPDF_WIDESTRING titlename) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDFBookmark_SetColorRef (FPDF_BOOKMARK bookmark, unsigned long color) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDFBookmark_SetFontStyle (FPDF_BOOKMARK bookmark, unsigned long fontstyle) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDFBookmark_SetAction (FPDF_BOOKMARK bookmark, FPDF_ACTION action) |
| DLLEXPORT FPDF_PAGE STDCALL | FPDFPage_New (FPDF_DOCUMENT document, int page_index, double width, double height) |
| DLLEXPORT void STDCALL | FPDFPage_Delete (FPDF_DOCUMENT document, int page_index) |
| DLLEXPORT void STDCALL | FPDFPage_InsertObject (FPDF_PAGE page, FPDF_PAGEOBJECT page_obj) |
| DLLEXPORT void STDCALL | FPDFPage_DeleteObject (FPDF_PAGE page, int index) |
| DLLEXPORT int STDCALL | FPDFPage_CountObject (FPDF_PAGE page) |
| DLLEXPORT FPDF_PAGEOBJECT STDCALL | FPDFPage_GetObject (FPDF_PAGE page, int index) |
| DLLEXPORT int STDCALL | FPDFPage_GetPageObjectIndex (FPDF_PAGE page, FPDF_PAGEOBJECT page_obj) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDFPage_GenerateContent (FPDF_PAGE page) |
| DLLEXPORT void STDCALL | FPDFPageObj_Transform (FPDF_PAGEOBJECT page_object, double a, double b, double c, double d, double e, double f) |
| DLLEXPORT FPDF_PAGEOBJECT STDCALL | FPDFPageObj_Clone (FPDF_PAGEOBJECT page_object) |
| DLLEXPORT void STDCALL | FPDFPageObj_Free (FPDF_PAGEOBJECT page_object) |
| DLLEXPORT int STDCALL | FPDFPageObj_GetType (FPDF_PAGEOBJECT page_object) |
| DLLEXPORT void STDCALL | FPDFPageObj_GetBBox (FPDF_PAGEOBJECT page_object, double *left, double *bottom, double *right, double *top) |
| DLLEXPORT int STDCALL | FPDFPageObj_GetClipCount (FPDF_PAGEOBJECT page_object) |
| DLLEXPORT FPDF_PATH STDCALL | FPDFPageObj_GetClip (FPDF_PAGEOBJECT page_object, int index) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDFPageObj_AddClip (FPDF_PAGEOBJECT page_object, FPDF_PATH path, int type) |
| DLLEXPORT FPDF_BOOL STDCALL | FPDFPageObj_AppendPathToClip (FPDF_PAGEOBJECT page_object, FPDF_PATH path, int type) |
| DLLEXPORT void STDCALL | FPDFPageObj_RemoveClip (FPDF_PAGEOBJECT page_object, int index) |
| DLLEXPORT FPDF_DWORD STDCALL | FPDFPageObj_GetFillColor (FPDF_PAGEOBJECT page_object) |
| DLLEXPORT void STDCALL | FPDFPageObj_SetFillColor (FPDF_PAGEOBJECT page_object, FPDF_DWORD argb) |
| DLLEXPORT FPDF_DWORD STDCALL | FPDFPageObj_GetStrokeColor (FPDF_PAGEOBJECT page_object) |
| DLLEXPORT void STDCALL | FPDFPageObj_SetStrokeColor (FPDF_PAGEOBJECT page_object, FPDF_DWORD argb) |
| DLLEXPORT double STDCALL | FPDFPageObj_GetLineWidth (FPDF_PAGEOBJECT page_object) |
| DLLEXPORT void STDCALL | FPDFPageObj_SetLineWidth (FPDF_PAGEOBJECT page_object, double width) |
| DLLEXPORT int STDCALL | FPDFPageObj_GetLineCapStyle (FPDF_PAGEOBJECT page_object) |
| DLLEXPORT void STDCALL | FPDFPageObj_SetLineCapStyle (FPDF_PAGEOBJECT page_object, int style) |
| DLLEXPORT int STDCALL | FPDFPageObj_GetLineJoinStyle (FPDF_PAGEOBJECT page_object) |
| DLLEXPORT void STDCALL | FPDFPageObj_SetLineJoinStyle (FPDF_PAGEOBJECT page_object, int style) |
| DLLEXPORT double STDCALL | FPDFPageObj_GetMiterLimit (FPDF_PAGEOBJECT page_object) |
| DLLEXPORT void STDCALL | FPDFPageObj_SetMiterLimit (FPDF_PAGEOBJECT page_object, double miter_limit) |
| DLLEXPORT int STDCALL | FPDFPageObj_GetDashCount (FPDF_PAGEOBJECT page_object) |
| DLLEXPORT void STDCALL | FPDFPageObj_SetDashCount (FPDF_PAGEOBJECT page_object, int count) |
| DLLEXPORT double STDCALL | FPDFPageObj_GetDashArray (FPDF_PAGEOBJECT page_object, int index) |
| DLLEXPORT void STDCALL | FPDFPageObj_SetDashArray (FPDF_PAGEOBJECT page_object, int index, double dash_value) |
| DLLEXPORT double STDCALL | FPDFPageObj_GetDashPhase (FPDF_PAGEOBJECT page_object) |
| DLLEXPORT void STDCALL | FPDFPageObj_SetDashPhase (FPDF_PAGEOBJECT page_object, double phase_value) |
| _FPDFEDITBASE_H_ | |
Header file for the Ebase module - provides the base functions for document editing.
(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 "Ebase" module to be enabled in your SDK license.
