Référence de la classe KoDocumentChild

Holds an embedded object. Plus de détails...

#include <KoDocumentChild.h>

Graphe d'héritage de KoDocumentChild:

[légende]
Graphe de collaboration de KoDocumentChild:
[légende]
Liste de tous les membres

Fonctions membres publiques

 KoDocumentChild (KoDocument *parent, KoDocument *doc, const QRect &geometry)
 KoDocumentChild (KoDocument *parent)
virtual ~KoDocumentChild ()
virtual void setDocument (KoDocument *doc, const QRect &geometry)
KoDocument * document () const
KoDocument * parentDocument () const
virtual KoDocument * hitTest (const QPoint &p, KoView *view, const QMatrix &_matrix=QMatrix())
KUrl url () const
virtual QDomElement save (QDomDocument &doc, bool uppercase=false)
void saveOasisAttributes (KoXmlWriter &xmlWriter, const QString &name)
virtual bool saveOasis (KoStore *store, KoXmlWriter *manifestWriter)
virtual bool load (const KoXmlElement &element, bool uppercase=false)
void loadOasis (const KoXmlElement &frameElement, const KoXmlElement &objectElement)
virtual bool loadDocument (KoStore *)
virtual bool loadOasisDocument (KoStore *store, const KoXmlDocument &manifestDoc)
virtual bool isStoredExtern () const
bool isDeleted () const
void setDeleted (bool on=true)

Attributs protégés

QString m_tmpURL
QRect m_tmpGeometry
QString m_tmpMimeType

Fonctions membres privées

bool createUnavailDocument (KoStore *store, bool doOpenURL, const QString &mimeType)
bool createAndLoadDocument (KoStore *store, bool doOpenURL, bool oasis, const QString &mimeType)
bool finishLoadingDocument (KoStore *store, KoDocument *doc, bool doOpenURL, bool oasis)

Attributs privés

KoDocumentChildPrivate * d

Description détaillée

Holds an embedded object.

In addition to its base class KoChild it cares about the content of an embedded document. That means it supports operations like loading and saving.

If you need a representation for embedded documents in your KOffice component then you should inherit from this class.

Définition à la ligne 46 du fichier KoDocumentChild.h.

Documentation des contructeurs et destructeur

KoDocumentChild::KoDocumentChild ( KoDocument *  parent,
KoDocument *  doc,
const QRect &  geometry 
)

Définition à la ligne 70 du fichier KoDocumentChild.cpp.

Références d, KoDocument::hasExternURL(), KoDocumentChildPrivate::m_deleted, KoDocumentChildPrivate::m_doc, KoDocumentChildPrivate::m_parent, KoChild::setGeometry(), et KoDocument::setStoreInternal().

Voici le graphe d'appel pour cette fonction :

KoDocumentChild::KoDocumentChild ( KoDocument *  parent  ) 

When using this constructor you must call setDocument before you can call any other function of this class.

Définition à la ligne 82 du fichier KoDocumentChild.cpp.

Références d, KoDocumentChildPrivate::m_deleted, KoDocumentChildPrivate::m_doc, et KoDocumentChildPrivate::m_parent.

KoDocumentChild::~KoDocumentChild (  )  [virtual]

Définition à la ligne 503 du fichier KoDocumentChild.cpp.

Références d, et KoDocumentChildPrivate::m_doc.

Documentation des fonctions membres

void KoDocumentChild::setDocument ( KoDocument *  doc,
const QRect &  geometry 
) [virtual]

Call this function only directly after calling the constructor that takes only a parent as argument.

Définition à la ligne 91 du fichier KoDocumentChild.cpp.

Références d, KoDocumentChildPrivate::m_doc, KoChild::setGeometry(), et KoChild::updateMatrix().

Référencé par finishLoadingDocument().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

KoDocument * KoDocumentChild::document (  )  const

Renvoie:
document contained in this child
Voir également:
KoDocument

Définition à la ligne 100 du fichier KoDocumentChild.cpp.

Références d, et KoDocumentChildPrivate::m_doc.

Référencé par KoContainerHandler::child(), KoView::hitTest(), KoDocument::insertChild(), KoViewChild::KoViewChild(), KoDocument::paintChild(), et KoDocument::saveExternalChildren().

Voici le graphe d'appel pour cette fonction :

KoDocument * KoDocumentChild::parentDocument (  )  const

Renvoie:
parent document of this child
Voir également:
KoDocument

Définition à la ligne 105 du fichier KoDocumentChild.cpp.

Références d, et KoDocumentChildPrivate::m_parent.

Référencé par finishLoadingDocument().

Voici le graphe d'appel pour cette fonction :

KoDocument * KoDocumentChild::hitTest ( const QPoint &  p,
KoView *  view,
const QMatrix &  _matrix = QMatrix() 
) [virtual]

