okular

Okular::DocumentInfo Class Reference

#include <document.h>

Inheritance diagram for Okular::DocumentInfo:

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 700 of file document.h.


Public Types
enum	Key { Title, Subject, Description, Author, Creator, Producer, Copyright, Pages, CreationDate, ModificationDate, MimeType, Category, Keywords }
Public Member Functions
	DocumentInfo ()
void	set (const QString &key, const QString &value, const QString &title=QString())
void	set (enum Key, const QString &value)
QString	get (const QString &key) const

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.

Definition at line 706 of file document.h.

DocumentInfo::DocumentInfo ( )

Creates a new document info.

Definition at line 2840 of file document.cpp.

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 2847 of file document.cpp.

Sets the value for a predefined key.

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

Definition at line 2867 of file document.cpp.

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 2915 of file document.cpp.

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