1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
/* Copyright (c) 2005-2021 Jay Berkenbilt
*
* This file is part of qpdf.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Versions of qpdf prior to version 7 were released under the terms
* of version 2.0 of the Artistic License. At your option, you may
* continue to consider qpdf to be licensed under those terms. Please
* see the manual for additional information.
*/
#ifndef QPDFCONSTANTS_H
#define QPDFCONSTANTS_H
/* Keep this file 'C' compatible so it can be used from the C and C++
* interfaces.
*/
/* Error Codes */
enum qpdf_error_code_e
{
qpdf_e_success = 0,
qpdf_e_internal, /* logic/programming error -- indicates bug */
qpdf_e_system, /* I/O error, memory error, etc. */
qpdf_e_unsupported, /* PDF feature not (yet) supported by qpdf */
qpdf_e_password, /* incorrect password for encrypted file */
qpdf_e_damaged_pdf, /* syntax errors or other damage in PDF */
qpdf_e_pages, /* erroneous or unsupported pages structure */
qpdf_e_object, /* type/bounds errors accessing objects */
};
/* Object Types */
/* PDF objects represented by QPDFObjectHandle or, in the C API, by
* qpdf_oh, have a unique type code that has one of the values in the
* list below. As new object types are added to qpdf, additional items
* may be added to the list, so code that switches on these values
* should take that into consideration.
*/
enum qpdf_object_type_e {
/* Object types internal to qpdf */
qpdf_ot_uninitialized,
qpdf_ot_reserved,
/* Object types that can occur in the main document */
qpdf_ot_null,
qpdf_ot_boolean,
qpdf_ot_integer,
qpdf_ot_real,
qpdf_ot_string,
qpdf_ot_name,
qpdf_ot_array,
qpdf_ot_dictionary,
qpdf_ot_stream,
/* Additional object types that can occur in content streams */
qpdf_ot_operator,
qpdf_ot_inlineimage,
/* NOTE: if adding to this list, update QPDFObject.hh */
};
/* Write Parameters. See QPDFWriter.hh for details. */
enum qpdf_object_stream_e
{
qpdf_o_disable = 0, /* disable object streams */
qpdf_o_preserve, /* preserve object streams */
qpdf_o_generate /* generate object streams */
};
enum qpdf_stream_data_e
{
qpdf_s_uncompress = 0, /* uncompress stream data */
qpdf_s_preserve, /* preserve stream data compression */
qpdf_s_compress /* compress stream data */
};
/* Stream data flags */
/* See pipeStreamData in QPDFObjectHandle.hh for details on these flags. */
enum qpdf_stream_encode_flags_e
{
qpdf_ef_compress = 1 << 0, /* compress uncompressed streams */
qpdf_ef_normalize = 1 << 1, /* normalize content stream */
};
enum qpdf_stream_decode_level_e
{
/* These must be in order from less to more decoding. */
qpdf_dl_none = 0, /* preserve all stream filters */
qpdf_dl_generalized, /* decode general-purpose filters */
qpdf_dl_specialized, /* also decode other non-lossy filters */
qpdf_dl_all /* also decode lossy filters */
};
/* R3 Encryption Parameters */
enum qpdf_r3_print_e
{
qpdf_r3p_full = 0, /* allow all printing */
qpdf_r3p_low, /* allow only low-resolution printing */
qpdf_r3p_none /* allow no printing */
};
/* qpdf_r3_modify_e doesn't allow the full flexibility of the spec. It
* corresponds to options in Acrobat 5's menus. The new interface in
* QPDFWriter offers more granularity and no longer uses this type.
*/
enum qpdf_r3_modify_e /* Allowed changes: */
{
qpdf_r3m_all = 0, /* All editing */
qpdf_r3m_annotate, /* Comments, fill forms, signing, assembly */
qpdf_r3m_form, /* Fill forms, signing, assembly */
qpdf_r3m_assembly, /* Only document assembly */
qpdf_r3m_none /* No modifications */
};
/* Form field flags from the PDF spec */
enum pdf_form_field_flag_e
{
/* flags that apply to all form fields */
ff_all_read_only = 1 << 0,
ff_all_required = 1 << 1,
ff_all_no_export = 1 << 2,
/* flags that apply to fields of type /Btn (button) */
ff_btn_no_toggle_off = 1 << 14,
ff_btn_radio = 1 << 15,
ff_btn_pushbutton = 1 << 16,
ff_btn_radios_in_unison = 1 << 17,
/* flags that apply to fields of type /Tx (text) */
ff_tx_multiline = 1 << 12,
ff_tx_password = 1 << 13,
ff_tx_file_select = 1 << 20,
ff_tx_do_not_spell_check = 1 << 22,
ff_tx_do_not_scroll = 1 << 23,
ff_tx_comb = 1 << 24,
ff_tx_rich_text = 1 << 25,
/* flags that apply to fields of type /Ch (choice) */
ff_ch_combo = 1 << 17,
ff_ch_edit = 1 << 18,
ff_ch_sort = 1 << 19,
ff_ch_multi_select = 1 << 21,
ff_ch_do_not_spell_check = 1 << 22,
ff_ch_commit_on_sel_change = 1 << 26
};
/* Annotation flags from the PDF spec */
enum pdf_annotation_flag_e
{
an_invisible = 1 << 0,
an_hidden = 1 << 1,
an_print = 1 << 2,
an_no_zoom = 1 << 3,
an_no_rotate = 1 << 4,
an_no_view = 1 << 5,
an_read_only = 1 << 6,
an_locked = 1 << 7,
an_toggle_no_view = 1 << 8,
an_locked_contents = 1 << 9
};
#endif /* QPDFCONSTANTS_H */
|
