Class TCoeInputCapabilities

class TCoeInputCapabilities;

Description

Describes which forms of text input are consumed by a control or view.

Members

Defined in TCoeInputCapabilities:

• Capabilities()constGets the input capability flags of this object.
• CaptionRetrieverForFep()constGets the caption retriever pointed to by this object.
• EAllTextSupports all types of text.
• EAutoSentenceCaseSupports auto sentence case. This is text in which first word in a sentence begi...
• EDialableCharactersSupports dialable characters
• EJapaneseHiraganaSupports Hiragana.
• EJapaneseKatakanaFullWidthSupports full width Katakana.
• EJapaneseKatakanaHalfWidthSupports half width Katakana.
• ENavigationSupports navigation keys. These include arrow keys, page-up, page-down, home, en...
• ENonPredictiveSupports non-predictive input.
• ENoneNo text input capabilities supported.
• ESecretTextSupports secret text. This is text in which characters appear as asterisks.
• EWesternAlphabeticSupports the western alphabets.
• EWesternNumericIntegerNegativeSupports negative western integers.
• EWesternNumericIntegerPositiveSupports positive western integers.
• EWesternNumericRealSupports real numbers.
• FepAwareTextEditor()constGets the FEP aware text editor object pointed to by this object.
• FepSpecificExtensions(TUid)constGets the specialised input capabilities of the application.
• IsNone()constTests whether the control supports any type of text input.
• MergeWith(const TCoeInputCapabilities &)Merges the capabilities of a specified TCoeInputCapabilities with this object.
• ObjectProvider()constGets the object provider of the control which supplied this TCoeInputCapabilitie...
• SetCapabilities(TUint)Sets the input capability flags of this object.
• SetObjectProvider(MObjectProvider *)Sets the object provider of the control which supplied this TCoeInputCapabilitie...
• SupportsAllText()constTests whether the control supports all types of text input.
• SupportsAutoSentenceCase()constTests whether the control supports auto sentence case.
• SupportsDialableCharacters()constTests whether the control supports dialable characters as text input.
• SupportsJapaneseHiragana()constTests whether the control supports text input in Japanese Hiragana.
• SupportsJapaneseKatakanaFullWidth()constTests whether the control supports text input in full width Japanese Katakana.
• SupportsJapaneseKatakanaHalfWidth()constTests whether the control supports text input in half width Japanese Katakana.
• SupportsNavigation()constTests whether the control supports navigation keys.
• SupportsNonPredictive()constTests whether the control supports non-predictive input.
• SupportsSecretText()constTests whether the control supports secret text.
• SupportsWesternAlphabetic()constTests whether the control supports entry of text in the western alphabets.
• SupportsWesternNumericIntegerNegative()constTests whether the control supports entry of negative integers.
• SupportsWesternNumericIntegerPositive()constTests whether the control supports entry of positive integers.
• SupportsWesternNumericReal()constTests whether the control supports entry of real numbers.
• TCoeInputCapabilities()
• TCoeInputCapabilities(TUint)Constructor which initialises the capabilities.
• TCoeInputCapabilities(TUint,MCoeFepAwareTextEditor *,MCoeCaptionRetrieverForFep *)Constructor which sets the capabilities, a FEP aware text editor and a FEP capti...
• TCoeInputCapabilities(TUint,MCoeFepAwareTextEditor *,MCoeCaptionRetrieverForFep *,TUid,MCoeFepSpecificExtensions *)Constructor which sets the capabilities, a FEP aware text editor, a FEP caption ...
• TCoeInputCapabilities(const TCoeInputCapabilities &)Copy constructor. Constructs this object using the capabilities of another insta...
• anonymousText input capability flags. These are used to define the text input capabilitie...
• operator!=(const TCoeInputCapabilities &)constInequality operator.
• operator=(const TCoeInputCapabilities &)Assignment operator.
• operator==(const TCoeInputCapabilities &)constEquality operator.

IMPORT_C TCoeInputCapabilities();

Description

IMPORT_C TCoeInputCapabilities(TUint aCapabilities);

Description

Constructor which initialises the capabilities.

The new object has NULL pointers to the FEP aware text editor and the FEP caption retriever objects.

Parameters

IMPORT_C TCoeInputCapabilities(TUint aCapabilities, MCoeFepAwareTextEditor *aFepAwareTextEditor, MCoeCaptionRetrieverForFep *aCaptionRetrieverForFep);

Description

Constructor which sets the capabilities, a FEP aware text editor and a FEP caption retriever object.

Parameters

IMPORT_C TCoeInputCapabilities(TUint aCapabilities, MCoeFepAwareTextEditor *aFepAwareTextEditor, MCoeCaptionRetrieverForFep *aCaptionRetrieverForFep, TUid aFepUid, MCoeFepSpecificExtensions *aFepSpecificExtensions);

Description

Constructor which sets the capabilities, a FEP aware text editor, a FEP caption retriever object, a FEP UID and a FEP specific extensions object.

This overload is provided to allow an application to report its specialised input capabilities, if any, to a FEP. The application should override CCoeControl::InputCapabilities()const and/or CCoeAppUi::InputCapabilities()const, to return a TCoeInputCapabilities object created using this overload, passing the FEP's UID (as published in its header file) and the address of a MCoeFepSpecificExtensions object.

Parameters

See also:

• TCoeInputCapabilities::FepSpecificExtensions(TUid)constGets the specialised input capabilities of the application.

