Référence de la classe KoFilterChain

This class represents a chain of plain KoFilter instances. Plus de détails...

#include <KoFilterChain.h>

Graphe de collaboration de KoFilterChain:

[légende]Liste de tous les membres

Types publics
typedef KSharedPtr< KoFilterChain >	Ptr
Fonctions membres publiques
virtual	~KoFilterChain ()
const KoFilterManager *	manager () const
KoFilter::ConversionStatus	invokeChain ()
QString	chainOutput () const
QString	inputFile ()
QString	outputFile ()
KoStoreDevice *	storageFile (const QString &name="root", KoStore::Mode mode=KoStore::Read)
KoDocument *	inputDocument ()
KoDocument *	outputDocument ()
void	dump () const
Types privés
enum	Whole { Beginning = 1, Middle = 2, End = 4, Done = 8 }
enum	IOState { Nil, File, Storage, Document }
Fonctions membres privées
	KoFilterChain (const KoFilterManager *manager)
void	appendChainLink (KoFilterEntry::Ptr filterEntry, const QByteArray &from, const QByteArray &to)
void	prependChainLink (KoFilterEntry::Ptr filterEntry, const QByteArray &from, const QByteArray &to)
void	enterDirectory (const QString &directory)
void	leaveDirectory ()
QString	filterManagerImportFile () const
QString	filterManagerExportFile () const
KoDocument *	filterManagerKoDocument () const
int	filterManagerDirection () const
KoFilterChain *const	filterManagerParentChain () const
void	manageIO ()
void	finalizeIO ()
bool	createTempFile (KTemporaryFile **tempFile, bool autoDelete=true)
void	inputFileHelper (KoDocument *document, const QString &alternativeFile)
void	outputFileHelper (bool autoDelete)
KoStoreDevice *	storageNewStreamHelper (KoStore **storage, KoStoreDevice **device, const QString &name)
KoStoreDevice *	storageHelper (const QString &file, const QString &streamName, KoStore::Mode mode, KoStore **storage, KoStoreDevice **device)
void	storageInit (const QString &file, KoStore::Mode mode, KoStore **storage)
KoStoreDevice *	storageInitEmbedding (const QString &name)
KoStoreDevice *	storageCreateFirstStream (const QString &streamName, KoStore **storage, KoStoreDevice **device)
KoStoreDevice *	storageCleanupHelper (KoStore **storage)
KoDocument *	createDocument (const QString &file)
KoDocument *	createDocument (const QByteArray &mimeType)
	KoFilterChain (const KoFilterChain &rhs)
KoFilterChain &	operator= (const KoFilterChain &rhs)
Attributs privés
const KoFilterManager *const	m_manager
Q3PtrList< ChainLink >	m_chainLinks
int	m_state
QString	m_inputFile
QString	m_outputFile
KoStore *	m_inputStorage
KoStoreDevice *	m_inputStorageDevice
KoStore *	m_outputStorage
KoStoreDevice *	m_outputStorageDevice
KoDocument *	m_inputDocument
KoDocument *	m_outputDocument
KTemporaryFile *	m_inputTempFile
KTemporaryFile *	m_outputTempFile
IOState	m_inputQueried
IOState	m_outputQueried
QStringList	m_internalEmbeddingDirectories
Private *	d
Amis
class	KOffice::Graph
class	KoFilterManager
void	KoEmbeddingFilter::filterChainEnterDirectory (const QString &directory) const
void	KoEmbeddingFilter::filterChainLeaveDirectory () const
Classes
class	ChainLink

---

Description détaillée

This class represents a chain of plain KoFilter instances.

Instances of this class are shared, so please just hold KoFilterChain::Ptr pointers to it.

Auteur:

Werner Trobin <trobin@kde.org>

À faire:

the class has no constructor and therefore cannot initialize its private class

Définition à la ligne 48 du fichier KoFilterChain.h.

---

Documentation des définition de type membres

typedef KSharedPtr<KoFilterChain> KoFilterChain::Ptr

Définition à la ligne 56 du fichier KoFilterChain.h.

---

Documentation des énumérations membres

enum KoFilterChain::Whole [private]

Valeurs énumérées:

Beginning
Middle
End
Done

Définition à la ligne 216 du fichier KoFilterChain.h.

