MCoeFepAwareTextEditor_Extension1 Class Reference

Detailed Description

An interface class which may be derived from by text editors to enable FEPs to store state information inside the editor. To be overridden by text-editors

The CState class, defined within the scope of MCoeFepAwareTextEditor_Extension1 represents the state information. This is information specific to the control which is only of interest to the FEP.

A class which implements this interface must implement the pure virtual functions State() and SetStateTransferingOwnershipL() , to get and set the state. The class should also implement the MCoeFepAwareTextEditor interface. It must override the private virtual MCoeFepAwareTextEditor::Extension1() to return a pointer to itself (the default implementation returns NULL). The private virtual MCoeFepAwareTextEditor::Extension1() function is called by the public, non-virtual MCoeFepAwareTextEditor::Extension1() function.

For example, if a FEP wants to set some state information in a text editor which is about to lose focus, the FEP should first call the editor's Extension1() function. If this returns non-NULL, the FEP should call the editor's implementation of SetStateTransferingOwnershipL() , passing in an object of a class derived from CState , which holds the state information. It should also pass in a UID which uniquely identifies the FEP. Later, when focus returns to the editor, the FEP can call State() to retrieve the state information it previously set. Note that CState has several reserved functions, to enable it to be extended in future, while retaining backwards compatibility.