KoDocumentInfo Class Reference

The class containing all meta information about a document. More...

#include <KoDocumentInfo.h>

Inheritance diagram for KoDocumentInfo:

Signals
void	infoUpdated (const QString &info, const QString &data)

Public Member Functions
QString	aboutInfo (const QString &info) const
QStringList	authorContactInfo () const
	authorContactInfo
QString	authorInfo (const QString &info) const
	KoDocumentInfo (const KoDocumentInfo &rhs, QObject *parent=0)
	KoDocumentInfo (QObject *parent=0)
bool	load (const QDomDocument &doc)
QString	originalGenerator () const
void	resetMetaData ()
QDomDocument	save (QDomDocument &doc)
void	setAboutInfo (const QString &info, const QString &data)
void	setAuthorInfo (const QString &info, const QString &data)
void	setOriginalGenerator (const QString &generator)
void	updateParameters ()
	~KoDocumentInfo () override

Private Member Functions
bool	loadAboutInfo (const QDomElement &e)
bool	loadAuthorInfo (const QDomElement &e)
QDomElement	saveAboutInfo (QDomDocument &doc)
QDomElement	saveAuthorInfo (QDomDocument &doc)
void	setActiveAuthorInfo (const QString &info, const QString &data)
void	updateParametersAndBumpNumCycles ()
	Bumps the editing cycles count and save date, and then calls updateParameters.

Private Attributes
QMap< QString, QString >	m_aboutInfo
QStringList	m_aboutTags
QMap< QString, QString >	m_authorInfo
QMap< QString, QString >	m_authorInfoOverride
QStringList	m_authorTags
QMap< QString, QString >	m_contact
QStringList	m_contactTags
QString	m_generator

Detailed Description

The class containing all meta information about a document.

Author

Torben Weis weis@.nosp@m.kde..nosp@m.org

David Faure faure.nosp@m.@kde.nosp@m..org

Martin Pfeiffer hubip.nosp@m.ete@.nosp@m.gmx.n.nosp@m.et

See also

KoDocumentInfoDlg

This class contains the meta information for a document. They are stored in two QMap and can be accessed through aboutInfo() and authorInfo(). The about info can be changed with setAboutInfo() and setAuthorInfo()

Definition at line 36 of file KoDocumentInfo.h.

Constructor & Destructor Documentation

KoDocumentInfo() [1/2]

KoDocumentInfo::KoDocumentInfo ( QObject * parent = 0 )

explicit

The constructor

Parameters

parent

a pointer to the parent object

Definition at line 27 of file KoDocumentInfo.cpp.

                                              : QObject(parent)
{
    m_aboutTags << "title" << "description" << "subject" << "abstract"
    << "keyword" << "initial-creator" << "editing-cycles" << "editing-time"
    << "date" << "creation-date" << "language" << "license";
 
    m_authorTags << "creator" << "creator-first-name" << "creator-last-name" << "initial" << "author-title" << "position" << "company";
    m_contactTags << "email" << "telephone" << "telephone-work" << "fax" << "country" << "postal-code" << "city" << "street";
    setAboutInfo("editing-cycles", "0");
    setAboutInfo("time-elapsed", "0");
    setAboutInfo("initial-creator", i18n("Unknown"));
    setAboutInfo("creation-date", QDateTime::currentDateTime()
                 .toString(Qt::ISODate));
}

References m_aboutTags, m_authorTags, m_contactTags, and setAboutInfo().

KoDocumentInfo() [2/2]

KoDocumentInfo::KoDocumentInfo ( const KoDocumentInfo & rhs, QObject * parent = 0 )

explicit

Definition at line 42 of file KoDocumentInfo.cpp.

    : QObject(parent),
      m_aboutTags(rhs.m_aboutTags),
      m_authorTags(rhs.m_authorTags),
      m_contact(rhs.m_contact),
      m_authorInfo(rhs.m_authorInfo),
      m_authorInfoOverride(rhs.m_authorInfoOverride),
      m_aboutInfo(rhs.m_aboutInfo),
      m_generator(rhs.m_generator)
{
}

~KoDocumentInfo()

KoDocumentInfo::~KoDocumentInfo ( )

override

The destructor

Definition at line 54 of file KoDocumentInfo.cpp.

{
}

Member Function Documentation

aboutInfo()

QString KoDocumentInfo::aboutInfo

(

const QString &

info

)

const

Obtain information about the document

Parameters

info	the kind of information to obtain

Returns

a QString with the information

Definition at line 135 of file KoDocumentInfo.cpp.

{
    if (!m_aboutTags.contains(info)) {
        return QString();
    }
 
    return m_aboutInfo[info];
}

References m_aboutInfo, and m_aboutTags.

authorContactInfo()

