Référence de la classe KoDocumentInfo

The class containing all meta information about a document. Plus de détails...

#include <KoDocumentInfo.h>

Liste de tous les membres

Fonctions membres publiques

 KoDocumentInfo (QObject *parent=0)
 ~KoDocumentInfo ()
bool loadOasis (const KoXmlDocument &metaDoc)
bool saveOasis (KoStore *store)
bool load (const KoXmlDocument &doc)
QDomDocument save ()
void setAuthorInfo (const QString &info, const QString &data)
QString authorInfo (const QString &info) const
void setAboutInfo (const QString &info, const QString &data)
QString aboutInfo (const QString &info) const
void resetMetaData ()

Fonctions membres privées

bool loadOasisAboutInfo (const KoXmlNode &metaDoc)
bool saveOasisAboutInfo (KoXmlWriter &xmlWriter)
bool loadAboutInfo (const KoXmlElement &e)
QDomElement saveAboutInfo (QDomDocument &doc)
bool loadOasisAuthorInfo (const KoXmlNode &metaDoc)
bool loadAuthorInfo (const KoXmlElement &e)
QDomElement saveAuthorInfo (QDomDocument &doc)
bool saveOasisAuthorInfo (KoXmlWriter &xmlWriter)
void saveParameters ()

Attributs privés

QStringList m_aboutTags
QStringList m_authorTags
QMap< QString, QString > m_authorInfo
QMap< QString, QString > m_aboutInfo
bool m_firstSave


Description détaillée

The class containing all meta information about a document.

Auteur:
Torben Weis <weis@kde.org>

David Faure <faure@kde.org>

Martin Pfeiffer <hubipete@gmx.net>

Voir également:
KoDocumentInfoDlg
This class contains the meta information for a document. They are stored in two QMap and can be accessed through setAuthorInfo(), setAboutInfo(), aboutInfo() and authorInfo().

Définition à la ligne 52 du fichier KoDocumentInfo.h.


Documentation des contructeurs et destructeur

KoDocumentInfo::KoDocumentInfo ( QObject *  parent = 0  ) 

The constructor

Paramètres:
parent a pointer to the parent object

Définition à la ligne 38 du fichier KoDocumentInfo.cpp.

Références m_aboutTags, m_authorTags, m_firstSave, setAboutInfo(), et setAuthorInfo().

Voici le graphe d'appel pour cette fonction :

KoDocumentInfo::~KoDocumentInfo (  ) 

The destructor

Définition à la ligne 58 du fichier KoDocumentInfo.cpp.


Documentation des fonctions membres

bool KoDocumentInfo::loadOasis ( const KoXmlDocument metaDoc  ) 

Load the KoDocumentInfo from an OASIS document

Paramètres:
metaDoc the QDomDocument with the metaInformation
Renvoie:
true if success

Définition à la ligne 73 du fichier KoDocumentInfo.cpp.

Références loadOasisAboutInfo(), loadOasisAuthorInfo(), KoDom::namedItemNS(), et KoXmlNS::office.

Référencé par KoDocument::loadNativeFormatFromStoreInternal().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

bool KoDocumentInfo::saveOasis ( KoStore store  ) 

Save the KoDocumentInfo to an OASIS document

Paramètres:
store a pointer to a KoStore to save in
Renvoie:
true if success

Définition à la ligne 112 du fichier KoDocumentInfo.cpp.

Références KoXmlWriter::addTextNode(), KoDocument::createOasisXmlWriter(), KoXmlWriter::endDocument(), KoXmlWriter::endElement(), KOFFICE_VERSION_STRING, saveOasisAboutInfo(), saveOasisAuthorInfo(), saveParameters(), et KoXmlWriter::startElement().

Référencé par KoDocument::saveNativeFormat().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

bool KoDocumentInfo::load ( const KoXmlDocument doc  ) 

Load the KoDocumentInfo from an KOffice-1.3 DomDocument

Paramètres:
doc the QDomDocument to load from
Renvoie:
true if success

Définition à la ligne 62 du fichier KoDocumentInfo.cpp.

Références loadAboutInfo(), et loadAuthorInfo().

Référencé par KoDocumentInfoPropsPage::KoDocumentInfoPropsPage(), et KoDocument::loadNativeFormatFromStoreInternal().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

QDomDocument KoDocumentInfo::save (  ) 

Save the KoDocumentInfo to an KOffice-1.3 DomDocument

Renvoie:
the QDomDocument to which was saved

Définition à la ligne 90 du fichier KoDocumentInfo.cpp.

Références KoDocument::createDomDocument(), saveAboutInfo(), saveAuthorInfo(), et saveParameters().

Référencé par KoDocumentInfoPropsPage::applyChanges(), et KoDocument::saveNativeFormat().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

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

Set information about the author

Paramètres:
info the kind of information to set
data the data to set for this information

Définition à la ligne 138 du fichier KoDocumentInfo.cpp.

