Location:
FEPBASE.H
Link against: fepbase.lib
class MCoeFepAwareTextEditor_Extension1;
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.
Defined in MCoeFepAwareTextEditor_Extension1
:
CState
, GetFepLayDocExtension()
, MCoeFepAwareTextEditor_Extension1_Reserved_4()
, SetCursorType()
, SetStateTransferingOwnershipL()
, StartFepInlineEditL()
, State()
virtual void SetStateTransferingOwnershipL(CState *aState, TUid aTypeSafetyUid)=0;
Sets state information in the text editor.
This function must only transfer ownership of the state object after it has successfully done everything that can leave.
|
virtual CState *State(TUid aTypeSafetyUid)=0;
Gets the state information previously set using SetStateTransferingOwnershipL()
.
This function does not transfer ownership. The function should first check that aTypeSafetyUid matches the UID value previously
specified by SetStateTransferingOwnershipL()
. If it doesn't match, the function should return NULL.
|
|
virtual IMPORT_C void StartFepInlineEditL(TBool &aSetToTrue, const TCursorSelection &aCursorSelection, const TDesC &aInitialInlineText,
TInt aPositionOfInsertionPointInInlineText, TBool aCursorVisibility, const MFormCustomDraw *aCustomDraw, MFepInlineTextFormatRetriever
&aInlineTextFormatRetriever, MFepPointerEventHandlerDuringInlineEdit &aPointerEventHandlerDuringInlineEdit);
Updates the inline text.
Called when a character is added to or deleted from the inline text.
The descriptor aNewInlineText contains the entire new inline text string, not just the new text to be combined with the old inline text.
|
virtual IMPORT_C void SetCursorType(TBool &aSetToTrue, const TTextCursor &aTextCursor);
Changes the cursor displayed to indicate different modes of operation. For example how text is enterered
|
virtual IMPORT_C MCoeFepLayDocExtension *GetFepLayDocExtension(TBool &aSetToTrue);
Retrieves the current MCoeFepLayDocExtension
object from the text editor
|
|
class CState : public CBase;
State information for a text editor control. This is information specific to the control which is only of interest to the FEP which sets it.
CBase
- Base class for all classes to be instantiated on the heap
MCoeFepAwareTextEditor_Extension1::CState
- State information for a text editor control
Defined in MCoeFepAwareTextEditor_Extension1::CState
:
BaseConstructL()
, CState()
, CState_Reserved_1()
, CState_Reserved_2()
, CState_Reserved_3()
, CState_Reserved_4()
, ~CState()
Inherited from CBase
:
Delete()
,
Extension_()
,
operator new()
CState()
protected: IMPORT_C CState();
Empty default constructor.
~CState()
virtual IMPORT_C ~CState();
Empty virtual destructor.
This is present because the class may be extended in the future to own resources.
BaseConstructL()
protected: IMPORT_C void BaseConstructL();
Empty second phase base class constructor.
This function should be called from derived classes at the beginning of their ConstructL() even though it is currently empty.
This is because this class may be extended in future to own resources, which will be allocated in BaseConstructL()
.
CState_Reserved_1()
private: virtual IMPORT_C void CState_Reserved_1();
CState_Reserved_2()
private: virtual IMPORT_C void CState_Reserved_2();
CState_Reserved_3()
private: virtual IMPORT_C void CState_Reserved_3();
CState_Reserved_4()
private: virtual IMPORT_C void CState_Reserved_4();