| The Sword Project: sword::SWOptionFilter Class Reference |
#include <swoptfilter.h>
Inheritance diagram for sword::SWOptionFilter:
Public Member Functions | |
| SWOptionFilter (const char *oName, const char *oTip, const StringList *oValues) | |
| 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 StringList | getOptionValues () |
| returns a list of the possible option values | |
| virtual const char * | getOptionValue () |
| |
| 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() | |
Protected Attributes | |
| SWBuf | optionValue |
| const char * | optName |
| const char * | optTip |
| const StringList * | optValues |
| bool | option |
Definition at line 38 of file swoptfilter.h.
| virtual const char* sword::SWOptionFilter::getOptionName | ( | ) | [inline, virtual] |
gets the name of the option of this filter
Reimplemented in sword::OSISVariants, sword::ThMLVariants, and sword::UTF8Transliterator.
Definition at line 55 of file swoptfilter.h.
| virtual const char* sword::SWOptionFilter::getOptionTip | ( | ) | [inline, virtual] |
gets a short explanation of the option of this filter; it could be presented to the user in frontend programs
Reimplemented in sword::OSISVariants, sword::ThMLVariants, and sword::UTF8Transliterator.
Definition at line 61 of file swoptfilter.h.
| virtual StringList sword::SWOptionFilter::getOptionValues | ( | ) | [inline, virtual] |
returns a list of the possible option values
Reimplemented in sword::OSISVariants, sword::ThMLVariants, and sword::UTF8Transliterator.
Definition at line 67 of file swoptfilter.h.
| virtual void sword::SWOptionFilter::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()
| ival | the new option value |
Reimplemented in sword::OSISVariants, sword::ThMLVariants, and sword::UTF8Transliterator.
| The SWORD Project; P. O. Box 2528; Tempe, AZ 85280-2528 USA |