Références m_authorInfo, et m_authorTags.

Référencé par KoDocumentInfo(), loadAuthorInfo(), loadOasisAuthorInfo(), KoDocumentInfoDlg::saveAuthorData(), KoDocumentAdaptor::setDocumentInfoAuthorName(), KoDocumentAdaptor::setDocumentInfoAuthorPosition(), KoDocumentAdaptor::setDocumentInfoCity(), KoDocumentAdaptor::setDocumentInfoCompanyName(), KoDocumentAdaptor::setDocumentInfoCountry(), KoDocumentAdaptor::setDocumentInfoEmail(), KoDocumentAdaptor::setDocumentInfoFax(), KoDocumentAdaptor::setDocumentInfoInitial(), KoDocumentAdaptor::setDocumentInfoPostalCode(), KoDocumentAdaptor::setDocumentInfoStreet(), KoDocumentAdaptor::setDocumentInfoTelephoneHome(), et KoDocumentAdaptor::setDocumentInfoTelephoneWork().

Voici le graphe d'appel pour cette fonction :

QString KoDocumentInfo::authorInfo ( const QString &  info  )  const

Obtain information about the author

Paramètres:
info the kind of information to obtain
Renvoie:
a QString with the information

Définition à la ligne 146 du fichier KoDocumentInfo.cpp.

Références m_authorInfo, et m_authorTags.

Référencé par KoDocument::addVersion(), KoDocumentAdaptor::documentInfoAuthorName(), KoDocumentAdaptor::documentInfoAuthorPostion(), KoDocumentAdaptor::documentInfoCity(), KoDocumentAdaptor::documentInfoCompanyName(), KoDocumentAdaptor::documentInfoCountry(), KoDocumentAdaptor::documentInfoEmail(), KoDocumentAdaptor::documentInfoFax(), KoDocumentAdaptor::documentInfoInitial(), KoDocumentAdaptor::documentInfoPostalCode(), KoDocumentAdaptor::documentInfoStreet(), KoDocumentAdaptor::documentInfoTelephoneHome(), KoDocumentAdaptor::documentInfoTelephoneWork(), KoDocumentInfoDlg::initAboutTab(), KoDocumentInfoDlg::initAuthorTab(), KoFieldVariable::recalc(), resetMetaData(), saveAuthorInfo(), saveOasisAuthorInfo(), et KoDocumentInfoDlg::slotResetMetaData().

Voici le graphe d'appel pour cette fonction :

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

Set information about the document

Paramètres:
info the kind of information to set
data the data to set for this information

Définition à la ligne 154 du fichier KoDocumentInfo.cpp.

Références m_aboutInfo.

Référencé par KoDocumentInfo(), loadAboutInfo(), loadOasisAboutInfo(), resetMetaData(), KoDocumentInfoDlg::saveAboutData(), saveOasisAboutInfo(), saveParameters(), KoDocumentAdaptor::setDocumentInfoAbstract(), KoDocumentAdaptor::setDocumentInfoKeywords(), KoDocumentAdaptor::setDocumentInfoSubject(), et KoDocumentAdaptor::setDocumentInfoTitle().

Voici le graphe d'appel pour cette fonction :

QString KoDocumentInfo::aboutInfo ( const QString &  info  )  const

Obtain information about the document

Paramètres:
info the kind of information to obtain
Renvoie:
a QString with the information

Définition à la ligne 159 du fichier KoDocumentInfo.cpp.

Références m_aboutInfo, et m_aboutTags.

Référencé par KoDocumentAdaptor::documentInfoAbstract(), KoDocumentAdaptor::documentInfoKeywords(), KoDocumentAdaptor::documentInfoSubject(), KoDocumentAdaptor::documentInfoTitle(), KoDocumentInfoDlg::initAboutTab(), KoMainWindow::print(), KoMainWindow::queryClose(), KoDocument::queryCloseDia(), KoFieldVariable::recalc(), saveAboutInfo(), saveOasisAboutInfo(), saveParameters(), KoDocument::setTitleModified(), KoDocumentInfoDlg::slotResetMetaData(), et KoMainWindow::updateCaption().

Voici le graphe d'appel pour cette fonction :

void KoDocumentInfo::resetMetaData (  ) 

Resets part of the meta data

Définition à la ligne 390 du fichier KoDocumentInfo.cpp.

Références authorInfo(), et setAboutInfo().

Référencé par KoDocumentInfoDlg::slotResetMetaData().

Voici le graphe d'appel pour cette fonction :

bool KoDocumentInfo::loadOasisAboutInfo ( const KoXmlNode metaDoc  )  [private]

Load the information about the document from an OASIS file

Paramètres:
metaDoc a reference to the information node
Renvoie:
true if success

Définition à la ligne 296 du fichier KoDocumentInfo.cpp.

Références KoXmlNS::dc, m_aboutTags, KoXmlNS::meta, KoDom::namedItemNS(), et setAboutInfo().

