KWDocument Class Reference

The class that represents a KWord document containing content and settings. More...

#include <KWDocument.h>

Inheritance diagram for KWDocument:

Public Slots
void	addFrameSet (KWFrameSet *f)
void	relayout ()
void	removeFrameSet (KWFrameSet *fs)
Signals
void	pageSetupChanged ()
Public Member Functions
	KWDocument (QWidget parentWidget=0, QObject parent=0, bool singleViewMode=false)
	~KWDocument ()
void	addShape (KoShape *shape)
KWPage	appendPage (const QString &masterPageName=QString())
const KWApplicationConfig &	config () const
KWApplicationConfig &	config ()
QList < KoDocument::CustomDocumentWidgetItem >	createCustomDocumentWidgets (QWidget *parent)
KoView *	createViewInstance (QWidget *)
QMap< QString, KoDataCenter * >	dataCenterMap () const
virtual QStringList	extraNativeMimeTypes (ImportExportType importExportType) const
void	firePageSetupChanged ()
KWFrameSet *	frameSetByName (const QString &name)
int	frameSetCount () const
const QList< KWFrameSet * > &	frameSets () const
virtual void	initEmpty ()
KoInlineTextObjectManager *	inlineTextObjectManager () const
KWPage	insertPage (int afterPageNum, const QString &masterPageName=QString())
bool	layoutFinishedAtleastOnce () const
virtual bool	loadOdf (KoOdfReadStore &odfStore)
virtual bool	loadXML (const KoXmlDocument &doc, KoStore *store)
KWTextFrameSet *	mainFrameSet () const
virtual int	pageCount () const
Q_SCRIPTABLE KWPageManager *	pageManager ()
const KWPageManager *	pageManager () const
virtual void	paintContent (QPainter &, const QRect &)
void	printDebug ()
void	removePage (int pageNumber)
void	removeShape (KoShape *shape)
virtual bool	saveOdf (SavingContext &documentContext)
QString	suggestFrameSetNameForCopy (const QString &base)
QString	uniqueFrameSetName (const QString &suggestion)
Protected Member Functions
virtual bool	completeLoading (KoStore *store)

Detailed Description

The class that represents a KWord document containing content and settings.

Definition at line 53 of file KWDocument.h.

Constructor & Destructor Documentation

KWDocument::KWDocument	(	QWidget *	parentWidget = `0`,
		QObject *	parent = `0`,
		bool	singleViewMode = `false`
	)			`[explicit]`

Constructor, normally called by the KWFactory::createPartObject().

Definition at line 129 of file KWDocument.cpp.

KWDocument::~KWDocument ( )

Definition at line 162 of file KWDocument.cpp.

Member Function Documentation

void KWDocument::addFrameSet ( KWFrameSet * f ) [slot]

Register new frameset.

Definition at line 324 of file KWDocument.cpp.

void KWDocument::addShape ( KoShape * shape )

reimplemented from KoShapeControllerBase

Definition at line 170 of file KWDocument.cpp.

KWPage KWDocument::appendPage ( const QString & masterPageName = QString() )

Append a new page, creating followup frames (but not headers/footers), and return the page number.

Parameters:

masterPageName

the name of the master page to use for this new page.

Definition at line 252 of file KWDocument.cpp.

bool KWDocument::completeLoading ( KoStore * store ) [protected, virtual]

reimplemented from KoDocument

Definition at line 710 of file KWDocument.cpp.

const KWApplicationConfig& KWDocument::config ( ) const [inline]

Definition at line 153 of file KWDocument.h.

KWApplicationConfig& KWDocument::config ( ) [inline]

Definition at line 150 of file KWDocument.h.

QList< KoDocument::CustomDocumentWidgetItem > KWDocument::createCustomDocumentWidgets ( QWidget * parent )

reimplemented from super

Definition at line 871 of file KWDocument.cpp.

KoView * KWDocument::createViewInstance ( QWidget * parent )

reimplemented from KoDocument

Definition at line 214 of file KWDocument.cpp.

QMap<QString, KoDataCenter *> KWDocument::dataCenterMap ( ) const [inline]

Returns:: the data center map for this document.

Definition at line 101 of file KWDocument.h.

QStringList KWDocument::extraNativeMimeTypes ( ImportExportType importExportType ) const [virtual]

Definition at line 729 of file KWDocument.cpp.

void KWDocument::firePageSetupChanged ( )

Definition at line 274 of file KWDocument.cpp.

