Class TCoeInputCapabilities

TCoeInputCapabilities

Support

Supported from 6.0

Description

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

Defined in TCoeInputCapabilities:
Anonymous, Capabilities(), CaptionRetrieverForFep(), EAllText, EDialableCharacters, EJapaneseHiragana, EJapaneseKatakanaFullWidth, EJapaneseKatakanaHalfWidth, ENavigation, ENone, ESecretText, EWesternAlphabetic, EWesternNumericIntegerNegative, EWesternNumericIntegerPositive, EWesternNumericReal, FepAwareTextEditor(), FepSpecificExtensions(), IsNone(), MergeWith(), SetCapabilities(), SupportsAllText(), SupportsDialableCharacters(), SupportsJapaneseHiragana(), SupportsJapaneseKatakanaFullWidth(), SupportsJapaneseKatakanaHalfWidth(), SupportsNavigation(), SupportsSecretText(), SupportsWesternAlphabetic(), SupportsWesternNumericIntegerNegative(), SupportsWesternNumericIntegerPositive(), SupportsWesternNumericReal(), TCoeInputCapabilities(), operator!=(), operator=(), operator==()

TCoeInputCapabilities(TUint aCapabilities);

Description

Constructor which sets capabilities. The new object has NULL pointers to FEP aware text editor and FEP caption retriever objects.

Parameters

TUint aCapabilities A bitmask of the text input capability flags giving the supported capabilities. ENone and the other flags are given in the enumeration at the bottom of this document.

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

Description

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

Parameters

TUint aCapabilities A bitmask of the text input capability flags giving the supported capabilities. ENone and the other flags are given in the enumeration at the bottom of this document. MCoeFepAwareTextEditor* aFepAwareTextEditor A FEP aware text editor. This enables FEPs to, for example, do things like inline-editing, retrieving portions of text, enquiring the position of the insertion-point (cursor), etc. MCoeCaptionRetrieverForFep* aCaptionRetrieverForFep A caption retriever for a FEP.

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

Description

Constructor which sets capabilities, a FEP aware text editor, a FEP caption retriever object, a FEP UID and an 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 and/or CCoeAppUi::InputCapabilities), 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.

Note:

• A brief description of the FEP specific extensions framework is provided in the linked topic below.

Parameters

TUint aCapabilities A bitmask of the text input capability flags giving the supported capabilities. ENone and the other flags are given in the enumeration at the bottom of this document. MCoeFepAwareTextEditor* aFepAwareTextEditor A FEP aware text editor. This enables FEPs to, for example, do things like inline-editing, retrieving portions of text, enquiring the position of the insertion-point (cursor), etc. MCoeCaptionRetrieverForFep* aCaptionRetrieverForFep A caption retriever for a FEP. TUid aFepUid The UID of the FEP for which the extended capabilities aFepSpecificExtensions apply. MCoeFepSpecificExtensions* aFepSpecificExtensions FEP specific extensions supported by the control or app UI returning this object.

See also:

• FepSpecificExtensions()

TCoeInputCapabilities(const TCoeInputCapabilities& aAnother);

Description

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

Parameters

const TCoeInputCapabilities& aAnother The input capabilities object to be copied.

MCoeCaptionRetrieverForFep* CaptionRetrieverForFep() const;

Description

Gets the caption retriever pointed to by this object.

Return value

MCoeCaptionRetrieverForFep* The caption retriever pointed to by this object.

MCoeFepAwareTextEditor* FepAwareTextEditor() const;

Description

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

Return value

MCoeFepAwareTextEditor* The FEP aware text editor object pointed to by this object

TBool IsNone() const;

Description

Tests whether the control supports any type of text input.

Return value

TBool ETrue if no text input is supported, otherwiseEFalse.

void MergeWith(const TCoeInputCapabilities& aAnother);

Description

Merges the capabilities of a specifiedTCoeInputCapabilitieswith this object. The capabilities are merged with a logical OR. The pointers to a FEP aware text editor and to a caption retriever for a FEP are merged only if this object has NULL pointers.

Parameters

const TCoeInputCapabilities& aAnother The capabilities to be merged.

TBool SupportsAllText() const;

Description

Tests whether the control supports all types of text input.

