libcrn  3.9.5
A document image processing library
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Public Attributes | List of all members
crn::PDF::Attributes Class Reference

Attributes to create a PDF export of a document. More...

#include <CRNPDFAttributes.h>

+ Inheritance diagram for crn::PDF::Attributes:
+ Collaboration diagram for crn::PDF::Attributes:

Public Types

enum  Layout : int { Layout::ONE_PAGE = 1, Layout::CONTINUOUS = 2, Layout::OPEN_LEFT = 3, Layout::OPEN_RIGHT = 4 }
 

Public Member Functions

 Attributes ()
 Default constructor. More...
 
 Attributes (const Attributes &)=default
 
 Attributes (Attributes &&)=default
 
Attributesoperator= (const Attributes &)=default
 
Attributesoperator= (Attributes &&)=default
 
virtual ~Attributes () override
 
void Deserialize (xml::Element &el)
 
xml::Element Serialize (xml::Element &parent) const
 
- Public Member Functions inherited from crn::Object
virtual ~Object ()=default
 

Public Attributes

bool lossy_compression
 
int jpeg_qual
 
Layout layout
 
StringUTF8 author
 
StringUTF8 creator
 
StringUTF8 title
 
StringUTF8 subject
 
StringUTF8 keywords
 
StringUTF8 owner_password
 
StringUTF8 user_password
 
bool printable
 
bool copyable
 

Detailed Description

Attributes to create a PDF export of a document.

Attributes to create a PDF export of a document.

Author
Yann LEYDIER
Version
0.2
Date
Feb. 2011

Definition at line 40 of file CRNPDFAttributes.h.

Member Enumeration Documentation

enum crn::PDF::Attributes::Layout : int
strong
Enumerator
ONE_PAGE 
CONTINUOUS 
OPEN_LEFT 
OPEN_RIGHT 

Definition at line 43 of file CRNPDFAttributes.h.

Constructor & Destructor Documentation

crn::PDF::Attributes::Attributes ( )
inline

Default constructor.

Definition at line 45 of file CRNPDFAttributes.h.

crn::PDF::Attributes::Attributes ( const Attributes )
default
crn::PDF::Attributes::Attributes ( Attributes &&  )
default
virtual crn::PDF::Attributes::~Attributes ( )
inlineoverridevirtual

Definition at line 50 of file CRNPDFAttributes.h.

Member Function Documentation

void Attributes::Deserialize ( xml::Element el)
Exceptions
ExceptionInvalidArgumentnot a PDF::Attributes
ExceptionNotFoundattribute not found
ExceptionDomainwrong attribute

Definition at line 35 of file CRNPDFAttributes.cpp.

Attributes& crn::PDF::Attributes::operator= ( const Attributes )
default
Attributes& crn::PDF::Attributes::operator= ( Attributes &&  )
default
xml::Element Attributes::Serialize ( xml::Element parent) const

Definition at line 68 of file CRNPDFAttributes.cpp.

Member Data Documentation

StringUTF8 crn::PDF::Attributes::author

Definition at line 55 of file CRNPDFAttributes.h.

bool crn::PDF::Attributes::copyable

Can the document be copy-pasted? (needs owner_password to be set)

Definition at line 58 of file CRNPDFAttributes.h.

StringUTF8 crn::PDF::Attributes::creator

Definition at line 55 of file CRNPDFAttributes.h.

int crn::PDF::Attributes::jpeg_qual

0: high compression / bad quality, 100: low compression / better quality

Definition at line 53 of file CRNPDFAttributes.h.

StringUTF8 crn::PDF::Attributes::keywords

Definition at line 55 of file CRNPDFAttributes.h.

Layout crn::PDF::Attributes::layout

Page display layout

Definition at line 54 of file CRNPDFAttributes.h.

bool crn::PDF::Attributes::lossy_compression

true = JPEG images, false = PNG images

Definition at line 52 of file CRNPDFAttributes.h.

StringUTF8 crn::PDF::Attributes::owner_password

Definition at line 56 of file CRNPDFAttributes.h.

bool crn::PDF::Attributes::printable

Can the document be printed? (needs owner_password to be set)

Definition at line 57 of file CRNPDFAttributes.h.

StringUTF8 crn::PDF::Attributes::subject

Definition at line 55 of file CRNPDFAttributes.h.

StringUTF8 crn::PDF::Attributes::title

Definition at line 55 of file CRNPDFAttributes.h.

StringUTF8 crn::PDF::Attributes::user_password

Definition at line 56 of file CRNPDFAttributes.h.


The documentation for this class was generated from the following files: