Make CJBig2_Object::operator delete accept nullptr
[pdfium.git] / public / fpdf_edit.h
1 // Copyright 2014 PDFium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4
5 // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
6
7 #ifndef PUBLIC_FPDF_EDIT_H_
8 #define PUBLIC_FPDF_EDIT_H_
9
10 #include <stdint.h>
11
12 #include "fpdfview.h"
13
14 // Define all types used in the SDK. Note they can be simply regarded as opaque pointers
15 // or long integer numbers.
16
17 #define FPDF_ARGB(a,r,g,b)      ((((uint32_t)(((uint8_t)(b)|((FX_WORD)((uint8_t)(g))<<8))|(((FX_DWORD)(uint8_t)(r))<<16)))) | (((FX_DWORD)(uint8_t)(a))<<24))
18 #define FPDF_GetBValue(argb)    ((uint8_t)(argb))
19 #define FPDF_GetGValue(argb)    ((uint8_t)(((uint16_t)(argb)) >> 8))
20 #define FPDF_GetRValue(argb)    ((uint8_t)((argb)>>16))
21 #define FPDF_GetAValue(argb)    ((uint8_t)((argb)>>24))
22
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26
27 //////////////////////////////////////////////////////////////////////
28 //
29 // Document functions
30 //
31 //////////////////////////////////////////////////////////////////////
32
33 // Function: FPDF_CreateNewDocument
34 //          Create a new PDF document.
35 // Parameters:
36 //          None.
37 // Return value:
38 //          A handle to a document. If failed, NULL is returned.
39 DLLEXPORT FPDF_DOCUMENT STDCALL FPDF_CreateNewDocument();
40
41 //////////////////////////////////////////////////////////////////////
42 //
43 // Page functions
44 //
45 //////////////////////////////////////////////////////////////////////
46
47 // Function: FPDFPage_New
48 //          Construct an empty page.
49 // Parameters:
50 //          document    -   Handle to document. Returned by FPDF_LoadDocument and FPDF_CreateNewDocument.
51 //          page_index  -   The index of a page.
52 //          width       -   The page width.
53 //          height      -   The page height.
54 // Return value:
55 //          The handle to the page.
56 // Comments:
57 //          Loaded page can be deleted by FPDFPage_Delete.
58 DLLEXPORT FPDF_PAGE STDCALL FPDFPage_New(FPDF_DOCUMENT document, int page_index, double width, double height);
59
60 // Function: FPDFPage_Delete
61 //          Delete a PDF page.
62 // Parameters:
63 //          document    -   Handle to document. Returned by FPDF_LoadDocument and FPDF_CreateNewDocument.
64 //          page_index  -   The index of a page.
65 // Return value:
66 //          None.
67 DLLEXPORT void STDCALL FPDFPage_Delete(FPDF_DOCUMENT document, int page_index);
68
69 // Function: FPDFPage_GetRotation
70 //          Get the page rotation. One of following values will be returned: 0(0), 1(90), 2(180), 3(270).
71 // Parameters:
72 //          page        -   Handle to a page. Returned by FPDFPage_New or FPDF_LoadPage.
73 // Return value:
74 //          The PDF page rotation.
75 // Comment:
76 //          The PDF page rotation is rotated clockwise.
77 DLLEXPORT int STDCALL FPDFPage_GetRotation(FPDF_PAGE page);
78
79 // Function: FPDFPage_SetRotation
80 //          Set page rotation. One of following values will be set: 0(0), 1(90), 2(180), 3(270).
81 // Parameters:
82 //          page        -   Handle to a page. Returned by FPDFPage_New or FPDF_LoadPage.
83 //          rotate      -   The value of the PDF page rotation.
84 // Return value:
85 //          None.
86 // Comment:
87 //          The PDF page rotation is rotated clockwise.
88 //
89 DLLEXPORT void STDCALL FPDFPage_SetRotation(FPDF_PAGE page, int rotate);
90
91 // Function: FPDFPage_InsertObject
92 //          Insert an object to the page. The page object is automatically freed.
93 // Parameters:
94 //          page        -   Handle to a page. Returned by FPDFPage_New or FPDF_LoadPage.
95 //          page_obj    -   Handle to a page object. Returned by FPDFPageObj_NewTextObj,FPDFPageObj_NewTextObjEx and
96 //                          FPDFPageObj_NewPathObj.
97 // Return value:
98 //          None.
99 DLLEXPORT void STDCALL FPDFPage_InsertObject(FPDF_PAGE page, FPDF_PAGEOBJECT page_obj);
100
101 // Function: FPDFPage_CountObject
102 //          Get number of page objects inside the page.
103 // Parameters:
104 //          page        -   Handle to a page. Returned by FPDFPage_New or FPDF_LoadPage.
105 // Return value:
106 //          The number of the page object.
107 DLLEXPORT int STDCALL FPDFPage_CountObject(FPDF_PAGE page);
108
109 // Function: FPDFPage_GetObject
110 //          Get page object by index.
111 // Parameters:
112 //          page        -   Handle to a page. Returned by FPDFPage_New or FPDF_LoadPage.
113 //          index       -   The index of a page object.
114 // Return value:
115 //          The handle of the page object. Null for failed.
116 DLLEXPORT FPDF_PAGEOBJECT STDCALL FPDFPage_GetObject(FPDF_PAGE page, int index);
117
118 // Function: FPDFPage_HasTransparency
119 //          Check that whether the content of specified PDF page contains transparency.
120 // Parameters:
121 //          page        -   Handle to a page. Returned by FPDFPage_New or FPDF_LoadPage.
122 // Return value:
123 //          TRUE means that the PDF page does contains transparency.
124 //          Otherwise, returns FALSE.
125 DLLEXPORT FPDF_BOOL STDCALL FPDFPage_HasTransparency(FPDF_PAGE page);
126
127 // Function: FPDFPage_GenerateContent
128 //          Generate PDF Page content.
129 // Parameters:
130 //          page        -   Handle to a page. Returned by FPDFPage_New or FPDF_LoadPage.
131 // Return value:
132 //          True if successful, false otherwise.
133 // Comment:
134 //          Before you save the page to a file, or reload the page, you must call the FPDFPage_GenerateContent function.
135 //          Or the changed information will be lost.
136 DLLEXPORT FPDF_BOOL STDCALL FPDFPage_GenerateContent(FPDF_PAGE page);
137
138 //////////////////////////////////////////////////////////////////////
139 //
140 // Page Object functions
141 //
142 //////////////////////////////////////////////////////////////////////
143
144 // Function: FPDFPageObj_HasTransparency
145 //          Check that whether the specified PDF page object contains transparency.
146 // Parameters:
147 //          pageObject  -   Handle to a page object.
148 // Return value:
149 //          TRUE means that the PDF page object does contains transparency.
150 //          Otherwise, returns FALSE.
151 DLLEXPORT FPDF_BOOL STDCALL FPDFPageObj_HasTransparency(FPDF_PAGEOBJECT pageObject);
152
153 // Function: FPDFPageObj_Transform
154 //          Transform (scale, rotate, shear, move) page object.
155 // Parameters:
156 //          page_object -   Handle to a page object. Returned by FPDFPageObj_NewImageObj.
157 //          a           -   The coefficient "a" of the matrix.
158 //          b           -   The coefficient "b" of the matrix.
159 //          c           -   The coefficient "c" of the matrix.
160 //          d           -   The coefficient "d" of the matrix.
161 //          e           -   The coefficient "e" of the matrix.
162 //          f           -   The coefficient "f" of the matrix.
163 // Return value:
164 //          None.
165 DLLEXPORT void STDCALL FPDFPageObj_Transform(FPDF_PAGEOBJECT page_object,
166                             double a, double b, double c, double d, double e, double f);
167
168 // Function: FPDFPage_TransformAnnots
169 //          Transform (scale, rotate, shear, move) all annots in a page.
170 // Parameters:
171 //          page        -   Handle to a page.
172 //          a           -   The coefficient "a" of the matrix.
173 //          b           -   The coefficient "b" of the matrix.
174 //          c           -   The coefficient "c" of the matrix.
175 //          d           -   The coefficient "d" of the matrix.
176 //          e           -   The coefficient "e" of the matrix.
177 //          f           -   The coefficient "f" of the matrix.
178 // Return value:
179 //          None.
180 DLLEXPORT void STDCALL FPDFPage_TransformAnnots(FPDF_PAGE page,
181                                              double a, double b, double c, double d, double e, double f);
182
183 // The page object constants.
184 #define FPDF_PAGEOBJ_TEXT       1
185 #define FPDF_PAGEOBJ_PATH       2
186 #define FPDF_PAGEOBJ_IMAGE      3
187 #define FPDF_PAGEOBJ_SHADING    4
188 #define FPDF_PAGEOBJ_FORM       5
189
190 //////////////////////////////////////////////////////////////////////
191 //
192 // Image functions
193 //
194 //////////////////////////////////////////////////////////////////////
195
196 // Function: FPDFPageObj_NewImgeObj
197 //          Create a new Image Object.
198 // Parameters:
199 //          document        -   Handle to document. Returned by FPDF_LoadDocument or FPDF_CreateNewDocument function.
200 // Return Value:
201 //          Handle of image object.
202 DLLEXPORT FPDF_PAGEOBJECT STDCALL FPDFPageObj_NewImgeObj(FPDF_DOCUMENT document);
203
204
205 // Function: FPDFImageObj_LoadJpegFile
206 //          Load Image from a JPEG image file and then set it to an image object.
207 // Parameters:
208 //          pages           -   Pointers to the start of all loaded pages, could be NULL.
209 //          nCount          -   Number of pages, could be 0.
210 //          image_object    -   Handle of image object returned by FPDFPageObj_NewImgeObj.
211 //          fileAccess      -   The custom file access handler, which specifies the JPEG image file.
212 //  Return Value:
213 //          TRUE if successful, FALSE otherwise.
214 //  Note:
215 //          The image object might already has an associated image, which is shared and cached by the loaded pages, In this case, we need to clear the cache of image for all the loaded pages.
216 //          Pass pages and count to this API to clear the image cache.
217 DLLEXPORT FPDF_BOOL STDCALL FPDFImageObj_LoadJpegFile(FPDF_PAGE* pages, int nCount,FPDF_PAGEOBJECT image_object, FPDF_FILEACCESS* fileAccess);
218
219
220 // Function: FPDFImageObj_SetMatrix
221 //          Set the matrix of an image object.
222 // Parameters:
223 //          image_object    -   Handle of image object returned by FPDFPageObj_NewImgeObj.
224 //          a               -   The coefficient "a" of the matrix.
225 //          b               -   The coefficient "b" of the matrix.
226 //          c               -   The coefficient "c" of the matrix.
227 //          d               -   The coefficient "d" of the matrix.
228 //          e               -   The coefficient "e" of the matrix.
229 //          f               -   The coefficient "f" of the matrix.
230 // Return value:
231 //          TRUE if successful, FALSE otherwise.
232 DLLEXPORT FPDF_BOOL STDCALL FPDFImageObj_SetMatrix(FPDF_PAGEOBJECT image_object,
233                                              double a, double b, double c, double d, double e, double f);
234
235 // Function: FPDFImageObj_SetBitmap
236 //          Set the bitmap to an image object.
237 // Parameters:
238 //          pages           -   Pointer's to the start of all loaded pages.
239 //          nCount          -   Number of pages.
240 //          image_object    -   Handle of image object returned by FPDFPageObj_NewImgeObj.
241 //          bitmap          -   The handle of the bitmap which you want to set it to the image object.
242 // Return value:
243 //          TRUE if successful, FALSE otherwise.
244 DLLEXPORT FPDF_BOOL STDCALL FPDFImageObj_SetBitmap(FPDF_PAGE* pages,int nCount,FPDF_PAGEOBJECT image_object, FPDF_BITMAP bitmap);
245
246 #ifdef __cplusplus
247 }
248 #endif
249
250 #endif  // PUBLIC_FPDF_EDIT_H_