The Sword Project: sword::ThMLVariants Class Reference
sword::ThMLVariants

sword::ThMLVariants Class Reference

This Filter shows/hides textual variants. More...

#include <thmlvariants.h>

Inheritance diagram for sword::ThMLVariants:

Inheritance graph
[legend]
Collaboration diagram for sword::ThMLVariants:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual char processText (SWBuf &text, const SWKey *key=0, const SWModule *module=0)
 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" - that would mean to show or not to show the strongs in the text, see also getOptionValues()
virtual const char * getOptionValue ()
 
Returns:
The value of the current option.

virtual StringList getOptionValues ()
 returns a list of the possible option values

Private Attributes

char option
StringList options

Static Private Attributes

static const char primary []
static const char secondary []
static const char all []
static const char optName []
static const char optTip []

Detailed Description

This Filter shows/hides textual variants.

Definition at line 30 of file thmlvariants.h.

Member Function Documentation

virtual char sword::ThMLVariants::processText ( SWBuf &  text,
const SWKey *  key = 0,
const SWModule *  module = 0 
) [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

Implements sword::SWFilter.

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

gets the name of the option of this filter

Returns:
option name

Reimplemented from sword::SWOptionFilter.

Definition at line 45 of file thmlvariants.h.

virtual const char* sword::ThMLVariants::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 sword::SWOptionFilter.

Definition at line 46 of file thmlvariants.h.

virtual void sword::ThMLVariants::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 value

Reimplemented from sword::SWOptionFilter.

virtual StringList sword::ThMLVariants::getOptionValues (  )  [inline, virtual]

returns a list of the possible option values

Returns:
list of option values

Reimplemented from sword::SWOptionFilter.

Definition at line 49 of file thmlvariants.h.

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