lib Library API Documentation

KoFilterChain Class Reference

This class represents a chain of plain KoFilter instances. More...

#include <koFilterChain.h>

List of all members.

Public Types

typedef KSharedPtr< KoFilterChainPtr

Public Member Functions

const KoFilterManagermanager () const
KoFilter::ConversionStatus invokeChain ()
QString chainOutput () const
QString inputFile ()
QString outputFile ()
KoStoreDevicestorageFile (const QString &name="root", KoStore::Mode mode=KoStore::Read)
KoDocumentinputDocument ()
KoDocumentoutputDocument ()
void dump () const

Friends

void KoEmbeddingFilter::filterChainEnterDirectory (const QString &directory) const
void KoEmbeddingFilter::filterChainLeaveDirectory () const


Detailed Description

This class represents a chain of plain KoFilter instances.

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

Author:
Werner Trobin <trobin@kde.org>

Definition at line 48 of file koFilterChain.h.


Member Function Documentation

const KoFilterManager* KoFilterChain::manager  )  const [inline]
 

The filter manager returned may be 0!

Definition at line 63 of file koFilterChain.h.

KoFilter::ConversionStatus KoFilterChain::invokeChain  ) 
 

Starts the filtering process.

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

Definition at line 134 of file koFilterChain.cpp.

References m_chainLinks.

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.

Definition at line 174 of file koFilterChain.cpp.

QString KoFilterChain::inputFile  ) 
 

Get the current file to read from.

This part of the API is for the filters in our chain.

Definition at line 181 of file koFilterChain.cpp.

Referenced by inputDocument(), and storageFile().

QString KoFilterChain::outputFile  ) 
 

Get the current file to write to.

This part of the API is for the filters in our chain.

Definition at line 205 of file koFilterChain.cpp.

Referenced by storageFile().

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.

Parameters:
name The name of the stream inside the storage
mode Whether we want to read or write from/to the stream
Returns:
The storage device to access the stream. May be 0!

Definition at line 233 of file koFilterChain.cpp.

References inputFile(), KoStore::mode(), outputFile(), and storageFile().

Referenced by storageFile().

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.

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

Definition at line 260 of file koFilterChain.cpp.

References inputFile().

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.

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

Definition at line 280 of file koFilterChain.cpp.


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.3.5.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Nov 17 06:54:22 2004 by doxygen 1.3.7 written by Dimitri van Heesch, © 1997-2003