KWFrameSet * KWDocument::frameSetByName ( const QString & name )

return a frameset, or null, by name.

See also:: KWFrameSet::name()

Definition at line 399 of file KWDocument.cpp.

int KWDocument::frameSetCount ( ) const [inline]

return the amount of framesets this document holds

Definition at line 128 of file KWDocument.h.

const QList<KWFrameSet*>& KWDocument::frameSets ( ) const [inline]

return a list of all the framesets this document holds

Definition at line 132 of file KWDocument.h.

void KWDocument::initEmpty ( ) [virtual]

Definition at line 464 of file KWDocument.cpp.

KoInlineTextObjectManager * KWDocument::inlineTextObjectManager ( ) const

return the inlineTextObjectManager for this document.

Definition at line 413 of file KWDocument.cpp.

KWPage KWDocument::insertPage	(	int	afterPageNum,
		const QString &	masterPageName = `QString()`
	)

Insert a new page after another, creating followup frames (but not headers/footers),.

Parameters:

	afterPageNum	the page is inserted after the one specified here If afterPageNum is 0, a page is inserted before page 1. In all cases, the new page will have the number afterPageNum+1. Use appendPage in WP mode, insertPage in DTP mode.
	masterPageName	the name of the master page to use for this new page.

Definition at line 244 of file KWDocument.cpp.

bool KWDocument::layoutFinishedAtleastOnce ( ) const [inline]

Definition at line 169 of file KWDocument.h.

bool KWDocument::loadOdf ( KoOdfReadStore & odfStore ) [virtual]

reimplemented from KoDocument

Definition at line 531 of file KWDocument.cpp.

bool KWDocument::loadXML	(	const KoXmlDocument &	doc,
		KoStore *	store
	)			`[virtual]`

reimplemented from KoDocument

Definition at line 545 of file KWDocument.cpp.

KWTextFrameSet * KWDocument::mainFrameSet ( ) const

return the main text frameset of the document

Definition at line 408 of file KWDocument.cpp.

virtual int KWDocument::pageCount ( ) const [inline, virtual]

reimplemented from KoDocument

Definition at line 82 of file KWDocument.h.

Q_SCRIPTABLE KWPageManager* KWDocument::pageManager ( ) [inline]

Return the pageManager used in this document.

Definition at line 96 of file KWDocument.h.

const KWPageManager* KWDocument::pageManager ( ) const [inline]

Return the pageManager used in this document.

Definition at line 90 of file KWDocument.h.

void KWDocument::pageSetupChanged ( ) [signal]

signal emitted when a page has been added

void KWDocument::paintContent	(	QPainter &	,
		const QRect &	rect
	)			`[virtual]`

reimplemented from KoDocument

Definition at line 209 of file KWDocument.cpp.

void KWDocument::printDebug ( )

Use a log of kDebug calls to print out the internal state of the document and its members.

Definition at line 818 of file KWDocument.cpp.

void KWDocument::relayout ( ) [slot]

Relayout the pages.

Definition at line 293 of file KWDocument.cpp.

void KWDocument::removeFrameSet ( KWFrameSet * fs ) [slot]

Remove frameset from the document stopping it from being saved or displayed.

Note that the document is normally the one that deletes framesets when the document is closed, after removing it the caller will have the responsibility to delete it when its no longer of use.

Parameters:

fs

the frameset that should be removed from the doc

See also:: addFrameSet()

Definition at line 281 of file KWDocument.cpp.

void KWDocument::removePage ( int pageNumber )

remove a page from the document.

Parameters:

pageNumber

the pageNumber that should be removed.

Definition at line 261 of file KWDocument.cpp.

void KWDocument::removeShape ( KoShape * shape )

reimplemented from KoShapeControllerBase

Definition at line 191 of file KWDocument.cpp.

bool KWDocument::saveOdf ( SavingContext & documentContext ) [virtual]

reimplemented from KoDocument

Definition at line 723 of file KWDocument.cpp.

QString KWDocument::suggestFrameSetNameForCopy ( const QString & base )

return a suggestion for a copy frameset that does not collide with known ones.

Definition at line 425 of file KWDocument.cpp.

QString KWDocument::uniqueFrameSetName ( const QString & suggestion )

return a suggestion for a new frameset name that does not collide with known ones.

Definition at line 418 of file KWDocument.cpp.

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

kword/part

KWDocument Class Reference

Public Slots

Signals

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

kword/part

API Reference