enum KoFilterChain::IOState [private]

Valeurs énumérées:

Nil
File
Storage
Document

Définition à la ligne 244 du fichier KoFilterChain.h.

---

Documentation des contructeurs et destructeur

KoFilterChain::~KoFilterChain

(

)

[virtual]

Définition à la ligne 143 du fichier KoFilterChain.cpp.

Références filterManagerParentChain(), KoStore::leaveDirectory(), m_outputStorage, et manageIO().

Voici le graphe d'appel pour cette fonction :

KoFilterChain::KoFilterChain

(

const KoFilterManager *

manager

)

[private]

Définition à la ligne 333 du fichier KoFilterChain.cpp.

Références m_chainLinks.

KoFilterChain::KoFilterChain

(

const KoFilterChain &

rhs

)

[private]

---

Documentation des fonctions membres

const KoFilterManager* KoFilterChain::manager

(

)

const [inline]

The filter manager returned may be 0!

Définition à la ligne 63 du fichier KoFilterChain.h.

Références m_manager.

Référencé par KoFilterChain::ChainLink::setupCommunication().

Voici le graphe d'appel pour cette fonction :

KoFilter::ConversionStatus KoFilterChain::invokeChain

(

)

Starts the filtering process.

Renvoie:

The return status of the conversion. KoFilter::OK if everything is alright.

Définition à la ligne 150 du fichier KoFilterChain.cpp.

Références Beginning, Done, End, filterManagerParentChain(), finalizeIO(), m_chainLinks, m_state, manageIO(), Middle, KoFilter::OK, et KoFilter::StupidError.

Voici le graphe d'appel pour cette fonction :

QString KoFilterChain::chainOutput

(

)

const

Tells the KoFilterManager the output file of the filter chain in case of an import operation. If it's QString::null we directly manipulated the document.

Définition à la ligne 191 du fichier KoFilterChain.cpp.

Références Done, m_inputFile, et m_state.

QString KoFilterChain::inputFile

(

)

Get the current file to read from. This part of the API is for the filters in our chain.

Définition à la ligne 198 du fichier KoFilterChain.cpp.

Références Beginning, File, filterManagerDirection(), filterManagerImportFile(), filterManagerKoDocument(), KoFilterManager::Import, inputFileHelper(), m_inputDocument, m_inputFile, m_inputQueried, m_state, et Nil.

Référencé par inputDocument(), et storageFile().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

QString KoFilterChain::outputFile

(

)

Get the current file to write to. This part of the API is for the filters in our chain.

Définition à la ligne 222 du fichier KoFilterChain.cpp.

Références End, File, filterManagerDirection(), filterManagerExportFile(), filterManagerParentChain(), KoFilterManager::Import, m_outputFile, m_outputQueried, m_state, Nil, et outputFileHelper().

Référencé par storageFile(), et storageInitEmbedding().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

KoStoreDevice * KoFilterChain::storageFile	(	const QString &	name = "root",
		KoStore::Mode	mode = KoStore::Read
	)

Get a file from a storage. May return 0! This part of the API is for the filters in our chain. If you call it multiple times with the same stream name the stream will be closed and re-opened. Note: Don't delete that KoStoreDevice we return.

Paramètres:

	name	The name of the stream inside the storage
	mode	Whether we want to read or write from/to the stream

Renvoie:

The storage device to access the stream. May be 0!

Définition à la ligne 250 du fichier KoFilterChain.cpp.

Références filterManagerParentChain(), inputFile(), m_inputQueried, m_inputStorage, m_inputStorageDevice, m_outputQueried, m_outputStorage, m_outputStorageDevice, KoStore::mode(), Nil, outputFile(), KoStore::Read, Storage, storageHelper(), storageInitEmbedding(), storageNewStreamHelper(), et KoStore::Write.

Voici le graphe d'appel pour cette fonction :

KoDocument * KoFilterChain::inputDocument

(

)

This method allows your filter to work directly on the KoDocument of the application. This part of the API is for the filters in our chain.

Renvoie:

The document containing the data. May return 0 on error.

Définition à la ligne 277 du fichier KoFilterChain.cpp.

Références Beginning, createDocument(), Document, KoFilterManager::Export, filterManagerDirection(), filterManagerKoDocument(), inputFile(), m_inputDocument, m_inputQueried, m_state, et Nil.

