fpdfeditbase.h

Go to the documentation of this file.

#ifndef _FPDFEDITBASE_H_
#define _FPDFEDITBASE_H_
#include "fpdfview.h"
#ifdef _WIN32

#define DLLEXPORT __declspec( dllexport )
#define STDCALL __stdcall
#define CDECL   _cdecl
#else
#define DLLEXPORT
#define STDCALL
#define CDECL
#endif

#ifdef __cplusplus
extern "C" {
#endif

#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))


#ifndef UNICODE
        #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
#else
        #define FPDF_SetMetaText                                FPDF_SetMetaTextW
        #define FPDF_VIEWERREF_SetUI                    FPDF_VIEWERREF_SetUIW
        #define FPDF_VIEWERREF_PrintScaling             FPDF_VIEWERREF_PrintScalingW
        #define FPDFAction_SetFilePath                  FPDFAction_SetFilePathW
        #define FPDFBookmark_AddBookmark                FPDFBookmark_AddBookmarkW
        #define FPDFBookmark_SetTitle                   FPDFBookmark_SetTitleW
#endif


DLLEXPORT FPDF_DOCUMENT STDCALL FPDF_CreateNewDocument();



#define FPDF_PERM_PRINT                         0x0004

#define FPDF_PERM_MODIFY                        0x0008

#define FPDF_PERM_EXTRACT                       0x0010

#define FPDF_PERM_ANNOT_FORM            0x0020

#define FPDF_PERM_FILL_FORM                     0x0100

#define FPDF_PERM_EXTRACT_ACCESS        0x0200

#define FPDF_PERM_ASSEMBLE                      0x0400

#define FPDF_PERM_PRINT_HIGH            0x0800

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);



struct FPDF_FILEWRITE{

        int version;

        int (CDECL *WriteBlock)( FPDF_FILEWRITE* pThis, const void* pData, unsigned long size);
        
};


#define FPDF_INCREMENTAL                1

#define FPDF_NO_INCREMENTAL             2





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);


#define FPDF_RECT_PAGE                          0

#define FPDF_RECT_BOUNDING                      1

#define FPDF_RECT_MEDIABOX                      2

#define FPDF_RECT_CROPBOX                       3

#define FPDF_RECT_TRIMBOX                       4

#define FPDF_RECT_ARTBOX                        5

#define FPDF_RECT_BLEEDBOX                      6

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);


#define PDFACTION_UNSUPPORTED           0

#define PDFACTION_GOTO                          1

#define PDFACTION_REMOTEGOTO            2

#define PDFACTION_URI                           3

#define PDFACTION_LAUNCH                        4

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);



#define PDFZOOM_XYZ                             1

#define PDFZOOM_FITPAGE                 2

#define PDFZOOM_FITHORZ                 3

#define PDFZOOM_FITVERT                 4

#define PDFZOOM_FITRECT                 5

#define PDFZOOM_FITBBOX                 6

#define PDFZOOM_FITBHORZ                7

#define PDFZOOM_FITBVERT                8

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);


#define FONTNORMAL                      0x00

#define FONTITALIC                      0x01

#define FONTBOLD                        0x02

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);

#define FPDF_RECT_PAGE                  0

#define FPDF_RECT_BOUNDING              1

#define FPDF_RECT_MEDIABOX              2

#define FPDF_RECT_CROPBOX               3

#define FPDF_RECT_TRIMBOX               4

#define FPDF_RECT_ARTBOX                5

#define FPDF_RECT_BLEEDBOX              6

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);


#define FPDF_PAGEOBJ_TEXT               1

#define FPDF_PAGEOBJ_PATH               2

#define FPDF_PAGEOBJ_IMAGE              3

#define FPDF_PAGEOBJ_SHADING    4

#define FPDF_PAGEOBJ_FORM               5

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);



#define FPDF_FILL_NULL                  0

#define FPDF_FILL_ALTERNATE             1

#define FPDF_FILL_WINDING               2

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);


#define FPDF_LINECAP_BUTT               0

#define FPDF_LINECAP_ROUND              1

#define FPDF_LINECAP_PROJECT    2

DLLEXPORT int STDCALL FPDFPageObj_GetLineCapStyle(FPDF_PAGEOBJECT page_object);


DLLEXPORT void STDCALL FPDFPageObj_SetLineCapStyle(FPDF_PAGEOBJECT page_object, int style);


#define FPDF_LINEJOIN_MITER             0

#define FPDF_LINEJOIN_ROUND             1

#define FPDF_LINEJOIN_BEVEL             2

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);


#ifdef __cplusplus
};
#endif


#endif