Okular::DocumentInfo
#include <document.h>
Public Types | |
enum | Key { Title , Subject , Description , Author , Creator , Producer , Copyright , Pages , CreationDate , ModificationDate , MimeType , Category , Keywords , FilePath , DocumentSize , PagesSize , CustomKeys , Invalid } |
Public Member Functions | |
DocumentInfo () | |
DocumentInfo (const DocumentInfo &info) | |
QString | get (const QString &key) const |
QString | get (Key key) const |
QString | getKeyTitle (const QString &key) const |
QStringList | keys () const |
DocumentInfo & | operator= (const DocumentInfo &) |
void | set (const QString &key, const QString &value, const QString &title=QString()) |
void | set (Key key, const QString &value) |
Static Public Member Functions | |
static Key | getKeyFromString (const QString &key) |
static QString | getKeyString (Key key) |
static QString | getKeyTitle (Key key) |
Detailed Description
The DocumentInfo structure can be filled in by generators to display metadata about the currently opened file.
Definition at line 75 of file document.h.
Member Enumeration Documentation
◆ Key
The list of predefined keys.
Definition at line 83 of file document.h.
Constructor & Destructor Documentation
◆ DocumentInfo() [1/2]
DocumentInfo::DocumentInfo | ( | ) |
◆ DocumentInfo() [2/2]
DocumentInfo::DocumentInfo | ( | const DocumentInfo & | info | ) |
Definition at line 5931 of file document.cpp.
◆ ~DocumentInfo()
DocumentInfo::~DocumentInfo | ( | ) |
Definition at line 5946 of file document.cpp.
Member Function Documentation
◆ get() [1/2]
Returns the value for a given key or an null string when the key doesn't exist.
Definition at line 5972 of file document.cpp.
◆ get() [2/2]
Returns the value for a given key or an null string when the key doesn't exist.
Definition at line 5967 of file document.cpp.
◆ getKeyFromString()
|
static |
◆ getKeyString()
Returns the internal string for the given key.
- Since
- 0.10 (KDE 4.4)
Definition at line 5977 of file document.cpp.
◆ getKeyTitle() [1/2]
Returns the user visible string for the given key Takes into account keys added by the set() that takes a QString.
- Since
- 0.21
Definition at line 6131 of file document.cpp.
◆ getKeyTitle() [2/2]
Returns the user visible string for the given key.
- Since
- 0.10 (KDE 4.4)
Definition at line 6074 of file document.cpp.
◆ keys()
QStringList DocumentInfo::keys | ( | ) | const |
Returns all the keys present in this DocumentInfo.
- Since
- 0.21
Definition at line 5962 of file document.cpp.
◆ operator=()
DocumentInfo & DocumentInfo::operator= | ( | const DocumentInfo & | info | ) |
Definition at line 5937 of file document.cpp.
◆ set() [1/2]
void DocumentInfo::set | ( | const QString & | key, |
const QString & | value, | ||
const QString & | title = QString() ) |
Sets a value for a custom key.
The title should be an i18n'ed string, since it's used in the document information dialog.
Definition at line 5951 of file document.cpp.
◆ set() [2/2]
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 5957 of file document.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sat Dec 21 2024 16:58:33 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.