• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • kdeedu
  • Sitemap
  • Contact Us
 

kig

KigFilter Class Reference

#include <filter.h>

Inheritance diagram for KigFilter:

Inheritance graph
[legend]

List of all members.


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.


Public Member Functions

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

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

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 KigFilterCabri, KigFilterDrgeo, KigFilterKGeo, KigFilterKSeg, and KigFilterNative.

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 KigFilterCabri, KigFilterDrgeo, KigFilterKGeo, KigFilterKSeg, and KigFilterNative.

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

kig

Skip menu "kig"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members

kdeedu

Skip menu "kdeedu"
  • kalzium
  • kanagram
  • kig
  •   lib
  • klettres
  • kstars
  • libkdeedu
  •   keduvocdocument
  •   docs
  •   src
  • parley
  •   stepcore
Generated for kdeedu by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal