Okular::DocumentInfo Class Reference

#include <document.h>

Inherits QDomDocument.

Public Types
enum	Key {   Title, Subject, Description, Author,   Creator, Producer, Copyright, Pages,   CreationDate, ModificationDate, MimeType, Category,   Keywords, FilePath, DocumentSize, PagesSize }

Public Member Functions
	DocumentInfo ()
QString	get (const QString &key) const
void	set (const QString &key, const QString &value, const QString &title=QString())
void	set (Key key, const QString &value)

Static Public Member Functions
static QString	getKeyString (Key key)
static QString	getKeyTitle (Key key)

Detailed Description

A DOM tree containing information about the document.

The DocumentInfo structure can be filled in by generators to display metadata about the currently opened file.

Definition at line 1073 of file document.h.

Member Enumeration Documentation

enum Okular::DocumentInfo::Key

The list of predefined keys.

Enumerator
Title	The title of the document.
Subject	The subject of the document.
Description	The description of the document.
Author	The author of the document.
Creator	The creator of the document (this can be different from the author)
Producer	The producer of the document (e.g. some software)
Copyright	The copyright of the document.
Pages	The number of pages of the document.
CreationDate	The date of creation of the document.
ModificationDate	The date of last modification of the document.
MimeType	The mime type of the document.
Category	The category of the document.
Keywords	The keywords which describe the content of the document.
FilePath	The path of the file. Since 0.10 (KDE 4.4)
DocumentSize	The size of the document. Since 0.10 (KDE 4.4)
PagesSize	The size of the pages (if all pages have the same size) Since 0.10 (KDE 4.4)

Definition at line 1079 of file document.h.

Constructor & Destructor Documentation

DocumentInfo::DocumentInfo

(

)

Creates a new document info.

DocumentInfo.

Definition at line 4621 of file document.cpp.

Member Function Documentation

QString DocumentInfo::get

(

const QString &

key

)

const

Returns the value for a given key or an empty string when the key doesn't exist.

Definition at line 4657 of file document.cpp.

QString DocumentInfo::getKeyString ( Key  key )

static

Returns the internal string for the given key.

Since

0.10 (KDE 4.4)

Definition at line 4669 of file document.cpp.

QString DocumentInfo::getKeyTitle ( Key  key )

static

Returns the user visible string for the given key.

Since

0.10 (KDE 4.4)

Definition at line 4726 of file document.cpp.

void DocumentInfo::set	(	const QString &	key,
		const QString &	value,
		const QString &	title = QString()
	)

Sets a value for a special key.

The title should be an i18n'ed string, since it's used in the document information dialog.

Definition at line 4628 of file document.cpp.

void DocumentInfo::set	(	Key	key,
		const QString &	value
	)

Sets the value for a predefined key.

You should use this method whenever a predefined key exists for your value.

Definition at line 4648 of file document.cpp.

---

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

• document.h
• document.cpp