#include <document.h>

Inheritance diagram for Okular::DocumentInfo:

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)

Public Member Functions inherited from QDomDocument
	QDomDocument ()

	QDomDocument (const QString &name)

	QDomDocument (const QDomDocument &x)

	QDomDocument (const QDomDocumentType &doctype)

	~QDomDocument ()

QDomAttr	createAttribute (const QString &name)

QDomAttr	createAttributeNS (const QString &nsURI, const QString &qName)

QDomCDATASection	createCDATASection (const QString &value)

QDomComment	createComment (const QString &value)

QDomDocumentFragment	createDocumentFragment ()

QDomElement	createElement (const QString &tagName)

QDomElement	createElementNS (const QString &nsURI, const QString &qName)

QDomEntityReference	createEntityReference (const QString &name)

QDomProcessingInstruction	createProcessingInstruction (const QString &target, const QString &data)

QDomText	createTextNode (const QString &value)

QDomDocumentType	doctype () const

QDomElement	documentElement () const

QDomElement	elementById (const QString &elementId)

QDomNodeList	elementsByTagName (const QString &tagname) const

QDomNodeList	elementsByTagNameNS (const QString &nsURI, const QString &localName)

QDomImplementation	implementation () const

QDomNode	importNode (const QDomNode &importedNode, bool deep)

QDomNode::NodeType	nodeType () const

QDomDocument &	operator= (const QDomDocument &x)

bool	setContent (QXmlInputSource source, bool namespaceProcessing, QString errorMsg, int errorLine, int errorColumn)

bool	setContent (const QByteArray &buffer, QString errorMsg, int errorLine, int *errorColumn)

bool	setContent (QIODevice dev, bool namespaceProcessing, QString errorMsg, int errorLine, int errorColumn)

bool	setContent (QIODevice dev, QString errorMsg, int errorLine, int errorColumn)

bool	setContent (const QString &text, QString errorMsg, int errorLine, int *errorColumn)

bool	setContent (const QByteArray &data, bool namespaceProcessing, QString errorMsg, int errorLine, int *errorColumn)

bool	setContent (const QString &text, bool namespaceProcessing, QString errorMsg, int errorLine, int *errorColumn)

bool	setContent (QXmlInputSource source, QXmlReader reader, QString errorMsg, int errorLine, int *errorColumn)

QByteArray	toByteArray (int indent) const

QString	toString (int indent) const

Public Member Functions inherited from QDomNode
	QDomNode ()

	QDomNode (const QDomNode &n)

	~QDomNode ()

QDomNode	appendChild (const QDomNode &newChild)

QDomNamedNodeMap	attributes () const

QDomNodeList	childNodes () const

void	clear ()

QDomNode	cloneNode (bool deep) const

int	columnNumber () const

QDomNode	firstChild () const

QDomElement	firstChildElement (const QString &tagName) const

bool	hasAttributes () const

bool	hasChildNodes () const

QDomNode	insertAfter (const QDomNode &newChild, const QDomNode &refChild)

QDomNode	insertBefore (const QDomNode &newChild, const QDomNode &refChild)

bool	isAttr () const

bool	isCDATASection () const

bool	isCharacterData () const

bool	isComment () const

bool	isDocument () const

bool	isDocumentFragment () const

bool	isDocumentType () const

bool	isElement () const

bool	isEntity () const

bool	isEntityReference () const

bool	isNotation () const

bool	isNull () const

bool	isProcessingInstruction () const

bool	isSupported (const QString &feature, const QString &version) const

bool	isText () const

QDomNode	lastChild () const

QDomElement	lastChildElement (const QString &tagName) const

int	lineNumber () const

QString	localName () const

QDomNode	namedItem (const QString &name) const

QString	namespaceURI () const

QDomNode	nextSibling () const

QDomElement	nextSiblingElement (const QString &tagName) const

QString	nodeName () const

NodeType	nodeType () const

QString	nodeValue () const

void	normalize ()

bool	operator!= (const QDomNode &n) const

QDomNode &	operator= (const QDomNode &n)

bool	operator== (const QDomNode &n) const

QDomDocument	ownerDocument () const

QDomNode	parentNode () const

QString	prefix () const

QDomNode	previousSibling () const

QDomElement	previousSiblingElement (const QString &tagName) const

QDomNode	removeChild (const QDomNode &oldChild)

QDomNode	replaceChild (const QDomNode &newChild, const QDomNode &oldChild)

void	save (QTextStream &str, int indent) const

void	save (QTextStream &str, int indent, EncodingPolicy encodingPolicy) const

void	setNodeValue (const QString &v)

void	setPrefix (const QString &pre)

QDomAttr	toAttr () const

QDomCDATASection	toCDATASection () const

QDomCharacterData	toCharacterData () const

QDomComment	toComment () const

QDomDocument	toDocument () const

QDomDocumentFragment	toDocumentFragment () const

QDomDocumentType	toDocumentType () const

QDomElement	toElement () const

QDomEntity	toEntity () const

QDomEntityReference	toEntityReference () const

QDomNotation	toNotation () const

QDomProcessingInstruction	toProcessingInstruction () const

QDomText	toText () const

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

Constructor & Destructor Documentation

DocumentInfo::DocumentInfo ( )

Creates a new document info.

DocumentInfo.

Definition at line 4644 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 4680 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 4692 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 4749 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 4651 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 4671 of file document.cpp.

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

okular

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

okular

kdegraphics API Reference

Search