Merge to XFA: "Redo range check in CPDF_SampledFunc::v_Call().""
[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 //
40 DLLEXPORT FPDF_DOCUMENT STDCALL FPDF_CreateNewDocument();
41
42 //////////////////////////////////////////////////////////////////////
43 //
44 // Page functions
45 //
46 //////////////////////////////////////////////////////////////////////
47
48 // Function: FPDFPage_New
49 //          Construct an empty page.
50 // Parameters:
51 //          document    -   Handle to document. Returned by FPDF_LoadDocument and FPDF_CreateNewDocument.
52 //          page_index  -   The index of a page.
53 //          width       -   The page width.
54 //          height      -   The page height.
55 // Return value:
56 //          The handle to the page.
57 // Comments:
58 //          Loaded page can be deleted by FPDFPage_Delete.
59 // Notes:
60 //          The method can not support to create a new page for the document consists of dynamic XFA fields.
61 //
62 DLLEXPORT FPDF_PAGE STDCALL FPDFPage_New(FPDF_DOCUMENT document, int page_index, double width, double height);
63
64 // Function: FPDFPage_Delete
65 //          Delete a PDF page.
66 // Parameters:
67 //          document    -   Handle to document. Returned by FPDF_LoadDocument and FPDF_CreateNewDocument.
68 //          page_index  -   The index of a page.
69 // Return value:
70 //          None.
71 // Notes:
72 //          The method can not support to delete page for the document consists of dynamic XFA fields.
73 //
74 DLLEXPORT void STDCALL FPDFPage_Delete(FPDF_DOCUMENT document, int page_index);
75
76 // Function: FPDFPage_GetRotation
77 //          Get the page rotation. One of following values will be returned: 0(0), 1(90), 2(180), 3(270).
78 // Parameters:
79 //          page        -   Handle to a page. Returned by FPDFPage_New or FPDF_LoadPage.
80 // Return value:
81 //          The PDF page rotation.
82 // Comment:
83 //          The PDF page rotation is rotated clockwise.
84 // Notes:
85 //          The method can not support to get the page rotate for the document consists of dynamic XFA fields.
86 //
87 DLLEXPORT int STDCALL FPDFPage_GetRotation(FPDF_PAGE page);
88
89 // Function: FPDFPage_SetRotation
90 //          Set page rotation. One of following values will be set: 0(0), 1(90), 2(180), 3(270).
91 // Parameters:
92 //          page        -   Handle to a page. Returned by FPDFPage_New or FPDF_LoadPage.
93 //          rotate      -   The value of the PDF page rotation.
94 // Return value:
95 //          None.
96 // Comment:
97 //          The PDF page rotation is rotated clockwise.
98 // Notes:
99 //          The method can not support to set this feature for the document consists of dynamic XFA fields.
100 //
101 DLLEXPORT void STDCALL FPDFPage_SetRotation(FPDF_PAGE page, int rotate);
102
103 // Function: FPDFPage_InsertObject
104 //          Insert an object to the page. The page object is automatically freed.
105 // Parameters:
106 //          page        -   Handle to a page. Returned by FPDFPage_New or FPDF_LoadPage.
107 //          page_obj    -   Handle to a page object. Returned by FPDFPageObj_NewTextObj,FPDFPageObj_NewTextObjEx and
108 //                          FPDFPageObj_NewPathObj.
109 // Return value:
110 //          None.
111 // Notes:
112 //          The method can not support this feature for the document consists of dynamic XFA fields.
113 //
114 DLLEXPORT void STDCALL FPDFPage_InsertObject(FPDF_PAGE page, FPDF_PAGEOBJECT page_obj);
115
116 // Function: FPDFPage_CountObject
117 //          Get number of page objects inside the page.
118 // Parameters:
119 //          page        -   Handle to a page. Returned by FPDFPage_New or FPDF_LoadPage.
120 // Return value:
121 //          The number of the page object.
122 // Notes:
123 //          The method can not support this feature for the document consists of dynamic XFA fields.
124 //
125 DLLEXPORT int STDCALL FPDFPage_CountObject(FPDF_PAGE page);
126
127 // Function: FPDFPage_GetObject
128 //          Get page object by index.
129 // Parameters:
130 //          page        -   Handle to a page. Returned by FPDFPage_New or FPDF_LoadPage.
131 //          index       -   The index of a page object.
132 // Return value:
133 //          The handle of the page object. Null for failed.
134 // Notes:
135 //          The method can not support this feature for the document consists of dynamic XFA fields.
136 //
137 DLLEXPORT FPDF_PAGEOBJECT STDCALL FPDFPage_GetObject(FPDF_PAGE page, int index);
138
139 // Function: FPDFPage_HasTransparency
140 //          Check that whether the content of specified PDF page contains transparency.
141 // Parameters:
142 //          page        -   Handle to a page. Returned by FPDFPage_New or FPDF_LoadPage.
143 // Return value:
144 //          TRUE means that the PDF page does contains transparency.
145 //          Otherwise, returns FALSE.
146 // Notes:
147 //          The method can not support this feature for the document consists of dynamic XFA fields.
148 //
149 DLLEXPORT FPDF_BOOL STDCALL FPDFPage_HasTransparency(FPDF_PAGE page);
150
151 // Function: FPDFPage_GenerateContent
152 //          Generate PDF Page content.
153 // Parameters:
154 //          page        -   Handle to a page. Returned by FPDFPage_New or FPDF_LoadPage.
155 // Return value:
156 //          True if successful, false otherwise.
157 // Comment:
158 //          Before you save the page to a file, or reload the page, you must call the FPDFPage_GenerateContent function.
159 //          Or the changed information will be lost.
160 // Notes:
161 //          The method can not support this feature for the document consists of dynamic XFA fields.
162 //
163 DLLEXPORT FPDF_BOOL STDCALL FPDFPage_GenerateContent(FPDF_PAGE page);
164
165 //////////////////////////////////////////////////////////////////////
166 //
167 // Page Object functions
168 //
169 //////////////////////////////////////////////////////////////////////
170
171 // Function: FPDFPageObj_HasTransparency
172 //          Check that whether the specified PDF page object contains transparency.
173 // Parameters:
174 //          pageObject  -   Handle to a page object.
175 // Return value:
176 //          TRUE means that the PDF page object does contains transparency.
177 //          Otherwise, returns FALSE.
178 DLLEXPORT FPDF_BOOL STDCALL FPDFPageObj_HasTransparency(FPDF_PAGEOBJECT pageObject);
179
180 // Function: FPDFPageObj_Transform
181 //          Transform (scale, rotate, shear, move) page object.
182 // Parameters:
183 //          page_object -   Handle to a page object. Returned by FPDFPageObj_NewImageObj.
184 //          a           -   The coefficient "a" of the matrix.
185 //          b           -   The coefficient "b" of the matrix.
186 //          c           -   The coefficient "c" of the matrix.
187 //          d           -   The coefficient "d" of the matrix.
188 //          e           -   The coefficient "e" of the matrix.
189 //          f           -   The coefficient "f" of the matrix.
190 // Return value:
191 //          None.
192 DLLEXPORT void STDCALL FPDFPageObj_Transform(FPDF_PAGEOBJECT page_object,
193                             double a, double b, double c, double d, double e, double f);
194
195 // Function: FPDFPage_TransformAnnots
196 //          Transform (scale, rotate, shear, move) all annots in a page.
197 // Parameters:
198 //          page        -   Handle to a page.
199 //          a           -   The coefficient "a" of the matrix.
200 //          b           -   The coefficient "b" of the matrix.
201 //          c           -   The coefficient "c" of the matrix.
202 //          d           -   The coefficient "d" of the matrix.
203 //          e           -   The coefficient "e" of the matrix.
204 //          f           -   The coefficient "f" of the matrix.
205 // Return value:
206 //          None.
207 // Notes:
208 //          The method can not support this feature for the document consists of dynamic XFA fields.
209 DLLEXPORT void STDCALL FPDFPage_TransformAnnots(FPDF_PAGE page,
210                                              double a, double b, double c, double d, double e, double f);
211
212 // The page object constants.
213 #define FPDF_PAGEOBJ_TEXT       1
214 #define FPDF_PAGEOBJ_PATH       2
215 #define FPDF_PAGEOBJ_IMAGE      3
216 #define FPDF_PAGEOBJ_SHADING    4
217 #define FPDF_PAGEOBJ_FORM       5
218
219 //////////////////////////////////////////////////////////////////////
220 //
221 // Image functions
222 //
223 //////////////////////////////////////////////////////////////////////
224
225 // Function: FPDFPageObj_NewImgeObj
226 //          Create a new Image Object.
227 // Parameters:
228 //          document        -   Handle to document. Returned by FPDF_LoadDocument or FPDF_CreateNewDocument function.
229 // Return Value:
230 //          Handle of image object.
231 DLLEXPORT FPDF_PAGEOBJECT STDCALL FPDFPageObj_NewImgeObj(FPDF_DOCUMENT document);
232
233
234 // Function: FPDFImageObj_LoadJpegFile
235 //          Load Image from a JPEG image file and then set it to an image object.
236 // Parameters:
237 //          pages           -   Pointers to the start of all loaded pages, could be NULL.
238 //          nCount          -   Number of pages, could be 0.
239 //          image_object    -   Handle of image object returned by FPDFPageObj_NewImgeObj.
240 //          fileAccess      -   The custom file access handler, which specifies the JPEG image file.
241 //  Return Value:
242 //          TRUE if successful, FALSE otherwise.
243 //  Note:
244 //          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.
245 //          Pass pages and count to this API to clear the image cache.
246 //          The method can not support this feature for the document consists of dynamic XFA fields.
247 //
248 DLLEXPORT FPDF_BOOL STDCALL FPDFImageObj_LoadJpegFile(FPDF_PAGE* pages, int nCount,FPDF_PAGEOBJECT image_object, FPDF_FILEACCESS* fileAccess);
249
250
251 // Function: FPDFImageObj_SetMatrix
252 //          Set the matrix of an image object.
253 // Parameters:
254 //          image_object    -   Handle of image object returned by FPDFPageObj_NewImgeObj.
255 //          a               -   The coefficient "a" of the matrix.
256 //          b               -   The coefficient "b" of the matrix.
257 //          c               -   The coefficient "c" of the matrix.
258 //          d               -   The coefficient "d" of the matrix.
259 //          e               -   The coefficient "e" of the matrix.
260 //          f               -   The coefficient "f" of the matrix.
261 // Return value:
262 //          TRUE if successful, FALSE otherwise.
263 DLLEXPORT FPDF_BOOL STDCALL FPDFImageObj_SetMatrix(FPDF_PAGEOBJECT image_object,
264                                              double a, double b, double c, double d, double e, double f);
265
266 // Function: FPDFImageObj_SetBitmap
267 //          Set the bitmap to an image object.
268 // Parameters:
269 //          pages           -   Pointer's to the start of all loaded pages.
270 //          nCount          -   Number of pages.
271 //          image_object    -   Handle of image object returned by FPDFPageObj_NewImgeObj.
272 //          bitmap          -   The handle of the bitmap which you want to set it to the image object.
273 // Return value:
274 //          TRUE if successful, FALSE otherwise.
275 // Notes;
276 //          The method can not support this feature for the document consists of dynamic XFA fields.
277 //
278 DLLEXPORT FPDF_BOOL STDCALL FPDFImageObj_SetBitmap(FPDF_PAGE* pages,int nCount,FPDF_PAGEOBJECT image_object, FPDF_BITMAP bitmap);
279
280 #ifdef __cplusplus
281 }
282 #endif
283
284 #endif  // PUBLIC_FPDF_EDIT_H_