TCoeInputCapabilities Class Reference

class TCoeInputCapabilities

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

Public Member Functions
TCoeInputCapabilities ()
TCoeInputCapabilities ( TUint )
TCoeInputCapabilities ( TUint , MCoeFepAwareTextEditor *, MCoeCaptionRetrieverForFep *)
TCoeInputCapabilities ( TUint , MCoeFepAwareTextEditor *, MCoeCaptionRetrieverForFep *, TUid , MCoeFepSpecificExtensions *)
TCoeInputCapabilities (const TCoeInputCapabilities &)
IMPORT_C TUint Capabilities ()
IMPORT_C MCoeCaptionRetrieverForFep * CaptionRetrieverForFep ()
IMPORT_C MCoeFepAwareTextEditor * FepAwareTextEditor ()
IMPORT_C MCoeFepSpecificExtensions * FepSpecificExtensions ( TUid )
IMPORT_C TBool IsNone ()
IMPORT_C void MergeWith (const TCoeInputCapabilities &)
IMPORT_C MObjectProvider * ObjectProvider ()
IMPORT_C void SetCapabilities ( TUint )
IMPORT_C void SetObjectProvider ( MObjectProvider *)
IMPORT_C TBool SupportsAllText ()
IMPORT_C TBool SupportsAutoSentenceCase ()
IMPORT_C TBool SupportsDialableCharacters ()
IMPORT_C TBool SupportsJapaneseHiragana ()
IMPORT_C TBool SupportsJapaneseKatakanaFullWidth ()
IMPORT_C TBool SupportsJapaneseKatakanaHalfWidth ()
IMPORT_C TBool SupportsNavigation ()
IMPORT_C TBool SupportsNonPredictive ()
IMPORT_C TBool SupportsSecretText ()
IMPORT_C TBool SupportsWesternAlphabetic ()
IMPORT_C TBool SupportsWesternNumericIntegerNegative ()
IMPORT_C TBool SupportsWesternNumericIntegerPositive ()
IMPORT_C TBool SupportsWesternNumericReal ()
IMPORT_C TBool operator!= (const TCoeInputCapabilities &)
IMPORT_C TCoeInputCapabilities & operator= (const TCoeInputCapabilities &)
IMPORT_C TBool operator== (const TCoeInputCapabilities &)
Public Member Enumerations
enum anonymous {
ENone  = 0, EWesternNumericIntegerPositive  = 0x00000001, EWesternNumericIntegerNegative  = 0x00000002, EWesternNumericReal  = 0x00000004, EWesternAlphabetic  = 0x00000008, EJapaneseHiragana  = 0x00000010, EJapaneseKatakanaHalfWidth  = 0x00000020, EJapaneseKatakanaFullWidth  = 0x00000040, EDialableCharacters  = 0x00000080, ESecretText  = 0x00000100, EAutoSentenceCase  = 0x00000200, ENonPredictive  = 0x00000400, EAllText  = 0x01000000, ENavigation  = 0x02000000
}
Private Attributes
TUint iCapabilities
MCoeCaptionRetrieverForFep * iCaptionRetrieverForFep
MCoeFepAwareTextEditor * iFepAwareTextEditor
MCoeFepSpecificExtensions * iFepSpecificExtensions
TUint iFepUid
MObjectProvider * iObjectProvider
TAny * iSpareForFutureUse

Constructor & Destructor Documentation

TCoeInputCapabilities()

IMPORT_C TCoeInputCapabilities ( )

TCoeInputCapabilities(TUint)

IMPORT_C TCoeInputCapabilities ( TUint aCapabilities )

Constructor which initialises the capabilities.

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

Parameters

TUint aCapabilities A bitmask of the text input capability flags giving the supported capabilities. The possible flags are given in the anonymous enumeration in this class, beginning with ENone.

TCoeInputCapabilities(TUint, MCoeFepAwareTextEditor *, MCoeCaptionRetrieverForFep *)

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

Constructor which sets the 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. The possible flags are given in the anonymous enumeration in this class, beginning with ENone.
MCoeFepAwareTextEditor * aFepAwareTextEditor A FEP aware text editor. This enables FEPs to 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, MCoeFepAwareTextEditor *, MCoeCaptionRetrieverForFep *, TUid, MCoeFepSpecificExtensions *)

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

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() 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.

FepSpecificExtensions()

Parameters

TUint aCapabilities A bitmask of the text input capability flags giving the supported capabilities. The possible flags are given in the anonymous enumeration in this class, beginning with ENone.
MCoeFepAwareTextEditor * aFepAwareTextEditor A FEP aware text editor. This enables FEPs to 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.

TCoeInputCapabilities(const TCoeInputCapabilities &)

IMPORT_C TCoeInputCapabilities ( const TCoeInputCapabilities & aAnother )

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

Parameters

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

Member Functions Documentation

Capabilities()

IMPORT_C TUint Capabilities ( ) const

Gets the input capability flags of this object.

SetCapabilities()

CaptionRetrieverForFep()

IMPORT_C MCoeCaptionRetrieverForFep * CaptionRetrieverForFep ( ) const

Gets the caption retriever pointed to by this object.

FepAwareTextEditor()

IMPORT_C MCoeFepAwareTextEditor * FepAwareTextEditor ( ) const

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

FepSpecificExtensions(TUid)

IMPORT_C MCoeFepSpecificExtensions * FepSpecificExtensions ( TUid aFepUid ) const

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() and/or CCoeAppUi::InputCapabilities() . 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

