lib
KoDocumentChild Class Reference
#include <KoDocumentChild.h>

Detailed Description
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.
Definition at line 43 of file KoDocumentChild.h.
Public Member Functions | |
KoDocumentChild (KoDocument *parent, KoDocument *doc, const QRect &geometry) | |
KoDocumentChild (KoDocument *parent) | |
virtual void | setDocument (KoDocument *doc, const QRect &geometry) |
KoDocument * | document () const |
virtual KoDocument * | parentDocument () const |
virtual KoDocument * | hitTest (const QPoint &p, const QWMatrix &_matrix=QWMatrix()) |
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 QDomElement &element, bool uppercase=false) |
void | loadOasis (const QDomElement &frameElement, const QDomElement &objectElement) |
virtual bool | loadDocument (KoStore *) |
virtual bool | loadOasisDocument (KoStore *store, const QDomDocument &manifestDoc) |
virtual bool | isStoredExtern () const |
bool | isDeleted () const |
void | setDeleted (bool on=true) |
Protected Attributes | |
QString | m_tmpURL |
QRect | m_tmpGeometry |
QString | m_tmpMimeType |
Constructor & Destructor Documentation
KoDocumentChild::KoDocumentChild | ( | KoDocument * | parent | ) |
When using this constructor you must call setDocument before you can call any other function of this class.
Definition at line 82 of file KoDocumentChild.cpp.
Member Function Documentation
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.
Definition at line 91 of file KoDocumentChild.cpp.
KoDocument * KoDocumentChild::document | ( | ) | const |
- Returns:
- document contained in this child
- See also:
- KoDocument
Definition at line 100 of file KoDocumentChild.cpp.
KoDocument * KoDocumentChild::parentDocument | ( | ) | const [virtual] |
- Returns:
- parent document of this child
- See also:
- KoDocument
Definition at line 105 of file KoDocumentChild.cpp.
KURL KoDocumentChild::url | ( | ) | const |
- Note:
- Can be empty (which is why it doesn't return a const KURL &)
Definition at line 499 of file KoDocumentChild.cpp.
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.
- Returns:
- the element containing the "object" tag.
Definition at line 467 of file KoDocumentChild.cpp.
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).
Definition at line 444 of file KoDocumentChild.cpp.
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
Definition at line 387 of file KoDocumentChild.cpp.
bool KoDocumentChild::load | ( | const QDomElement & | 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.
Definition at line 143 of file KoDocumentChild.cpp.
bool KoDocumentChild::loadDocument | ( | KoStore * | store | ) | [virtual] |
Actually loads the document from the disk/net or from the store, depending on url.
Definition at line 194 of file KoDocumentChild.cpp.
bool KoDocumentChild::loadOasisDocument | ( | KoStore * | store, | |
const QDomDocument & | manifestDoc | |||
) | [virtual] |
Actually loads the document from the disk/net or from the store depending on the document's url.
Definition at line 224 of file KoDocumentChild.cpp.
bool KoDocumentChild::isDeleted | ( | ) | const |
Member Data Documentation
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.
Definition at line 156 of file KoDocumentChild.h.
QRect KoDocumentChild::m_tmpGeometry [protected] |
This variable is set after parsing the OBJECT tag in load and is reset after calling loadDocument.
Definition at line 163 of file KoDocumentChild.h.
QString KoDocumentChild::m_tmpMimeType [protected] |
This variable is set after parsing the OBJECT tag in load and is reset after calling loadDocument.
Definition at line 170 of file KoDocumentChild.h.
The documentation for this class was generated from the following files: