1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/epoc32/include/mw/coeinput.h Wed Mar 31 12:27:01 2010 +0100
1.3 @@ -0,0 +1,115 @@
1.4 +// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// 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.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +//
1.18 +
1.19 +#ifndef __COEINPUT_H__
1.20 +#define __COEINPUT_H__
1.21 +
1.22 +#include <e32std.h>
1.23 +
1.24 +// classes defined in FEPBASE, declared here
1.25 +class MCoeFepAwareTextEditor;
1.26 +class MCoeCaptionRetrieverForFep;
1.27 +
1.28 +class MObjectProvider;
1.29 +
1.30 +class TCoeInputCapabilities
1.31 +/** Describes which forms of text input are consumed by a control or view.
1.32 +
1.33 +@publishedAll
1.34 +@released */
1.35 + {
1.36 +public:
1.37 + /** Text input capability flags. These are used to define the text input
1.38 + capabilities of a control or view. */
1.39 + enum
1.40 + {
1.41 + /** No text input capabilities supported. */
1.42 + ENone =0,
1.43 + /** Supports positive western integers. */
1.44 + EWesternNumericIntegerPositive =0x00000001,
1.45 + /** Supports negative western integers. */
1.46 + EWesternNumericIntegerNegative =0x00000002,
1.47 + /** Supports real numbers. */
1.48 + EWesternNumericReal =0x00000004,
1.49 + /** Supports the western alphabets. */
1.50 + EWesternAlphabetic =0x00000008,
1.51 + /** Supports Hiragana. */
1.52 + EJapaneseHiragana =0x00000010,
1.53 + /** Supports half width Katakana. */
1.54 + EJapaneseKatakanaHalfWidth =0x00000020,
1.55 + /** Supports full width Katakana. */
1.56 + EJapaneseKatakanaFullWidth =0x00000040,
1.57 + /** Supports dialable characters */
1.58 + EDialableCharacters =0x00000080,
1.59 + /** Supports secret text. This is text in which characters appear
1.60 + as asterisks. */
1.61 + ESecretText =0x00000100,
1.62 + /** Supports auto sentence case.
1.63 + This is text in which first word in a sentence begins with an uppercase letter,
1.64 + with all other letters and words in lowercase. */
1.65 + EAutoSentenceCase =0x00000200,
1.66 + /** Supports non-predictive input. */
1.67 + ENonPredictive =0x00000400,
1.68 + /** Supports all types of text. */
1.69 + EAllText =0x01000000,
1.70 + /** Supports navigation keys. These include arrow keys, page-up,
1.71 + page-down, home, end, tab, etc. */
1.72 + ENavigation =0x02000000
1.73 + };
1.74 + class MCoeFepSpecificExtensions; // to be defined by concrete FEPs, declared here
1.75 +public:
1.76 + // all these functions are exported (rather than inline) so that binary compatibility becomes easier to maintain
1.77 + IMPORT_C TCoeInputCapabilities();
1.78 + IMPORT_C TCoeInputCapabilities(TUint aCapabilities);
1.79 + IMPORT_C TCoeInputCapabilities(TUint aCapabilities, MCoeFepAwareTextEditor* aFepAwareTextEditor, MCoeCaptionRetrieverForFep* aCaptionRetrieverForFep);
1.80 + IMPORT_C TCoeInputCapabilities(TUint aCapabilities, MCoeFepAwareTextEditor* aFepAwareTextEditor, MCoeCaptionRetrieverForFep* aCaptionRetrieverForFep, TUid aFepUid, MCoeFepSpecificExtensions* aFepSpecificExtensions);
1.81 + IMPORT_C TCoeInputCapabilities(const TCoeInputCapabilities& aAnother); // defined so that iSpareForFutureUse is not copied
1.82 + IMPORT_C TCoeInputCapabilities& operator=(const TCoeInputCapabilities& aAnother); // defined so that iSpareForFutureUse is not copied
1.83 + IMPORT_C TBool operator==(const TCoeInputCapabilities& aAnother) const; // defined so that iSpareForFutureUse is not tested
1.84 + IMPORT_C TBool operator!=(const TCoeInputCapabilities& aAnother) const; // defined so that iSpareForFutureUse is not tested
1.85 + IMPORT_C void MergeWith(const TCoeInputCapabilities& aAnother);
1.86 + IMPORT_C void SetCapabilities(TUint aCapabilities);
1.87 + IMPORT_C TUint Capabilities() const;
1.88 + IMPORT_C TBool IsNone() const;
1.89 + IMPORT_C TBool SupportsWesternNumericIntegerPositive() const;
1.90 + IMPORT_C TBool SupportsWesternNumericIntegerNegative() const;
1.91 + IMPORT_C TBool SupportsWesternNumericReal() const;
1.92 + IMPORT_C TBool SupportsWesternAlphabetic() const;
1.93 + IMPORT_C TBool SupportsJapaneseHiragana() const;
1.94 + IMPORT_C TBool SupportsJapaneseKatakanaHalfWidth() const;
1.95 + IMPORT_C TBool SupportsJapaneseKatakanaFullWidth() const;
1.96 + IMPORT_C TBool SupportsDialableCharacters() const;
1.97 + IMPORT_C TBool SupportsSecretText() const;
1.98 + IMPORT_C TBool SupportsAutoSentenceCase() const;
1.99 + IMPORT_C TBool SupportsNonPredictive() const;
1.100 + IMPORT_C TBool SupportsAllText() const;
1.101 + IMPORT_C TBool SupportsNavigation() const;
1.102 + IMPORT_C MCoeFepAwareTextEditor* FepAwareTextEditor() const;
1.103 + IMPORT_C MCoeCaptionRetrieverForFep* CaptionRetrieverForFep() const;
1.104 + IMPORT_C MCoeFepSpecificExtensions* FepSpecificExtensions(TUid aFepUid) const;
1.105 + IMPORT_C MObjectProvider* ObjectProvider() const;
1.106 + IMPORT_C void SetObjectProvider(MObjectProvider* aObjectProvider);
1.107 +
1.108 +private:
1.109 + TUint iCapabilities;
1.110 + MCoeFepAwareTextEditor* iFepAwareTextEditor;
1.111 + MCoeCaptionRetrieverForFep* iCaptionRetrieverForFep;
1.112 + TUint iFepUid;
1.113 + MCoeFepSpecificExtensions* iFepSpecificExtensions;
1.114 + MObjectProvider* iObjectProvider;
1.115 + TAny* iSpareForFutureUse[5];
1.116 + };
1.117 +
1.118 +#endif // __COEINPUT_H__