TUid aFepUid The UID of the current FEP.

IsNone()

IMPORT_C TBool IsNone ( ) const

Tests whether the control supports any type of text input.

MergeWith(const TCoeInputCapabilities &)

IMPORT_C void MergeWith ( const TCoeInputCapabilities & aAnother )

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

const TCoeInputCapabilities & aAnother The capabilities to be merged.

ObjectProvider()

IMPORT_C MObjectProvider * ObjectProvider ( ) const

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.

SetCapabilities(TUint)

IMPORT_C void SetCapabilities ( TUint aCapabilities )

Sets the input capability flags of this object.

Capabilities()

Parameters

TUint aCapabilities The input capabilities. This is a bitwise-"or" of one or more values from the anonymous enum in this class.

SetObjectProvider(MObjectProvider *)

IMPORT_C void SetObjectProvider ( MObjectProvider * aObjectProvider )

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

MObjectProvider * aObjectProvider The object provider.

SupportsAllText()

IMPORT_C TBool SupportsAllText ( ) const

Tests whether the control supports all types of text input.

SupportsAutoSentenceCase()

IMPORT_C TBool SupportsAutoSentenceCase ( ) const

Tests whether the control supports auto sentence case.

SupportsDialableCharacters()

IMPORT_C TBool SupportsDialableCharacters ( ) const

Tests whether the control supports dialable characters as text input.

SupportsJapaneseHiragana()

IMPORT_C TBool SupportsJapaneseHiragana ( ) const

Tests whether the control supports text input in Japanese Hiragana.

SupportsJapaneseKatakanaFullWidth()

IMPORT_C TBool SupportsJapaneseKatakanaFullWidth ( ) const

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

SupportsJapaneseKatakanaHalfWidth()

IMPORT_C TBool SupportsJapaneseKatakanaHalfWidth ( ) const

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

SupportsNavigation()

IMPORT_C TBool SupportsNavigation ( ) const

Tests whether the control supports navigation keys.

SupportsNonPredictive()

IMPORT_C TBool SupportsNonPredictive ( ) const

Tests whether the control supports non-predictive input.

SupportsSecretText()

IMPORT_C TBool SupportsSecretText ( ) const

Tests whether the control supports secret text.

SupportsWesternAlphabetic()

IMPORT_C TBool SupportsWesternAlphabetic ( ) const

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

SupportsWesternNumericIntegerNegative()

IMPORT_C TBool SupportsWesternNumericIntegerNegative ( ) const

Tests whether the control supports entry of negative integers.

SupportsWesternNumericIntegerPositive()

IMPORT_C TBool SupportsWesternNumericIntegerPositive ( ) const

Tests whether the control supports entry of positive integers.

SupportsWesternNumericReal()

IMPORT_C TBool SupportsWesternNumericReal ( ) const

Tests whether the control supports entry of real numbers.

operator!=(const TCoeInputCapabilities &)

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

Inequality operator.

Compares this and aAnother for inequality.

Parameters

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

operator=(const TCoeInputCapabilities &)

IMPORT_C TCoeInputCapabilities & operator= ( const TCoeInputCapabilities & aAnother )

Assignment operator.

This copies the capabilities of aAnother into this object.

Parameters

const TCoeInputCapabilities & aAnother The object to be copied

operator==(const TCoeInputCapabilities &)

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

Equality operator.

Compares this and aAnother for equality.

Parameters

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

Member Enumerations Documentation

Enum anonymous

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

Enumerators

ENone = 0

No text input capabilities supported.

EWesternNumericIntegerPositive = 0x00000001

Supports positive western integers.

EWesternNumericIntegerNegative = 0x00000002

Supports negative western integers.

EWesternNumericReal = 0x00000004

Supports real numbers.

EWesternAlphabetic = 0x00000008

Supports the western alphabets.

EJapaneseHiragana = 0x00000010

Supports Hiragana.

EJapaneseKatakanaHalfWidth = 0x00000020

Supports half width Katakana.

EJapaneseKatakanaFullWidth = 0x00000040

Supports full width Katakana.

EDialableCharacters = 0x00000080

Supports dialable characters

ESecretText = 0x00000100

Supports secret text. This is text in which characters appear as asterisks.

EAutoSentenceCase = 0x00000200

Supports auto sentence case. This is text in which first word in a sentence begins with an uppercase letter, with all other letters and words in lowercase.

ENonPredictive = 0x00000400

Supports non-predictive input.

EAllText = 0x01000000

Supports all types of text.

ENavigation = 0x02000000

Supports navigation keys. These include arrow keys, page-up, page-down, home, end, tab, etc.

Member Data Documentation

TUint iCapabilities

TUint iCapabilities [private]

MCoeCaptionRetrieverForFep * iCaptionRetrieverForFep

MCoeCaptionRetrieverForFep * iCaptionRetrieverForFep [private]

MCoeFepAwareTextEditor * iFepAwareTextEditor

MCoeFepAwareTextEditor * iFepAwareTextEditor [private]

MCoeFepSpecificExtensions * iFepSpecificExtensions

MCoeFepSpecificExtensions * iFepSpecificExtensions [private]

TUint iFepUid

TUint iFepUid [private]

MObjectProvider * iObjectProvider

MObjectProvider * iObjectProvider [private]

TAny * iSpareForFutureUse

TAny * iSpareForFutureUse [private]