PoDoFo::PdfInfo Class Reference

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

#include <PdfInfo.h>

Inherits PoDoFo::PdfDictionaryElement.

Public Member Functions
	PdfInfo (PdfObject &obj)
	Create a PdfInfo object from an existing object in the PDF file. More...
	PdfInfo (PdfObject &obj, PdfInfoInitial initial)
	Create a PdfInfo object from an existing object in the PDF file. More...
void	SetTitle (nullable< const PdfString & > title)
	Set the title of the document. More...
nullable< const PdfString & >	GetTitle () const
	Get the title of the document. More...
void	SetAuthor (nullable< const PdfString & > author)
	Set the author of the document. More...
nullable< const PdfString & >	GetAuthor () const
	Get the author of the document. More...
void	SetSubject (nullable< const PdfString & > subject)
	Set the subject of the document. More...
nullable< const PdfString & >	GetSubject () const
	Get the subject of the document. More...
void	SetKeywords (nullable< const PdfString & > keywords)
	Set keywords for this document. More...
nullable< const PdfString & >	GetKeywords () const
	Get the keywords of the document. More...
void	SetCreator (nullable< const PdfString & > creator)
	Set the creator of the document. More...
nullable< const PdfString & >	GetCreator () const
	Get the creator of the document. More...
void	SetProducer (nullable< const PdfString & > producer)
	Set the producer of the document. More...
nullable< const PdfString & >	GetProducer () const
	Get the producer of the document. More...
void	SetCreationDate (nullable< PdfDate > date)
nullable< PdfDate >	GetCreationDate () const
	Get creation date of document. More...
void	SetModDate (nullable< PdfDate > date)
nullable< PdfDate >	GetModDate () const
	Get modification date of document. More...
void	SetTrapped (nullable< const PdfName & > trapped)
	Set the trapping state of the document. More...
nullable< const PdfName & >	GetTrapped () const
	Get the trapping state of the document. More...

Detailed Description

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

Constructor & Destructor Documentation

PdfInfo() [1/2]

PdfInfo::PdfInfo

(

PdfObject &

obj

)

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

Parameters

obj	must be an info dictionary

PdfInfo() [2/2]

PdfInfo::PdfInfo	(	PdfObject &	obj,
		PdfInfoInitial	initial
	)

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

Parameters

obj	must be an info dictionary.
initial	which information should be writing initially to the information

Member Function Documentation

GetAuthor()

nullable< const PdfString & > PdfInfo::GetAuthor

(

)

const

Get the author of the document.

Returns

the author

GetCreationDate()

nullable< PdfDate > PdfInfo::GetCreationDate

(

)

const

Get creation date of document.

Returns

creation date

GetCreator()

nullable< const PdfString & > PdfInfo::GetCreator

(

)

const

Get the creator of the document.

Returns

the creator

GetKeywords()

nullable< const PdfString & > PdfInfo::GetKeywords

(

)

const

Get the keywords of the document.

Returns

the keywords

GetModDate()

nullable< PdfDate > PdfInfo::GetModDate

(

)

const

Get modification date of document.

Returns

modification date

GetProducer()

nullable< const PdfString & > PdfInfo::GetProducer

(

)

const

Get the producer of the document.

Returns

the producer

GetSubject()

nullable< const PdfString & > PdfInfo::GetSubject

(

)

const

Get the subject of the document.

Returns

the subject

GetTitle()

nullable< const PdfString & > PdfInfo::GetTitle

(

)

const

Get the title of the document.

Returns

the title

GetTrapped()

nullable< const PdfName & > PdfInfo::GetTrapped

(

)

const

Get the trapping state of the document.

Returns

the title

SetAuthor()

void PdfInfo::SetAuthor

(

nullable< const PdfString & >

author

)

Set the author of the document.

Parameters

author

author

SetCreator()

void PdfInfo::SetCreator

(

nullable< const PdfString & >

creator

)

Set the creator of the document.

Typically the name of the application using the library.

Parameters

creator

creator

SetKeywords()

void PdfInfo::SetKeywords

(

nullable< const PdfString & >

keywords

)

Set keywords for this document.

Parameters

keywords

a list of keywords

SetProducer()

void PdfInfo::SetProducer

(

nullable< const PdfString & >

producer

)

Set the producer of the document.

Parameters

producer

producer

SetSubject()

void PdfInfo::SetSubject

(

nullable< const PdfString & >

subject

)

Set the subject of the document.

Parameters

subject

subject

SetTitle()

void PdfInfo::SetTitle

(

nullable< const PdfString & >

title

)

Set the title of the document.

Parameters

title

title

SetTrapped()

void PdfInfo::SetTrapped

(

nullable< const PdfName & >

trapped

)

Set the trapping state of the document.

Parameters

trapped

trapped

---

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

• src/podofo/main/PdfInfo.h
• src/podofo/main/PdfInfo.cpp