#include <swfilter.h>
Inheritance diagram for SWFilter:
Public Methods | |
virtual | ~SWFilter () |
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 OptionsList | getOptionValues () |
returns a list of the possible option values might be. More... | |
virtual void | setOptionValue (const char *) |
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 char | ProcessText (char *text, int maxlen, const SWKey *) |
This is the main filter function. More... | |
virtual char | ProcessText (char *text, int maxlen = -1) |
This is the main filter function without the 3rd parameter. More... |
Filters are used to filter/convert text between different formats like GBF, HTML, RTF ...
Definition at line 41 of file swfilter.h.
|
This is the main filter function without the 3rd parameter.
text | the text to be filtered/converted |
maxlen | maximal length of text to be processed |
Reimplemented in GBFThML, ThMLGBF, ThMLHTML, ThMLOLB, ThMLPlain, and ThMLRTF.
Definition at line 100 of file swfilter.h.
|
This is the main filter function.
text | the text to be filtered/converted |
maxlen | maximal length of text to be processed |
key | sorry I don't know |
Reimplemented in GBFFootnotes, GBFHTML, GBFHeadings, GBFPlain, GBFRTF, GBFStrongs, PLAINFootnotes, PLAINHTML, RTFHTML, RWPHTML, RWPRTF, and UnicodeRTF.
Definition at line 91 of file swfilter.h.
Referenced by ProcessText().
|
gets the name of the option of this filter.
Reimplemented in GBFFootnotes, GBFHeadings, GBFStrongs, and PLAINFootnotes.
Definition at line 51 of file swfilter.h.
|
gets a short explanation of the option of this filter; it could be presented to the user in frontend programs.
Reimplemented in GBFFootnotes, GBFHeadings, GBFStrongs, and PLAINFootnotes.
Definition at line 59 of file swfilter.h.
|
returns a list of the possible option values might be.
Reimplemented in GBFFootnotes, GBFHeadings, GBFStrongs, and PLAINFootnotes.
Definition at line 67 of file swfilter.h.
|
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 valus |
Reimplemented in GBFFootnotes, GBFHeadings, GBFStrongs, and PLAINFootnotes.
Definition at line 78 of file swfilter.h.