Symbian
Symbian Developer Library

SYMBIAN OS V9.4

Feedback

[Index] [Previous] [Next]

#include <FEPBASE.H>
Link against: fepbase.lib

Class MCoeFepAwareTextEditor_Extension1

class MCoeFepAwareTextEditor_Extension1;

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 MCoeFepAwareTextEditor_Extension1::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 MCoeFepAwareTextEditor_Extension1::State(TUid) and MCoeFepAwareTextEditor_Extension1::SetStateTransferingOwnershipL(CState *,TUid) , 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 MCoeFepAwareTextEditor_Extension1::SetStateTransferingOwnershipL(CState *,TUid) , passing in an object of a class derived from MCoeFepAwareTextEditor_Extension1::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 MCoeFepAwareTextEditor_Extension1::State(TUid) to retrieve the state information it previously set. Note that MCoeFepAwareTextEditor_Extension1::CState has several reserved functions, to enable it to be extended in future, while retaining backwards compatibility.

Members

Defined in MCoeFepAwareTextEditor_Extension1:

Member functions

SetStateTransferingOwnershipL(CState *,TUid)

virtual void SetStateTransferingOwnershipL(CState *aState, TUid aTypeSafetyUid)=0;

Description

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.

Parameters

MCoeFepAwareTextEditor_Extension1::CState *aState

Pointer to the state information object.

TUid aTypeSafetyUid

A UID which uniquely identifies the FEP which is calling this function. The text editor should store this value for use by the MCoeFepAwareTextEditor_Extension1::State(TUid) function.

State(TUid)

virtual CState* State(TUid aTypeSafetyUid)=0;

Description

Gets the state information previously set using MCoeFepAwareTextEditor_Extension1::SetStateTransferingOwnershipL(CState *,TUid).

This function does not transfer ownership. The function should first check that aTypeSafetyUid matches the UID value previously specified by MCoeFepAwareTextEditor_Extension1::SetStateTransferingOwnershipL(CState *,TUid). If it doesn't match, the function should return NULL.

Parameters

TUid aTypeSafetyUid

A UID which uniquely identifies the FEP which is calling this function. The purpose of this is to enable the FEP to safely downcast the MCoeFepAwareTextEditor_Extension1::CState pointer returned by this function to a pointer to a derived class known about by the FEP.

Return value

MCoeFepAwareTextEditor_Extension1::CState *

Pointer to the state information object.

StartFepInlineEditL(TBool &,const TCursorSelection &,const TDesC &,TInt,TBool,const MFormCustomDraw *,MFepInlineTextFormatRetriever &,MFepPointerEventHandlerDuringInlineEdit &)

IMPORT_C virtual void StartFepInlineEditL(TBool &aSetToTrue, const TCursorSelection &aCursorSelection, const TDesC &aInitialInlineText, TInt aPositionOfInsertionPointInInlineText, TBool aCursorVisibility, const MFormCustomDraw *aCustomDraw, MFepInlineTextFormatRetriever &aInlineTextFormatRetriever, MFepPointerEventHandlerDuringInlineEdit &aPointerEventHandlerDuringInlineEdit);

Description

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.

Parameters

TBool &aSetToTrue

Boolean set to EFalse by the caller and subsequently to ETrue by the function indicating that this is the implemented version and not the previous reserved funtion.

const TCursorSelection &aCursorSelection

The position of any hilighted text.

const TDesC16 &aInitialInlineText

TInt aPositionOfInsertionPointInInlineText

The position of the insertion point (i.e. the cursor) within the inline text string aNewInlineText. This is an offset from the start of the string.

TBool aCursorVisibility

const MFormCustomDraw *aCustomDraw

MFepInlineTextFormatRetriever &aInlineTextFormatRetriever

MFepPointerEventHandlerDuringInlineEdit &aPointerEventHandlerDuringInlineEdit

SetCursorType(TBool &,const TTextCursor &)

IMPORT_C virtual void SetCursorType(TBool &aSetToTrue, const TTextCursor &aTextCursor);

Description

Changes the cursor displayed to indicate different modes of operation. For example how text is enterered

Parameters

TBool &aSetToTrue

Boolean set to EFalse by the caller and subsequently to ETrue by the function indicating that this is the implemented version and not the previously reserved funtion.

const TTextCursor &aTextCursor

The new cursor to be displayed.

GetFepLayDocExtension(TBool &)

IMPORT_C virtual MCoeFepLayDocExtension* GetFepLayDocExtension(TBool &aSetToTrue);

Description

Retrieves the current MCoeFepLayDocExtension object from the text editor

Parameters

TBool &aSetToTrue

Boolean set to EFalse by the caller and subsequently to ETrue by the function indicating that this is the implemented version and not the previously reserved funtion.

Return value

MCoeFepLayDocExtension *

MCoeFepAwareTextEditor_Extension1_Reserved_4()

private: IMPORT_C virtual void MCoeFepAwareTextEditor_Extension1_Reserved_4();

Description

[Top]

Member classes

Class CState

class CState : public CBase;

Description

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.

Derivation

Members

Defined in MCoeFepAwareTextEditor_Extension1::CState:

Inherited from CBase:

Construction and destruction

CState()

protected: IMPORT_C CState();

Description

Empty default constructor.

~CState()

IMPORT_C virtual ~CState();

Description

Empty virtual destructor.

This is present because the class may be extended in the future to own resources.

Member functions

BaseConstructL()

protected: IMPORT_C void BaseConstructL();

Description

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 MCoeFepAwareTextEditor_Extension1::CState::BaseConstructL().

CState_Reserved_1()

private: IMPORT_C virtual void CState_Reserved_1();

Description

CState_Reserved_2()

private: IMPORT_C virtual void CState_Reserved_2();

Description

CState_Reserved_3()

private: IMPORT_C virtual void CState_Reserved_3();

Description

CState_Reserved_4()

private: IMPORT_C virtual void CState_Reserved_4();

Description

[Previous] [Top] [Next]