SWOptionFilter Class Reference

#include <swoptfilter.h>

Inheritance diagram for SWOptionFilter:

Collaboration diagram for SWOptionFilter:

Public Member Functions
virtual const char *	getHeader () const
virtual const char *	getOptionName ()
virtual const char *	getOptionTip ()
virtual const char *	getOptionValue ()
virtual StringList	getOptionValues ()
bool	isBoolean ()
virtual char	processText (SWBuf &text, const SWKey *key=0, const SWModule *module=0)=0
virtual void	setOptionValue (const char *ival)
	SWOptionFilter ()
	SWOptionFilter (const char *oName, const char *oTip, const StringList *oValues)
virtual	~SWOptionFilter ()

Protected Attributes
bool	isBooleanVal
bool	option
SWBuf	optionValue
const char *	optName
const char *	optTip
const StringList *	optValues

Detailed Description

Base class for all option filters.

Definition at line 47 of file swoptfilter.h.

Constructor & Destructor Documentation

SWORD_NAMESPACE_START SWOptionFilter::SWOptionFilter

(

)

Definition at line 30 of file swoptfilter.cpp.

                               {
    static StringList empty;
    static const char *empty2 = "";
    optName   = empty2;
    optTip    = empty2;
    optValues = ∅
}

SWOptionFilter::SWOptionFilter	(	const char *	oName,
		const char *	oTip,
		const StringList *	oValues
	)

Definition at line 39 of file swoptfilter.cpp.

                                                                                             {
    optName   = oName;
    optTip    = oTip;
    optValues = oValues;
    if (optValues->begin() != optValues->end()) setOptionValue(*(optValues->begin()));
    isBooleanVal = optValues->size() == 2 && (optionValue == "On" || optionValue == "Off");
}

SWOptionFilter::~SWOptionFilter ( )

virtual

Definition at line 48 of file swoptfilter.cpp.

                                {
}

Member Function Documentation

virtual const char* SWFilter::getHeader ( ) const

inlinevirtualinherited

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 const char* SWOptionFilter::getOptionName ( )

inlinevirtual

gets the name of the option of this filter

Returns

option name

Reimplemented in UTF8Transliterator.

Definition at line 72 of file swoptfilter.h.

{ return optName; }

virtual const char* SWOptionFilter::getOptionTip ( )

inlinevirtual

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 UTF8Transliterator.

Definition at line 78 of file swoptfilter.h.

{ return optTip; }

const char * SWOptionFilter::getOptionValue ( )

virtual

Returns

The value of the current option.

Reimplemented in UTF8Transliterator.

Definition at line 62 of file swoptfilter.cpp.

                                           {
    return optionValue;
}

virtual StringList SWOptionFilter::getOptionValues ( )

inlinevirtual

returns a list of the possible option values

Returns

list of option values

Reimplemented in UTF8Transliterator.

Definition at line 84 of file swoptfilter.h.

{ return *optValues; }

bool SWOptionFilter::isBoolean ( )

inline

many options are simple Off/On boolean type, and frontends may wish to show these with checkmarks or the like to the end user. This is a convenience method to allow a frontend to check if this filter has only Off/On values

Definition at line 67 of file swoptfilter.h.

{ return isBooleanVal; }

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

pure virtualinherited

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.

void SWOptionFilter::setOptionValue ( const char *  ival )

virtual

sets the value of the option of this filter, e.g maybe a strong's filter might 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 value

Reimplemented in UTF8Transliterator.

Definition at line 52 of file swoptfilter.cpp.

                                                    {
    for (StringList::const_iterator loop = optValues->begin(); loop != optValues->end(); loop++) {
        if (!stricmp(loop->c_str(), ival)) {
            optionValue = *loop;
            option = (!strnicmp(ival, "On", 2));    // convenience for boolean filters
            break;
        }
    }
}

Member Data Documentation

bool SWOptionFilter::isBooleanVal

protected

Definition at line 55 of file swoptfilter.h.

bool SWOptionFilter::option

protected

Definition at line 54 of file swoptfilter.h.

SWBuf SWOptionFilter::optionValue

protected

Definition at line 50 of file swoptfilter.h.

const char* SWOptionFilter::optName

protected

Definition at line 51 of file swoptfilter.h.

const char* SWOptionFilter::optTip

protected

Definition at line 52 of file swoptfilter.h.

const StringList* SWOptionFilter::optValues

protected

Definition at line 53 of file swoptfilter.h.

---

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

• include/swoptfilter.h
• src/modules/filters/swoptfilter.cpp