#include <KoFilterChain.h>
Public Types | |
| typedef TDESharedPtr< KoFilterChain > | Ptr |
Public Member Functions | |
| const KoFilterManager * | manager () const |
| KoFilter::ConversionStatus | invokeChain () |
| TQString | chainOutput () const |
| TQString | inputFile () |
| TQString | outputFile () |
| KoStoreDevice * | storageFile (const TQString &name="root", KoStore::Mode mode=KoStore::Read) |
| KoDocument * | inputDocument () |
| KoDocument * | outputDocument () |
| void | dump () const |
Friends | |
| class | KOffice::Graph |
| class | KoFilterManager |
| void | KoEmbeddingFilter::filterChainEnterDirectory (const TQString &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.
- Todo
- the class has no constructor and therefore cannot initialize its private class
Definition at line 50 of file KoFilterChain.h.
Member Typedef Documentation
◆ Ptr
| typedef TDESharedPtr<KoFilterChain> KoFilterChain::Ptr |
Definition at line 58 of file KoFilterChain.h.
Constructor & Destructor Documentation
◆ ~KoFilterChain()
|
virtual |
Definition at line 127 of file KoFilterChain.cpp.
Member Function Documentation
◆ chainOutput()
| TQString KoFilterChain::chainOutput | ( | ) | const |
Tells the KoFilterManager the output file of the filter chain in case of an import operation.
If it's TQString() we directly manipulated the document.
Definition at line 175 of file KoFilterChain.cpp.
◆ dump()
| void KoFilterChain::dump | ( | ) | const |
Definition at line 308 of file KoFilterChain.cpp.
◆ inputDocument()
| 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 261 of file KoFilterChain.cpp.
◆ inputFile()
| TQString KoFilterChain::inputFile | ( | ) |
Get the current file to read from.
This part of the API is for the filters in our chain.
Definition at line 182 of file KoFilterChain.cpp.
◆ invokeChain()
| 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.
◆ manager()
|
inline |
The filter manager returned may be 0!
Definition at line 65 of file KoFilterChain.h.
◆ outputDocument()
| 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 281 of file KoFilterChain.cpp.
◆ outputFile()
| TQString KoFilterChain::outputFile | ( | ) |
Get the current file to write to.
This part of the API is for the filters in our chain.
Definition at line 206 of file KoFilterChain.cpp.
◆ storageFile()
| KoStoreDevice * KoFilterChain::storageFile | ( | const TQString & | 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 234 of file KoFilterChain.cpp.
Friends And Related Symbol Documentation
◆ KOffice::Graph
|
friend |
Definition at line 54 of file KoFilterChain.h.
◆ KoFilterManager
|
friend |
Definition at line 55 of file KoFilterChain.h.
The documentation for this class was generated from the following files: