Reference

gbfstrongs(3)

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

NAME

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

SYNOPSIS

#include <gbfstrongs.h>

Inherits SWFilter.

Public Methods

GBFStrongs ()
virtual ~GBFStrongs ()
virtual char ProcessText (char *text, int maxlen, const SWKey *key)
This is the main filter function. virtual const char* getOptionName ()
gets the name of the option of this filter. virtual const char* getOptionTip ()
gets a short explanation of the option of this filter; it could be presented to the user in frontend programs. 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-thatwouldmeantoshowornottoshowthestrongsinthetext,seealsogetOptionValues." virtual const char* getOptionValue ()
virtual OptionsList getOptionValues ()
returns a list of the possible option values might be.

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.

AUTHOR

Generated automatically by Doxygen for The Sword Project from the source code.