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
void	SetTitle (nullable< const PdfString & > title)
	Set the title of the document.
nullable< const PdfString & >	GetTitle () const
	Get the title of the document.
void	SetAuthor (nullable< const PdfString & > author)
	Set the author of the document.
nullable< const PdfString & >	GetAuthor () const
	Get the author of the document.
void	SetSubject (nullable< const PdfString & > subject)
	Set the subject of the document.
nullable< const PdfString & >	GetSubject () const
	Get the subject of the document.
void	SetKeywords (nullable< const PdfString & > keywords)
	Set keywords for this document.
nullable< const PdfString & >	GetKeywords () const
	Get the keywords of the document.
void	SetCreator (nullable< const PdfString & > creator)
	Set the creator of the document.
nullable< const PdfString & >	GetCreator () const
	Get the creator of the document.
void	SetProducer (nullable< const PdfString & > producer)
	Set the producer of the document.
nullable< const PdfString & >	GetProducer () const
	Get the producer of the document.
void	SetCreationDate (nullable< PdfDate > date)
nullable< PdfDate >	GetCreationDate () const
	Get creation date of document.
void	SetModDate (nullable< PdfDate > date)
nullable< PdfDate >	GetModDate () const
	Get modification date of document.
void	SetTrapped (nullable< const PdfName & > trapped)
	Set the trapping state of the document.
nullable< const PdfName & >	GetTrapped () const
	Get the trapping state of the document.

Static Public Member Functions
static bool	TryCreateFromObject (const PdfObject &obj, std::unique_ptr< const PdfInfo > &info)
static bool	TryCreateFromObject (PdfObject &obj, std::unique_ptr< PdfInfo > &info)

Friends
class	PdfDocument

Detailed Description

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

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 trapping state

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