KigFilter Class Reference

#include <filter.h>

Inheritance diagram for KigFilter:

Public Member Functions
	KigFilter ()
virtual	~KigFilter ()
virtual KigDocument *	load (const QString &fromfile)=0
virtual bool	supportMime (const QString &mime)

Protected Member Functions
void	fileNotFound (const QString &file) const
void	notSupported (const QString &file, const QString &explanation) const
void	parseError (const QString &file, const QString &explanation=QString()) const
void	warning (const QString &explanation) const

Detailed Description

This is the base class for an input filter.

All the needed work to add a new input filter to Kig is subclassing this class and implement supportMime() and load().

Definition at line 68 of file filter.h.

Constructor & Destructor Documentation

KigFilter::KigFilter

(

)

Definition at line 57 of file filter.cc.

KigFilter::~KigFilter ( )

virtual

Definition at line 61 of file filter.cc.

Member Function Documentation

void KigFilter::fileNotFound ( const QString &  file ) const

protected

Definition at line 70 of file filter.cc.

virtual KigDocument* KigFilter::load ( const QString &  fromfile )

pure virtual

load file fromfile and build a KigDocument from it.

. If this function returns 0, that means that an error occurred while loading ( implementations of this function are responsible for showing an error message themselves, using the above error functions ). If this functions returns non-0, the caller owns the returned KigDocument ( that was allocated with "new" ).

Implemented in KigFilterNative, KigFilterCabri, KigFilterDrgeo, KigFilterKGeo, and KigFilterKSeg.

void KigFilter::notSupported ( const QString &  file, const QString &  explanation  ) const

protected

Definition at line 92 of file filter.cc.

void KigFilter::parseError ( const QString &  file, const QString &  explanation = QString()  ) const

protected

Definition at line 79 of file filter.cc.

bool KigFilter::supportMime ( const QString &  mime )

virtual

can the filter handle the mimetype mime ?

Reimplemented in KigFilterNative, KigFilterCabri, KigFilterDrgeo, KigFilterKGeo, and KigFilterKSeg.

Definition at line 65 of file filter.cc.

void KigFilter::warning ( const QString &  explanation ) const

protected

Definition at line 99 of file filter.cc.

---

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

• filter.h
• filter.cc