diff options
Diffstat (limited to 'doc/api-documentation/man/man3/SWFilter.3')
| -rw-r--r-- | doc/api-documentation/man/man3/SWFilter.3 | 151 |
1 files changed, 0 insertions, 151 deletions
diff --git a/doc/api-documentation/man/man3/SWFilter.3 b/doc/api-documentation/man/man3/SWFilter.3 deleted file mode 100644 index 396ed0e..0000000 --- a/doc/api-documentation/man/man3/SWFilter.3 +++ /dev/null @@ -1,151 +0,0 @@ -.TH "SWFilter" 3 "5 Dec 2001" "The Sword Project" \" -*- nroff -*- -.ad l -.nh -.SH NAME -SWFilter \- Base class for all filters in sword. -.SH SYNOPSIS -.br -.PP -\fC#include <swfilter.h>\fP -.PP -Inherited by CipherFilter, \fBGBFFootnotes\fP, \fBGBFHeadings\fP, \fBGBFHTML\fP, \fBGBFMorph\fP, \fBGBFPlain\fP, \fBGBFRTF\fP, \fBGBFStrongs\fP, \fBGBFThML\fP, \fBLatin1UTF16\fP, \fBLatin1UTF8\fP, \fBPLAINFootnotes\fP, \fBPLAINHTML\fP, \fBRTFHTML\fP, \fBRWPHTML\fP, \fBRWPRTF\fP, \fBSCSUUTF8\fP, SWBasicFilter, \fBThMLFootnotes\fP, \fBThMLGBF\fP, \fBThMLHeadings\fP, \fBThMLLemma\fP, \fBThMLMorph\fP, \fBThMLOLB\fP, \fBThMLPlain\fP, \fBThMLScripref\fP, \fBThMLStrongs\fP, \fBUnicodeRTF\fP, \fBUTF16UTF8\fP, \fBUTF8Cantillation\fP, \fBUTF8GreekAccents\fP, \fBUTF8HebrewPoints\fP, \fBUTF8HTML\fP, \fBUTF8Latin1\fP, and \fBUTF8UTF16\fP. -.PP -.SS "Public Methods" - -.in +1c -.ti -1c -.RI "virtual \fB~SWFilter\fP ()" -.br -.ti -1c -.RI "virtual const char * \fBgetOptionName\fP ()" -.br -.RI "\fIgets the name of the option of this filter.\fP" -.ti -1c -.RI "virtual const char * \fBgetOptionTip\fP ()" -.br -.RI "\fIgets a short explanation of the option of this filter; it could be presented to the user in frontend programs.\fP" -.ti -1c -.RI "virtual OptionsList \fBgetOptionValues\fP ()" -.br -.RI "\fIreturns a list of the possible option values might be.\fP" -.ti -1c -.RI "virtual void \fBsetOptionValue\fP (const char *)" -.br -.RI "\fIsets 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 \fBgetOptionValues\fP.\fP" -.ti -1c -.RI "virtual const char * \fBgetOptionValue\fP ()" -.br -.ti -1c -.RI "virtual char \fBProcessText\fP (char *text, int maxlen, const \fBSWKey\fP *)" -.br -.RI "\fIThis is the main filter function.\fP" -.ti -1c -.RI "virtual char \fBProcessText\fP (char *text, int maxlen=-1)" -.br -.RI "\fIThis is the main filter function without the 3rd parameter.\fP" -.in -1c -.SH "DETAILED DESCRIPTION" -.PP -Base class for all filters in sword. -.PP -Filters are used to filter/convert text between different formats like GBF, HTML, RTF ... -.PP -Definition at line 41 of file swfilter.h. -.SH "MEMBER FUNCTION DOCUMENTATION" -.PP -.SS "virtual char SWFilter::ProcessText (char * text, int maxlen = -1)\fC [inline, virtual]\fP" -.PP -This is the main filter function without the 3rd parameter. -.PP -Parameters: -.in +1c -.TP -\fB\fItext\fP\fP -the text to be filtered/converted -.TP -\fB\fImaxlen\fP\fP -maximal length of text to be processed -.PP -\fBReturns: \fP -.in +1c -0 -.PP -Reimplemented in \fBGBFThML\fP, \fBThMLGBF\fP, \fBThMLOLB\fP, and \fBThMLPlain\fP. -.PP -Definition at line 100 of file swfilter.h. -.SS "virtual char SWFilter::ProcessText (char * text, int maxlen, const \fBSWKey\fP * key)\fC [inline, virtual]\fP" -.PP -This is the main filter function. -.PP -Parameters: -.in +1c -.TP -\fB\fItext\fP\fP -the text to be filtered/converted -.TP -\fB\fImaxlen\fP\fP -maximal length of text to be processed -.TP -\fB\fIkey\fP\fP -sorry I don't know -.PP -\fBReturns: \fP -.in +1c -0 -.PP -Reimplemented in \fBGBFFootnotes\fP, \fBGBFHeadings\fP, \fBGBFHTML\fP, \fBGBFMorph\fP, \fBGBFPlain\fP, \fBGBFRTF\fP, \fBGBFStrongs\fP, \fBLatin1UTF16\fP, \fBLatin1UTF8\fP, \fBPLAINFootnotes\fP, \fBPLAINHTML\fP, \fBRTFHTML\fP, \fBRWPHTML\fP, \fBRWPRTF\fP, \fBSCSUUTF8\fP, \fBThMLFootnotes\fP, \fBThMLHeadings\fP, \fBThMLLemma\fP, \fBThMLMorph\fP, \fBThMLScripref\fP, \fBThMLStrongs\fP, \fBUnicodeRTF\fP, \fBUTF16UTF8\fP, \fBUTF8Cantillation\fP, \fBUTF8GreekAccents\fP, \fBUTF8HebrewPoints\fP, \fBUTF8HTML\fP, \fBUTF8Latin1\fP, and \fBUTF8UTF16\fP. -.PP -Definition at line 91 of file swfilter.h. -.PP -Referenced by ProcessText(). -.PP -.SS "virtual const char* SWFilter::getOptionName ()\fC [inline, virtual]\fP" -.PP -gets the name of the option of this filter. -.PP -\fBReturns: \fP -.in +1c -option name -.PP -Reimplemented in \fBGBFFootnotes\fP, \fBGBFHeadings\fP, \fBGBFMorph\fP, \fBGBFStrongs\fP, \fBPLAINFootnotes\fP, \fBThMLFootnotes\fP, \fBThMLHeadings\fP, \fBThMLLemma\fP, \fBThMLMorph\fP, \fBThMLScripref\fP, \fBThMLStrongs\fP, \fBUTF8Cantillation\fP, \fBUTF8GreekAccents\fP, and \fBUTF8HebrewPoints\fP. -.PP -Definition at line 51 of file swfilter.h. -.SS "virtual const char* SWFilter::getOptionTip ()\fC [inline, virtual]\fP" -.PP -gets a short explanation of the option of this filter; it could be presented to the user in frontend programs. -.PP -\fBReturns: \fP -.in +1c -option tip/explanation -.PP -Reimplemented in \fBGBFFootnotes\fP, \fBGBFHeadings\fP, \fBGBFMorph\fP, \fBGBFStrongs\fP, \fBPLAINFootnotes\fP, \fBThMLFootnotes\fP, \fBThMLHeadings\fP, \fBThMLLemma\fP, \fBThMLMorph\fP, \fBThMLScripref\fP, \fBThMLStrongs\fP, \fBUTF8Cantillation\fP, \fBUTF8GreekAccents\fP, and \fBUTF8HebrewPoints\fP. -.PP -Definition at line 59 of file swfilter.h. -.SS "virtual OptionsList SWFilter::getOptionValues ()\fC [inline, virtual]\fP" -.PP -returns a list of the possible option values might be. -.PP -\fBReturns: \fP -.in +1c -list of option values -.PP -Reimplemented in \fBGBFFootnotes\fP, \fBGBFHeadings\fP, \fBGBFMorph\fP, \fBGBFStrongs\fP, \fBPLAINFootnotes\fP, \fBThMLFootnotes\fP, \fBThMLHeadings\fP, \fBThMLLemma\fP, \fBThMLMorph\fP, \fBThMLScripref\fP, \fBThMLStrongs\fP, \fBUTF8Cantillation\fP, \fBUTF8GreekAccents\fP, and \fBUTF8HebrewPoints\fP. -.PP -Definition at line 67 of file swfilter.h. -.SS "virtual void SWFilter::setOptionValue (const char * ival)\fC [inline, virtual]\fP" -.PP -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 \fBgetOptionValues\fP. -.PP -Parameters: -.in +1c -.TP -\fB\fIival\fP\fP -the new option valus -.PP -Reimplemented in \fBGBFFootnotes\fP, \fBGBFHeadings\fP, \fBGBFMorph\fP, \fBGBFStrongs\fP, \fBPLAINFootnotes\fP, \fBThMLFootnotes\fP, \fBThMLHeadings\fP, \fBThMLLemma\fP, \fBThMLMorph\fP, \fBThMLScripref\fP, \fBThMLStrongs\fP, \fBUTF8Cantillation\fP, \fBUTF8GreekAccents\fP, and \fBUTF8HebrewPoints\fP. -.PP -Definition at line 78 of file swfilter.h. - -.SH "AUTHOR" -.PP -Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file |