Document Class Reference

A document that can contain a lot of formulas (container). More...

#include <kformuladocument.h>

Inheritance diagram for Document:

[legend]Collaboration diagram for Document:


Public Member Functions
	Document (QObject parent=0, const char name=0, const QStringList &args=QStringList())
virtual Container *	createFormula (int pos=-1, bool registerMe=true)
virtual void	registerFormula (Container *, int pos=-1)
virtual void	unregisterFormula (Container *)
virtual void	evaluateFormulas ()
virtual void	enableEvaluation (bool)
bool	loadXML (const QDomDocument &doc)
bool	loadOasis (const QDomDocument &doc)
bool	loadDocumentPart (QDomElement node)
QDomDocument	saveXML ()
QDomElement	saveDocumentPart (QDomDocument &doc)
ContextStyle &	getContextStyle (bool edit=false)
void	setZoomAndResolution (int zoom, int dpiX, int dpiY)
void	newZoomAndResolution (bool updateViews, bool forPrint)
void	setZoomAndResolution (int zoom, double zoomX, double zoomY, bool updateViews=false, bool forPrint=false)
double	getXResolution () const
double	getYResolution () const
void	activate (Container *formula)
void	setEnabled (bool enabled)
KoCommandHistory *	getHistory () const
const SymbolTable &	getSymbolTable () const
void	updateConfig ()
QPtrListIterator< Container >	formulas ()
SymbolType	leftBracketChar ()
SymbolType	rightBracketChar ()
DocumentWrapper *	wrapper ()
Static Public Member Functions
static QDomDocument	createDomDocument ()
Protected Member Functions
int	formulaPos (Container *formula)
Container *	formulaAt (uint pos)
int	formulaCount ()
void	sortFormulaList ()
Friends
class	DocumentWrapper
class	Container

Detailed Description

A document that can contain a lot of formulas (container).

The relationship between the document and its formulas is an open one. The document sure owns the formulas and when it vanishes the formulas will be destroyed, too. But the user will most often work with those formulas directly and not bother to ask the document. It's legal to directly create or destroy a Container object.

Definition at line 67 of file kformuladocument.h.

Constructor & Destructor Documentation

Document::Document ( QObject * parent = 0,

const char * name = 0,

const QStringList & args = QStringList()

)

Creates a formula document.

Definition at line 70 of file kformuladocument.cc.

Member Function Documentation

Container * Document::createFormula ( int pos = -1,

bool registerMe = true

) [virtual]

Factory method.

Definition at line 99 of file kformuladocument.cc.
References Container::initialize().

void Document::registerFormula ( Container * ,

int pos = -1

) [virtual]

Registers a new formula to be part of this document.
Each formula must be part of exactly one document.
Definition at line 205 of file kformuladocument.cc.

void Document::unregisterFormula ( Container * ) [virtual]

Removes a formula from this document.
The formula will stay alive and might be registered again.
Definition at line 218 of file kformuladocument.cc.

virtual void Document::evaluateFormulas ( ) [inline, virtual]

Triggers the evaluation of the whole document.
This obviously required evaluation support.
Definition at line 103 of file kformuladocument.h.

bool Document::loadXML ( const QDomDocument & doc )

Load a kformula DomDocument with all its formulas.
This must only be called on a virgin document.
Definition at line 131 of file kformuladocument.cc.
References Container::load(), and loadDocumentPart().

bool Document::loadOasis ( const QDomDocument & doc )

Load a OASIS content.xml DomDocument.

Since:
1.4

Definition at line 167 of file kformuladocument.cc.

bool Document::loadDocumentPart ( QDomElement node )

Load the document settings.

Definition at line 174 of file kformuladocument.cc.
Referenced by loadXML().

QDomDocument Document::saveXML ( )

Save the document with all its formulae.

Definition at line 179 of file kformuladocument.cc.
References createDomDocument(), and saveDocumentPart().

QDomElement Document::saveDocumentPart ( QDomDocument & doc )

Save the document settings.

Definition at line 192 of file kformuladocument.cc.
Referenced by saveXML().

ContextStyle & Document::getContextStyle ( bool edit = false )

Returns:
the documents context style.

Definition at line 261 of file kformuladocument.cc.
References ContextStyle::setEdit().
Referenced by setZoomAndResolution().

void Document::setZoomAndResolution ( int zoom,

int dpiX,

int dpiY

)

Change the zoom factor to z (e.g.
150 for 150%) and/or change the resolution, given in DPI. Uses the KoZoomHandler.
Definition at line 267 of file kformuladocument.cc.
References ContextStyle::setZoomAndResolution().
Referenced by setZoomAndResolution().

void Document::setZoomAndResolution ( int zoom,

double zoomX,

double zoomY,

bool updateViews = false,

bool forPrint = false

)

Sets the zoom by hand.
This is to be used in paintContent.
Definition at line 279 of file kformuladocument.cc.
References getContextStyle(), and setZoomAndResolution().

void Document::activate ( Container * formula )

Sets a new formula.

Definition at line 226 of file kformuladocument.cc.

void Document::setEnabled ( bool enabled )

Enables our action according to enabled.

Definition at line 300 of file kformuladocument.cc.
References DocumentWrapper::setEnabled().

KoCommandHistory * Document::getHistory ( ) const

Returns:
our undo stack so the formulas can use it.

Definition at line 306 of file kformuladocument.cc.
References DocumentWrapper::getHistory().

const SymbolTable & Document::getSymbolTable ( ) const

Returns:
the documents symbol table

Definition at line 256 of file kformuladocument.cc.
References ContextStyle::symbolTable().

void Document::updateConfig ( )

Gets called when the configuration changed.
(Maybe we can find a better solution.)
Definition at line 322 of file kformuladocument.cc.
References DocumentWrapper::updateConfig().

QDomDocument Document::createDomDocument ( ) [static]

Return a kformula DomDocument.

Definition at line 199 of file kformuladocument.cc.
References KoDocument::createDomDocument().
Referenced by saveXML().

QPtrListIterator< Container > Document::formulas ( )

Returns:
an iterator for the collection of formulas.

Definition at line 107 of file kformuladocument.cc.

int Document::formulaPos ( Container * formula ) [protected]

Returns:
the internal position of this formula or -1 if it doesn't belong to us.

Definition at line 113 of file kformuladocument.cc.

Container * Document::formulaAt ( uint pos ) [protected]

Returns:
the formula at position pos.

Definition at line 119 of file kformuladocument.cc.

int Document::formulaCount ( ) [protected]

Returns:
the number of formulas in this document.

Definition at line 125 of file kformuladocument.cc.

void Document::sortFormulaList ( ) [protected]

Sorts the list of formulas according to their screen positions.

Definition at line 232 of file kformuladocument.cc.

The documentation for this class was generated from the following files:

lib Library API Documentation

Document Class Reference

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation