The Sword Project: sword::UTF8Transliterator Class Reference
sword::UTF8Transliterator

sword::UTF8Transliterator Class Reference

This Filter uses ICU for transliteration. More...

#include <utf8transliterator.h>

Inheritance diagram for sword::UTF8Transliterator:

Inheritance graph
[legend]
Collaboration diagram for sword::UTF8Transliterator:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual char processText (SWBuf &text, const SWKey *key=0, const SWModule *module=0)
 This is the main filter function.
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 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()
virtual const char * getOptionValue ()
 
Returns:
The value of the current option.

virtual StringList getOptionValues ()
 returns a list of the possible option values

Private Member Functions

void Load (UErrorCode &status)
void registerTrans (const UnicodeString &ID, const UnicodeString &resource, UTransDirection dir, UErrorCode &status)
bool addTrans (const char *newTrans, SWBuf *transList)
bool checkTrans (const UnicodeString &ID, UErrorCode &status)
Transliterator * createTrans (const UnicodeString &ID, UTransDirection dir, UErrorCode &status)

Private Attributes

unsigned char option
StringList options
UErrorCode utf8status

Static Private Attributes

static const char optionstring [48-3][16]
static const char optName []
static const char optTip []
static const char SW_RB_RULE_BASED_IDS []
static const char SW_RB_RULE []
static const char SW_RESDATA []
static SWTransMap transMap

Detailed Description

This Filter uses ICU for transliteration.

Definition at line 54 of file utf8transliterator.h.

Member Function Documentation

virtual char sword::UTF8Transliterator::processText ( SWBuf &  text,
const SWKey *  key = 0,
const SWModule *  module = 0 
) [virtual]

This is the main filter function.

Parameters:
text The text to be filtered/converted
key Current key That was used.
module Current module.
Returns:
0

Implements sword::SWFilter.

virtual const char* sword::UTF8Transliterator::getOptionName (  )  [inline, virtual]

gets the name of the option of this filter

Returns:
option name

Reimplemented from sword::SWOptionFilter.

Definition at line 79 of file utf8transliterator.h.

virtual const char* sword::UTF8Transliterator::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 sword::SWOptionFilter.

Definition at line 80 of file utf8transliterator.h.

virtual void sword::UTF8Transliterator::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 value

Reimplemented from sword::SWOptionFilter.

virtual StringList sword::UTF8Transliterator::getOptionValues (  )  [inline, virtual]

returns a list of the possible option values

Returns:
list of option values

Reimplemented from sword::SWOptionFilter.

Definition at line 83 of file utf8transliterator.h.

The documentation for this class was generated from the following file:
The SWORD Project; P. O. Box 2528; Tempe, AZ 85280-2528 USA