IMPORT_C TCoeInputCapabilities(const TCoeInputCapabilities &aAnother);

Description

Copy constructor. Constructs this object using the capabilities of another instance.

Parameters

IMPORT_C TCoeInputCapabilities& operator=(const TCoeInputCapabilities &aAnother);

Description

Assignment operator.

This copies the capabilities of aAnother into this object.

Parameters

Return value

IMPORT_C TBool operator==(const TCoeInputCapabilities &aAnother) const;

Description

Equality operator.

Compares this and aAnother for equality.

Parameters

Return value

IMPORT_C TBool operator!=(const TCoeInputCapabilities &aAnother) const;

Description

Inequality operator.

Compares this and aAnother for inequality.

Parameters

Return value

IMPORT_C void MergeWith(const TCoeInputCapabilities &aAnother);

Description

Merges the capabilities of a specified TCoeInputCapabilities with this object.

The capabilities are merged using a logical OR. The pointers to the FEP aware text editor, caption retriever and object provider are merged only if this object has NULL pointers.

Parameters

IMPORT_C void SetCapabilities(TUint aCapabilities);

Description

Sets the input capability flags of this object.

Parameters

See also:

• TCoeInputCapabilities::Capabilities()constGets the input capability flags of this object.

IMPORT_C TUint Capabilities() const;

Description

Gets the input capability flags of this object.

Return value

See also:

• TCoeInputCapabilities::SetCapabilities(TUint)Sets the input capability flags of this object.

IMPORT_C TBool IsNone() const;

Description

Tests whether the control supports any type of text input.

Return value

IMPORT_C TBool SupportsWesternNumericIntegerPositive() const;

Description

Tests whether the control supports entry of positive integers.

Return value

IMPORT_C TBool SupportsWesternNumericIntegerNegative() const;

Description

Tests whether the control supports entry of negative integers.

Return value

IMPORT_C TBool SupportsWesternNumericReal() const;

Description

Tests whether the control supports entry of real numbers.

Return value

IMPORT_C TBool SupportsWesternAlphabetic() const;

Description

Tests whether the control supports entry of text in the western alphabets.

Return value

IMPORT_C TBool SupportsJapaneseHiragana() const;

Description

Tests whether the control supports text input in Japanese Hiragana.

Return value

IMPORT_C TBool SupportsJapaneseKatakanaHalfWidth() const;

Description

Tests whether the control supports text input in half width Japanese Katakana.

Return value

IMPORT_C TBool SupportsJapaneseKatakanaFullWidth() const;

Description

Tests whether the control supports text input in full width Japanese Katakana.

Return value

IMPORT_C TBool SupportsDialableCharacters() const;

Description

Tests whether the control supports dialable characters as text input.

Return value

IMPORT_C TBool SupportsSecretText() const;

Description

Tests whether the control supports secret text.

Return value

IMPORT_C TBool SupportsAutoSentenceCase() const;

Description

Tests whether the control supports auto sentence case.

Return value

IMPORT_C TBool SupportsNonPredictive() const;

Description

Tests whether the control supports non-predictive input.

Return value

IMPORT_C TBool SupportsAllText() const;

Description

Tests whether the control supports all types of text input.

Return value

IMPORT_C TBool SupportsNavigation() const;

Description

Tests whether the control supports navigation keys.

Return value

IMPORT_C MCoeFepAwareTextEditor* FepAwareTextEditor() const;

Description

Gets the FEP aware text editor object pointed to by this object.

Return value

IMPORT_C MCoeCaptionRetrieverForFep* CaptionRetrieverForFep() const;

Description

Gets the caption retriever pointed to by this object.

Return value

IMPORT_C MCoeFepSpecificExtensions* FepSpecificExtensions(TUid aFepUid) const;

Description

Gets the specialised input capabilities of the application.

This function is called by the FEP and returns the specialised capabilities supported by the application. If the application has no specialised input capabilities, or if the application does not know about this FEP, the function returns NULL.

Notes:

The application only knows about one FEP. This is the one that was written to implement its specialised capabilities. If aFepUid does not match the UID of this known FEP then NULL is returned.

If an MCoeFepSpecificExtensions is returned, the FEP then calls the supported extension functions in the application via its virtual interface. The functions return some value, which, depending on the current context, may instruct the FEP to perform some actions.

Background information:

The specialised capabilities are defined as pure virtual functions in the concrete FEP's MCoeFepSpecificExtensions interface, and are implemented by the app UI.

When the focus in the app UI changes, the FEP queries the application's capabilities using CCoeControl::InputCapabilities()const and/or CCoeAppUi::InputCapabilities()const. It then gets the extensions using this function.

The FEP then calls any member functions of MCoeFepSpecificExtensions that it needs to (to inquire about the extended capabilities). The functions return a value to the FEP instructing it to perform an action, if that extended functionality is appropriate to the current state of the application.

Parameters

Return value

IMPORT_C MObjectProvider* ObjectProvider() const;

Description

Gets the object provider of the control which supplied this TCoeInputCapabilities object.

This function can be called by a FEP to gain access to the object provider tree. For instance, the FEP might need to update an input mode indicator that is located in the same object provider tree as the editor with focus.

Return value

IMPORT_C void SetObjectProvider(MObjectProvider *aObjectProvider);

Description

Sets the object provider of the control which supplied this TCoeInputCapabilities object.

This allows the control to give the FEP access to its object provider tree.

Parameters

n/a

Description

Text input capability flags. These are used to define the text input capabilities of a control or view.