---

GBFFootnotes Class Reference

This Filter shows/hides footnotes in a GBF text. More...

#include <gbffootnotes.h>

Inheritance diagram for GBFFootnotes::

List of all members.

Public Methods
	GBFFootnotes ()
virtual	~GBFFootnotes ()
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 footnotes in a GBF text.

Definition at line 30 of file gbffootnotes.h.

---

Member Function Documentation

virtual char GBFFootnotes::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 * GBFFootnotes::getOptionName ( ) [inline, virtual]

gets the name of the option of this filter. Returns: option name Reimplemented from SWFilter. Definition at line 42 of file gbffootnotes.h.

const char * GBFFootnotes::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 gbffootnotes.h.

OptionsList GBFFootnotes::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 gbffootnotes.h.

virtual void GBFFootnotes::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:

• gbffootnotes.h

---