UTF8Transliterator Class Reference

#include <utf8transliterator.h>

Inheritance diagram for UTF8Transliterator:

Collaboration diagram for UTF8Transliterator:

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

Protected Attributes
bool	isBooleanVal
SWBuf	optionValue
const StringList *	optValues

Private Member Functions
bool	addTrans (const char *newTrans, SWBuf *transList)
icu::Transliterator *	createTrans (const icu::UnicodeString &ID, UTransDirection dir, UErrorCode &status)

Private Attributes
unsigned char	option
StringList	options

Static Private Attributes
static const char	optionstring [NUMTARGETSCRIPTS][16]
static const char	optName []
static const char	optTip []

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

icu::Transliterator* UTF8Transliterator::createTrans ( const icu::UnicodeString &  ID, UTransDirection  dir, UErrorCode &  status  )

private

virtual const char* SWFilter::getHeader ( ) const

inlinevirtualinherited

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 OSISLaTeX, OSISXHTML, ThMLLaTeX, ThMLXHTML, TEIXHTML, GBFLaTeX, and GBFXHTML.

Definition at line 62 of file swfilter.h.

{ return ""; }

virtual const char* UTF8Transliterator::getOptionName ( )

inlinevirtual

gets the name of the option of this filter

Returns

option name

Reimplemented from SWOptionFilter.

Definition at line 92 of file utf8transliterator.h.

{ return optName; }

virtual const char* UTF8Transliterator::getOptionTip ( )

inlinevirtual

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 93 of file utf8transliterator.h.

{ return optTip; }

virtual const char* UTF8Transliterator::getOptionValue ( )

virtual

Returns

The value of the current option.

Reimplemented from SWOptionFilter.

virtual StringList UTF8Transliterator::getOptionValues ( )

inlinevirtual

returns a list of the possible option values

Returns

list of option values

Reimplemented from SWOptionFilter.

Definition at line 96 of file utf8transliterator.h.

{ return options; }

bool SWOptionFilter::isBoolean ( )

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.

{ return isBooleanVal; }

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.

virtual void UTF8Transliterator::setOptionValue ( const char *  ival )

virtual

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()

Parameters

ival	the new option value

Reimplemented from SWOptionFilter.

Member Data Documentation

bool SWOptionFilter::isBooleanVal

protectedinherited

Definition at line 55 of file swoptfilter.h.

unsigned char UTF8Transliterator::option

private

Definition at line 66 of file utf8transliterator.h.

StringList UTF8Transliterator::options

private

Definition at line 72 of file utf8transliterator.h.

const char UTF8Transliterator::optionstring[NUMTARGETSCRIPTS][16]

staticprivate

Definition at line 68 of file utf8transliterator.h.

SWBuf SWOptionFilter::optionValue

protectedinherited

Definition at line 50 of file swoptfilter.h.

const char UTF8Transliterator::optName[]

staticprivate

Definition at line 70 of file utf8transliterator.h.

const char UTF8Transliterator::optTip[]

staticprivate

Definition at line 71 of file utf8transliterator.h.

const StringList* SWOptionFilter::optValues

protectedinherited

Definition at line 53 of file swoptfilter.h.

---

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

• include/utf8transliterator.h