ULAPI  8.0
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
ULLanguage Class Reference

An enhanced enumerated type used to represent languages. More...

#include <ullanguage.h>

Public Member Functions

 ULLanguage ()
 
 ULLanguage (const ULLanguage &other)
 
 ULLanguage (int id)
 
 ULLanguage (const char *otherStringID)
 
virtual ~ULLanguage ()
 
virtual void clear ()
 
ULLanguageoperator= (const ULLanguage &other)
 
ULLanguageoperator= (int otherID)
 
ULLanguageoperator= (const char *otherStringID)
 
bool operator== (const ULLanguage &other) const
 
bool operator== (const char *otherStringID) const
 
bool operator!= (const ULLanguage &other) const
 
bool operator!= (const char *otherStringID) const
 
bool operator< (const ULLanguage &other) const
 
bool operator< (const char *otherStringID) const
 
const char * getTwoLetterISOCode () const
 
const char * getThreeLetterISOCode () const
 
- Public Member Functions inherited from ULEnum
 ULEnum ()
 
 ULEnum (const ULEnum &other)
 
virtual ~ULEnum ()
 
virtual ULEnumoperator= (const ULEnum &other)
 
 operator int () const
 
uluint32 hash (uluint32 tableSize) const
 
int getID () const
 
const char * getStringID () const
 
virtual const char * getDisplayString () const
 

Static Public Member Functions

static int getEnumeratedValueCount ()
 
static const ULLanguagegetInstance (int id)
 
- Static Public Member Functions inherited from ULEnum
static bool isEnumeratedFeature (const ULString &featureName)
 
static uluint32 getRunTimeFeatureID (const ULString &featureName)
 

Static Public Attributes

static const ULLanguageNoLanguage = ULLanguage("nolanguage", "nolanguage", "No language")
 
static const ULLanguageAny = ULLanguage("any", "any", "Any language")
 
static const ULLanguageEnglish = ULLanguage("en", "eng", "English")
 
static const ULLanguageFrench = ULLanguage("fr", "fra", "French")
 
static const ULLanguageSpanish = ULLanguage("es", "spa", "Spanish")
 
static const ULLanguageGerman = ULLanguage("de", "deu", "German")
 
static const ULLanguageItalian = ULLanguage("it", "ita", "Italian")
 
static const ULLanguagePortuguese = ULLanguage("pt", "por", "Portuguese")
 
static const ULLanguageNorwegian = ULLanguage("no", "nor", "Norwegian")
 
static const ULLanguageLatin = ULLanguage("la", "lat", "Latin")
 
static const ULLanguageEsperanto = ULLanguage("eo", "epo", "Esperanto")
 
static const ULLanguageRussian = ULLanguage("ru", "rus", "Russian")
 
static const ULLanguageDutch = ULLanguage("nl", "nld", "Dutch")
 
static const ULLanguagePolish = ULLanguage("pl", "pol", "Polish")
 
static const ULLanguageChinese = ULLanguage("zh", "zho", "Chinese")
 
static const ULLanguageMandarin = ULLanguage("cmn", "cmn", "Mandarin")
 
static const ULLanguageCantonese = ULLanguage("yue", "yue", "Cantonese")
 
static const ULLanguageKlingon = ULLanguage("tlh", "tlh", "Klingon")
 
static const ULLanguageTurkish = ULLanguage("tr", "tur", "Turkish")
 
static const ULLanguageHaitian = ULLanguage("ht", "hat", "Haitian")
 
static const ULLanguageSwedish = ULLanguage("sv", "swe", "Swedish")
 
static const ULLanguageDanish = ULLanguage("da", "dan", "Danish")
 
static const ULLanguageJapanese = ULLanguage("ja", "jpn", "Japanese")
 
static const ULLanguageHindi = ULLanguage("hi", "hin", "Hindi")
 
static const ULLanguageKorean = ULLanguage("ko", "kor", "Korean")
 
static const ULLanguageIcelandic = ULLanguage("is", "isl", "Icelandic")
 
static const ULLanguageSwissGerman = ULLanguage("gsw", "gsw", "Swiss German")
 
static const ULLanguageRomanian = ULLanguage("ro", "ron", "Romanian")
 
static const ULLanguageLithuanian = ULLanguage("lt", "lit", "Lithuanian")
 
