S60 3rd Edition API Reference: ptiuserdicentry.h Source File

00001 /*
00002 * ============================================================================
00003 *  Name       : PtiUserDicEntry.h
00004 *  Part of    : PtiEngine
00005 *  Description: User dictionary interface
00006 *  Version:
00007 *
00008 *  Copyright � 2003 Nokia Corporation.
00009 *  This material, including documentation and any related 
00010 *  computer programs, is protected by copyright controlled by 
00011 *  Nokia Corporation. All rights are reserved. Copying, 
00012 *  including reproducing, storing,  adapting or translating, any 
00013 *  or all of this material requires the prior written consent of 
00014 *  Nokia Corporation. This material also contains confidential 
00015 *  information which may not be disclosed to others without the 
00016 *  prior written consent of Nokia Corporation.
00017 * ============================================================================
00018 */
00019 
00020 #ifndef _PTI_USERDICENTRY_H
00021 #define _PTI_USERDICENTRY_H
00022 
00023 // INCLUDES
00024 #include <e32base.h>
00025 
00026 // CONSTANTS
00027 const TInt KMaxUserDictionaryEntrySize = 100;
00028 
00029 class MPtiUserDictionaryEntry
00030     {
00031     public:
00032         virtual TPtrC Word() const = 0;
00033         virtual TPtrC Reading() const = 0;
00034         virtual void SetWord(TDesC& aWord, TDesC& aReading) = 0;
00035                 virtual void SetWord(TDesC& aWord) = 0;
00036     };
00037 
00038 
00039 // This is for latin languages (or any other language, which needs
00040 // only one component (=word) for user dictionary entry).
00041 // Implementation of Reading() method is same as implementation of
00042 // Word() method.
00043 class TPtiUserDictionaryEntry : public MPtiUserDictionaryEntry
00044         {
00045         public:         
00046                 inline TPtiUserDictionaryEntry();
00047                 inline TPtiUserDictionaryEntry(const TDesC& aWord);
00048 
00049             inline TPtrC Word() const;
00050         inline TPtrC Reading() const;
00051         inline void SetWord(TDesC& aWord, TDesC& aReading);
00052                 inline void SetWord(TDesC& aWord);
00053 
00054         private:
00055                 TBuf<KMaxUserDictionaryEntrySize> iEntry;
00056         };
00057 
00058 #include "PtiUserDicEntry.inl"
00059 
00060 #endif
00061 
00062 // End of file
00063