Voici le graphe d'appel pour cette fonction :

KoDocument * KoFilterChain::outputDocument

(

)

This method allows your filter to work directly on the KoDocument of the application. This part of the API is for the filters in our chain.

Renvoie:

The document you have to write to. May return 0 on error.

Définition à la ligne 297 du fichier KoFilterChain.cpp.

Références createDocument(), Document, End, filterManagerDirection(), filterManagerKoDocument(), filterManagerParentChain(), KoFilterManager::Import, m_chainLinks, m_outputDocument, m_outputQueried, m_state, et Nil.

Voici le graphe d'appel pour cette fonction :

void KoFilterChain::dump

(

)

const

Définition à la ligne 324 du fichier KoFilterChain.cpp.

Références m_chainLinks.

void KoFilterChain::appendChainLink	(	KoFilterEntry::Ptr	filterEntry,
		const QByteArray &	from,
		const QByteArray &	to
	)			[private]

Définition à la ligne 343 du fichier KoFilterChain.cpp.

Références m_chainLinks.

void KoFilterChain::prependChainLink	(	KoFilterEntry::Ptr	filterEntry,
		const QByteArray &	from,
		const QByteArray &	to
	)			[private]

Définition à la ligne 348 du fichier KoFilterChain.cpp.

Références m_chainLinks.

void KoFilterChain::enterDirectory

(

const QString &

directory

)

[private]

Définition à la ligne 353 du fichier KoFilterChain.cpp.

Références KoStore::enterDirectory(), m_internalEmbeddingDirectories, et m_outputStorage.

Référencé par KoEmbeddingFilter::filterChainEnterDirectory().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

void KoFilterChain::leaveDirectory

(

)

[private]

Définition à la ligne 362 du fichier KoFilterChain.cpp.

Références KoStore::leaveDirectory(), m_internalEmbeddingDirectories, et m_outputStorage.

Référencé par KoEmbeddingFilter::filterChainLeaveDirectory().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

QString KoFilterChain::filterManagerImportFile

(

)

const [private]

Définition à la ligne 370 du fichier KoFilterChain.cpp.

Références KoFilterManager::importFile(), et m_manager.

Référencé par inputFile().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

QString KoFilterChain::filterManagerExportFile

(

)

const [private]

Définition à la ligne 375 du fichier KoFilterChain.cpp.

Références KoFilterManager::exportFile(), et m_manager.

Référencé par finalizeIO(), et outputFile().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

KoDocument * KoFilterChain::filterManagerKoDocument

(

)

const [private]

Définition à la ligne 380 du fichier KoFilterChain.cpp.

Références KoFilterManager::document(), et m_manager.

Référencé par inputDocument(), inputFile(), manageIO(), et outputDocument().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

int KoFilterChain::filterManagerDirection

(

)

const [private]

Définition à la ligne 385 du fichier KoFilterChain.cpp.

Références KoFilterManager::direction(), et m_manager.

Référencé par finalizeIO(), inputDocument(), inputFile(), outputDocument(), et outputFile().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

KoFilterChain *const KoFilterChain::filterManagerParentChain

(

)

const [private]

Définition à la ligne 390 du fichier KoFilterChain.cpp.

Références m_manager, et KoFilterManager::parentChain().

Référencé par invokeChain(), manageIO(), outputDocument(), outputFile(), storageCleanupHelper(), storageFile(), storageInitEmbedding(), et ~KoFilterChain().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

void KoFilterChain::manageIO

(

)

[private]

Définition à la ligne 395 du fichier KoFilterChain.cpp.

Références KoStore::close(), filterManagerKoDocument(), filterManagerParentChain(), m_inputDocument, m_inputFile, m_inputQueried, m_inputStorage, m_inputStorageDevice, m_inputTempFile, m_outputDocument, m_outputFile, m_outputQueried, m_outputStorage, m_outputStorageDevice, m_outputTempFile, KoStore::mode(), Nil, et KoStore::Write.

Référencé par invokeChain(), et ~KoFilterChain().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

void KoFilterChain::finalizeIO

(

)

[private]

Définition à la ligne 437 du fichier KoFilterChain.cpp.

Références KoFilterManager::Export, filterManagerDirection(), filterManagerExportFile(), m_inputDocument, m_inputFile, et KoDocument::saveNativeFormat().

