PoDoFo  0.9.4
Public Types | Public Member Functions | List of all members
PoDoFo::PdfInfo Class Reference

#include <PdfInfo.h>

Inheritance diagram for PoDoFo::PdfInfo:
PoDoFo::PdfElement

Public Types

enum  EPdfInfoInitial { ePdfInfoInitial_WriteCreationTime = 0x01, ePdfInfoInitial_WriteModificationTime = 0x02, ePdfInfoInitial_WriteProducer = 0x04 }
 

Public Member Functions

 PdfInfo (PdfVecObjects *pParent, int eInitial=ePdfInfoInitial_WriteCreationTime|ePdfInfoInitial_WriteProducer)
 
 PdfInfo (PdfObject *pObject, int eInitial=ePdfInfoInitial_WriteModificationTime)
 
 ~PdfInfo ()
 
void SetAuthor (const PdfString &sAuthor)
 
const PdfStringGetAuthor () const
 
void SetCreator (const PdfString &sCreator)
 
const PdfStringGetCreator () const
 
void SetKeywords (const PdfString &sKeywords)
 
const PdfStringGetKeywords () const
 
void SetSubject (const PdfString &sSubject)
 
const PdfStringGetSubject () const
 
void SetTitle (const PdfString &sTitle)
 
const PdfStringGetTitle () const
 
void SetProducer (const PdfString &sProducer)
 
const PdfStringGetProducer () const
 
void SetTrapped (const PdfName &sTrapped)
 
const PdfNameGetTrapped () const
 
PdfDate GetCreationDate () const
 
PdfDate GetModDate () const
 
void SetCustomKey (const PdfName &sName, const PdfString &sValue)
 
- Public Member Functions inherited from PoDoFo::PdfElement
PdfObjectGetObject ()
 
const PdfObjectGetObject () const
 

Additional Inherited Members

- Protected Member Functions inherited from PoDoFo::PdfElement
 PdfElement (const char *pszType, PdfVecObjects *pParent)
 
 PdfElement (const char *pszType, PdfDocument *pParent)
 
 PdfElement (const char *pszType, PdfObject *pObject)
 
 PdfElement (EPdfDataType eExpectedDataType, PdfObject *pObject)
 
const char * TypeNameForIndex (int i, const char **ppTypes, long lLen) const
 
int TypeNameToIndex (const char *pszType, const char **ppTypes, long lLen, int nUnknownValue) const
 
PdfObjectCreateObject (const char *pszType=NULL)
 
PdfObjectGetNonConstObject () const
 

Detailed Description

This class provides access to the documents info dictionary, which provides information about the PDF document.

Member Enumeration Documentation

Enum to specifiy the initial information of the info dictionary.

Enumerator
ePdfInfoInitial_WriteCreationTime 

Write the creation time (current time). Default for new documents.

ePdfInfoInitial_WriteModificationTime 

Write the modification time (current time). Default for loaded documents.

ePdfInfoInitial_WriteProducer 

Write producer key. Default for new documents.

Constructor & Destructor Documentation

PoDoFo::PdfInfo::PdfInfo ( PdfVecObjects pParent,
int  eInitial = ePdfInfoInitial_WriteCreationTime | ePdfInfoInitial_WriteProducer 
)

Create a new PdfInfo object

Parameters
pParentthe parent of this object
eInitialwhich information should be writting initially to the information dictionary
PoDoFo::PdfInfo::PdfInfo ( PdfObject pObject,
int  eInitial = ePdfInfoInitial_WriteModificationTime 
)

Create a PdfInfo object from an existing object in the PDF file.

Parameters
pObjectmust be an info dictionary.
eInitialwhich information should be writting initially to the information
PoDoFo::PdfInfo::~PdfInfo ( )

Destructor

Member Function Documentation

const PdfString & PoDoFo::PdfInfo::GetAuthor ( ) const
inline

Get the author of the document

Returns
the author
PdfDate PoDoFo::PdfInfo::GetCreationDate ( ) const
inline

Get creation date of document

Returns
creation date
const PdfString & PoDoFo::PdfInfo::GetCreator ( ) const
inline

Get the creator of the document

Returns
the creator
const PdfString & PoDoFo::PdfInfo::GetKeywords ( ) const
inline

Get the keywords of the document

Returns
the keywords
PdfDate PoDoFo::PdfInfo::GetModDate ( ) const
inline

Get modification date of document

Returns
modification date
const PdfString & PoDoFo::PdfInfo::GetProducer ( ) const
inline

Get the producer of the document

Returns
the producer
const PdfString & PoDoFo::PdfInfo::GetSubject ( ) const
inline

Get the subject of the document

Returns
the subject
const PdfString & PoDoFo::PdfInfo::GetTitle ( ) const
inline

Get the title of the document

Returns
the title
const PdfName & PoDoFo::PdfInfo::GetTrapped ( ) const
inline

Get the trapping state of the document

Returns
the title
void PoDoFo::PdfInfo::SetAuthor ( const PdfString sAuthor)

Set the author of the document.

Parameters
sAuthorauthor
void PoDoFo::PdfInfo::SetCreator ( const PdfString sCreator)

Set the creator of the document. Typically the name of the application using the library.

Parameters
sCreatorcreator
void PoDoFo::PdfInfo::SetCustomKey ( const PdfName sName,
const PdfString sValue 
)

Set custom info key.

Parameters
sNameName of the key.
sValueValue of the key.
void PoDoFo::PdfInfo::SetKeywords ( const PdfString sKeywords)

Set keywords for this document

Parameters
sKeywordsa list of keywords
void PoDoFo::PdfInfo::SetProducer ( const PdfString sProducer)

Set the producer of the document.

Parameters
sProducerproducer
void PoDoFo::PdfInfo::SetSubject ( const PdfString sSubject)

Set the subject of the document.

Parameters
sSubjectsubject
void PoDoFo::PdfInfo::SetTitle ( const PdfString sTitle)

Set the title of the document.

Parameters
sTitletitle
void PoDoFo::PdfInfo::SetTrapped ( const PdfName sTrapped)

Set the trapping state of the document.

Parameters
sTrappedtrapped