QStringList KoDocumentInfo::authorContactInfo

(

)

const

authorContactInfo

Returns

returns list of contact info for author.

Definition at line 121 of file KoDocumentInfo.cpp.

{
    return m_contact.keys();
}

References m_contact.

authorInfo()

QString KoDocumentInfo::authorInfo

(

const QString &

info

)

const

Obtain information about the author

Parameters

info	the kind of information to obtain

Returns

a QString with the information

Definition at line 113 of file KoDocumentInfo.cpp.

{
    if (!m_authorTags.contains(info)  && !m_contactTags.contains(info) && !info.contains("contact-mode-"))
        return QString();
 
    return m_authorInfo[ info ];
}

References m_authorInfo, m_authorTags, and m_contactTags.

infoUpdated

void KoDocumentInfo::infoUpdated ( const QString & info, const QString & data )

signal

load()

bool KoDocumentInfo::load

(

const QDomDocument &

doc

)

Load the KoDocumentInfo from an Calligra-1.3 DomDocument

Parameters

doc	the QDomDocument to load from

Returns

true if success

Definition at line 58 of file KoDocumentInfo.cpp.

{
    m_authorInfo.clear();
 
    if (!loadAboutInfo(doc.documentElement()))
        return false;
 
    if (!loadAuthorInfo(doc.documentElement()))
        return false;
 
    return true;
}

References loadAboutInfo(), loadAuthorInfo(), and m_authorInfo.

loadAboutInfo()

bool KoDocumentInfo::loadAboutInfo ( const QDomElement & e )

private

Load the information about the document from a Calligra-1.3 file

Parameters

e	the element to load from

Returns

true if success

Definition at line 196 of file KoDocumentInfo.cpp.

{
    QDomElement e = root.firstChildElement("about");
    if(e.isNull()) {
        return false;
    }
 
    for (e = e.firstChildElement(); !e.isNull(); e = e.nextSiblingElement()) {
        setAboutInfo(e.tagName(), e.text());
    }
 
    return true;
}

References setAboutInfo().

loadAuthorInfo()

bool KoDocumentInfo::loadAuthorInfo ( const QDomElement & e )

private

Load the information about the document from a Calligra-1.3 file

Parameters

e	the element to load from

Returns

true if success

Definition at line 145 of file KoDocumentInfo.cpp.

{
    m_contact.clear();
 
    QDomElement e = root.firstChildElement("author");
    if(e.isNull()) {
        return false;
    }
 
    for (e = e.firstChildElement(); !e.isNull(); e = e.nextSiblingElement()) {
        QString field = e.tagName();
        QString value = e.text();
 
        if (field == "full-name") {
            setActiveAuthorInfo("creator", value.trimmed());
        } else if (field == "contact") {
            m_contact.insert(value, e.attribute("type"));
        } else {
            setActiveAuthorInfo(field, value.trimmed());
        }
    }
 
    return true;
}

References m_contact, setActiveAuthorInfo(), and value().

originalGenerator()

QString KoDocumentInfo::originalGenerator

(

)

const

Obtain the generator of the document, as it was loaded from the document

Definition at line 329 of file KoDocumentInfo.cpp.

{
    return m_generator;
}

References m_generator.

resetMetaData()

void KoDocumentInfo::resetMetaData

(

)

Resets part of the meta data

Definition at line 321 of file KoDocumentInfo.cpp.

{
    setAboutInfo("editing-cycles", QString::number(0));
    setAboutInfo("initial-creator", authorInfo("creator"));
    setAboutInfo("creation-date", QDateTime::currentDateTime().toString(Qt::ISODate));
    setAboutInfo("editing-time", QString::number(0));
}

References authorInfo(), and setAboutInfo().

save()

QDomDocument KoDocumentInfo::save

(

QDomDocument &

doc

)

Save the KoDocumentInfo to an Calligra-1.3 DomDocument

Returns

the QDomDocument to which was saved

Definition at line 72 of file KoDocumentInfo.cpp.

{
    updateParametersAndBumpNumCycles();
 
    QDomElement s = saveAboutInfo(doc);
    if (!s.isNull())
        doc.documentElement().appendChild(s);
 
    s = saveAuthorInfo(doc);
    if (!s.isNull())
        doc.documentElement().appendChild(s);
 
 
    if (doc.documentElement().isNull())
        return QDomDocument();
 
    return doc;
}

References saveAboutInfo(), saveAuthorInfo(), and updateParametersAndBumpNumCycles().

saveAboutInfo()

QDomElement KoDocumentInfo::saveAboutInfo ( QDomDocument & doc )

private

Save the information about the document to a Calligra-1.3 file

Parameters

doc	the QDomDocument to save in

Returns

