The Sword Project: sword::SWFilter Class Reference
sword::SWFilter

sword::SWFilter Class Reference

Base class for all filters in sword. More...

#include <swfilter.h>

Inheritance diagram for sword::SWFilter:

Inheritance graph
[legend]
List of all members.

Public Member Functions

virtual ~SWFilter ()
virtual char processText (SWBuf &text, const SWKey *key=0, const SWModule *module=0)=0
 This is the main filter function.

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.

Member Function Documentation

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

This is the main filter function.

Parameters:
text The text to be filtered/converted
key Current key That was used.
module Current module.
Returns:
0

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

The documentation for this class was generated from the following file:
The SWORD Project; P. O. Box 2528; Tempe, AZ 85280-2528 USA