filters

Public Member Functions | Protected Member Functions | List of all members
KSpread::Leader Class Reference

#include <KSpreadLeader.h>

Public Member Functions

 Leader (KoFilterChain *filterChain)
 
 Leader (KoFilterChain *filterChain, KSpreadBaseWorker *newWorker)
 
virtual ~Leader ()
 
void setWorker (KSpreadBaseWorker *newWorker)
 
KoFilter::ConversionStatus convert ()
 

Protected Member Functions

KSpreadBaseWorker * getWorker () const
 
KoFilter::ConversionStatus doSpreadCell (Cell *spreadCell, int column, int row)
 
KoFilter::ConversionStatus doSpreadSheet (Sheet *spreadSheet)
 
KoFilter::ConversionStatus doSpreadBook (Doc *document)
 
KoFilter::ConversionStatus doInfo (KoDocumentInfo *info)
 

Detailed Description

This class is a leader which will call the callbacks to the worker with your own implementation for your export filter.

To write an export filter, just instanciate a leader and implement you own worker based on the BaseWorker.

A Leader for an KSpread export filter

Author
Fred Malabre
See also
KSpreadBaseWorker
KoFilter

Definition at line 46 of file KSpreadLeader.h.

Constructor & Destructor Documentation

◆ Leader() [1/2]

Leader::Leader ( KoFilterChain *  filterChain)

Default constructor.

Call setWorker() before starting to convert the KSpread document.

Parameters
thefilter chain of the filter using the lib.

Definition at line 25 of file KSpreadLeader.cpp.

◆ Leader() [2/2]

Leader::Leader ( KoFilterChain *  filterChain,
KSpreadBaseWorker *  newWorker 
)

This constructor set up the Worker at initialization.

convert can be called right away after instanciation of the Leader.

Parameters
thefilter chain of the filter using the lib.
implementationof a class derived from KSpreadWorker.

Definition at line 31 of file KSpreadLeader.cpp.

◆ ~Leader()

Leader::~Leader ( )
virtual

Default destructor.

It does nothing.

Definition at line 37 of file KSpreadLeader.cpp.

Member Function Documentation

◆ convert()

KoFilter::ConversionStatus Leader::convert ( )

Start the conversion process.

The callbacks of your Worker will be called at this time.

Returns
status of the conversion.

Definition at line 51 of file KSpreadLeader.cpp.

◆ doInfo()

KoFilter::ConversionStatus Leader::doInfo ( KoDocumentInfo *  info)
protected

Definition at line 125 of file KSpreadLeader.cpp.

◆ doSpreadBook()

KoFilter::ConversionStatus Leader::doSpreadBook ( Doc *  document)
protected

Definition at line 167 of file KSpreadLeader.cpp.

◆ doSpreadCell()

KoFilter::ConversionStatus Leader::doSpreadCell ( Cell *  spreadCell,
int  column,
int  row 
)
protected

Definition at line 260 of file KSpreadLeader.cpp.

◆ doSpreadSheet()

KoFilter::ConversionStatus Leader::doSpreadSheet ( Sheet *  spreadSheet)
protected

Definition at line 219 of file KSpreadLeader.cpp.

◆ getWorker()

KSpreadBaseWorker * Leader::getWorker ( ) const
protected

Definition at line 41 of file KSpreadLeader.cpp.

◆ setWorker()

void Leader::setWorker ( KSpreadBaseWorker *  newWorker)

Set your own implementation of the Worker.

Parameters
implementationof a class derived from KSpreadWorker.

Definition at line 46 of file KSpreadLeader.cpp.

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