Top |
char * | author | Read / Write |
int | creation-date | Read / Write |
GDateTime * | creation-datetime | Read / Write |
char * | creator | Read / Write |
char * | format | Read |
guint | format-major | Read |
guint | format-minor | Read |
char * | keywords | Read / Write |
gboolean | linearized | Read |
char * | metadata | Read |
int | mod-date | Read / Write |
GDateTime * | mod-datetime | Read / Write |
PopplerPageLayout | page-layout | Read |
PopplerPageMode | page-mode | Read |
PopplerPermissions | permissions | Read |
PopplerPrintDuplex | print-duplex | Read |
int | print-n-copies | Read |
PopplerPrintScaling | print-scaling | Read |
char * | producer | Read / Write |
char * | subject | Read / Write |
PopplerPDFSubtype | subtype | Read |
PopplerPDFConformance | subtype-conformance | Read |
PopplerPDFPart | subtype-part | Read |
char * | subtype-string | Read |
char * | title | Read / Write |
PopplerViewerPreferences | viewer-preferences | Read |
GBoxed ├── PopplerFontsIter ├── PopplerIndexIter ╰── PopplerLayersIter GEnum ├── PopplerFontType ├── PopplerPDFConformance ├── PopplerPDFPart ├── PopplerPDFSubtype ├── PopplerPageLayout ├── PopplerPageMode ├── PopplerPrintDuplex ╰── PopplerPrintScaling GFlags ├── PopplerPermissions ╰── PopplerViewerPreferences GObject ├── PopplerDocument ├── PopplerFontInfo ╰── PopplerPSFile
GTree *
poppler_document_create_dests_tree (PopplerDocument *document
);
Creates a balanced binary tree of all named destinations in document
The tree key is strings in the form returned by
poppler_named_dest_to_bytestring()
which constains a destination name.
The tree value is the PopplerDest which contains a named destination.
The return value must be freed with g_tree_destroy()
.
Since: 0.78
PopplerDest * poppler_document_find_dest (PopplerDocument *document
,const gchar *link_name
);
Creates a PopplerDest for the named destination link_name
in document
.
Note that named destinations are bytestrings, not string. That means that
unless link_name
was returned by a poppler function (e.g. is
PopplerDest.named_dest), it needs to be converted to string
using poppler_named_dest_from_bytestring()
before being passed to this
function.
The returned value must be freed with poppler_dest_free()
.
GList *
poppler_document_get_attachments (PopplerDocument *document
);
Returns a GList containing PopplerAttachments. These attachments
are unowned, and must be unreffed, and the list must be freed with
g_list_free()
.
gchar *
poppler_document_get_author (PopplerDocument *document
);
Returns the author of the document
Since: 0.16
time_t
poppler_document_get_creation_date (PopplerDocument *document
);
Returns the date the document was created as seconds since the Epoch
Since: 0.16
GDateTime *
poppler_document_get_creation_date_time
(PopplerDocument *document
);
Returns the date the document was created as a GDateTime
Since: 20.09.0
gchar *
poppler_document_get_creator (PopplerDocument *document
);
Returns the creator of the document. If the document was converted from another format, the creator is the name of the product that created the original document from which it was converted.
Since: 0.16
PopplerFormField * poppler_document_get_form_field (PopplerDocument *document
,gint id
);
Returns the PopplerFormField for the given id
. It must be freed with
g_object_unref()
gboolean poppler_document_get_id (PopplerDocument *document
,gchar **permanent_id
,gchar **update_id
);
Returns the PDF file identifier represented as two byte string arrays of size 32.
permanent_id
is the permanent identifier that is built based on the file
contents at the time it was originally created, so that this identifer
never changes. update_id
is the update identifier that is built based on
the file contents at the time it was last updated.
Note that returned strings are not null-terminated, they have a fixed size of 32 bytes.
document |
||
permanent_id |
location to store an allocated string, use |
[out][allow-none] |
update_id |
location to store an allocated string, use |
[out][allow-none] |
Since: 0.16
gchar *
poppler_document_get_keywords (PopplerDocument *document
);
Returns the keywords associated to the document
Since: 0.16
gchar *
poppler_document_get_metadata (PopplerDocument *document
);
Returns the XML metadata string of the document
Since: 0.16
time_t
poppler_document_get_modification_date
(PopplerDocument *document
);
Returns the date the document was most recently modified as seconds since the Epoch
Since: 0.16
GDateTime *
poppler_document_get_modification_date_time
(PopplerDocument *document
);
Returns the date the document was most recently modified as a GDateTime
Since: 20.09.0
guint
poppler_document_get_n_attachments (PopplerDocument *document
);
Returns the number of attachments in a loaded document.
See also poppler_document_get_attachments()
Since: 0.18
int
poppler_document_get_n_pages (PopplerDocument *document
);
Returns the number of pages in a loaded document.
gint
poppler_document_get_n_signatures (const PopplerDocument *document
);
Returns how many digital signatures document
contains.
PDF digital signatures ensure that the content hash not been altered since last edit and
that it was produced by someone the user can trust
Since: 21.12.0
PopplerPage * poppler_document_get_page (PopplerDocument *document
,int index
);
Returns the PopplerPage indexed at index
. This object is owned by the
caller.
PopplerPage * poppler_document_get_page_by_label (PopplerDocument *document
,const char *label
);
Returns the PopplerPage reference by label
. This object is owned by the
caller. label
is a human-readable string representation of the page number,
and can be document specific. Typically, it is a value such as "iii" or "3".
By default, "1" refers to the first page.
PopplerPageLayout
poppler_document_get_page_layout (PopplerDocument *document
);
Returns the page layout that should be used when the document is opened
Since: 0.16
PopplerPageMode
poppler_document_get_page_mode (PopplerDocument *document
);
Returns a PopplerPageMode representing how the document should be initially displayed when opened.
Since: 0.16
PopplerPDFConformance
poppler_document_get_pdf_conformance (PopplerDocument *document
);
Returns the conformance level of the document
as PopplerPDFConformance.
Since: 0.70
PopplerPDFPart
poppler_document_get_pdf_part (PopplerDocument *document
);
Returns the part of the conforming standard that the document
adheres to
as a PopplerPDFSubtype.
Since: 0.70
PopplerPDFSubtype
poppler_document_get_pdf_subtype (PopplerDocument *document
);
Returns the subtype of document
as a PopplerPDFSubtype.
Since: 0.70
gchar *
poppler_document_get_pdf_subtype_string
(PopplerDocument *document
);
Returns the PDF subtype version of document
as a string.
a newly allocated string containing
the PDF subtype version of document
, or NULL
.
[transfer full][nullable]
Since: 0.70
void poppler_document_get_pdf_version (PopplerDocument *document
,guint *major_version
,guint *minor_version
);
Updates values referenced by major_version
& minor_version
with the
major and minor PDF versions of document
.
document |
||
major_version |
return location for the PDF major version number. |
[out][nullable] |
minor_version |
return location for the PDF minor version number. |
[out][nullable] |
Since: 0.16
gchar *
poppler_document_get_pdf_version_string
(PopplerDocument *document
);
Returns the PDF version of document
as a string (e.g. PDF-1.6)
Since: 0.16
PopplerPermissions
poppler_document_get_permissions (PopplerDocument *document
);
Returns the flags specifying which operations are permitted when the document is opened.
Since: 0.16
PopplerPrintDuplex
poppler_document_get_print_duplex (PopplerDocument *document
);
Returns the duplex mode value suggested for printing by author of the document. Value POPPLER_PRINT_DUPLEX_NONE means that the document does not specify this preference.
Since: 0.80
gint
poppler_document_get_print_n_copies (PopplerDocument *document
);
Returns the suggested number of copies to be printed. This preference should be applied only if returned value is greater than 1 since value 1 usually means that the document does not specify it.
Since: 0.80
PopplerPageRange * poppler_document_get_print_page_ranges (PopplerDocument *document
,int *n_ranges
);
Returns the suggested page ranges to print in the form of array
of PopplerPageRanges and number of ranges.
NULL
pointer means that the document does not specify page ranges
for printing.
an array
of PopplerPageRanges or NULL
. Free the array when
it is no longer needed.
[array length=n_ranges][transfer full]
Since: 0.80
PopplerPrintScaling
poppler_document_get_print_scaling (PopplerDocument *document
);
Returns the print scaling value suggested by author of the document.
Since: 0.73
gchar *
poppler_document_get_producer (PopplerDocument *document
);
Returns the producer of the document. If the document was converted from another format, the producer is the name of the product that converted it to PDF
Since: 0.16
GList *
poppler_document_get_signature_fields (PopplerDocument *document
);
Returns a GList containing all signature PopplerFormFields in the document.
Since: 22.02.0
gchar *
poppler_document_get_subject (PopplerDocument *document
);
Returns the subject of the document
Since: 0.16
gchar *
poppler_document_get_title (PopplerDocument *document
);
Returns the document's title
Since: 0.16
gboolean
poppler_document_has_attachments (PopplerDocument *document
);
Returns TRUE
of document
has any attachments.
gboolean
poppler_document_has_javascript (PopplerDocument *document
);
Returns whether document
has any javascript in it.
Since: 0.90
gboolean
poppler_document_is_linearized (PopplerDocument *document
);
Returns whether document
is linearized or not. Linearization of PDF
enables efficient incremental access of the PDF file in a network environment.
Since: 0.16
PopplerDocument * poppler_document_new_from_bytes (GBytes *bytes
,const char *password
,GError **error
);
Creates a new PopplerDocument from bytes
. The returned document
will hold a reference to bytes
.
On error, NULL
is returned, with error
set. Possible errors include
those in the POPPLER_ERROR and G_FILE_ERROR domains.
bytes |
a GBytes |
|
password |
password to unlock the file with, or |
[allow-none] |
error |
Return location for an error, or |
[allow-none] |
Since: 0.82
PopplerDocument * poppler_document_new_from_data (char *data
,int length
,const char *password
,GError **error
);
poppler_document_new_from_data
has been deprecated since version 0.82 and should not be used in newly-written code.
This requires directly managing length
and data
.
Use poppler_document_new_from_bytes()
instead.
Creates a new PopplerDocument. If NULL
is returned, then error
will be
set. Possible errors include those in the POPPLER_ERROR and G_FILE_ERROR
domains.
Note that data
is not copied nor is a new reference to it created.
It must remain valid and cannot be destroyed as long as the returned
document exists.
PopplerDocument * poppler_document_new_from_fd (int fd
,const char *password
,GError **error
);
Creates a new PopplerDocument reading the PDF contents from the file
descriptor fd
. fd
must refer to a regular file, or STDIN, and be open
for reading.
Possible errors include those in the POPPLER_ERROR and G_FILE_ERROR
domains.
Note that this function takes ownership of fd
; you must not operate on it
again, nor close it.
fd |
a valid file descriptor |
|
password |
password to unlock the file with, or |
[allow-none] |
error |
Return location for an error, or |
[allow-none] |
Since: 21.12.0
PopplerDocument * poppler_document_new_from_file (const char *uri
,const char *password
,GError **error
);
Creates a new PopplerDocument. If NULL
is returned, then error
will be
set. Possible errors include those in the POPPLER_ERROR and G_FILE_ERROR
domains.
PopplerDocument * poppler_document_new_from_gfile (GFile *file
,const char *password
,GCancellable *cancellable
,GError **error
);
Creates a new PopplerDocument reading the PDF contents from file
.
Possible errors include those in the POPPLER_ERROR and G_FILE_ERROR
domains.
file |
a GFile to load |
|
password |
password to unlock the file with, or |
[allow-none] |
cancellable |
a GCancellable, or |
[allow-none] |
error |
Return location for an error, or |
[allow-none] |
Since: 0.22
PopplerDocument * poppler_document_new_from_stream (GInputStream *stream
,goffset length
,const char *password
,GCancellable *cancellable
,GError **error
);
Creates a new PopplerDocument reading the PDF contents from stream
.
Note that the given GInputStream must be seekable or G_IO_ERROR_NOT_SUPPORTED
will be returned.
Possible errors include those in the POPPLER_ERROR, G_FILE_ERROR
and G_IO_ERROR domains.
stream |
a GInputStream to read from |
|
length |
the stream length, or -1 if not known |
|
password |
password to unlock the file with, or |
[allow-none] |
cancellable |
a GCancellable, or |
[allow-none] |
error |
Return location for an error, or |
[allow-none] |
Since: 0.22
void poppler_document_reset_form (PopplerDocument *document
,GList *fields
,gboolean exclude_fields
);
Resets the form fields specified by fields if exclude_fields is FALSE. Resets all others if exclude_fields is TRUE. All form fields are reset regardless of the exclude_fields flag if fields is empty.
document |
||
fields |
list of fields to reset. |
[element-type utf8][nullable] |
exclude_fields |
whether to reset all fields except those in |
Since: 0.90
gboolean poppler_document_save (PopplerDocument *document
,const char *uri
,GError **error
);
Saves document
. Any change made in the document such as
form fields filled, annotations added or modified
will be saved.
If error
is set, FALSE
will be returned. Possible errors
include those in the G_FILE_ERROR domain.
gboolean poppler_document_save_a_copy (PopplerDocument *document
,const char *uri
,GError **error
);
Saves a copy of the original document
.
Any change made in the document such as
form fields filled by the user will not be saved.
If error
is set, FALSE
will be returned. Possible errors
include those in the G_FILE_ERROR domain.
gboolean poppler_document_save_to_fd (PopplerDocument *document
,int fd
,gboolean include_changes
,GError **error
);
Saves document
. Any change made in the document such as
form fields filled, annotations added or modified
will be saved if include_changes
is TRUE
, or discarded i
include_changes
is FALSE
.
Note that this function takes ownership of fd
; you must not operate on it
again, nor close it.
If error
is set, FALSE
will be returned. Possible errors
include those in the G_FILE_ERROR domain.
document |
||
fd |
a valid file descriptor open for writing |
|
include_changes |
whether to include user changes (e.g. form fills) |
|
error |
return location for an error, or |
[allow-none] |
Since: 21.12.0
void poppler_document_set_author (PopplerDocument *document
,const gchar *author
);
Sets the document's author. If author
is NULL
, Author
entry is removed from the document's Info dictionary.
Since: 0.46
void poppler_document_set_creation_date (PopplerDocument *document
,time_t creation_date
);
Sets the document's creation date. If creation_date
is -1, CreationDate
entry is removed from the document's Info dictionary.
Since: 0.46
void poppler_document_set_creation_date_time (PopplerDocument *document
,GDateTime *creation_datetime
);
Sets the document's creation date. If creation_datetime
is NULL
,
CreationDate entry is removed from the document's Info dictionary.
Since: 20.09.0
void poppler_document_set_creator (PopplerDocument *document
,const gchar *creator
);
Sets the document's creator. If creator
is NULL
, Creator
entry is removed from the document's Info dictionary.
Since: 0.46
void poppler_document_set_keywords (PopplerDocument *document
,const gchar *keywords
);
Sets the document's keywords. If keywords
is NULL
,
Keywords entry is removed from the document's Info dictionary.
Since: 0.46
void poppler_document_set_modification_date (PopplerDocument *document
,time_t modification_date
);
Sets the document's modification date. If modification_date
is -1, ModDate
entry is removed from the document's Info dictionary.
Since: 0.46
void poppler_document_set_modification_date_time (PopplerDocument *document
,GDateTime *modification_datetime
);
Sets the document's modification date. If modification_datetime
is NULL
,
ModDate entry is removed from the document's Info dictionary.
Since: 20.09.0
void poppler_document_set_producer (PopplerDocument *document
,const gchar *producer
);
Sets the document's producer. If producer
is NULL
,
Producer entry is removed from the document's Info dictionary.
Since: 0.46
void poppler_document_set_subject (PopplerDocument *document
,const gchar *subject
);
Sets the document's subject. If subject
is NULL
, Subject
entry is removed from the document's Info dictionary.
Since: 0.46
void poppler_document_set_title (PopplerDocument *document
,const gchar *title
);
Sets the document's title. If title
is NULL
, Title entry
is removed from the document's Info dictionary.
Since: 0.46
PopplerFontInfo *
poppler_font_info_new (PopplerDocument *document
);
Creates a new PopplerFontInfo object
gboolean poppler_font_info_scan (PopplerFontInfo *font_info
,int n_pages
,PopplerFontsIter **iter
);
Scans the document associated with font_info
for fonts. At most
n_pages
will be scanned starting from the current iterator. iter
will
point to the first font scanned.
Here is a simple example of code to scan fonts in a document
1 2 3 4 5 6 7 8 9 10 11 12 13 |
font_info = poppler_font_info_new (document); scanned_pages = 0; while (scanned_pages <= poppler_document_get_n_pages(document)) { poppler_font_info_scan (font_info, 20, &fonts_iter); scanned_pages += 20; if (!fonts_iter) continue; /* No fonts found in these 20 pages */ do { /* Do something with font iter */ g_print ("Font Name: %s\n", poppler_fonts_iter_get_name (fonts_iter)); } while (poppler_fonts_iter_next (fonts_iter)); poppler_fonts_iter_free (fonts_iter); } |
font_info |
||
n_pages |
number of pages to scan |
|
iter |
return location for a PopplerFontsIter. |
[out] |
PopplerFontsIter *
poppler_fonts_iter_copy (PopplerFontsIter *iter
);
Creates a copy of iter
void
poppler_fonts_iter_free (PopplerFontsIter *iter
);
Frees the given PopplerFontsIter
const char *
poppler_fonts_iter_get_encoding (PopplerFontsIter *iter
);
Returns the encoding of the font associated with iter
Since: 0.20
const char *
poppler_fonts_iter_get_file_name (PopplerFontsIter *iter
);
The filename of the font associated with iter
or NULL
if
the font is embedded
PopplerFontType
poppler_fonts_iter_get_font_type (PopplerFontsIter *iter
);
Returns the type of the font associated with iter
const char *
poppler_fonts_iter_get_full_name (PopplerFontsIter *iter
);
Returns the full name of the font associated with iter
const char *
poppler_fonts_iter_get_name (PopplerFontsIter *iter
);
Returns the name of the font associated with iter
const char *
poppler_fonts_iter_get_substitute_name
(PopplerFontsIter *iter
);
The name of the substitute font of the font associated with iter
or NULL
if
the font is embedded
Since: 0.20
gboolean
poppler_fonts_iter_is_embedded (PopplerFontsIter *iter
);
Returns whether the font associated with iter
is embedded in the document
gboolean
poppler_fonts_iter_is_subset (PopplerFontsIter *iter
);
Returns whether the font associated with iter
is a subset of another font
gboolean
poppler_fonts_iter_next (PopplerFontsIter *iter
);
Sets iter
to point to the next font
PopplerIndexIter *
poppler_index_iter_copy (PopplerIndexIter *iter
);
Creates a new PopplerIndexIter as a copy of iter
. This must be freed with
poppler_index_iter_free()
.
PopplerAction *
poppler_index_iter_get_action (PopplerIndexIter *iter
);
Returns the PopplerAction associated with iter
. It must be freed with
poppler_action_free()
.
PopplerIndexIter *
poppler_index_iter_get_child (PopplerIndexIter *parent
);
Returns a newly created child of parent
, or NULL
if the iter has no child.
See poppler_index_iter_new()
for more information on this function.
gboolean
poppler_index_iter_is_open (PopplerIndexIter *iter
);
Returns whether this node should be expanded by default to the user. The document can provide a hint as to how the document's index should be expanded initially.
PopplerIndexIter *
poppler_index_iter_new (PopplerDocument *document
);
Returns the root PopplerIndexIter for document
, or NULL
. This must be
freed with poppler_index_iter_free()
.
Certain documents have an index associated with them. This index can be used to help the user navigate the document, and is similar to a table of contents. Each node in the index will contain a PopplerAction that can be displayed to the user — typically a POPPLER_ACTION_GOTO_DEST or a POPPLER_ACTION_URI.
Here is a simple example of some code that walks the full index:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
static void walk_index (PopplerIndexIter *iter) { do { /* Get the action and do something with it */ PopplerIndexIter *child = poppler_index_iter_get_child (iter); if (child) walk_index (child); poppler_index_iter_free (child); } while (poppler_index_iter_next (iter)); } ... { iter = poppler_index_iter_new (document); walk_index (iter); poppler_index_iter_free (iter); } |
gboolean
poppler_index_iter_next (PopplerIndexIter *iter
);
Sets iter
to point to the next action at the current level, if valid. See
poppler_index_iter_new()
for more information.
PopplerLayersIter *
poppler_layers_iter_copy (PopplerLayersIter *iter
);
Creates a new PopplerLayersIter as a copy of iter
. This must be freed with
poppler_layers_iter_free()
.
void
poppler_layers_iter_free (PopplerLayersIter *iter
);
Frees iter
.
Since: 0.12
PopplerLayersIter *
poppler_layers_iter_get_child (PopplerLayersIter *parent
);
Returns a newly created child of parent
, or NULL
if the iter has no child.
See poppler_layers_iter_new()
for more information on this function.
Since: 0.12
PopplerLayer *
poppler_layers_iter_get_layer (PopplerLayersIter *iter
);
Returns the PopplerLayer associated with iter
.
Since: 0.12
gchar *
poppler_layers_iter_get_title (PopplerLayersIter *iter
);
Returns the title associated with iter
. It must be freed with
g_free()
.
a new string containing the iter
's title or NULL
if iter
doesn't have a title.
The returned string should be freed with g_free()
when no longer needed.
Since: 0.12
PopplerLayersIter *
poppler_layers_iter_new (PopplerDocument *document
);
Since: 0.12
gboolean
poppler_layers_iter_next (PopplerLayersIter *iter
);
Sets iter
to point to the next action at the current level, if valid. See
poppler_layers_iter_new()
for more information.
Since: 0.12
PopplerPSFile * poppler_ps_file_new (PopplerDocument *document
,const char *filename
,int first_page
,int n_pages
);
Create a new postscript file to render to
PopplerPSFile * poppler_ps_file_new_fd (PopplerDocument *document
,int fd
,int first_page
,int n_pages
);
Create a new postscript file to render to.
Note that this function takes ownership of fd
; you must not operate on it
again, nor close it.
document |
||
fd |
a valid file descriptor open for writing |
|
first_page |
the first page to print |
|
n_pages |
the number of pages to print |
Since: 21.12.0
void poppler_ps_file_set_duplex (PopplerPSFile *ps_file
,gboolean duplex
);
Enable or disable Duplex printing.
void poppler_ps_file_set_paper_size (PopplerPSFile *ps_file
,double width
,double height
);
Set the output paper size. These values will end up in the DocumentMedia, the BoundingBox DSC comments and other places in the generated PostScript.
typedef struct _PopplerFontInfo PopplerFontInfo;
Interface for getting the Fonts of a poppler_document
Since 24.10 this type supports g_autoptr
Font types
unknown font type |
||
Type 1 font type |
||
Type 1 font type embedded in Compact Font Format (CFF) font program |
||
Type 1 font type embedded in OpenType font program |
||
A font type that is defined with PDF graphics operators |
||
TrueType font type |
||
TrueType font type embedded in OpenType font program |
||
CIDFont type based on Type 1 font technology |
||
CIDFont type based on Type 1 font technology embedded in CFF font program |
||
CIDFont type based on Type 1 font technology embedded in OpenType font program |
||
CIDFont type based on TrueType font technology |
||
CIDFont type based on TrueType font technology embedded in OpenType font program |
typedef struct _PopplerFontsIter PopplerFontsIter;
Since 24.10 this type supports g_autoptr
typedef struct _PopplerIndexIter PopplerIndexIter;
Interface for getting the Index of a poppler_document
Since 24.10 this type supports g_autoptr
typedef struct _PopplerLayersIter PopplerLayersIter;
Interface for getting the Layers of a poppler_document
Since 24.10 this type supports g_autoptr
PDF Subtype Conformance
Null |
||
Level A (accessible) conformance (PDF/A) |
||
Level B (basic) conformance (PDF/A) |
||
Level G (external graphical content) (PDF/X) |
||
Level N (external ICC Profile) (PDF/X) |
||
Level P (ICC Profile) (PDF/X) |
||
Level PG (conjunction of P and G) (PDF/X) |
||
Level U (Unicode) conformance (PDF/A) |
||
No conformance level available |
Since: 0.70
PDF Subtype
Null |
||
ISO 19005 - Document management -- Electronic document file format for long-term preservation (PDF/A) |
||
ISO 24517 - Document management -- Engineering document format using PDF (PDF/E) |
||
ISO 14289 - Document management applications -- Electronic document file format enhancement for accessibility (PDF/UA) |
||
ISO 16612 - Graphic technology -- Variable data exchange (PDF/VT) |
||
ISO 15930 - Graphic technology -- Prepress digital data exchange (PDF/X) |
||
Not compliant with the above standards |
Since: 0.70
Page layout types
Page modes
typedef struct { gint start_page; gint end_page; } PopplerPageRange;
A PopplerPageRange is used to specify a range of pages.
Since: 0.80
Permissions
document can be printer |
||
document contents can be modified |
||
document can be copied |
||
annotations can added to the document |
||
interactive form fields can be filled in |
||
extract text and graphics (in support of accessibility to users with disabilities or for other purposes). Since 0.18 |
||
assemble the document (insert, rotate, or delete pages and create bookmarks or thumbnail images). Since 0.18 |
||
document can be printer at high resolution. Since 0.18 |
||
document permits all operations |
Viewer preferences
no preferences set |
||
hider toolbars when document is active |
||
hide menu bar when document is active |
||
hide UI elements in document's window |
||
resize document's window to fit the size of the first displayed page |
||
position the document's window in the center of the screen |
||
display document title in window's title bar |
||
the predominant reading order for text is right to left |
“author”
property “author” char *
The author of the document
Owner: PopplerDocument
Flags: Read / Write
Default value: NULL
“creation-date”
property “creation-date” int
The date the document was created as seconds since the Epoch, or -1
PopplerDocument:creation-date
has been deprecated since version 20.09.0 and should not be used in newly-written code.
This will overflow in 2038. Use creation-datetime instead.
Owner: PopplerDocument
Flags: Read / Write
Allowed values: >= -1
Default value: -1
“creation-datetime”
property “creation-datetime” GDateTime *
The date and time the document was created.
Owner: PopplerDocument
Flags: Read / Write
Since: 20.09.0
“creator”
property “creator” char *
The creator of the document. See also poppler_document_get_creator()
Owner: PopplerDocument
Flags: Read / Write
Default value: NULL
“format”
property “format” char *
The PDF version as string. See also poppler_document_get_pdf_version_string()
Owner: PopplerDocument
Flags: Read
Default value: NULL
“format-major”
property “format-major” guint
The PDF major version number. See also poppler_document_get_pdf_version()
Owner: PopplerDocument
Flags: Read
Default value: 1
“format-minor”
property “format-minor” guint
The PDF minor version number. See also poppler_document_get_pdf_version()
Owner: PopplerDocument
Flags: Read
Default value: 0
“keywords”
property “keywords” char *
The keywords associated to the document
Owner: PopplerDocument
Flags: Read / Write
Default value: NULL
“linearized”
property “linearized” gboolean
Whether document is linearized. See also poppler_document_is_linearized()
Owner: PopplerDocument
Flags: Read
Default value: FALSE
“metadata”
property “metadata” char *
Document metadata in XML format, or NULL
Owner: PopplerDocument
Flags: Read
Default value: NULL
“mod-date”
property “mod-date” int
The date the document was most recently modified as seconds since the Epoch, or -1
PopplerDocument:mod-date
has been deprecated since version 20.09.0 and should not be used in newly-written code.
This will overflow in 2038. Use mod-datetime instead.
Owner: PopplerDocument
Flags: Read / Write
Allowed values: >= -1
Default value: -1
“mod-datetime”
property “mod-datetime” GDateTime *
The GDateTime the document was most recently modified.
Owner: PopplerDocument
Flags: Read / Write
Since: 20.09.0
“page-layout”
property“page-layout” PopplerPageLayout
The page layout that should be used when the document is opened
Owner: PopplerDocument
Flags: Read
Default value: POPPLER_PAGE_LAYOUT_UNSET
“page-mode”
property“page-mode” PopplerPageMode
The mode that should be used when the document is opened
Owner: PopplerDocument
Flags: Read
Default value: POPPLER_PAGE_MODE_UNSET
“permissions”
property“permissions” PopplerPermissions
Flags specifying which operations are permitted when the document is opened
Owner: PopplerDocument
Flags: Read
Default value: 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 | POPPLER_PERMISSIONS_OK_TO_EXTRACT_CONTENTS | POPPLER_PERMISSIONS_OK_TO_ASSEMBLE | POPPLER_PERMISSIONS_OK_TO_PRINT_HIGH_RESOLUTION
“print-duplex”
property“print-duplex” PopplerPrintDuplex
Duplex Viewer Preference.
Owner: PopplerDocument
Flags: Read
Default value: POPPLER_PRINT_DUPLEX_NONE
Since: 0.80
“print-n-copies”
property “print-n-copies” int
Suggested number of copies to be printed for this document
Owner: PopplerDocument
Flags: Read
Allowed values: >= 1
Default value: 1
Since: 0.80
“print-scaling”
property“print-scaling” PopplerPrintScaling
Print Scaling Viewer Preference.
Owner: PopplerDocument
Flags: Read
Default value: POPPLER_PRINT_SCALING_APP_DEFAULT
Since: 0.73
“producer”
property “producer” char *
The producer of the document. See also poppler_document_get_producer()
Owner: PopplerDocument
Flags: Read / Write
Default value: NULL
“subject”
property “subject” char *
The subject of the document
Owner: PopplerDocument
Flags: Read / Write
Default value: NULL
“subtype”
property“subtype” PopplerPDFSubtype
Document PDF subtype type
Owner: PopplerDocument
Flags: Read
Default value: POPPLER_PDF_SUBTYPE_UNSET
“subtype-conformance”
property“subtype-conformance” PopplerPDFConformance
Document PDF subtype conformance
Owner: PopplerDocument
Flags: Read
Default value: POPPLER_PDF_SUBTYPE_CONF_UNSET
“subtype-part”
property“subtype-part” PopplerPDFPart
Document PDF subtype part
Owner: PopplerDocument
Flags: Read
Default value: POPPLER_PDF_SUBTYPE_PART_UNSET
“subtype-string”
property “subtype-string” char *
Document PDF subtype. See also poppler_document_get_pdf_subtype_string()
Owner: PopplerDocument
Flags: Read
Default value: NULL
“title”
property “title” char *
The document's title or NULL
Owner: PopplerDocument
Flags: Read / Write
Default value: NULL
“viewer-preferences”
property“viewer-preferences” PopplerViewerPreferences
Viewer Preferences.
Owner: PopplerDocument
Flags: Read