the QDomElement to which was saved

Definition at line 210 of file KoDocumentInfo.cpp.

{
    QDomElement e = doc.createElement("about");
    QDomElement t;
 
    Q_FOREACH (const QString &tag, m_aboutTags) {
        if (tag == "abstract") {
            t = doc.createElement("abstract");
            e.appendChild(t);
            t.appendChild(doc.createCDATASection(aboutInfo(tag)));
        } else {
            t = doc.createElement(tag);
            e.appendChild(t);
            t.appendChild(doc.createTextNode(aboutInfo(tag)));
        }
    }
 
    return e;
}

References aboutInfo(), and m_aboutTags.

saveAuthorInfo()

QDomElement KoDocumentInfo::saveAuthorInfo ( QDomDocument & doc )

private

Save the information about the author to a Calligra-1.3 file

Parameters

doc	the QDomDocument to save in

Returns

the QDomElement to which was saved

Definition at line 170 of file KoDocumentInfo.cpp.

{
    QDomElement e = doc.createElement("author");
    QDomElement t;
 
    Q_FOREACH (const QString &tag, m_authorTags) {
        if (tag == "creator")
            t = doc.createElement("full-name");
        else
            t = doc.createElement(tag);
 
        e.appendChild(t);
        t.appendChild(doc.createTextNode(authorInfo(tag)));
    }
    for (int i=0; i<m_contact.keys().size(); i++) {
        t = doc.createElement("contact");
        e.appendChild(t);
        QString key = m_contact.keys().at(i);
        t.setAttribute("type", m_contact[key]);
        t.appendChild(doc.createTextNode(key));
    }
 
    return e;
}

References authorInfo(), m_authorTags, and m_contact.

setAboutInfo()

void KoDocumentInfo::setAboutInfo	(	const QString &	info,
		const QString &	data )

Set information about the document

Parameters

info	the kind of information to set
data	the data to set for this information

Definition at line 126 of file KoDocumentInfo.cpp.

{
    if (!m_aboutTags.contains(info))
        return;
 
    m_aboutInfo.insert(info, data);
    Q_EMIT infoUpdated(info, data);
}

References infoUpdated(), m_aboutInfo, and m_aboutTags.

setActiveAuthorInfo()

void KoDocumentInfo::setActiveAuthorInfo ( const QString & info, const QString & data )

private

Set information about the author This sets what is actually saved to file. The public method setAuthorInfo() can be used to set values that override what is fetched from the author profile. During saveParameters() author profile and any overrides is combined resulting in calls to this method.

Parameters

info	the kind of information to set
data	the data to set for this information

Definition at line 100 of file KoDocumentInfo.cpp.

{
    if (!m_authorTags.contains(info) && !m_contactTags.contains(info) && !info.contains("contact-mode-")) {
        return;
    }
    if (m_contactTags.contains(info)) {
        m_contact.insert(data, info);
    } else {
        m_authorInfo.insert(info, data);
    }
    Q_EMIT infoUpdated(info, data);
}

References infoUpdated(), m_authorInfo, m_authorTags, m_contact, and m_contactTags.

setAuthorInfo()

void KoDocumentInfo::setAuthorInfo	(	const QString &	info,
		const QString &	data )