static const ULLanguageBulgarian = ULLanguage("bg", "bul", "Bulgarian")
 
static const ULLanguageLatvian = ULLanguage("lv", "lav", "Latvian")
 
static const ULLanguageArabic = ULLanguage("ar", "ara", "Arabic")
 
static const ULLanguageHebrew = ULLanguage("he", "heb", "Hebrew")
 
static const ULLanguageSwahili = ULLanguage("sw", "swa", "Swahili")
 
static const ULLanguageUrdu = ULLanguage("ur", "urd", "Urdu")
 
static const ULLanguageSanskrit = ULLanguage("sa", "san", "Sanskrit")
 
static const ULLanguagePersian = ULLanguage("fa", "fas", "Persian")
 
static const ULLanguageThai = ULLanguage("th", "tha", "Thai")
 
static const ULLanguageVietnamese = ULLanguage("vi", "vie", "Vietnamese")
 
static const ULLanguageSynonyms = ULLanguage("syn", "syn", "Synonyms")
 

Additional Inherited Members

- Protected Attributes inherited from ULEnum
int id
 
const char * stringID
 
const char * displayString
 
- Static Protected Attributes inherited from ULEnum
static ULHashTable< ULString,
uluint32 > 
featureNameToRunTimeID
 

Detailed Description

An enhanced enumerated type used to represent languages.

See ULEnum for a discussion of enhanced enumerated types in ULAPI.

Constructor & Destructor Documentation

ULLanguage::ULLanguage ( )

Default constructor.

ULLanguage::ULLanguage ( const ULLanguage other)

Copy constructor.

ULLanguage::ULLanguage ( int  otherID)

Constructor by id.

ULLanguage::ULLanguage ( const char *  otherStringID)

Constructor.

Parameters
[in]otherStringIDThe string ID corresponding to the ULLanguage value this ULLanguage should be copied from.
ULLanguage::~ULLanguage ( )
virtual

Destructor.

Member Function Documentation

void ULLanguage::clear ( )
virtual

Sets this ULLanguage object to its default state.

Reimplemented from ULEnum.

int ULLanguage::getEnumeratedValueCount ( )
static
Returns
the number of distinct enumerated values of this type.
const ULLanguage & ULLanguage::getInstance ( int  id)
static
Returns
the statically allocated instance of this type corresponding to the specified integer id.
Parameters
[in]idthe desired integer id.
const char * ULLanguage::getThreeLetterISOCode ( ) const
Returns
a pointer to this language's three-letter ISO code.
const char * ULLanguage::getTwoLetterISOCode ( ) const
Returns
a pointer to this language's two-letter ISO code.
bool ULLanguage::operator!= ( const ULLanguage other) const

Inequality operator.

bool ULLanguage::operator!= ( const char *  stringID) const

Inequality operator.

Returns
true if the specified string is not equal to this ULLanguage's string ID.
Parameters
[in]stringIDThe string to compare to this object's string ID.
bool ULLanguage::operator< ( const ULLanguage other) const

Comparison operator.

Returns
true if this ULLanguage's integer ID is strictly less than other's.
Parameters
[in]otherThe other ULLanguage object.
bool ULLanguage::operator< ( const char *  stringID) const

Comparison operator.

Returns
true if this ULLanguage's integer ID is is strictly less the integer ID of the ULLanguage value corresponding to the specified string ID.
Parameters
[in]stringIDThe string ID.
ULLanguage & ULLanguage::operator= ( const ULLanguage other)

Assignment operator.

Returns
a reference to this ULLanguage object.
ULLanguage & ULLanguage::operator= ( int  otherID)

Assignment operator.

Parameters
[in]otherIDThe ID of the enumerated value of ULLanguage to assign to this ULLanguage.
ULLanguage & ULLanguage::operator= ( const char *  otherStringID)

Assignment operator.

Returns
a reference to this ULLanguage object.
Parameters
[in]stringIDIf stringID is the string ID of one of the ULLanguage enumerated values, then this object is copied from that ULLanguage. Otherwise, this object is assigned the default value.
bool ULLanguage::operator== ( const ULLanguage other) const

Equality operator.

bool ULLanguage::operator== ( const char *  stringID) const

Equality operator.

Returns
true if the specified string is equal to this ULLanguage's string ID.
Parameters
[in]stringIDThe string to compare to this object's string ID.

Member Data Documentation