Référencé par invokeChain().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

bool KoFilterChain::createTempFile	(	KTemporaryFile **	tempFile,
		bool	autoDelete = true
	)			[private]

Définition à la ligne 451 du fichier KoFilterChain.cpp.

Référencé par inputFileHelper(), et outputFileHelper().

Voici le graphe d'appel pour cette fonction :

void KoFilterChain::inputFileHelper	(	KoDocument *	document,
		const QString &	alternativeFile
	)			[private]

Définition à la ligne 462 du fichier KoFilterChain.cpp.

Références createTempFile(), m_inputFile, m_inputTempFile, et KoDocument::saveNativeFormat().

Référencé par inputFile().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

void KoFilterChain::outputFileHelper

(

bool

autoDelete

)

[private]

Définition à la ligne 483 du fichier KoFilterChain.cpp.

Références createTempFile(), m_outputFile, et m_outputTempFile.

Référencé par outputFile().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

KoStoreDevice * KoFilterChain::storageNewStreamHelper	(	KoStore **	storage,
		KoStoreDevice **	device,
		const QString &	name
	)			[private]

Définition à la ligne 494 du fichier KoFilterChain.cpp.

Références KoStoreDevice::close(), et storageCleanupHelper().

Référencé par storageFile().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

KoStoreDevice * KoFilterChain::storageHelper	(	const QString &	file,
		const QString &	streamName,
		KoStore::Mode	mode,
		KoStore **	storage,
		KoStoreDevice **	device
	)			[private]

Définition à la ligne 510 du fichier KoFilterChain.cpp.

Références m_inputQueried, m_outputQueried, KoStore::Read, Storage, storageCleanupHelper(), storageCreateFirstStream(), et storageInit().

Référencé par storageFile().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

void KoFilterChain::storageInit	(	const QString &	file,
		KoStore::Mode	mode,
		KoStore **	storage
	)			[private]

Définition à la ligne 537 du fichier KoFilterChain.cpp.

Références KoStore::createStore(), m_chainLinks, et KoStore::Write.

Référencé par storageHelper(), et storageInitEmbedding().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

KoStoreDevice * KoFilterChain::storageInitEmbedding

(

const QString &

name

)

[private]

Définition à la ligne 552 du fichier KoFilterChain.cpp.

Références KoStore::bad(), KoStore::close(), filterManagerParentChain(), KoStore::isOpen(), m_chainLinks, m_outputQueried, m_outputStorage, m_outputStorageDevice, outputFile(), Storage, storageCleanupHelper(), storageCreateFirstStream(), storageInit(), et KoStore::Write.

Référencé par storageFile().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

KoStoreDevice * KoFilterChain::storageCreateFirstStream	(	const QString &	streamName,
		KoStore **	storage,
		KoStoreDevice **	device
	)			[private]

Définition à la ligne 592 du fichier KoFilterChain.cpp.

Références m_internalEmbeddingDirectories, et storageCleanupHelper().

Référencé par storageHelper(), et storageInitEmbedding().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

KoStoreDevice * KoFilterChain::storageCleanupHelper

(

KoStore **

storage

)

[private]

Définition à la ligne 616 du fichier KoFilterChain.cpp.

Références filterManagerParentChain(), m_outputStorage, et KoStore::Write.

Référencé par storageCreateFirstStream(), storageHelper(), storageInitEmbedding(), et storageNewStreamHelper().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

KoDocument * KoFilterChain::createDocument

(

const QString &

file

)

[private]

Définition à la ligne 626 du fichier KoFilterChain.cpp.

Références KoDocument::loadNativeFormat().

Référencé par inputDocument(), et outputDocument().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

KoDocument * KoFilterChain::createDocument

(

const QByteArray &

mimeType

)

[private]

Définition à la ligne 646 du fichier KoFilterChain.cpp.

Références KoDocumentEntry::createDoc(), KoDocumentEntry::isEmpty(), et KoDocumentEntry::queryByMimeType().

Voici le graphe d'appel pour cette fonction :

KoFilterChain& KoFilterChain::operator=

(

const KoFilterChain &

rhs

)

[private]

---

Documentation des fonctions amies et associées

friend class KOffice::Graph [friend]

