deLanguagePack Class Reference

Language Pack. More...

#include <deLanguagePack.h>

Inheritance diagram for deLanguagePack:
deFileResource deResource deObject

List of all members.

Public Member Functions

Constructors and Destructors
 deLanguagePack (deLanguagePackManager *manager, const char *filename)
 Creates a new translator section object.
virtual ~deLanguagePack ()
 Cleans up the translator section.
Management
const decUnicodeStringGetName () const
 Retrieves the name in the native language.
void SetName (const decUnicodeString &name)
 Sets the name in the native language.
const decUnicodeStringGetDescription () const
 Retrieves the description in the native language.
void SetDescription (const decUnicodeString &description)
 Sets the description in the native language.
const decUnicodeStringGetMissingText () const
 Retrieves the missing text in the native language.
void SetMissingText (const decUnicodeString &missingText)
 Sets the description in the native language.
Entries
int GetEntryCount () const
 Retrieves the number of entries.
deLanguagePackEntryGetEntryAt (int index) const
 Retrieves the entry at the given index.
deLanguagePackEntryGetEntryNamed (const char *name) const
 Retrieves the entry with the given name.
int FindEntry (deLanguagePackEntry *entry) const
 Retrieves the index of the entry or -1 if not part of this translator.
bool HasEntry (deLanguagePackEntry *entry) const
 Determines if the entry is part of this translator.
bool HasEntryNamed (const char *name) const
 Determines if the entry is part of this translator.
void AddEntry (deLanguagePackEntry *entry)
 Adds a new entry.
void RemoveEntry (deLanguagePackEntry *entry)
 Removes a entry.
void RemoveAllEntries ()
 Removes all entries.

Detailed Description

Language Pack.

Provides translations from external files. A language pack contains a large list of entries which assign translations to a name. This list is not very optimal which is why the translator exists to fetch the translations from language packs organizing them in a section/entry list.

Author:
Plüss Roland
Version:
1.0
Date:
2008

Constructor & Destructor Documentation

deLanguagePack::deLanguagePack ( deLanguagePackManager manager,
const char *  filename 
)

Creates a new translator section object.

virtual deLanguagePack::~deLanguagePack (  ) [virtual]

Cleans up the translator section.


Member Function Documentation

void deLanguagePack::AddEntry ( deLanguagePackEntry entry )

Adds a new entry.

int deLanguagePack::FindEntry ( deLanguagePackEntry entry ) const

Retrieves the index of the entry or -1 if not part of this translator.

const decUnicodeString& deLanguagePack::GetDescription (  ) const [inline]

Retrieves the description in the native language.

deLanguagePackEntry* deLanguagePack::GetEntryAt ( int  index ) const

Retrieves the entry at the given index.

int deLanguagePack::GetEntryCount (  ) const [inline]

Retrieves the number of entries.

deLanguagePackEntry* deLanguagePack::GetEntryNamed ( const char *  name ) const

Retrieves the entry with the given name.

const decUnicodeString& deLanguagePack::GetMissingText (  ) const [inline]

Retrieves the missing text in the native language.

const decUnicodeString& deLanguagePack::GetName (  ) const [inline]

Retrieves the name in the native language.

bool deLanguagePack::HasEntry ( deLanguagePackEntry entry ) const

Determines if the entry is part of this translator.

bool deLanguagePack::HasEntryNamed ( const char *  name ) const

Determines if the entry is part of this translator.

void deLanguagePack::RemoveAllEntries (  )

Removes all entries.

void deLanguagePack::RemoveEntry ( deLanguagePackEntry entry )

Removes a entry.

void deLanguagePack::SetDescription ( const decUnicodeString description )

Sets the description in the native language.

void deLanguagePack::SetMissingText ( const decUnicodeString missingText )

Sets the description in the native language.

void deLanguagePack::SetName ( const decUnicodeString name )

Sets the name in the native language.


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