xref: /aosp_15_r20/external/pdfium/public/fpdf_flatten.h (revision 3ac0a46f773bac49fa9476ec2b1cf3f8da5ec3a4)
1*3ac0a46fSAndroid Build Coastguard Worker // Copyright 2014 The PDFium Authors
2*3ac0a46fSAndroid Build Coastguard Worker // Use of this source code is governed by a BSD-style license that can be
3*3ac0a46fSAndroid Build Coastguard Worker // found in the LICENSE file.
4*3ac0a46fSAndroid Build Coastguard Worker 
5*3ac0a46fSAndroid Build Coastguard Worker // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
6*3ac0a46fSAndroid Build Coastguard Worker 
7*3ac0a46fSAndroid Build Coastguard Worker #ifndef PUBLIC_FPDF_FLATTEN_H_
8*3ac0a46fSAndroid Build Coastguard Worker #define PUBLIC_FPDF_FLATTEN_H_
9*3ac0a46fSAndroid Build Coastguard Worker 
10*3ac0a46fSAndroid Build Coastguard Worker // NOLINTNEXTLINE(build/include)
11*3ac0a46fSAndroid Build Coastguard Worker #include "fpdfview.h"
12*3ac0a46fSAndroid Build Coastguard Worker 
13*3ac0a46fSAndroid Build Coastguard Worker // Flatten operation failed.
14*3ac0a46fSAndroid Build Coastguard Worker #define FLATTEN_FAIL 0
15*3ac0a46fSAndroid Build Coastguard Worker // Flatten operation succeed.
16*3ac0a46fSAndroid Build Coastguard Worker #define FLATTEN_SUCCESS 1
17*3ac0a46fSAndroid Build Coastguard Worker // Nothing to be flattened.
18*3ac0a46fSAndroid Build Coastguard Worker #define FLATTEN_NOTHINGTODO 2
19*3ac0a46fSAndroid Build Coastguard Worker 
20*3ac0a46fSAndroid Build Coastguard Worker // Flatten for normal display.
21*3ac0a46fSAndroid Build Coastguard Worker #define FLAT_NORMALDISPLAY 0
22*3ac0a46fSAndroid Build Coastguard Worker // Flatten for print.
23*3ac0a46fSAndroid Build Coastguard Worker #define FLAT_PRINT 1
24*3ac0a46fSAndroid Build Coastguard Worker 
25*3ac0a46fSAndroid Build Coastguard Worker #ifdef __cplusplus
26*3ac0a46fSAndroid Build Coastguard Worker extern "C" {
27*3ac0a46fSAndroid Build Coastguard Worker #endif  // __cplusplus
28*3ac0a46fSAndroid Build Coastguard Worker 
29*3ac0a46fSAndroid Build Coastguard Worker // Flatten annotations and form fields into the page contents.
30*3ac0a46fSAndroid Build Coastguard Worker //
31*3ac0a46fSAndroid Build Coastguard Worker //   page  - handle to the page.
32*3ac0a46fSAndroid Build Coastguard Worker //   nFlag - One of the |FLAT_*| values denoting the page usage.
33*3ac0a46fSAndroid Build Coastguard Worker //
34*3ac0a46fSAndroid Build Coastguard Worker // Returns one of the |FLATTEN_*| values.
35*3ac0a46fSAndroid Build Coastguard Worker //
36*3ac0a46fSAndroid Build Coastguard Worker // Currently, all failures return |FLATTEN_FAIL| with no indication of the
37*3ac0a46fSAndroid Build Coastguard Worker // cause.
38*3ac0a46fSAndroid Build Coastguard Worker FPDF_EXPORT int FPDF_CALLCONV FPDFPage_Flatten(FPDF_PAGE page, int nFlag);
39*3ac0a46fSAndroid Build Coastguard Worker 
40*3ac0a46fSAndroid Build Coastguard Worker #ifdef __cplusplus
41*3ac0a46fSAndroid Build Coastguard Worker }  // extern "C"
42*3ac0a46fSAndroid Build Coastguard Worker #endif  // __cplusplus
43*3ac0a46fSAndroid Build Coastguard Worker 
44*3ac0a46fSAndroid Build Coastguard Worker #endif  // PUBLIC_FPDF_FLATTEN_H_
45