SWFilter Class Reference

#include <swfilter.h>

Inheritance diagram for SWFilter:
Inheritance graph

List of all members.

Public Member Functions

virtual const char * getHeader () const
virtual char processText (SWBuf &text, const SWKey *key=0, const SWModule *module=0)=0
virtual ~SWFilter ()

Detailed Description

Base class for all filters in sword. Filters are used to filter/convert text between different formats like GBF, HTML, RTF ...

Definition at line 41 of file swfilter.h.

Constructor & Destructor Documentation

virtual SWFilter::~SWFilter (  )  [inline, virtual]

Definition at line 43 of file swfilter.h.

00043 {}

Member Function Documentation

virtual const char* SWFilter::getHeader (  )  const [inline, virtual]

This method can supply a header associated with the processing done with this filter. A typical example is a suggested CSS style block for classed containers.

Reimplemented in GBFXHTML, OSISXHTML, and ThMLXHTML.

Definition at line 58 of file swfilter.h.

00058 { return ""; }

virtual char SWFilter::processText ( SWBuf text,
const SWKey key = 0,
const SWModule module = 0 
) [pure virtual]

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

Generated on 18 Mar 2013 for The SWORD Project by  doxygen 1.6.1