lib Library API Documentation

KoDocumentChild Class Reference

Holds an embedded object. More...

#include <koDocumentChild.h>

Inheritance diagram for KoDocumentChild:

Inheritance graph
[legend]
Collaboration diagram for KoDocumentChild:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 KoDocumentChild (KoDocument *parent, KoDocument *doc, const QRect &geometry)
 KoDocumentChild (KoDocument *parent)
virtual void setDocument (KoDocument *doc, const QRect &geometry)
KoDocumentdocument () const
virtual KoDocumentparentDocument () const
virtual KoDocumenthitTest (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 saveOasisToStore (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

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.


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.cc.


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.cc.

References KoChild::setGeometry(), and KoChild::updateMatrix().

KoDocument * KoDocumentChild::document  )  const
 

Returns:
document contained in this child
See also:
KoDocument

Definition at line 100 of file koDocumentChild.cc.

Referenced by KoView::hitTest(), KoDocument::paintChild(), KoView::partActivateEvent(), save(), KoDocument::saveExternalChildren(), saveOasisAttributes(), saveOasisToStore(), and url().

KoDocument * KoDocumentChild::parentDocument  )  const [virtual]
 

Returns:
parent document of this child
See also:
KoDocument

Definition at line 105 of file koDocumentChild.cc.

KURL KoDocumentChild::url  )  const
 

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

Definition at line 476 of file koDocumentChild.cc.

References document().

Referenced by save(), and saveOasisToStore().

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 444 of file koDocumentChild.cc.

References document(), KoChild::geometry(), and url().

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 421 of file koDocumentChild.cc.

References KoXmlWriter::addAttribute(), and document().

bool KoDocumentChild::saveOasisToStore 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.cc.

References document(), and url().

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.cc.

References m_tmpGeometry, m_tmpMimeType, m_tmpURL, and KoChild::setGeometry().

bool KoDocumentChild::loadDocument KoStore  )  [virtual]
 

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

Definition at line 194 of file koDocumentChild.cc.

References KoDocumentEntry::isEmpty(), m_tmpMimeType, m_tmpURL, and KoDocumentEntry::queryByMimeType().

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.cc.

References KoStore::currentDirectory(), KoDocumentEntry::isEmpty(), m_tmpURL, KoOasisStore::mimeForPath(), and KoDocumentEntry::queryByMimeType().

bool KoDocumentChild::isDeleted  )  const
 

This document (child) is deleted.

Definition at line 490 of file koDocumentChild.cc.

Referenced by KoDocument::paintChild(), and KoDocument::saveExternalChildren().


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.

Referenced by load(), loadDocument(), and loadOasisDocument().

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.

Referenced by load().

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.

Referenced by load(), and loadDocument().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for lib Library Version 1.4.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Mon Feb 13 09:40:51 2006 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003