KoDocumentChild Class Reference
Holds an embedded object. More...
#include <koDocumentChild.h>
Inheritance diagram for KoDocumentChild:


Public Member Functions | |
KoDocumentChild (KoDocument *parent, KoDocument *doc, const QRect &geometry) | |
KoDocumentChild (KoDocument *parent) | |
virtual void | setDocument (KoDocument *doc, const QRect &geometry) |
virtual KoDocument * | document () const |
virtual KoDocument * | parentDocument () const |
virtual KoDocument * | hitTest (const QPoint &p, const QWMatrix &_matrix=QWMatrix()) |
virtual KURL | url () |
virtual QDomElement | save (QDomDocument &doc, bool uppercase=false) |
virtual bool | load (const QDomElement &element, bool uppercase=false) |
virtual bool | loadDocument (KoStore *) |
virtual bool | isStoredExtern () |
bool | isDeleted () const |
void | setDeleted (bool on=true) |
Protected Attributes | |
QString | m_tmpURL |
QRect | m_tmpGeometry |
QString | m_tmpMimeType |
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 42 of file koDocumentChild.h.
Constructor & Destructor Documentation
|
When using this constructor you must call setDocument before you can call any other function of this class.
Definition at line 74 of file koDocumentChild.cc. |
Member Function Documentation
|
Call this function only directly after calling the constructor that takes only a parent as argument.
Definition at line 83 of file koDocumentChild.cc. References KoChild::setGeometry(). |
|
Definition at line 92 of file koDocumentChild.cc. Referenced by KoView::hitTest(), KoDocument::insertChild(), KoViewChild::KoViewChild(), KoDocument::paintChild(), KoView::partActivateEvent(), save(), KoDocument::saveExternalChildren(), and url(). |
|
Definition at line 97 of file koDocumentChild.cc. |
|
Can be empty (which is why it doesn't return a const KURL &).
Definition at line 330 of file koDocumentChild.cc. References document(). Referenced by save(). |
|
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.
Definition at line 299 of file koDocumentChild.cc. References document(), KoChild::geometry(), KoDocument::nativeFormatMimeType(), and url(). |
|
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 114 of file koDocumentChild.cc. References m_tmpGeometry, m_tmpMimeType, m_tmpURL, and KoChild::setGeometry(). |
|
Actually loads the document from the disk/net or from the store, depending on url.
Definition at line 163 of file koDocumentChild.cc. References KoDocumentEntry::isEmpty(), m_tmpMimeType, m_tmpURL, and KoDocumentEntry::queryByMimeType(). |
|
This document (child) is deleted.
Definition at line 344 of file koDocumentChild.cc. Referenced by KoDocument::paintChild(), and KoDocument::saveExternalChildren(). |
Member Data Documentation
|
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 132 of file koDocumentChild.h. Referenced by load(), and loadDocument(). |
|
This variable is set after parsing the OBJECT tag in load and is reset after calling loadDocument.
Definition at line 139 of file koDocumentChild.h. Referenced by load(). |
|
This variable is set after parsing the OBJECT tag in load and is reset after calling loadDocument.
Definition at line 146 of file koDocumentChild.h. Referenced by load(), and loadDocument(). |
The documentation for this class was generated from the following files: