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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
|
/* poppler-document.h: glib interface to poppler
* Copyright (C) 2004, Red Hat, Inc.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2, or (at your option)
* any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
*/
#ifndef __POPPLER_DOCUMENT_H__
#define __POPPLER_DOCUMENT_H__
#include <glib-object.h>
#include "poppler.h"
G_BEGIN_DECLS
#define POPPLER_TYPE_DOCUMENT (poppler_document_get_type ())
#define POPPLER_DOCUMENT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), POPPLER_TYPE_DOCUMENT, PopplerDocument))
#define POPPLER_IS_DOCUMENT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), POPPLER_TYPE_DOCUMENT))
/**
* PopplerPageLayout:
* @POPPLER_PAGE_LAYOUT_UNSET: no specific layout set
* @POPPLER_PAGE_LAYOUT_SINGLE_PAGE: one page at a time
* @POPPLER_PAGE_LAYOUT_ONE_COLUMN: pages in one column
* @POPPLER_PAGE_LAYOUT_TWO_COLUMN_LEFT: pages in two columns with odd numbered pages on the left
* @POPPLER_PAGE_LAYOUT_TWO_COLUMN_RIGHT: pages in two columns with odd numbered pages on the right
* @POPPLER_PAGE_LAYOUT_TWO_PAGE_LEFT: two pages at a time with odd numbered pages on the left
* @POPPLER_PAGE_LAYOUT_TWO_PAGE_RIGHT: two pages at a time with odd numbered pages on the right
*
* Page layout types
*/
typedef enum
{
POPPLER_PAGE_LAYOUT_UNSET,
POPPLER_PAGE_LAYOUT_SINGLE_PAGE,
POPPLER_PAGE_LAYOUT_ONE_COLUMN,
POPPLER_PAGE_LAYOUT_TWO_COLUMN_LEFT,
POPPLER_PAGE_LAYOUT_TWO_COLUMN_RIGHT,
POPPLER_PAGE_LAYOUT_TWO_PAGE_LEFT,
POPPLER_PAGE_LAYOUT_TWO_PAGE_RIGHT
} PopplerPageLayout;
/**
* PopplerPageMode:
* @POPPLER_PAGE_MODE_UNSET: no specific mode set
* @POPPLER_PAGE_MODE_NONE: neither document outline nor thumbnails visible
* @POPPLER_PAGE_MODE_USE_OUTLINES: document outline visible
* @POPPLER_PAGE_MODE_USE_THUMBS: thumbnails visible
* @POPPLER_PAGE_MODE_FULL_SCREEN: full-screen mode
* @POPPLER_PAGE_MODE_USE_OC: layers panel visible
* @POPPLER_PAGE_MODE_USE_ATTACHMENTS: attachments panel visible
*
* Page modes
*/
typedef enum
{
POPPLER_PAGE_MODE_UNSET,
POPPLER_PAGE_MODE_NONE,
POPPLER_PAGE_MODE_USE_OUTLINES,
POPPLER_PAGE_MODE_USE_THUMBS,
POPPLER_PAGE_MODE_FULL_SCREEN,
POPPLER_PAGE_MODE_USE_OC,
POPPLER_PAGE_MODE_USE_ATTACHMENTS
} PopplerPageMode;
/**
* PopplerFontType:
* @POPPLER_FONT_TYPE_UNKNOWN: unknown font type
* @POPPLER_FONT_TYPE_TYPE1:
* @POPPLER_FONT_TYPE_TYPE1C:
* @POPPLER_FONT_TYPE_TYPE1COT:
* @POPPLER_FONT_TYPE_TYPE3:
* @POPPLER_FONT_TYPE_TRUETYPE:
* @POPPLER_FONT_TYPE_TRUETYPEOT:
* @POPPLER_FONT_TYPE_CID_TYPE0:
* @POPPLER_FONT_TYPE_CID_TYPE0C:
* @POPPLER_FONT_TYPE_CID_TYPE0COT:
* @POPPLER_FONT_TYPE_CID_TYPE2:
* @POPPLER_FONT_TYPE_CID_TYPE2OT:
*
* Font types
*/
typedef enum
{
POPPLER_FONT_TYPE_UNKNOWN,
POPPLER_FONT_TYPE_TYPE1,
POPPLER_FONT_TYPE_TYPE1C,
POPPLER_FONT_TYPE_TYPE1COT,
POPPLER_FONT_TYPE_TYPE3,
POPPLER_FONT_TYPE_TRUETYPE,
POPPLER_FONT_TYPE_TRUETYPEOT,
POPPLER_FONT_TYPE_CID_TYPE0,
POPPLER_FONT_TYPE_CID_TYPE0C,
POPPLER_FONT_TYPE_CID_TYPE0COT,
POPPLER_FONT_TYPE_CID_TYPE2,
POPPLER_FONT_TYPE_CID_TYPE2OT
} PopplerFontType;
/**
* PopplerViewerPreferences:
* @POPPLER_VIEWER_PREFERENCES_UNSET: no preferences set
* @POPPLER_VIEWER_PREFERENCES_HIDE_TOOLBAR: hider toolbars when document is active
* @POPPLER_VIEWER_PREFERENCES_HIDE_MENUBAR: hide menu bar when document is active
* @POPPLER_VIEWER_PREFERENCES_HIDE_WINDOWUI: hide UI elements in document's window
* @POPPLER_VIEWER_PREFERENCES_FIT_WINDOW: resize document's window to fit the size of the first displayed page
* @POPPLER_VIEWER_PREFERENCES_CENTER_WINDOW: position the document's window in the center of the screen
* @POPPLER_VIEWER_PREFERENCES_DISPLAY_DOC_TITLE: display document title in window's title bar
* @POPPLER_VIEWER_PREFERENCES_DIRECTION_RTL:
*
* Viewer preferences
*/
typedef enum /*< flags >*/
{
POPPLER_VIEWER_PREFERENCES_UNSET = 0,
POPPLER_VIEWER_PREFERENCES_HIDE_TOOLBAR = 1 << 0,
POPPLER_VIEWER_PREFERENCES_HIDE_MENUBAR = 1 << 1,
POPPLER_VIEWER_PREFERENCES_HIDE_WINDOWUI = 1 << 2,
POPPLER_VIEWER_PREFERENCES_FIT_WINDOW = 1 << 3,
POPPLER_VIEWER_PREFERENCES_CENTER_WINDOW = 1 << 4,
POPPLER_VIEWER_PREFERENCES_DISPLAY_DOC_TITLE = 1 << 5,
POPPLER_VIEWER_PREFERENCES_DIRECTION_RTL = 1 << 6
} PopplerViewerPreferences;
/**
* PopplerPermissions:
* @POPPLER_PERMISSIONS_OK_TO_PRINT: document can be printer
* @POPPLER_PERMISSIONS_OK_TO_MODIFY: document contents can be modified
* @POPPLER_PERMISSIONS_OK_TO_COPY: document can be copied
* @POPPLER_PERMISSIONS_OK_TO_ADD_NOTES: annotations can added to the document
* @POPPLER_PERMISSIONS_OK_TO_FILL_FORM: interactive form fields can be filled in
* @POPPLER_PERMISSIONS_FULL:
*
* Permissions
*/
typedef enum /*< flags >*/
{
POPPLER_PERMISSIONS_OK_TO_PRINT = 1 << 0,
POPPLER_PERMISSIONS_OK_TO_MODIFY = 1 << 1,
POPPLER_PERMISSIONS_OK_TO_COPY = 1 << 2,
POPPLER_PERMISSIONS_OK_TO_ADD_NOTES = 1 << 3,
POPPLER_PERMISSIONS_OK_TO_FILL_FORM = 1 << 4,
POPPLER_PERMISSIONS_FULL = (POPPLER_PERMISSIONS_OK_TO_PRINT | POPPLER_PERMISSIONS_OK_TO_MODIFY | POPPLER_PERMISSIONS_OK_TO_COPY | POPPLER_PERMISSIONS_OK_TO_ADD_NOTES | POPPLER_PERMISSIONS_OK_TO_FILL_FORM)
} PopplerPermissions;
GType poppler_document_get_type (void) G_GNUC_CONST;
PopplerDocument *poppler_document_new_from_file (const char *uri,
const char *password,
GError **error);
PopplerDocument *poppler_document_new_from_data (char *data,
int length,
const char *password,
GError **error);
gboolean poppler_document_save (PopplerDocument *document,
const char *uri,
GError **error);
gboolean poppler_document_save_a_copy (PopplerDocument *document,
const char *uri,
GError **error);
gboolean poppler_document_get_id (PopplerDocument *document,
gchar **permanent_id,
gchar **update_id);
int poppler_document_get_n_pages (PopplerDocument *document);
PopplerPage *poppler_document_get_page (PopplerDocument *document,
int index);
PopplerPage *poppler_document_get_page_by_label (PopplerDocument *document,
const char *label);
/* Attachments */
gboolean poppler_document_has_attachments (PopplerDocument *document);
GList *poppler_document_get_attachments (PopplerDocument *document);
/* Links */
PopplerDest *poppler_document_find_dest (PopplerDocument *document,
const gchar *link_name);
/* Form */
PopplerFormField *poppler_document_get_form_field (PopplerDocument *document,
gint id);
/* Interface for getting the Index of a poppler_document */
#define POPPLER_TYPE_INDEX_ITER (poppler_index_iter_get_type ())
GType poppler_index_iter_get_type (void) G_GNUC_CONST;
PopplerIndexIter *poppler_index_iter_new (PopplerDocument *document);
PopplerIndexIter *poppler_index_iter_copy (PopplerIndexIter *iter);
void poppler_index_iter_free (PopplerIndexIter *iter);
PopplerIndexIter *poppler_index_iter_get_child (PopplerIndexIter *parent);
gboolean poppler_index_iter_is_open (PopplerIndexIter *iter);
PopplerAction *poppler_index_iter_get_action (PopplerIndexIter *iter);
gboolean poppler_index_iter_next (PopplerIndexIter *iter);
/* Interface for getting the Fonts of a poppler_document */
#define POPPLER_TYPE_FONT_INFO (poppler_font_info_get_type ())
#define POPPLER_FONT_INFO(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), POPPLER_TYPE_FONT_INFO, PopplerFontInfo))
#define POPPLER_IS_FONT_INFO(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), POPPLER_TYPE_FONT_INFO))
GType poppler_font_info_get_type (void) G_GNUC_CONST;
PopplerFontInfo *poppler_font_info_new (PopplerDocument *document);
gboolean poppler_font_info_scan (PopplerFontInfo *font_info,
int n_pages,
PopplerFontsIter **iter);
void poppler_font_info_free (PopplerFontInfo *font_info);
#define POPPLER_TYPE_FONTS_ITER (poppler_fonts_iter_get_type ())
GType poppler_fonts_iter_get_type (void) G_GNUC_CONST;
PopplerFontsIter *poppler_fonts_iter_copy (PopplerFontsIter *iter);
void poppler_fonts_iter_free (PopplerFontsIter *iter);
const char *poppler_fonts_iter_get_name (PopplerFontsIter *iter);
const char *poppler_fonts_iter_get_full_name (PopplerFontsIter *iter);
const char *poppler_fonts_iter_get_file_name (PopplerFontsIter *iter);
PopplerFontType poppler_fonts_iter_get_font_type (PopplerFontsIter *iter);
gboolean poppler_fonts_iter_is_embedded (PopplerFontsIter *iter);
gboolean poppler_fonts_iter_is_subset (PopplerFontsIter *iter);
gboolean poppler_fonts_iter_next (PopplerFontsIter *iter);
/* Interface for getting the Layers of a poppler_document */
#define POPPLER_TYPE_LAYERS_ITER (poppler_layers_iter_get_type ())
GType poppler_layers_iter_get_type (void) G_GNUC_CONST;
PopplerLayersIter *poppler_layers_iter_new (PopplerDocument *document);
PopplerLayersIter *poppler_layers_iter_copy (PopplerLayersIter *iter);
void poppler_layers_iter_free (PopplerLayersIter *iter);
PopplerLayersIter *poppler_layers_iter_get_child (PopplerLayersIter *parent);
gchar *poppler_layers_iter_get_title (PopplerLayersIter *iter);
PopplerLayer *poppler_layers_iter_get_layer (PopplerLayersIter *iter);
gboolean poppler_layers_iter_next (PopplerLayersIter *iter);
/* Export to ps */
#define POPPLER_TYPE_PS_FILE (poppler_ps_file_get_type ())
#define POPPLER_PS_FILE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), POPPLER_TYPE_PS_FILE, PopplerPSFile))
#define POPPLER_IS_PS_FILE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), POPPLER_TYPE_PS_FILE))
GType poppler_ps_file_get_type (void) G_GNUC_CONST;
PopplerPSFile *poppler_ps_file_new (PopplerDocument *document,
const char *filename,
int first_page,
int n_pages);
void poppler_ps_file_set_paper_size (PopplerPSFile *ps_file,
double width,
double height);
void poppler_ps_file_set_duplex (PopplerPSFile *ps_file,
gboolean duplex);
void poppler_ps_file_free (PopplerPSFile *ps_file);
G_END_DECLS
#endif /* __POPPLER_DOCUMENT_H__ */
|
