1.1 --- a/epoc32/include/mw/akneditstateindicator.h Tue Nov 24 13:55:44 2009 +0000
1.2 +++ b/epoc32/include/mw/akneditstateindicator.h Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -1,1 +1,271 @@
1.4 -akneditstateindicator.h
1.5 +/*
1.6 +* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
1.7 +* All rights reserved.
1.8 +* This component and the accompanying materials are made available
1.9 +* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
1.10 +* which accompanies this distribution, and is available
1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.12 +*
1.13 +* Initial Contributors:
1.14 +* Nokia Corporation - initial contribution.
1.15 +*
1.16 +* Contributors:
1.17 +*
1.18 +* Description:
1.19 +* Avkon Editing State Indicator Interface
1.20 +*
1.21 +*
1.22 +*/
1.23 +
1.24 +
1.25 +#ifndef AKNEDITSTATEINDICATOR_H
1.26 +#define AKNEDITSTATEINDICATOR_H
1.27 +
1.28 +#include <coemop.h>
1.29 +
1.30 +class CAknIndicatorContainer;
1.31 +
1.32 +enum TAknEditingState
1.33 + {
1.34 + /** No input mode */
1.35 + EStateNone,
1.36 + /** Predictive upper case input mode */
1.37 + ET9Upper,
1.38 + /** Predictive lower case input mode */
1.39 + ET9Lower,
1.40 + /** Predictive shifted input mode */
1.41 + ET9Shifted,
1.42 + /** Numeric input mode */
1.43 + ENumeric,
1.44 + /** Multitap upper case input mode */
1.45 + EMultitapUpper,
1.46 + /** Multitap lower case input mode */
1.47 + EMultitapLower,
1.48 + /** Multitap shifted input mode */
1.49 + EMultitapShifted,
1.50 + /** Predictive Arabic input mode */
1.51 + ET9Arabic,
1.52 + /** Predictive Hebrew input mode */
1.53 + ET9Hebrew,
1.54 + /** Multitap Arabic input mode */
1.55 + EMultitapArabic,
1.56 + /** Multitap Hebrew input mode */
1.57 + EMultitapHebrew,
1.58 + /** Arabic-Indic numeric input mode */
1.59 + EArabicIndicNumeric,
1.60 + /** Multitap Thai input mode */
1.61 + EMultitapThai,
1.62 + /** Predictive Thai input mode */
1.63 + ET9Thai,
1.64 + /** QWERTY shifted input mode */
1.65 + EQwertyShift,
1.66 + /** Predictive Farsi and Urdu input mode */
1.67 + ET9FarsiAndUrdu,
1.68 + /** Multitap Farsi and Urdu input mode */
1.69 + EMultitapFarsiAndUrdu,
1.70 +
1.71 + //
1.72 + // Chinese states
1.73 + //
1.74 + /** Pinyin input mode */
1.75 + EIndicatorStatePinyin =20,
1.76 + /** Zhuyin inout mode */
1.77 + EIndicatorStateZhuyin,
1.78 + /** Stroke input mode */
1.79 + EIndicatorStateStroke,
1.80 + /** Zhuyin find input mode */
1.81 + EIndicatorStateZhuyinFind,
1.82 + /** Stroke find input mode */
1.83 + EIndicatorStateStrokeFind,
1.84 + /** Stroke trad input mode */
1.85 + EIndicatorStateStrokeTrad,
1.86 + /** Cang Jie input mode */
1.87 + EIndicatorStateCangJie,
1.88 + /** Pinyin phrase pinput mode */
1.89 + EIndicatorStatePinyinPhrase,
1.90 + /** Zhuyin phrase inout mode */
1.91 + EIndicatorStateZhuyinPhrase,
1.92 + /** Stroke phrase input mode */
1.93 + EIndicatorStateStrokePhrase,
1.94 + /** Stroke phrase trad input mode */
1.95 + EIndicatorStateStrokeTradPhrase,
1.96 +
1.97 + //
1.98 + // Japanese states
1.99 + //
1.100 + /** Kanji and Hiragana input mode */
1.101 + EIndicatorStateHiraganaKanji = 40,
1.102 + /** Hiragana input mode */
1.103 + EIndicatorStateHiragana,
1.104 + /** Half-width Katakana input mode */
1.105 + EIndicatorStateHalfKatakana,
1.106 + /** Full-width Katakana input mode */
1.107 + EIndicatorStateFullKatakana,
1.108 + /** Full-width LatinUpper input mode */
1.109 + EIndicatorStateFullLatinUpper,
1.110 + /** Full-width LatinLower input mode */
1.111 + EIndicatorStateFullLatinLower,
1.112 + /** Full-width LatinText input mode */
1.113 + EIndicatorStateFullLatinText,
1.114 + /** Numeric input mode */
1.115 + EIndicatorStateFullNumeric,
1.116 + /** japanese predictive mode */
1.117 + EIndicatorStateJapanesePredictive,
1.118 +
1.119 + //
1.120 + // Vietnamese
1.121 + //
1.122 + /** Predictive Vietnamese upper case input mode */
1.123 + ET9UpperVietnamese = 60,
1.124 + /** Predictive Vietnamese lower case input mode */
1.125 + ET9LowerVietnamese,
1.126 + /** Predictive Vietnamese shifted input mode */
1.127 + ET9ShiftedVietnamese,
1.128 + /** Multitap Vietnamese upper case input mode */
1.129 + EMultitapUpperVietnamese,
1.130 + /** Multitap Vietnamese lower case input mode */
1.131 + EMultitapLowerVietnamese,
1.132 + /** Multitap Vietnamese shifted input mode */
1.133 + EMultitapShiftedVietnamese,
1.134 +
1.135 + //
1.136 + // Hindi
1.137 + //
1.138 + /** Multitap Hindi input mode */
1.139 + EIndicatorStateMultitapHindi= 80,
1.140 + /** Predictive Hindi input mode */
1.141 + EIndicatorStatePredictiveHindi,
1.142 + EDevanagariIndicNumeric,
1.143 +
1.144 + /** Devangari Indic numeric input mode */
1.145 + EIndicatorStateHindiPhoneticUpper,
1.146 + EIndicatorStateHindiPhoneticLower,
1.147 + /** Multitap Marathi input mode */
1.148 + EIndicatorStateMultitapMarathi,
1.149 + /** Predictive Marathi input mode */
1.150 + EIndicatorStatePredictiveMarathi,
1.151 +
1.152 + // Korean
1.153 + // Multitap hangul input mode
1.154 + EIndicatorStateHangul,
1.155 +
1.156 + // Auto Word Completion
1.157 + //
1.158 + /** Auto Word Completion upper case input mode */
1.159 + EAutoCompleteUpper = 100,
1.160 + /** Auto Word Completion lower case input mode */
1.161 + EAutoCompleteLower,
1.162 + /** Auto Word Completion shifted input mode */
1.163 + EAutoCompleteShifted,
1.164 + /** Auto Word Completion Hindi input mode */
1.165 + EAutoCompleteHindi,
1.166 + /** Auto Word Completion Arabic input mode */
1.167 + EAutoCompleteArabic,
1.168 + /** Auto Word Completion Hebrew input mode */
1.169 + EAutoCompleteHebrew,
1.170 + /** Auto Word Completion Farsi - Urdu input mode */
1.171 + EAutoCompleteFarsiAndUrdu,
1.172 + /** Auto Word Completion Thai input mode */
1.173 + EAutoCompleteThai,
1.174 + /** Auto Word Completion Vietnamese upper case input mode */
1.175 + EAutoCompleteUpperVietnamese,
1.176 + /** Auto Word Completion Vietnamese lower case input mode */
1.177 + EAutoCompleteLowerVietnamese,
1.178 + /** Auto Word Completion Vietnamese shifted input mode */
1.179 + EAutoCompleteShiftedVietnamese,
1.180 + // AutoComplete - End
1.181 +
1.182 + // Fn Mode input
1.183 + /** Functionized input mode is activated for the subsequent key press **/
1.184 + EFnKeyPressed,
1.185 + /** Functionized input is enabled untill turned off **/
1.186 + EFnKeyLocked,
1.187 +
1.188 + //
1.189 + // Greek
1.190 + //
1.191 + /** Predictive Greek upper case input mode */
1.192 + ET9UpperGreek = 200,
1.193 + /** Predictive Greek lower case input mode */
1.194 + ET9LowerGreek,
1.195 + /** Predictive Greek shifted input mode */
1.196 + ET9ShiftedGreek,
1.197 + /** Multitap Greek upper case input mode */
1.198 + EMultitapUpperGreek,
1.199 + /** Multitap Greek lower case input mode */
1.200 + EMultitapLowerGreek,
1.201 + /** Multitap Greek shifted input mode */
1.202 + EMultitapShiftedGreek,
1.203 +
1.204 + //
1.205 + // Cyrillic
1.206 + //
1.207 + /** Predictive Cyrillic upper case input mode */
1.208 + ET9UpperCyrillic = 220,
1.209 + /** Predictive Cyrillic lower case input mode */
1.210 + ET9LowerCyrillic,
1.211 + /** Predictive Cyrillic shifted input mode */
1.212 + ET9ShiftedCyrillic,
1.213 + /** Multitap Cyrillic upper case input mode */
1.214 + EMultitapUpperCyrillic,
1.215 + /** Multitap Cyrillic lower case input mode */
1.216 + EMultitapLowerCyrillic,
1.217 + /** Multitap Cyrillic shifted input mode */
1.218 + EMultitapShiftedCyrillic
1.219 + };
1.220 +
1.221 +/**
1.222 + * An abstact class of which virtual methods implementation should be provided for FEP component.
1.223 + */
1.224 +class MAknEditingStateIndicator
1.225 + {
1.226 +public:
1.227 +
1.228 + DECLARE_TYPE_ID(0x101F4108)
1.229 +
1.230 + /**
1.231 + * Sets editing state indicator state.
1.232 + *
1.233 + * @param aState State of the editing indicator.
1.234 + */
1.235 + virtual void SetState(TAknEditingState aState) = 0;
1.236 +
1.237 + /**
1.238 + * Gets pointer to indicator container that contains
1.239 + * the editing state indicators.
1.240 + *
1.241 + * @return Indicator container of the editing indicators.
1.242 + */
1.243 + virtual CAknIndicatorContainer* IndicatorContainer() = 0;
1.244 + };
1.245 +
1.246 +/**
1.247 + * This function should be called from MopSupplyObject() of those
1.248 + * components that supply MAknEditingStateIndicator interface for FEP.
1.249 + *
1.250 + * Retrieves an object of the same type as that encapsulated in aId.
1.251 + *
1.252 + * This function is used to allow controls to ask their owners for
1.253 + * access to other objects that they own.
1.254 + *
1.255 + * Other than in the case where NULL is returned, the object returned
1.256 + * must be of the same object type - that is, the @c ETypeId member of
1.257 + * the object pointed to by the pointer returned by this function must
1.258 + * be equal to the @c iUid member of @c aId.
1.259 + *
1.260 + * @param aId An encapsulated object type ID.
1.261 + * @return Encapsulated pointer to the provided object.
1.262 + * Note that the encapsulated pointer may be NULL.
1.263 + */
1.264 +inline TTypeUid::Ptr SupplyMopObject( TTypeUid aId,
1.265 + MAknEditingStateIndicator* aIndicator )
1.266 + {
1.267 + if ( aIndicator && aId.iUid == MAknEditingStateIndicator::ETypeId )
1.268 + {
1.269 + return aId.MakePtr( aIndicator );
1.270 + }
1.271 +
1.272 + return TTypeUid::Null();
1.273 + }
1.274 +
1.275 +#endif