UTF8Transliterator Class Reference

#include <utf8transliterator.h>

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

List of all members.

Public Member Functions

virtual const char * getHeader () const
virtual const char * getOptionName ()
virtual const char * getOptionTip ()
virtual const char * getOptionValue ()
virtual StringList getOptionValues ()
virtual char processText (SWBuf &text, const SWKey *key=0, const SWModule *module=0)
virtual void setOptionValue (const char *ival)
 UTF8Transliterator ()
 ~UTF8Transliterator ()

Protected Attributes

SWBuf optionValue
const StringListoptValues

Private Member Functions

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

Private Attributes

unsigned char option
StringList options
UErrorCode utf8status

Static Private Attributes

static const char optionstring [NUMTARGETSCRIPTS][16]
static const char optName []
static const char optTip []
static const char SW_RB_RULE []
static const char SW_RB_RULE_BASED_IDS []
static const char SW_RESDATA []
static SWTransMap transMap

Detailed Description

This Filter uses ICU for transliteration

Definition at line 63 of file utf8transliterator.h.


Constructor & Destructor Documentation

UTF8Transliterator::UTF8Transliterator (  ) 
UTF8Transliterator::~UTF8Transliterator (  ) 

Member Function Documentation

bool UTF8Transliterator::addTrans ( const char *  newTrans,
SWBuf transList 
) [private]
bool UTF8Transliterator::checkTrans ( const UnicodeString &  ID,
UErrorCode &  status 
) [private]
Transliterator* UTF8Transliterator::createTrans ( const UnicodeString &  ID,
UTransDirection  dir,
UErrorCode &  status 
) [private]
virtual const char* SWFilter::getHeader (  )  const [inline, virtual, inherited]

This method can supply a header associated with the processing done with this filter. A typical example is a suggested CSS style block for classed containers.

Reimplemented in GBFXHTML, OSISXHTML, and ThMLXHTML.

Definition at line 58 of file swfilter.h.

00058 { return ""; }

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

gets the name of the option of this filter

Returns:
option name

Reimplemented from SWOptionFilter.

Definition at line 89 of file utf8transliterator.h.

00089 { return optName; }

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

Definition at line 90 of file utf8transliterator.h.

00090 { return optTip; }

virtual const char* UTF8Transliterator::getOptionValue (  )  [virtual]
Returns:
The value of the current option.

Reimplemented from SWOptionFilter.

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

returns a list of the possible option values

Returns:
list of option values

Reimplemented from SWOptionFilter.

Definition at line 93 of file utf8transliterator.h.

00093 { return options; }

void UTF8Transliterator::Load ( UErrorCode &  status  )  [private]
virtual char UTF8Transliterator::processText ( SWBuf text,
const SWKey key = 0,
const SWModule module = 0 
) [virtual]

This method processes and appropriately modifies the text given it for a particular filter task

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

Implements SWFilter.

void UTF8Transliterator::registerTrans ( const UnicodeString &  ID,
const UnicodeString &  resource,
UTransDirection  dir,
UErrorCode &  status 
) [private]
virtual void 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 SWOptionFilter.


Member Data Documentation

unsigned char UTF8Transliterator::option [private]

Reimplemented from SWOptionFilter.

Definition at line 66 of file utf8transliterator.h.

Definition at line 75 of file utf8transliterator.h.

const char UTF8Transliterator::optionstring[NUMTARGETSCRIPTS][16] [static, private]

Definition at line 68 of file utf8transliterator.h.

SWBuf SWOptionFilter::optionValue [protected, inherited]

Definition at line 40 of file swoptfilter.h.

const char UTF8Transliterator::optName[] [static, private]

Reimplemented from SWOptionFilter.

Definition at line 70 of file utf8transliterator.h.

const char UTF8Transliterator::optTip[] [static, private]

Reimplemented from SWOptionFilter.

Definition at line 71 of file utf8transliterator.h.

const StringList* SWOptionFilter::optValues [protected, inherited]

Definition at line 43 of file swoptfilter.h.

const char UTF8Transliterator::SW_RB_RULE[] [static, private]

Definition at line 73 of file utf8transliterator.h.

const char UTF8Transliterator::SW_RB_RULE_BASED_IDS[] [static, private]

Definition at line 72 of file utf8transliterator.h.

const char UTF8Transliterator::SW_RESDATA[] [static, private]

Definition at line 74 of file utf8transliterator.h.

Definition at line 76 of file utf8transliterator.h.

UErrorCode UTF8Transliterator::utf8status [private]

Definition at line 77 of file utf8transliterator.h.


The documentation for this class was generated from the following file:

Generated on 18 Mar 2013 for The SWORD Project by  doxygen 1.6.1