Class CSDLexicon

class CSDLexicon : public CBase;

Description

Class to encapsulate a Speaker Dependent Lexicon.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CSDLexicon - Class to encapsulate a Speaker Dependent Lexicon

Members

Defined in CSDLexicon:
Add(), At(), Count(), FindPronunciation(), LexiconID(), NewL(), NewLC(), ~CSDLexicon()

Inherited from CBase:
Delete(), Extension_(), operator new()

IMPORT_C ~CSDLexicon();

Description

Destructor.

static IMPORT_C CSDLexicon *NewL(TLexiconID aLexiconID);

Description

Instantiates an instance of CSDLexicon.

Parameters

TLexiconID aLexiconID The lexicon identifier.

Return value

CSDLexicon * A pointer to a CSDLexicon object.

static IMPORT_C CSDLexicon *NewLC(TLexiconID aLexiconID);

Description

Instantiates an instance of CSDGrammar and leaves a pointer on the cleanup stack.

Parameters

TLexiconID aLexiconID The lexicon identifier.

Return value

CSDLexicon * A pointer to a CSDLexicon object.

IMPORT_C TLexiconID LexiconID() const;

Description

Returns the ID of the lexicon.

Return value

TLexiconID The lexicon identifier.

IMPORT_C TInt Add(CSDPronunciation &aPronunciation);

Description

Adds a lexicon entry to the lexicon.

Parameters

CSDPronunciation &aPronunciation A reference to a CSDPronunciation object.

Return value

TInt An error code indicating if the function call was successful. KErrNone on success, otherwise another of the system-wide error codes.

IMPORT_C const CSDPronunciation &At(TInt aIndex) const;

Description

Returns a pronunciation based at an index.

Parameters

TInt aIndex The pronunciation index. This value must not be negative and must not be greater than the number of pronunciations currently in the lexicon, otherwise the function will panic.

Return value

const CSDPronunciation & A reference to a CSDPronunciation object.

IMPORT_C TInt FindPronunciation(TPronunciationID aPronunciationID) const;

Description

Finds a pronunciation based on the specified pronunciation ID.

Parameters

TPronunciationID aPronunciationID The pronunciation identifier.

Return value

TInt The index of the first matching pronunciation within the lexicon. Returns KErrNotFound, if a matching pronunciation can not be found.

IMPORT_C TInt Count() const;

Description

Returns the number of lexicon entries in the lexicon.

Return value

TInt The number of pronunciations.