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

GBFStrongs Class Reference

This Filter shows/hides strong's numbers in a GBF text. More...

#include <gbfstrongs.h>

Inheritance diagram for GBFStrongs:

SWFilter List of all members.

Public Methods

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

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 void setOptionValue (const char *ival)
 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 OptionsList getOptionValues ()
 returns a list of the possible option values might be. More...


Private Attributes

bool option
OptionsList options

Static Private Attributes

const char on []
const char off []
const char optName []
const char optTip []

Detailed Description

This Filter shows/hides strong's numbers in a GBF text.

Definition at line 30 of file gbfstrongs.h.

Member Function Documentation

virtual char GBFStrongs::ProcessText ( char * text,
int maxlen,
const SWKey * key ) [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 from SWFilter.

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

gets the name of the option of this filter.

Returns:
option name

Reimplemented from SWFilter.

Definition at line 42 of file gbfstrongs.h.

const char * GBFStrongs::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 from SWFilter.

Definition at line 46 of file gbfstrongs.h.

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

returns a list of the possible option values might be.

Returns:
list of option values

Reimplemented from SWFilter.

Definition at line 52 of file gbfstrongs.h.

virtual void GBFStrongs::setOptionValue ( const char * ival ) [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 from SWFilter.

The documentation for this class was generated from the following file:
Generated at Thu May 24 19:50:27 2001 for The Sword Project by doxygen1.1.5 written by Dimitri van Heesch, © 1997-2000