akneditstateindicator.h

00001 /*
00002 * ============================================================================
00003 *  Name     : AknEditStateIndicator.h
00004 *  Part of  : Avkon
00005 *
00006 *  Description:
00007 *       Avkon Editing State Indicator Interface
00008 *
00009 *  Version:
00010 *
00011 *  Copyright ?2002 Nokia Corporation.
00012 *  This material, including documentation and any related 
00013 *  computer programs, is protected by copyright controlled by 
00014 *  Nokia Corporation. All rights are reserved. Copying, 
00015 *  including reproducing, storing,  adapting or translating, any 
00016 *  or all of this material requires the prior written consent of 
00017 *  Nokia Corporation. This material also contains confidential 
00018 *  information which may not be disclosed to others without the 
00019 *  prior written consent of Nokia Corporation.
00020 */
00021 
00022 #ifndef AKNEDITSTATEINDICATOR_H
00023 #define AKNEDITSTATEINDICATOR_H
00024 
00025 #include <coemop.h>
00026 
00027 class CAknIndicatorContainer;
00028 
00029 enum TAknEditingState
00030         {
00032         EStateNone,
00034         ET9Upper,
00036         ET9Lower,
00038         ET9Shifted,
00040         ENumeric,
00042         EMultitapUpper,
00044         EMultitapLower,
00046         EMultitapShifted,
00048     ET9Arabic,
00050     ET9Hebrew,
00052     EMultitapArabic, 
00054     EMultitapHebrew,
00056     EArabicIndicNumeric,
00058     EMultitapThai,
00060     ET9Thai,
00062     EQwertyShift,
00064     ET9FarsiAndUrdu,
00066     EMultitapFarsiAndUrdu,
00067         
00068         //
00069         // Chinese states
00070         //
00072         EIndicatorStatePinyin =20,
00074         EIndicatorStateZhuyin,  
00076         EIndicatorStateStroke,
00078         EIndicatorStateZhuyinFind,
00080     EIndicatorStateStrokeFind,
00082     EIndicatorStateStrokeTrad,
00084     EIndicatorStateCangJie,
00086         EIndicatorStatePinyinPhrase,
00088         EIndicatorStateZhuyinPhrase,    
00090         EIndicatorStateStrokePhrase,
00092     EIndicatorStateStrokeTradPhrase,
00093     
00094     //
00095     // Japanese states
00096         //
00098     EIndicatorStateHiraganaKanji = 40,  
00100     EIndicatorStateHiragana,        
00102     EIndicatorStateHalfKatakana,    
00104     EIndicatorStateFullKatakana,    
00106     EIndicatorStateFullLatinUpper,  
00108     EIndicatorStateFullLatinLower,  
00110     EIndicatorStateFullLatinText,   
00112     EIndicatorStateFullNumeric,     
00114     EIndicatorStateJapanesePredictive,  
00115     
00116     //
00117     // Vietnamese
00118     //
00120     ET9UpperVietnamese = 60,
00122     ET9LowerVietnamese,
00124     ET9ShiftedVietnamese,        
00126     EMultitapUpperVietnamese,
00128     EMultitapLowerVietnamese,
00130     EMultitapShiftedVietnamese,
00131     
00132     //
00133     // Hindi
00134     //
00136     EIndicatorStateMultitapHindi= 80,
00138     EIndicatorStatePredictiveHindi,
00139     EDevanagariIndicNumeric,
00140     
00142     EIndicatorStateHindiPhoneticUpper,
00143     EIndicatorStateHindiPhoneticLower,
00145     EIndicatorStateMultitapMarathi,
00147     EIndicatorStatePredictiveMarathi,
00148     
00149     
00150     // Auto Word Completion
00151     //
00153     EAutoCompleteUpper = 100,
00155     EAutoCompleteLower,
00157     EAutoCompleteShifted,
00159     EAutoCompleteHindi,
00161     EAutoCompleteArabic,
00163     EAutoCompleteHebrew,
00165     EAutoCompleteFarsiAndUrdu,
00167     EAutoCompleteThai,
00169     EAutoCompleteUpperVietnamese,
00171     EAutoCompleteLowerVietnamese,
00173     EAutoCompleteShiftedVietnamese
00174     // AutoComplete - End 
00175         };
00176 
00180 class MAknEditingStateIndicator
00181         {
00182 public:
00183 
00184         DECLARE_TYPE_ID(0x101F4108)
00185 
00186     
00191         virtual void SetState(TAknEditingState aState) = 0; 
00192         
00199         virtual CAknIndicatorContainer* IndicatorContainer() = 0;
00200         };
00201 
00220 inline TTypeUid::Ptr SupplyMopObject( TTypeUid aId,
00221                                   MAknEditingStateIndicator* aIndicator )
00222         {
00223     if ( aIndicator && aId.iUid == MAknEditingStateIndicator::ETypeId )
00224         {
00225         return aId.MakePtr( aIndicator );
00226         }
00227 
00228     return TTypeUid::Null();
00229         }
00230 
00231 #endif