const ULLanguage & ULLanguage::Any = ULLanguage("any", "any", "Any language")
static
const ULLanguage & ULLanguage::Arabic = ULLanguage("ar", "ara", "Arabic")
static
const ULLanguage & ULLanguage::Bulgarian = ULLanguage("bg", "bul", "Bulgarian")
static
const ULLanguage & ULLanguage::Cantonese = ULLanguage("yue", "yue", "Cantonese")
static
const ULLanguage & ULLanguage::Chinese = ULLanguage("zh", "zho", "Chinese")
static
const ULLanguage & ULLanguage::Danish = ULLanguage("da", "dan", "Danish")
static
const ULLanguage & ULLanguage::Dutch = ULLanguage("nl", "nld", "Dutch")
static
const ULLanguage & ULLanguage::English = ULLanguage("en", "eng", "English")
static
const ULLanguage & ULLanguage::Esperanto = ULLanguage("eo", "epo", "Esperanto")
static
const ULLanguage & ULLanguage::French = ULLanguage("fr", "fra", "French")
static
const ULLanguage & ULLanguage::German = ULLanguage("de", "deu", "German")
static
const ULLanguage & ULLanguage::Haitian = ULLanguage("ht", "hat", "Haitian")
static
const ULLanguage & ULLanguage::Hebrew = ULLanguage("he", "heb", "Hebrew")
static
const ULLanguage & ULLanguage::Hindi = ULLanguage("hi", "hin", "Hindi")
static
const ULLanguage & ULLanguage::Icelandic = ULLanguage("is", "isl", "Icelandic")
static
const ULLanguage & ULLanguage::Italian = ULLanguage("it", "ita", "Italian")
static
const ULLanguage & ULLanguage::Japanese = ULLanguage("ja", "jpn", "Japanese")
static
const ULLanguage & ULLanguage::Klingon = ULLanguage("tlh", "tlh", "Klingon")
static
const ULLanguage & ULLanguage::Korean = ULLanguage("ko", "kor", "Korean")
static
const ULLanguage & ULLanguage::Latin = ULLanguage("la", "lat", "Latin")
static
const ULLanguage & ULLanguage::Latvian = ULLanguage("lv", "lav", "Latvian")
static
const ULLanguage & ULLanguage::Lithuanian = ULLanguage("lt", "lit", "Lithuanian")
static
const ULLanguage & ULLanguage::Mandarin = ULLanguage("cmn", "cmn", "Mandarin")
static
const ULLanguage & ULLanguage::NoLanguage = ULLanguage("nolanguage", "nolanguage", "No language")
static
const ULLanguage & ULLanguage::Norwegian = ULLanguage("no", "nor", "Norwegian")
static
const ULLanguage & ULLanguage::Persian = ULLanguage("fa", "fas", "Persian")
static
const ULLanguage & ULLanguage::Polish = ULLanguage("pl", "pol", "Polish")
static
const ULLanguage & ULLanguage::Portuguese = ULLanguage("pt", "por", "Portuguese")
static
const ULLanguage & ULLanguage::Romanian = ULLanguage("ro", "ron", "Romanian")
static
const ULLanguage & ULLanguage::Russian = ULLanguage("ru", "rus", "Russian")
static
const ULLanguage & ULLanguage::Sanskrit = ULLanguage("sa", "san", "Sanskrit")
static
const ULLanguage & ULLanguage::Spanish = ULLanguage("es", "spa", "Spanish")
static
const ULLanguage & ULLanguage::Swahili = ULLanguage("sw", "swa", "Swahili")
static
const ULLanguage & ULLanguage::Swedish = ULLanguage("sv", "swe", "Swedish")
static
const ULLanguage & ULLanguage::SwissGerman = ULLanguage("gsw", "gsw", "Swiss German")
static
const ULLanguage & ULLanguage::Synonyms = ULLanguage("syn", "syn", "Synonyms")
static
const ULLanguage & ULLanguage::Thai = ULLanguage("th", "tha", "Thai")
static
const ULLanguage & ULLanguage::Turkish = ULLanguage("tr", "tur", "Turkish")
static
const ULLanguage & ULLanguage::Urdu = ULLanguage("ur", "urd", "Urdu")
static
const ULLanguage & ULLanguage::Vietnamese = ULLanguage("vi", "vie", "Vietnamese")
static

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