PoDoFo  0.9.20
Public Member Functions | List of all members
PoDoFo::PdfInfo Class Referencefinal

#include <PdfInfo.h>

Inherits PoDoFo::PdfDictionaryElement.

Public Member Functions

 PdfInfo (PdfObject &obj)
 
 PdfInfo (PdfObject &obj, PdfInfoInitial initial)
 
void SetTitle (nullable< const PdfString & > title)
 
nullable< const PdfString & > GetTitle () const
 
void SetAuthor (nullable< const PdfString & > author)
 
nullable< const PdfString & > GetAuthor () const
 
void SetSubject (nullable< const PdfString & > subject)
 
nullable< const PdfString & > GetSubject () const
 
void SetKeywords (nullable< const PdfString & > keywords)
 
nullable< const PdfString & > GetKeywords () const
 
void SetCreator (nullable< const PdfString & > creator)
 
nullable< const PdfString & > GetCreator () const
 
void SetProducer (nullable< const PdfString & > producer)
 
nullable< const PdfString & > GetProducer () const
 
nullable< PdfDateGetCreationDate () const
 
nullable< PdfDateGetModDate () const
 
void SetTrapped (nullable< const PdfName & > trapped)
 
nullable< const PdfName & > GetTrapped () const
 

Detailed Description

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

Constructor & Destructor Documentation

PdfInfo::PdfInfo ( PdfObject obj)

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

Parameters
objmust be an info dictionary
PdfInfo::PdfInfo ( PdfObject obj,
PdfInfoInitial  initial 
)

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

Parameters
objmust be an info dictionary.
initialwhich information should be writting initially to the information

Member Function Documentation

nullable< const PdfString & > PdfInfo::GetAuthor ( ) const

Get the author of the document

Returns
the author
nullable< PdfDate > PdfInfo::GetCreationDate ( ) const

Get creation date of document

Returns
creation date
nullable< const PdfString & > PdfInfo::GetCreator ( ) const

Get the creator of the document

Returns
the creator
nullable< const PdfString & > PdfInfo::GetKeywords ( ) const

Get the keywords of the document

Returns
the keywords
nullable< PdfDate > PdfInfo::GetModDate ( ) const

Get modification date of document

Returns
modification date
nullable< const PdfString & > PdfInfo::GetProducer ( ) const

Get the producer of the document

Returns
the producer
nullable< const PdfString & > PdfInfo::GetSubject ( ) const

Get the subject of the document

Returns
the subject
nullable< const PdfString & > PdfInfo::GetTitle ( ) const

Get the title of the document

Returns
the title
nullable< const PdfName & > PdfInfo::GetTrapped ( ) const

Get the trapping state of the document

Returns
the title
void PdfInfo::SetAuthor ( nullable< const PdfString & >  author)

Set the author of the document.

Parameters
authorauthor
void PdfInfo::SetCreator ( nullable< const PdfString & >  creator)

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

Parameters
creatorcreator
void PdfInfo::SetKeywords ( nullable< const PdfString & >  keywords)

Set keywords for this document

Parameters
keywordsa list of keywords
void PdfInfo::SetProducer ( nullable< const PdfString & >  producer)

Set the producer of the document.

Parameters
producerproducer
void PdfInfo::SetSubject ( nullable< const PdfString & >  subject)

Set the subject of the document.

Parameters
subjectsubject
void PdfInfo::SetTitle ( nullable< const PdfString & >  title)

Set the title of the document.

Parameters
titletitle
void PdfInfo::SetTrapped ( nullable< const PdfName & >  trapped)

Set the trapping state of the document.

Parameters
trappedtrapped