Set information about the author. This will override any information retrieved from the author profile But it does not change the author profile Note: authorInfo() will not return the new value until the document has been saved by the user.(autosave doesn't count)

Parameters

info	the kind of information to set
data	the data to set for this information

Definition at line 91 of file KoDocumentInfo.cpp.

{
    if (!m_authorTags.contains(info) && !m_contactTags.contains(info) && !info.contains("contact-mode-")) {
        return;
    }
 
    m_authorInfoOverride.insert(info, data);
}

References m_authorInfoOverride, m_authorTags, and m_contactTags.

setOriginalGenerator()

void KoDocumentInfo::setOriginalGenerator

(

const QString &

generator

)

Sets the original generator of the document. This does not affect what gets saved to a document in the meta:generator field, it only changes what originalGenerator() will return.

Definition at line 334 of file KoDocumentInfo.cpp.

{
    m_generator = generator;
}

References m_generator.

updateParameters()

void KoDocumentInfo::updateParameters

(

)

Takes care of updating the document info from configuration correctly

Definition at line 243 of file KoDocumentInfo.cpp.

{
    KisDocument *doc = dynamic_cast< KisDocument *>(parent());
    if (doc && (!doc->isModified())) {
        return;
    }
 
    KConfig config("kritarc");
    config.reparseConfiguration();
    KConfigGroup appAuthorGroup(&config, "Author");
    QString profile = appAuthorGroup.readEntry("active-profile", "");
 
    QString authorInfo = KoResourcePaths::getAppDataLocation() + "/authorinfo/";
    QDir dir(authorInfo);
    QStringList filters = QStringList() << "*.authorinfo";
 
    //Anon case
    setActiveAuthorInfo("creator", QString());
    setActiveAuthorInfo("initial", "");
    setActiveAuthorInfo("author-title", "");
    setActiveAuthorInfo("position", "");
    setActiveAuthorInfo("company", "");
    if (dir.entryList(filters).contains(profile+".authorinfo")) {
        QFile file(dir.absoluteFilePath(profile+".authorinfo"));
        if (file.exists()) {
            file.open(QFile::ReadOnly);
            QByteArray ba = file.readAll();
            file.close();
            QDomDocument doc = QDomDocument();
            doc.setContent(ba);
            QDomElement root = doc.firstChildElement();
 
            QDomElement el = root.firstChildElement("nickname");
            if (!el.isNull()) {
                setActiveAuthorInfo("creator", el.text());
            }
            el = root.firstChildElement("givenname");
            if (!el.isNull()) {
                setActiveAuthorInfo("creator-first-name", el.text());
            }
            el = root.firstChildElement("middlename");
            if (!el.isNull()) {
                setActiveAuthorInfo("initial", el.text());
            }
            el = root.firstChildElement("familyname");
            if (!el.isNull()) {
               setActiveAuthorInfo("creator-last-name", el.text());
            }
            el = root.firstChildElement("title");
            if (!el.isNull()) {
                setActiveAuthorInfo("author-title", el.text());
            }
            el = root.firstChildElement("position");
            if (!el.isNull()) {
                setActiveAuthorInfo("position", el.text());
            }
            el = root.firstChildElement("company");
            if (!el.isNull()) {
                setActiveAuthorInfo("company", el.text());
            }
 
            m_contact.clear();
            el = root.firstChildElement("contact");
            while (!el.isNull()) {
                m_contact.insert(el.text(), el.attribute("type"));
                el = el.nextSiblingElement("contact");
            }
        }
    }
 
    //allow author info set programmatically to override info from author profile
    Q_FOREACH (const QString &tag, m_authorTags) {
        if (m_authorInfoOverride.contains(tag)) {
            setActiveAuthorInfo(tag, m_authorInfoOverride.value(tag));
        }
    }
}

References authorInfo(), KoResourcePaths::getAppDataLocation(), KisDocument::isModified(), m_authorInfoOverride, m_authorTags, m_contact, and setActiveAuthorInfo().

updateParametersAndBumpNumCycles()

void KoDocumentInfo::updateParametersAndBumpNumCycles ( )

private

Bumps the editing cycles count and save date, and then calls updateParameters.

Definition at line 230 of file KoDocumentInfo.cpp.

{
    KisDocument *doc = dynamic_cast< KisDocument *>(parent());
    if (doc && doc->isAutosaving()) {
        return;
    }
 
    setAboutInfo("editing-cycles", QString::number(aboutInfo("editing-cycles").toInt() + 1));
    setAboutInfo("date", QDateTime::currentDateTime().toString(Qt::ISODate));
 
    updateParameters();
}

References aboutInfo(), KisDocument::isAutosaving, setAboutInfo(), and updateParameters().

Member Data Documentation

m_aboutInfo

QMap<QString, QString> KoDocumentInfo::m_aboutInfo

private

The map containing information about the document

Definition at line 174 of file KoDocumentInfo.h.

m_aboutTags

QStringList KoDocumentInfo::m_aboutTags

private

A QStringList containing all tags for the document information

Definition at line 162 of file KoDocumentInfo.h.

m_authorInfo

QMap<QString, QString> KoDocumentInfo::m_authorInfo

private

The map containing information about the author

Definition at line 170 of file KoDocumentInfo.h.

m_authorInfoOverride

QMap<QString, QString> KoDocumentInfo::m_authorInfoOverride

private

The map containing information about the author set programmatically

Definition at line 172 of file KoDocumentInfo.h.

m_authorTags

QStringList KoDocumentInfo::m_authorTags

private

A QStringList containing all tags for the author information

Definition at line 164 of file KoDocumentInfo.h.

m_contact

QMap<QString, QString> KoDocumentInfo::m_contact

private

A QMap with the contact modes and their type in the second string

Definition at line 168 of file KoDocumentInfo.h.

m_contactTags

QStringList KoDocumentInfo::m_contactTags

private

A QStringList containing all valid contact tags

Definition at line 166 of file KoDocumentInfo.h.

m_generator

QString KoDocumentInfo::m_generator

private

The original meta:generator of the document

Definition at line 176 of file KoDocumentInfo.h.

---

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

• libs/ui/KoDocumentInfo.h
• libs/ui/KoDocumentInfo.cpp