The SWORD Project
1.9.0.svnversion
|
#include <osisheadings.h>
Public Member Functions | |
virtual BasicFilterUserData * | createUserData (const SWModule *module, const SWKey *key) |
virtual const char * | getHeader () const |
virtual const char * | getOptionName () |
virtual const char * | getOptionTip () |
virtual const char * | getOptionValue () |
virtual StringList | getOptionValues () |
virtual bool | handleToken (SWBuf &buf, const char *token, BasicFilterUserData *userData) |
bool | isBoolean () |
OSISHeadings () | |
virtual char | processText (SWBuf &text, const SWKey *key=0, const SWModule *module=0)=0 |
virtual char | processText (SWBuf &text, const SWKey *key=0, const SWModule *module=0) |
virtual void | setOptionValue (const char *ival) |
Protected Attributes | |
bool | isBooleanVal |
bool | option |
SWBuf | optionValue |
const char * | optName |
const char * | optTip |
const StringList * | optValues |
Static Protected Attributes | |
static const char | FINALIZE = 8 |
static const char | INITIALIZE = 1 |
static const char | POSTCHAR = 4 |
static const char | PRECHAR = 2 |
This Filter shows/hides headings in a OSIS text
Definition at line 34 of file osisheadings.h.
OSISHeadings::OSISHeadings | ( | ) |
Definition at line 77 of file osisheadings.cpp.
|
protectedinherited |
Registers an esc control sequence that can pass unchanged
Definition at line 156 of file swbasicfilter.cpp.
|
protectedinherited |
Registers an esc control sequence
Definition at line 176 of file swbasicfilter.cpp.
|
protectedinherited |
Registers a simple token substitutions. Usually called from the c-tor of a subclass
Definition at line 136 of file swbasicfilter.cpp.
|
virtual |
Reimplemented from SWBasicFilter.
Definition at line 72 of file osisheadings.cpp.
|
inlinevirtualinherited |
|
inlinevirtualinherited |
gets the name of the option of this filter
Reimplemented in UTF8Transliterator.
Definition at line 72 of file swoptfilter.h.
|
inlinevirtualinherited |
gets a short explanation of the option of this filter; it could be presented to the user in frontend programs
Reimplemented in UTF8Transliterator.
Definition at line 78 of file swoptfilter.h.
|
virtualinherited |
Reimplemented in UTF8Transliterator.
Definition at line 62 of file swoptfilter.cpp.
|
inlinevirtualinherited |
returns a list of the possible option values
Reimplemented in UTF8Transliterator.
Definition at line 84 of file swoptfilter.h.
|
protectedvirtualinherited |
This function is called for every escape sequence encountered in the input text.
buf | the output buffer |
escString | the escape sequence (e.g. "amp" for &) |
userData | user storage space for data transient to 1 full buffer parse |
false
if was not handled and should be handled in Definition at line 286 of file swbasicfilter.cpp.
|
protectedvirtualinherited |
This function is called for all numeric escape sequences. If passThrough
buf | the output buffer |
escString | the escape sequence (e.g. "#235" for &235;) |
Definition at line 244 of file swbasicfilter.cpp.
|
virtual |
This function is called for every token encountered in the input text.
buf | the output buffer |
token | the token (e.g. "p align='left'" |
userData | user storage space for data transient to 1 full buffer parse |
Reimplemented from SWBasicFilter.
Definition at line 82 of file osisheadings.cpp.
|
inlineinherited |
many options are simple Off/On boolean type, and frontends may wish to show these with checkmarks or the like to the end user. This is a convenience method to allow a frontend to check if this filter has only Off/On values
Definition at line 67 of file swoptfilter.h.
|
protectedinherited |
This passes allowed escapeStrings
Definition at line 223 of file swbasicfilter.cpp.
|
inlineprotectedvirtualinherited |
|
pure virtualinherited |
This method processes and appropriately modifies the text given it for a particular filter task
text | The text to be filtered/converted |
key | Current key That was used. |
module | Current module. |
Implemented in UTF8Transliterator, SWBasicFilter, GBFOSIS, SCSUUTF8, OSISReferenceLinks, ThMLRTF, OSISOSIS, ThMLWordJS, UTF8SCSU, UTF8arShaping, UTF8BiDiReorder, UTF8NFC, OSISWordJS, GBFWordJS, OSISMorphSegmentation, UTF8Latin1, UTF8NFKD, GBFRedLetterWords, CipherFilter, OSISRTF, OSISVariants, OSISRedLetterWords, OSISStrongs, GBFFootnotes, GBFHeadings, GBFMorph, GBFStrongs, GreekLexAttribs, OSISEnum, OSISFootnotes, OSISGlosses, OSISLemma, OSISMorph, OSISScripref, OSISXlit, RTFHTML, ThMLFootnotes, ThMLHeadings, ThMLLemma, ThMLMorph, ThMLOSIS, ThMLScripref, ThMLStrongs, ThMLVariants, UTF8ArabicPoints, UTF8Cantillation, UTF8GreekAccents, UTF8HebrewPoints, GBFRTF, GBFThML, Latin1UTF16, Latin1UTF8, PapyriPlain, ThMLGBF, ThMLPlain, UnicodeRTF, UTF16UTF8, UTF8HTML, UTF8UTF16, and GBFPlain.
|
virtualinherited |
This method processes and appropriately modifies the text given it for a particular filter task
text | The text to be filtered/converted |
key | Current key That was used. |
module | Current module. |
Implements SWFilter.
Reimplemented in ThMLRTF, OSISOSIS, and OSISRTF.
Definition at line 315 of file swbasicfilter.cpp.
|
protectedinherited |
Unregisters an esc control sequence that can pass unchanged
Definition at line 169 of file swbasicfilter.cpp.
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
Sets the end of escape sequence (by default ";").
Definition at line 297 of file swbasicfilter.cpp.
|
protectedinherited |
Sets the beginning of escape sequence (by default "&").
Definition at line 291 of file swbasicfilter.cpp.
|
protectedinherited |
Are escapeStrings case sensitive or not? Call this function before addEscapeStingSubstitute()
Definition at line 131 of file swbasicfilter.cpp.
|
virtualinherited |
sets the value of the option of this filter, e.g maybe a strong's filter might 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 UTF8Transliterator.
Definition at line 52 of file swoptfilter.cpp.
|
protectedinherited |
Sets whether to pass thru a numeric escape sequence unchanged or allow it to be handled otherwise. Default is false.
Definition at line 121 of file swbasicfilter.cpp.
|
protectedinherited |
Sets whether to pass thru an unknown escape sequence unchanged or just remove it. Default is false.
Definition at line 116 of file swbasicfilter.cpp.
|
protectedinherited |
Sets whether to pass thru an unknown token unchanged or just remove it. Default is false.
Definition at line 111 of file swbasicfilter.cpp.
|
inlineprotectedvirtualinherited |
Definition at line 186 of file swbasicfilter.h.
|
protectedinherited |
Are tokens case sensitive (like in GBF) or not? Call this function before addTokenSubstitute()
Definition at line 126 of file swbasicfilter.cpp.
|
protectedinherited |
Sets the end of token start sequence (by default ">").
Definition at line 309 of file swbasicfilter.cpp.
|
protectedinherited |
Sets the beginning of token start sequence (by default "<").
Definition at line 303 of file swbasicfilter.cpp.
|
protectedinherited |
This function performs the substitution of escapeStrings
Definition at line 253 of file swbasicfilter.cpp.
This function performs the substitution of tokens
Definition at line 196 of file swbasicfilter.cpp.
|
staticprotectedinherited |
Definition at line 99 of file swbasicfilter.h.
|
staticprotectedinherited |
Definition at line 96 of file swbasicfilter.h.
|
protectedinherited |
Definition at line 55 of file swoptfilter.h.
|
protectedinherited |
Definition at line 54 of file swoptfilter.h.
|
protectedinherited |
Definition at line 50 of file swoptfilter.h.
|
protectedinherited |
Definition at line 51 of file swoptfilter.h.
|
protectedinherited |
Definition at line 52 of file swoptfilter.h.
|
protectedinherited |
Definition at line 53 of file swoptfilter.h.
|
staticprotectedinherited |
Definition at line 98 of file swbasicfilter.h.
|
staticprotectedinherited |
Definition at line 97 of file swbasicfilter.h.