mm::PdfInfo Class Reference

#include <PdfInfo.h>

Inherits mm::PdfDictionaryElement.

Public Member Functions
	PdfInfo (PdfDocument &doc, PdfInfoInitial initial=PdfInfoInitial::WriteCreationTime|PdfInfoInitial::WriteProducer)
	PdfInfo (PdfObject &obj, PdfInfoInitial initial=PdfInfoInitial::None)
void	SetTitle (nullable< const PdfString & > title)
nullable< PdfString >	GetTitle () const
void	SetAuthor (nullable< const PdfString & > author)
nullable< PdfString >	GetAuthor () const
void	SetSubject (nullable< const PdfString & > subject)
nullable< PdfString >	GetSubject () const
void	SetKeywords (nullable< const PdfString & > keywords)
nullable< PdfString >	GetKeywords () const
void	SetCreator (nullable< const PdfString & > creator)
nullable< PdfString >	GetCreator () const
void	SetProducer (nullable< const PdfString & > producer)
nullable< PdfString >	GetProducer () const
nullable< PdfDate >	GetCreationDate () const
nullable< PdfDate >	GetModDate () const
void	SetTrapped (const PdfName &trapped)
const PdfName &	GetTrapped () const
void	SetCustomKey (const PdfName &name, const PdfString &value)

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	(	PdfDocument &	doc,
		PdfInfoInitial	initial = PdfInfoInitial::WriteCreationTime | PdfInfoInitial::WriteProducer
	)

Create a new PdfInfo object

Parameters

parent	the parent of this object
initial	which information should be writting initially to the information dictionary

PdfInfo() [2/2]

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

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

Parameters

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

Member Function Documentation

GetAuthor()

nullable< 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< PdfString > PdfInfo::GetCreator

(

)

const

Get the creator of the document

Returns

the creator

GetKeywords()

nullable< 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< PdfString > PdfInfo::GetProducer

(

)

const

Get the producer of the document

Returns

the producer

GetSubject()

nullable< PdfString > PdfInfo::GetSubject

(

)

const

Get the subject of the document

Returns

the subject

GetTitle()

nullable< PdfString > PdfInfo::GetTitle

(

)

const

Get the title of the document

Returns

the title

GetTrapped()

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

SetCustomKey()

void PdfInfo::SetCustomKey	(	const PdfName &	name,
		const PdfString &	value
	)

Set custom info key.

Parameters

name	Name of the key.
value	Value of the key.

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

(

const PdfName &

trapped

)

Set the trapping state of the document.

Parameters

trapped

trapped