wxPdfInfo Class Reference

Class representing a PDF document information dictionary. More...

#include <pdfinfo.h>

Public Member Functions
	wxPdfInfo ()
	Default constructor.
virtual	~wxPdfInfo ()
	Destructor.
void	SetTitle (const wxString &title)
void	SetAuthor (const wxString &author)
void	SetSubject (const wxString &subject)
void	SetKeywords (const wxString &keywords)
void	SetCreator (const wxString &creator)
void	SetProducer (const wxString &producer)
void	SetCreationDate (const wxString &creationDate)
void	SetModDate (const wxString &modDate)
const wxString	GetTitle () const
const wxString	GetAuthor () const
const wxString	GetSubject () const
const wxString	GetKeywords () const
const wxString	GetCreator () const
const wxString	GetProducer () const
const wxString	GetCreationDate () const
const wxString	GetModDate () const

Detailed Description

Class representing a PDF document information dictionary.

Constructor & Destructor Documentation

wxPdfInfo()

wxPdfInfo::wxPdfInfo ( )

inline

Default constructor.

~wxPdfInfo()

virtual wxPdfInfo::~wxPdfInfo ( )

inline

Destructor.

Member Function Documentation

GetAuthor()

const wxString wxPdfInfo::GetAuthor ( ) const

inline

Get the author of the document. The author is the person or organization that created the document's content.

Returns

The name of the author

GetCreationDate()

const wxString wxPdfInfo::GetCreationDate ( ) const

inline

Get the creation date of the document. The creation date records when the document was originally created.

Returns

The date and time the document was created

GetCreator()

const wxString wxPdfInfo::GetCreator ( ) const

inline

Get the creator of the document. The creator is the application that initiated document creation, typically your application's name.

Returns

The name of the application that created the document

GetKeywords()

const wxString wxPdfInfo::GetKeywords ( ) const

inline

Get the keywords for the document. Keywords are words or phrases associated with the document, used for searching and categorization.

Returns

Keywords associated with the document

GetModDate()

const wxString wxPdfInfo::GetModDate ( ) const

inline

Get the modification date of the document. The modification date records when the document was last changed.

Returns

The date and time the document was last modified

GetProducer()

const wxString wxPdfInfo::GetProducer ( ) const

inline

Get the producer of the document. The producer is the PDF-writing library, analogous to a PDF distiller.

Returns

The name of the PDF-writing library that produced the document

GetSubject()

const wxString wxPdfInfo::GetSubject ( ) const

inline

Get the subject of the document. The subject is a brief description of the document's topic or purpose.

Returns

The subject of the document

GetTitle()

const wxString wxPdfInfo::GetTitle ( ) const

inline

Get the title of the document. The title appears in the document's metadata and is typically displayed in the PDF viewer's title bar or document properties.

Returns

The document's title

SetAuthor()

void wxPdfInfo::SetAuthor ( const wxString & author )

inline

Set the author of the document. The author is the person or organization that created the document's content.

Parameters

author

The name of the author

SetCreationDate()

void wxPdfInfo::SetCreationDate ( const wxString & creationDate )

inline

Set the creation date of the document. The creation date records when the document was originally created. The value should be formatted as a PDF date string (e.g., "D:20240101120000").

Parameters

creationDate

The date and time the document was created

SetCreator()

void wxPdfInfo::SetCreator ( const wxString & creator )

inline

Set the creator of the document. The creator is the application that initiated document creation, typically your application's name.

Parameters

creator

The name of the application that created the document

SetKeywords()

void wxPdfInfo::SetKeywords ( const wxString & keywords )

inline

Set the keywords for the document. Keywords are words or phrases associated with the document, used for searching and categorization.

Parameters

keywords

Keywords associated with the document

SetModDate()

void wxPdfInfo::SetModDate ( const wxString & modDate )

inline

Set the modification date of the document. The modification date records when the document was last changed. The value should be formatted as a PDF date string (e.g., "D:20240101120000").

Parameters

modDate

The date and time the document was last modified

SetProducer()

void wxPdfInfo::SetProducer ( const wxString & producer )

inline

Set the producer of the document. The producer is the PDF-writing library, analogous to a PDF distiller. wxPdfDocument sets this field automatically; override it only if you want a different value to appear in the document's metadata.

Parameters

producer

The name of the PDF-writing library that produced the document

SetSubject()

void wxPdfInfo::SetSubject ( const wxString & subject )

inline

Set the subject of the document. The subject is a brief description of the document's topic or purpose.

Parameters

subject

The subject of the document

SetTitle()

void wxPdfInfo::SetTitle ( const wxString & title )

inline

Set the title of the document. The title appears in the document's metadata and is typically displayed in the PDF viewer's title bar or document properties.

Parameters

title

The document's title

---

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

• E:/github/wxpdfdoc-current/include/wx/pdfinfo.h