Initial commit.
[pdfium.git] / fpdfsdk / include / fpdf_flatten.h
1 // Copyright 2014 PDFium Authors. All rights reserved.\r
2 // Use of this source code is governed by a BSD-style license that can be\r
3 // found in the LICENSE file.\r
4  \r
5 // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com\r
6 \r
7 #ifndef _FPDF_FLATTEN_H_\r
8 #define _FPDF_FLATTEN_H_\r
9         \r
10 #include "fpdfview.h"\r
11 \r
12 #define FLATTEN_FAIL                    0       // Flatten operation failed.\r
13 #define FLATTEN_SUCCESS                 1       // Flatten operation succeed.\r
14 #define FLATTEN_NOTINGTODO              2       // There is nothing can be flatten.\r
15         \r
16 #ifdef __cplusplus\r
17 extern "C" {\r
18 #endif\r
19 \r
20 #define FLAT_NORMALDISPLAY     0\r
21 #define FLAT_PRINT             1    \r
22         //Function: FPDFPage_Flatten\r
23 \r
24         //                      Flat a pdf page,annotations or form fields will become part of the page contents.\r
25         //Parameters:\r
26 \r
27         //                      page  - Handle to the page. Returned by FPDF_LoadPage function.\r
28         //                      nFlag - the flag for the use of flatten result. Zero for normal display, 1 for print.\r
29         //Return value:\r
30         //                      The result flag of the function, See flags above ( FLATTEN_FAIL, FLATTEN_SUCCESS, FLATTEN_NOTINGTODO ).\r
31         //\r
32         // Comments: Current version all fails return zero. If necessary we will assign different value\r
33         //                      to indicate different fail reason.\r
34         // \r
35         DLLEXPORT int STDCALL FPDFPage_Flatten( FPDF_PAGE page, int nFlag);\r
36                 \r
37                 \r
38 #ifdef __cplusplus\r
39 };\r
40 #endif\r
41 \r
42 #endif //_FPDF_FLATTEN_H_\r