Référencé par loadOasis().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

bool KoDocumentInfo::saveOasisAboutInfo ( KoXmlWriter xmlWriter  )  [private]

Save the information about the document to an OASIS file

Paramètres:
xmlWriter a reference to the KoXmlWriter to write in
Renvoie:
true if success

Définition à la ligne 253 du fichier KoDocumentInfo.cpp.

Références aboutInfo(), KoXmlWriter::addTextNode(), KoXmlWriter::endElement(), m_aboutTags, saveParameters(), setAboutInfo(), et KoXmlWriter::startElement().

Référencé par saveOasis().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

bool KoDocumentInfo::loadAboutInfo ( const KoXmlElement e  )  [private]

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

Paramètres:
e the element to load from
Renvoie:
true if success

Définition à la ligne 330 du fichier KoDocumentInfo.cpp.

Références setAboutInfo().

Référencé par load().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

QDomElement KoDocumentInfo::saveAboutInfo ( QDomDocument &  doc  )  [private]

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

Paramètres:
doc the QDomDocument to save in
Renvoie:
the QDomElement to which was saved

Définition à la ligne 349 du fichier KoDocumentInfo.cpp.

Références aboutInfo(), m_aboutTags, et saveParameters().

Référencé par save().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

bool KoDocumentInfo::loadOasisAuthorInfo ( const KoXmlNode metaDoc  )  [private]

Load the information about the document from an OASIS file

Paramètres:
metaDoc a reference to the information node
Renvoie:
true if success

Définition à la ligne 192 du fichier KoDocumentInfo.cpp.

Références KoXmlNS::dc, KoXmlNS::meta, KoPageFormat::name(), KoDom::namedItemNS(), et setAuthorInfo().

Référencé par loadOasis().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

bool KoDocumentInfo::loadAuthorInfo ( const KoXmlElement e  )  [private]

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

Paramètres:
e the element to load from
Renvoie:
true if success

Définition à la ligne 216 du fichier KoDocumentInfo.cpp.

Références setAuthorInfo().

Référencé par load().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

QDomElement KoDocumentInfo::saveAuthorInfo ( QDomDocument &  doc  )  [private]

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

Paramètres:
doc the QDomDocument to save in
Renvoie:
the QDomElement to which was saved

Définition à la ligne 234 du fichier KoDocumentInfo.cpp.

Références authorInfo(), et m_authorTags.

Référencé par save().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

bool KoDocumentInfo::saveOasisAuthorInfo ( KoXmlWriter xmlWriter  )  [private]

Save the information about the document to an OASIS file

Paramètres:
xmlWriter a reference to the KoXmlWriter to write in
Renvoie:
true if success

Définition à la ligne 170 du fichier KoDocumentInfo.cpp.

Références KoXmlWriter::addAttribute(), KoXmlWriter::addTextNode(), authorInfo(), KoXmlWriter::endElement(), m_authorTags, et KoXmlWriter::startElement().

Référencé par saveOasis().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

void KoDocumentInfo::saveParameters (  )  [private]

Takes care of saving the per-editing-cycle data correctly

Définition à la ligne 375 du fichier KoDocumentInfo.cpp.

Références aboutInfo(), KoDocument::isAutosaving(), m_firstSave, et setAboutInfo().

Référencé par save(), saveAboutInfo(), saveOasis(), et saveOasisAboutInfo().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :


Documentation des données membres

QStringList KoDocumentInfo::m_aboutTags [private]

A QStringList containing all tags for the document information

Définition à la ligne 185 du fichier KoDocumentInfo.h.

Référencé par aboutInfo(), KoDocumentInfo(), loadOasisAboutInfo(), saveAboutInfo(), et saveOasisAboutInfo().

QStringList KoDocumentInfo::m_authorTags [private]

A QStringList containing all tags for the author information

Définition à la ligne 187 du fichier KoDocumentInfo.h.

Référencé par authorInfo(), KoDocumentInfo(), saveAuthorInfo(), saveOasisAuthorInfo(), et setAuthorInfo().

QMap<QString, QString> KoDocumentInfo::m_authorInfo [private]

The map containing information about the author

Définition à la ligne 189 du fichier KoDocumentInfo.h.

Référencé par authorInfo(), et setAuthorInfo().

QMap<QString, QString> KoDocumentInfo::m_aboutInfo [private]

The map containing information about the document

Définition à la ligne 191 du fichier KoDocumentInfo.h.

Référencé par aboutInfo(), et setAboutInfo().

bool KoDocumentInfo::m_firstSave [private]

Définition à la ligne 193 du fichier KoDocumentInfo.h.

Référencé par KoDocumentInfo(), et saveParameters().


La documentation de cette classe a été générée à partir des fichiers suivants :
Généré le Wed Nov 22 23:45:09 2006 pour KPlato par  doxygen 1.5.1-p1