Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  

SWFilter Class Reference

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

#include <swfilter.h>

Inheritance diagram for SWFilter::

GBFFootnotes GBFHeadings GBFHTML GBFMorph GBFPlain GBFRTF GBFStrongs GBFThML Latin1UTF16 Latin1UTF8 PLAINFootnotes PLAINHTML RTFHTML RWPHTML RWPRTF SCSUUTF8 ThMLGBF ThMLOLB ThMLPlain ThMLRTF UnicodeRTF UTF16UTF8 UTF8Cantillation UTF8GreekAccents UTF8HebrewPoints UTF8UTF16 List of all members.

Public Methods

virtual ~SWFilter ()
virtual const char* getOptionName ()
 gets the name of the option of this filter. More...

virtual const char* getOptionTip ()
 gets a short explanation of the option of this filter; it could be presented to the user in frontend programs. More...

virtual OptionsList getOptionValues ()
 returns a list of the possible option values might be. More...

virtual void setOptionValue (const char *)
 sets the value of the option of this filter, e.g maybe a strong's filter mioght be set to "on" / "off" - that would mean to show or not to show the strongs in the text, see also getOptionValues. More...

virtual const char* getOptionValue ()
virtual char ProcessText (char *text, int maxlen, const SWKey *)
 This is the main filter function. More...

virtual char ProcessText (char *text, int maxlen=-1)
 This is the main filter function without the 3rd parameter. More...


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

char SWFilter::ProcessText ( char * text,
int maxlen = -1 ) [inline, virtual]
 

This is the main filter function without the 3rd parameter.

Parameters:
text   the text to be filtered/converted
maxlen   maximal length of text to be processed
Returns:
0

Reimplemented in GBFThML, ThMLGBF, ThMLOLB, ThMLPlain, and ThMLRTF.

Definition at line 100 of file swfilter.h.

char SWFilter::ProcessText ( char * text,
int maxlen,
const SWKey * key ) [inline, virtual]
 

This is the main filter function.

Parameters:
text   the text to be filtered/converted
maxlen   maximal length of text to be processed
key   sorry I don't know
Returns:
0

Reimplemented in GBFFootnotes, GBFHeadings, GBFHTML, GBFMorph, GBFPlain, GBFRTF, GBFStrongs, Latin1UTF16, Latin1UTF8, PLAINFootnotes, PLAINHTML, RTFHTML, RWPHTML, RWPRTF, SCSUUTF8, UnicodeRTF, UTF16UTF8, UTF8Cantillation, UTF8GreekAccents, UTF8HebrewPoints, and UTF8UTF16.

Definition at line 91 of file swfilter.h.

Referenced by ProcessText().

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

gets the name of the option of this filter.

Returns:
option name

Reimplemented in GBFFootnotes, GBFHeadings, GBFMorph, GBFStrongs, PLAINFootnotes, UTF8Cantillation, UTF8GreekAccents, and UTF8HebrewPoints.

Definition at line 51 of file swfilter.h.

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

gets a short explanation of the option of this filter; it could be presented to the user in frontend programs.

Returns:
option tip/explanation

Reimplemented in GBFFootnotes, GBFHeadings, GBFMorph, GBFStrongs, PLAINFootnotes, UTF8Cantillation, UTF8GreekAccents, and UTF8HebrewPoints.

Definition at line 59 of file swfilter.h.

OptionsList SWFilter::getOptionValues ( ) [inline, virtual]
 

returns a list of the possible option values might be.

Returns:
list of option values

Reimplemented in GBFFootnotes, GBFHeadings, GBFMorph, GBFStrongs, PLAINFootnotes, UTF8Cantillation, UTF8GreekAccents, and UTF8HebrewPoints.

Definition at line 67 of file swfilter.h.

void SWFilter::setOptionValue ( const char * ival ) [inline, virtual]
 

sets the value of the option of this filter, e.g maybe a strong's filter mioght be set to "on" / "off" - that would mean to show or not to show the strongs in the text, see also getOptionValues.

Parameters:
ival   the new option valus

Reimplemented in GBFFootnotes, GBFHeadings, GBFMorph, GBFStrongs, PLAINFootnotes, UTF8Cantillation, UTF8GreekAccents, and UTF8HebrewPoints.

Definition at line 78 of file swfilter.h.


The documentation for this class was generated from the following file:
Generated at Fri Oct 5 22:45:36 2001 for The Sword Project by doxygen1.2.6 written by Dimitri van Heesch, © 1997-2001