SWFilter Class Reference

#include <swfilter.h>

Inheritance diagram for SWFilter:

[legend]

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.

{}

---

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.

{ 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 CipherFilter, GBFFootnotes, GBFHeadings, GBFMorph, GBFOSIS, GBFPlain, GBFRedLetterWords, GBFRTF, GBFStrongs, GBFThML, GBFWordJS, GreekLexAttribs, Latin1UTF16, Latin1UTF8, OSISFootnotes, OSISLemma, OSISMorph, OSISMorphSegmentation, OSISOSIS, OSISRedLetterWords, OSISRTF, OSISRuby, OSISScripref, OSISStrongs, OSISVariants, OSISWordJS, PapyriPlain, PLAINFootnotes, PLAINHTML, RTFHTML, SWBasicFilter, ThMLFootnotes, ThMLGBF, ThMLHeadings, ThMLLemma, ThMLMorph, ThMLOSIS, ThMLPlain, ThMLRTF, ThMLScripref, ThMLStrongs, ThMLVariants, ThMLWordJS, UnicodeRTF, UTF16UTF8, UTF8ArabicPoints, UTF8arShaping, UTF8BiDiReorder, UTF8Cantillation, UTF8GreekAccents, UTF8HebrewPoints, UTF8HTML, UTF8Latin1, UTF8NFC, UTF8NFKD, UTF8Transliterator, and UTF8UTF16.

---

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

• include/swfilter.h