Définition à la ligne 52 du fichier KoFilterChain.h.

friend class KoFilterManager [friend]

Définition à la ligne 53 du fichier KoFilterChain.h.

void KoEmbeddingFilter::filterChainEnterDirectory

(

const QString &

directory

)

const [friend]

void KoEmbeddingFilter::filterChainLeaveDirectory

(

)

const [friend]

---

Documentation des données membres

const KoFilterManager* const KoFilterChain::m_manager [private]

Définition à la ligne 222 du fichier KoFilterChain.h.

Référencé par filterManagerDirection(), filterManagerExportFile(), filterManagerImportFile(), filterManagerKoDocument(), et filterManagerParentChain().

Q3PtrList<ChainLink> KoFilterChain::m_chainLinks [private]

Définition à la ligne 223 du fichier KoFilterChain.h.

Référencé par appendChainLink(), dump(), invokeChain(), KoFilterChain(), outputDocument(), prependChainLink(), storageInit(), et storageInitEmbedding().

int KoFilterChain::m_state [private]

Définition à la ligne 226 du fichier KoFilterChain.h.

Référencé par chainOutput(), inputDocument(), inputFile(), invokeChain(), outputDocument(), et outputFile().

QString KoFilterChain::m_inputFile [private]

Définition à la ligne 228 du fichier KoFilterChain.h.

Référencé par chainOutput(), finalizeIO(), inputFile(), inputFileHelper(), et manageIO().

QString KoFilterChain::m_outputFile [private]

Définition à la ligne 229 du fichier KoFilterChain.h.

Référencé par manageIO(), outputFile(), et outputFileHelper().

KoStore* KoFilterChain::m_inputStorage [private]

Définition à la ligne 231 du fichier KoFilterChain.h.

Référencé par manageIO(), et storageFile().

KoStoreDevice* KoFilterChain::m_inputStorageDevice [private]

Définition à la ligne 232 du fichier KoFilterChain.h.

Référencé par manageIO(), et storageFile().

KoStore* KoFilterChain::m_outputStorage [private]

Définition à la ligne 233 du fichier KoFilterChain.h.

Référencé par enterDirectory(), leaveDirectory(), manageIO(), storageCleanupHelper(), storageFile(), storageInitEmbedding(), et ~KoFilterChain().

KoStoreDevice* KoFilterChain::m_outputStorageDevice [private]

Définition à la ligne 234 du fichier KoFilterChain.h.

Référencé par manageIO(), storageFile(), et storageInitEmbedding().

KoDocument* KoFilterChain::m_inputDocument [private]

Définition à la ligne 236 du fichier KoFilterChain.h.

Référencé par finalizeIO(), inputDocument(), inputFile(), et manageIO().

KoDocument* KoFilterChain::m_outputDocument [private]

Définition à la ligne 237 du fichier KoFilterChain.h.

Référencé par manageIO(), et outputDocument().

KTemporaryFile* KoFilterChain::m_inputTempFile [private]

Définition à la ligne 239 du fichier KoFilterChain.h.

Référencé par inputFileHelper(), et manageIO().

KTemporaryFile* KoFilterChain::m_outputTempFile [private]

Définition à la ligne 240 du fichier KoFilterChain.h.

Référencé par manageIO(), et outputFileHelper().

IOState KoFilterChain::m_inputQueried [private]

Définition à la ligne 245 du fichier KoFilterChain.h.

Référencé par inputDocument(), inputFile(), manageIO(), storageFile(), et storageHelper().

IOState KoFilterChain::m_outputQueried [private]

Définition à la ligne 245 du fichier KoFilterChain.h.

Référencé par manageIO(), outputDocument(), outputFile(), storageFile(), storageHelper(), et storageInitEmbedding().

QStringList KoFilterChain::m_internalEmbeddingDirectories [private]

Définition à la ligne 252 du fichier KoFilterChain.h.

Référencé par enterDirectory(), leaveDirectory(), et storageCreateFirstStream().

Private* KoFilterChain::d [private]

Définition à la ligne 254 du fichier KoFilterChain.h.

---

La documentation de cette classe a été générée à partir des fichiers suivants :

• F:/KPlato/koffice/libs/kofficecore/KoFilterChain.h
• F:/KPlato/koffice/libs/kofficecore/KoFilterChain.cpp

---