Définition à la ligne 110 du fichier KoDocumentChild.cpp.

Références d, KoDocument::hitTest(), KoDocumentChildPrivate::m_doc, KoChild::matrix(), KoChild::region(), KoChild::xScaling(), et KoChild::yScaling().

Voici le graphe d'appel pour cette fonction :

KUrl KoDocumentChild::url (  )  const

Note:
Can be empty (which is why it doesn't return a const KUrl &)

Définition à la ligne 498 du fichier KoDocumentChild.cpp.

Références d, et KoDocumentChildPrivate::m_doc.

Référencé par finishLoadingDocument(), et loadOasis().

Voici le graphe d'appel pour cette fonction :

QDomElement KoDocumentChild::save ( QDomDocument &  doc,
bool  uppercase = false 
) [virtual]

Writes the "object" tag, but does NOT write the content of the embedded documents. Saving the embedded documents themselves is done in KoDocument::saveChildren. This function just stores information about the position and id of the embedded document and should be called from within KoDocument::saveXML.

The "object" element is not added to the document. It is just created and returned.

Renvoie:
the element containing the "object" tag.

Définition à la ligne 466 du fichier KoDocumentChild.cpp.

Références d, KoChild::geometry(), KoPageFormat::height(), INTERNAL_PROTOCOL, KoDocumentChildPrivate::m_doc, KoDocument::nativeFormatMimeType(), et KoPageFormat::width().

Voici le graphe d'appel pour cette fonction :

void KoDocumentChild::saveOasisAttributes ( KoXmlWriter &  xmlWriter,
const QString &  name 
)

Save an embedded object to OASIS. This method sets the attributes for the draw:object element in the parent XML document. It also prepares the embedded object for being saved into the store at the end of saving (see saveOasisToStore). Note that name is only used for "internal" documents (not extern).

Définition à la ligne 443 du fichier KoDocumentChild.cpp.

Références KoXmlWriter::addAttribute(), d, INTERNAL_PROTOCOL, KoDocument::isStoredExtern(), KoDocumentChildPrivate::m_doc, et KoDocument::setURL().

Voici le graphe d'appel pour cette fonction :

bool KoDocumentChild::saveOasis ( KoStore *  store,
KoXmlWriter *  manifestWriter 
) [virtual]

Save an embedded object to an OASIS store. This is called automatically by the parent KoDocument's saveOasis

Définition à la ligne 386 du fichier KoDocumentChild.cpp.

Références KoXmlWriter::addManifestEntry(), KoStore::currentDirectory(), d, KoStore::enterDirectory(), INTERNAL_PROTOCOL, KoDocument::isStoredExtern(), KoDocumentChildPrivate::m_doc, KoPageFormat::name(), KoDocument::nativeFormatMimeType(), KoDocument::nativeOasisMimeType(), KoStore::popDirectory(), KoStore::pushDirectory(), KoDocument::saveOasis(), et KoDocument::saveToStore().

Voici le graphe d'appel pour cette fonction :

bool KoDocumentChild::load ( const KoXmlElement &  element,
bool  uppercase = false 
) [virtual]

Parses the "object" tag. This does NOT mean creating the child documents. AFTER the 'parser' has finished parsing, you must use loadDocument to actually load the embedded documents.

What you should have in mind is that this method is called from within KoDocument::loadXML while loadDocument is called from within KoDocument::loadChildren, respectively from your implementation of these methods.

Définition à la ligne 143 du fichier KoDocumentChild.cpp.

Références m_tmpGeometry, m_tmpMimeType, m_tmpURL, et KoChild::setGeometry().

Voici le graphe d'appel pour cette fonction :

void KoDocumentChild::loadOasis ( const KoXmlElement &  frameElement,
const KoXmlElement &  objectElement 
)

Définition à la ligne 122 du fichier KoDocumentChild.cpp.

Références INTERNAL_PROTOCOL, m_tmpGeometry, m_tmpURL, KoUnit::parseValue(), KoChild::setGeometry(), KoXmlNS::svg, url(), et KoXmlNS::xlink.

Voici le graphe d'appel pour cette fonction :

bool KoDocumentChild::loadDocument ( KoStore *   )  [virtual]

Actually loads the document from the disk/net or from the store, depending on url

Définition à la ligne 194 du fichier KoDocumentChild.cpp.

Références createAndLoadDocument(), m_tmpMimeType, et m_tmpURL.

Voici le graphe d'appel pour cette fonction :

bool KoDocumentChild::loadOasisDocument ( KoStore *  store,
const KoXmlDocument &  manifestDoc 
) [virtual]

Actually loads the document from the disk/net or from the store depending on the document's url

Définition à la ligne 207 du fichier KoDocumentChild.cpp.

Références createAndLoadDocument(), KoStore::currentDirectory(), INTERNAL_PROTOCOL, m_tmpURL, et KoOasisStore::mimeForPath().

Voici le graphe d'appel pour cette fonction :

bool KoDocumentChild::isStoredExtern (  )  const [virtual]

Définition à la ligne 492 du fichier KoDocumentChild.cpp.

Références d, KoDocument::isStoredExtern(), et KoDocumentChildPrivate::m_doc.

Voici le graphe d'appel pour cette fonction :

bool KoDocumentChild::isDeleted (  )  const

This document (child) is deleted.

Définition à la ligne 512 du fichier KoDocumentChild.cpp.

Références d, et KoDocumentChildPrivate::m_deleted.

Référencé par KoDocument::paintChild(), et KoDocument::saveExternalChildren().

Voici le graphe d'appel pour cette fonction :

void KoDocumentChild::setDeleted ( bool  on = true  ) 

Définition à la ligne 517 du fichier KoDocumentChild.cpp.

Références d, et KoDocumentChildPrivate::m_deleted.

bool KoDocumentChild::createUnavailDocument ( KoStore *  store,
bool  doOpenURL,
const QString &  mimeType 
) [private]

Définition à la ligne 364 du fichier KoDocumentChild.cpp.

Références KoDocumentEntry::createDoc(), d, finishLoadingDocument(), KoDocumentEntry::isEmpty(), KoDocumentChildPrivate::m_doc, et KoDocumentChildPrivate::m_parent.

Référencé par createAndLoadDocument(), et finishLoadingDocument().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

bool KoDocumentChild::createAndLoadDocument ( KoStore *  store,
bool  doOpenURL,
bool  oasis,
const QString &  mimeType 
) [private]

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

Références KoDocumentEntry::createDoc(), createUnavailDocument(), d, finishLoadingDocument(), KoDocumentEntry::isEmpty(), KoDocumentChildPrivate::m_doc, KoDocumentChildPrivate::m_parent, m_tmpURL, KoDocumentEntry::queryByMimeType(), et KoDocumentEntry::service().

Référencé par loadDocument(), et loadOasisDocument().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

bool KoDocumentChild::finishLoadingDocument ( KoStore *  store,
KoDocument *  doc,
bool  doOpenURL,
bool  oasis 
) [private]

Définition à la ligne 268 du fichier KoDocumentChild.cpp.

Références createUnavailDocument(), d, KoStore::enterDirectory(), KoDocument::errorMessage(), INTERNAL_PROTOCOL, KoDocument::isSingleViewMode(), KoDocument::loadFromStore(), KoDocument::loadOasisFromStore(), KoDocumentChildPrivate::m_doc, KoDocumentChildPrivate::m_parent, m_tmpGeometry, m_tmpMimeType, m_tmpURL, KoDocument::openURL(), parentDocument(), KoStore::popDirectory(), KoStore::pushDirectory(), testguiform::result, setDocument(), KoDocument::setErrorMessage(), KoDocument::setStoreInternal(), STORE_PROTOCOL, et url().

Référencé par createAndLoadDocument(), et createUnavailDocument().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

Documentation des données membres

QString KoDocumentChild::m_tmpURL [protected]

Holds the source of this object, for example "file:/home/weis/image.gif" or "tar:/table1/2" if it is stored in a koffice store. This variable is set after parsing the OBJECT tag in load and is reset after calling loadDocument.

Définition à la ligne 159 du fichier KoDocumentChild.h.

Référencé par createAndLoadDocument(), finishLoadingDocument(), load(), loadDocument(), loadOasis(), et loadOasisDocument().

QRect KoDocumentChild::m_tmpGeometry [protected]

This variable is set after parsing the OBJECT tag in load and is reset after calling loadDocument.

Définition à la ligne 166 du fichier KoDocumentChild.h.

Référencé par finishLoadingDocument(), load(), et loadOasis().

QString KoDocumentChild::m_tmpMimeType [protected]

This variable is set after parsing the OBJECT tag in load and is reset after calling loadDocument.

Définition à la ligne 173 du fichier KoDocumentChild.h.

Référencé par finishLoadingDocument(), load(), et loadDocument().

KoDocumentChildPrivate* KoDocumentChild::d [private]

Réimplémentée à partir de KoChild.

Définition à la ligne 181 du fichier KoDocumentChild.h.

Référencé par createAndLoadDocument(), createUnavailDocument(), document(), finishLoadingDocument(), hitTest(), isDeleted(), isStoredExtern(), KoDocumentChild(), parentDocument(), save(), saveOasis(), saveOasisAttributes(), setDeleted(), setDocument(), url(), et ~KoDocumentChild().

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