poppler Namespace Reference

Classes
class	destination
class	document
class	embedded_file
class	font_info
class	font_iterator
class	image
class	page
class	page_renderer
class	page_transition
class	rectangle
class	text_box
class	toc
class	toc_item
class	ustring

Typedefs
typedef unsigned int	argb
typedef std::vector< char >	byte_array
typedef void(*	debug_func) (const std::string &, void *)
typedef rectangle< int >	rect
typedef rectangle< double >	rectf
typedef unsigned int	time_type

Enumerations
enum	case_sensitivity_enum {   case_sensitive ,   case_insensitive }
enum	page_box_enum {   media_box ,   crop_box ,   bleed_box ,   trim_box ,   art_box }
enum	permission_enum {   perm_print ,   perm_change ,   perm_copy ,   perm_add_notes ,   perm_fill_forms ,   perm_accessibility ,   perm_assemble ,   perm_print_high_resolution }
enum	rotation_enum {   rotate_0 ,   rotate_90 ,   rotate_180 ,   rotate_270 }

Functions
time_type	convert_date (const std::string &date)
time_t	convert_date_t (const std::string &date)
std::ostream &	operator<< (std::ostream &stream, const byte_array &array)
std::ostream &	operator<< (std::ostream &stream, const rect &r)
std::ostream &	operator<< (std::ostream &stream, const rectf &r)
bool	set_data_dir (const std::string &new_data_dir)
void	set_debug_error_function (debug_func debug_function, void *closure)
unsigned int	version_major ()
unsigned int	version_micro ()
unsigned int	version_minor ()
std::string	version_string ()

Detailed Description

Single namespace containing all the classes and functions of poppler-cpp.

Typedef Documentation

debug_func

poppler::debug_func

Debug/error function.

This function type is used for debugging & error output; the first parameter is the actual message, the second is the unaltered closure argument which was passed to the set_debug_error_function() call.

Since

0.30.0

rect

poppler::rect

A rectangle with int dimensions and coordinates.

rectf

poppler::rectf

A rectangle with float (double) dimensions and coordinates.

Enumeration Type Documentation

case_sensitivity_enum

enum poppler::case_sensitivity_enum

The case sensitivity.

page_box_enum

enum poppler::page_box_enum

A possible box of a page in a PDF document.

Enumerator
media_box	The "media" box.
crop_box	The "crop" box.
bleed_box	The "bleed" box.
trim_box	The "trim" box.
art_box	The "art" box.

permission_enum

enum poppler::permission_enum

A possible permission in a PDF document.

Enumerator
perm_print	The permission to allow the print of a document.
perm_change	The permission to change a document. This is a generic "change" permission, so other permissions could affect some types of changes.
perm_copy	The permission to allow the copy or extraction of the text in a document.
perm_add_notes	The permission to allow the addition or editing of annotations, and the filling of interactive form fields (including signature fields).
perm_fill_forms	The permission to allow the filling of interactive form fields (including signature fields). Note this permission can be set even when the perm_add_notes is not: this means that only the filling of forms is allowed.
perm_accessibility	The permission to allow the extracting of content (for example, text) for accessibility usage (e.g. for a screen reader).
perm_assemble	The permission to allow to "assemble" a document. This implies operations such as the insertion, the rotation and the deletion of pages; the creation of bookmarks and thumbnail images. Note this permission can be set even when the perm_change is not
perm_print_high_resolution	The permission to allow the high resolution print of a document.

rotation_enum

enum poppler::rotation_enum

The case sensitivity.

Enumerator
rotate_0	A rotation of 0 degrees clockwise.
rotate_90	A rotation of 90 degrees clockwise.
rotate_180	A rotation of 180 degrees clockwise.
rotate_270	A rotation of 270 degrees clockwise.

Function Documentation

convert_date()

time_type poppler::convert_date

(

const std::string &

date

)

Converts a string representing a PDF date to a value compatible with time_type.

convert_date_t()

time_t poppler::convert_date_t

(

const std::string &

date

)

Converts a string representing a PDF date to a value compatible with time_t.

set_data_dir()

bool poppler::set_data_dir

(

const std::string &

new_data_dir

)

Sets a custom data directory for initialization of global parameters.

If no instances of

See also

document currently exist, this will save the given path as a custom data directory to be used when the first instance of the

document is constructed.

Returns

true on success, false on failure

Since

0.73.0

set_debug_error_function()

void poppler::set_debug_error_function	(	debug_func	debug_function,
		void *	closure
	)

Set a new debug/error output function.

If not set, by default error and debug messages will be sent to stderr.

Parameters

debug_function	the new debug function
closure	user data which will be passed as-is to the debug function

Since

0.30.0

version_major()

unsigned int poppler::version_major

(

)

Returns

the "major" number of the version of the current poppler-cpp library

version_micro()

unsigned int poppler::version_micro

(

)

Returns

the "micro" number of the version of the current poppler-cpp library

version_minor()

unsigned int poppler::version_minor

(

)

Returns

the "minor" number of the version of the current poppler-cpp library

version_string()

std::string poppler::version_string

(

)

Returns

the version string of the current poppler-cpp library