TPtiUserDictionaryEntry Class Reference

API published in: S60 3rd Ed

Link against: ptiengine.lib

Capability Information

Required Capabilities

None

#include <ptiuserdicentry.h>

Inherits MPtiUserDictionaryEntry.

Detailed Description

This is implementation of MPtiUserDictionaryEntry interface for latin languages (or any other language, which needs only one component (=word) for user dictionary entry).

Implementation of Reading() method is same as implementation of Word() method.


Public Member Functions
  TPtiUserDictionaryEntry ()
  TPtiUserDictionaryEntry (const TDesC &aWord)
TPtrC  Word () const
  Returns a pointer to the word held by this user dictionary entry.
TPtrC  Reading () const
  Returns a pointer to latin alphabet "reading" version for this user dictionary entry.
void  SetWord (TDesC &aWord, TDesC &aReading)
  Sets word for this user dictionary entry.
void  SetWord (TDesC &aWord)
  Sets word for this user dictionary entry.

Constructor & Destructor Documentation

TPtiUserDictionaryEntry::TPtiUserDictionaryEntry (   )  [inline]
 
TPtiUserDictionaryEntry::TPtiUserDictionaryEntry (  const TDesC &  aWord  )  [inline]
 

Member Function Documentation

TPtrC TPtiUserDictionaryEntry::Reading (   )  const [inline, virtual]
 

Returns a pointer to latin alphabet "reading" version for this user dictionary entry.

Needed for Japanese input.

Returns:
A pointer to reading word

Implements MPtiUserDictionaryEntry.

void TPtiUserDictionaryEntry::SetWord (  TDesC &  aWord  )  [inline, virtual]
 

Sets word for this user dictionary entry.

This version sets reading text to same value as "word":

Parameters:
aWord  A descriptor containing word to be set.

Implements MPtiUserDictionaryEntry.

void TPtiUserDictionaryEntry::SetWord (  TDesC &  aWord,
TDesC &  aReading
)  [inline, virtual]
 

Sets word for this user dictionary entry.

This version also sets reading text.

Parameters:
aWord  A descriptor containing word to be set.
aReading  A descriptor containing reading text for aWord.

Implements MPtiUserDictionaryEntry.

TPtrC TPtiUserDictionaryEntry::Word (   )  const [inline, virtual]
 

Returns a pointer to the word held by this user dictionary entry.

Returns:
A pointer to user dictionary word.

Implements MPtiUserDictionaryEntry.

The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top