Return value

TBool ETrue if all text input is supported, otherwiseEFalse.

TBool SupportsDialableCharacters() const;

Description

Tests whether the control supports dialable characters as text input.

Return value

TBool ETrue if dialable characters are supported, otherwiseEFalse.

TBool SupportsJapaneseHiragana() const;

Description

Tests whether the control supports text input in Japanese Hiragana.

Return value

TBool ETrue if Japanese Hiragana is supported, otherwiseEFalse.

TBool SupportsJapaneseKatakanaFullWidth() const;

Description

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

Return value

TBool ETrue if full width Japanese Katakana is supported, otherwise EFalse.

TBool SupportsJapaneseKatakanaHalfWidth() const;

Description

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

Return value

TBool ETrue if half width Japanese Katakana is supported, otherwise EFalse.

TBool SupportsNavigation() const;

Description

Tests whether the control supports navigation keys.

Return value

TBool ETrue if navigation keys are supported, otherwiseEFalse.

TBool SupportsSecretText() const;

Description

Tests whether the control supports secret text.

Return value

TBool ETrue if secret text is supported, otherwiseEFalse.

TBool SupportsWesternAlphabetic() const;

Description

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

Return value

TBool ETrue if the western alphabet is supported, otherwiseEFalse.

TBool SupportsWesternNumericIntegerNegative() const;

Description

Tests whether the control supports entry of negative integers.

Return value

TBool ETrue if negative integers are supported, otherwiseEFalse.

TBool SupportsWesternNumericIntegerPositive() const;

Description

Tests whether the control supports entry of positive integers.

Return value

TBool ETrue if positive integers are supported, otherwiseEFalse.

TBool SupportsWesternNumericReal() const;

Description

Tests whether the control supports entry of real numbers.

Return value

TBool ETrue if real numbers are supported, otherwiseEFalse.

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

Description

Inequality operator. This operator compares this andaAnotherfor inequality.

Parameters

const TCoeInputCapabilities& aAnother The object to be compared to this object.

Return value

TBool ETrue if aAnother is not equal to this object, otherwise EFalse.

TCoeInputCapabilities& operator=(const TCoeInputCapabilities& aAnother);

Description

Equals operator. This copies the capabilities ofaAnotherinto this object.

Parameters

const TCoeInputCapabilities& aAnother The object to be copied

Return value

TCoeInputCapabilities& This object.

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

Description

Equality operator. This operator compares this andaAnotherfor equality.

Parameters

const TCoeInputCapabilities& aAnother The object to be compared to this object.

Return value

TBool ETrue if the object is equal, otherwiseEFalse.

void SetCapabilities(TUint aCapabilities);

Description

Sets the input-capability flags of this object.

Parameters

TUint aCapabilities The input capabilities. This is a bitwise-"or" of one or more values from the “Text input capability flags” anonymous enum below.

See also:

• Capabilities()

TUint Capabilities() const;

Description

Gets the input-capability flags of this object.

Return value

TUint The input capabilities. This is a bitwise-"or" of one or more values from the “Text input capability flags” anonymous enum below.

See also:

• SetCapabilities()

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.

Note:

• The application only knows about one FEP — 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 a 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 and/or CCoeAppUi::InputCapabilities. It then gets the extensions using FepSpecificExtensions() (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

TUid aFepUid The UID of the current FEP.

Return value

MCoeFepSpecificExtensions* NULL if there are no FEP specific input-capabilities or if the FEP is not "known" about by the application.

Anonymous

Description

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

ENone No text input capabilities supported. EWesternNumericIntegerPositive Supports positive western integers. EWesternNumericIntegerNegative Supports negative western integers. EWesternNumericReal Supports real numbers. EWesternAlphabetic Supports the western alphabets. EJapaneseHiragana Supports Hiragana. EJapaneseKatakanaHalfWidth Supports half width Katakana. EJapaneseKatakanaFullWidth Supports full width Katakana. EDialableCharacters Supports dialable characters ESecretText Supports secret text. This is text in which entered characters appear as asterisks. EAllText Supports all types of text. ENavigation Supports navigation keys. These keys include arrow keys, page-up, page-down, home, end, tab, etc.