SWFilter Class Reference

#include <swfilter.h>

Inheritance diagram for SWFilter:

Collaboration diagram for SWFilter:

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 45 of file swfilter.h.

Constructor & Destructor Documentation

virtual SWFilter::~SWFilter ( )

inlinevirtual

Definition at line 47 of file swfilter.h.

{}

Member Function Documentation

virtual const char* SWFilter::getHeader ( ) const

inlinevirtual

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 OSISLaTeX, OSISXHTML, ThMLLaTeX, ThMLXHTML, TEIXHTML, GBFLaTeX, and GBFXHTML.

Definition at line 62 of file swfilter.h.

{ return ""; }

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

pure virtual

This method processes and appropriately modifies the text given it for a particular filter task

Parameters

text	The text to be filtered/converted
key	Current key That was used.
module	Current module.

Returns

0

Implemented in UTF8Transliterator, SWBasicFilter, GBFOSIS, SCSUUTF8, OSISReferenceLinks, ThMLRTF, OSISOSIS, ThMLWordJS, UTF8SCSU, UTF8arShaping, UTF8BiDiReorder, UTF8NFC, OSISWordJS, GBFWordJS, OSISMorphSegmentation, UTF8Latin1, UTF8NFKD, GBFRedLetterWords, CipherFilter, OSISRTF, OSISVariants, OSISRedLetterWords, OSISStrongs, GBFFootnotes, GBFHeadings, GBFMorph, GBFStrongs, GreekLexAttribs, OSISEnum, OSISFootnotes, OSISGlosses, OSISLemma, OSISMorph, OSISScripref, OSISXlit, RTFHTML, ThMLFootnotes, ThMLHeadings, ThMLLemma, ThMLMorph, ThMLOSIS, ThMLScripref, ThMLStrongs, ThMLVariants, UTF8ArabicPoints, UTF8Cantillation, UTF8GreekAccents, UTF8HebrewPoints, GBFRTF, GBFThML, Latin1UTF16, Latin1UTF8, PapyriPlain, ThMLGBF, ThMLPlain, UnicodeRTF, UTF16UTF8, UTF8HTML, UTF8UTF16, and GBFPlain.

---

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

• include/swfilter.h