CEikEdwin::CEikEdwinExtension Class Reference

class CEikEdwin::CEikEdwinExtension : public CBase

Inherits from

  • CEikEdwin::CEikEdwinExtension
Public Member Functions
~CEikEdwinExtension()
TInt ClearDirection()
voidCreateFormExtendedInterfaceProviderIfNeededL()
voidCreateNoMatchesIndicatorFormatterL(CTextLayout &)
voidCreatePurePhoneNumberFormatterL(CTextLayout &, const CPlainText &)
voidCreateRichTextPhoneNumberFormatterL(CTextLayout &, const CRichText &)
TInt CurrentAlignment()
voidEnableKineticScrollingL()
voidEnablePhysicsL()
IMPORT_C CAknEdwinFormAccessor *FormAccessor()
IMPORT_C CFormCursorModifier *FormCursorModifier()
CAknEdwinFormExtendedInterfaceProvider *FormExtendedInferfaceProvider()
voidHandleNotifyInt(TUint32, TInt)
voidInitPhysicsL()
CAknInlineTextSource *InlineTextSource()
TBool IsBackgroundDrawingSuppressed()
CEikEdwinExtension *NewL(CEikEdwin *)
const TCallBack &PictoCallBack()
CAknPictographInterface *PictographInterface()
IMPORT_C CIdle *ScrollBarSetter()
voidSetAlignment(TInt)
IMPORT_C voidSetFormAccessor(CAknEdwinFormAccessor *)
voidSetPictoCallBack(TCallBack &)
IMPORT_C voidSetScrollBarSetter(CIdle *)
voidSetSkinBackgroundControlContext(MAknsControlContext *)
voidSetSuppressBackgroundDrawing(TBool)
MAknsControlContext *SkinBackgroundControlContext()
TBool SkinBackgroundControlContextHasBeenSet()
IMPORT_C const TAvkonEditorCustomWrap &TextWrapper()
Private Member Functions
CEikEdwinExtension()
voidConstructL(CEikEdwin *)
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Public Member Enumerations
enumTDrawState { ENotDraw = 0, EDrawn, EDrawing }
Private Member Enumerations
enumTFlagIndices { ESkinBackgroundControlContextHasBeenSetIndex = 0, ESuppressBackgroundDrawing, EKineticScrollingEnabled }
Public Attributes
CEdwinAsyncFormat *iAsyncFormat
TBool iCursorWasVisible
TBool *iDestroyedPtr
TBool iDisableConvertInFormat
TBool iDragging
TInt iDrawInvoked
SAknRgb iEditorBackgroundColor
CEikEdwin *iEdwin
TBool iEndBorderExceeded
CAknExtendedInputCapabilities *iExtendedInputCapabilities
TBool iInlineEditing
CAknEdwinPhysicsHandler *iPhysicsHandler
TInt iPixelsOutOfBorder
CAknPointerEventSuppressor *iPtSuppressor
TInt iRecordCursor
TInt iRecordFormattedHeight
TBool iRecordScroll
TRect iScrollRect
TInt iScrollbarPosition
TBool iScrolledByScrollBar
TInt iScrolledDelta
TAknsHighlightStyle iSkinHighlightStyle
TInt iSkinIdForText
MAknsSkinInstance *iSkinInstance
CSmileyManager *iSmiley
CSmileyCustomWrap *iSmileyWrap
TBool iStartBorderExceeded
TInt iTempAnchorPos
TInt iTempCursorPos
TInt iTempSelect
TRect iTextLinesRect
TInt iThumbPos
TInt iUpperFullFormattingLength
TBool iUseRateScroll
TCursorSelection iVisibleRange
Private Attributes
TInt iAlignment
CRepository *iCenRep
CCenRepNotifyHandler *iCenRepNotifyHandler
TInt iClearDirection
TBitFlags iFlags
CAknEdwinFormAccessor *iFormAccessor
CFormCursorModifier *iFormCursorModifier
CAknEdwinFormExtendedInterfaceProvider *iFormExtendedInterfaceProvider
CAknNoMatchesIndicatorInlineTextSource *iNoMatchesIndicatorFormatter
CAknInlineTextSource *iPhoneNumberFormatter
TCallBack iPictoCallBack
TAknEdwinPictographDrawer iPictographDrawer
CAknPictographInterface *iPictographInterface
CIdle *iSetScrollBar
MAknsControlContext *iSkinBackgroundControlContext
TAvkonEditorCustomWrap iTextWrapper

Constructor & Destructor Documentation

CEikEdwinExtension()

CEikEdwinExtension()[private]

~CEikEdwinExtension()

~CEikEdwinExtension()

Destructor.

Member Functions Documentation

ClearDirection()

TInt ClearDirection()const

Returns the value of ClearDirection

value of current ClearDirection

ConstructL(CEikEdwin *)

voidConstructL(CEikEdwin *aEdwin)[private]

Parameters

CEikEdwin * aEdwin

CreateFormExtendedInterfaceProviderIfNeededL()

voidCreateFormExtendedInterfaceProviderIfNeededL()

Creates the CAknFormExtendedInterfaceProvider object if it does not exist.

CreateNoMatchesIndicatorFormatterL(CTextLayout &)

voidCreateNoMatchesIndicatorFormatterL(CTextLayout &aTextLayout)

Create a custom formatter for pure phone number content.

Calls CreateFormExtendedInterfaceProviderIfNeededL to ensure that there is an ExtendedInterfaceProvider object built.

Parameters

CTextLayout & aTextLayoutReference to the CTextLayout object used for this editor

CreatePurePhoneNumberFormatterL(CTextLayout &, const CPlainText &)

voidCreatePurePhoneNumberFormatterL(CTextLayout &aTextLayout,
const CPlainText &aText
)

Create a custom formatter for pure phone number content.

Calls CreateFormExtendedInterfaceProviderIfNeededL to ensure that there is an ExtendedInterfaceProvider object built.

Parameters

CTextLayout & aTextLayoutReference to the CTextLayout object used for this editor. aText CPlainText object reference for the text used in the editor.
const CPlainText & aText

CreateRichTextPhoneNumberFormatterL(CTextLayout &, const CRichText &)

voidCreateRichTextPhoneNumberFormatterL(CTextLayout &aTextLayout,
const CRichText &aText
)

Create a custom formatter for rich text editor with general content. Phone numbers are recognized using an internal parser and formatted with the number grouping engine

Calls CreateFormExtendedInterfaceProviderIfNeededL to ensure that there is an ExtendedInterfaceProvider object built.

Parameters

CTextLayout & aTextLayoutReference to the CTextLayout object used for this editor
const CRichText & aText

CurrentAlignment()

TInt CurrentAlignment()const

Returns the stored alignment value.

Value of the current editor alignment.

EnableKineticScrollingL()

voidEnableKineticScrollingL()

Enables kinetic scrolling.

EnablePhysicsL()

voidEnablePhysicsL()

Enables physics.

FormAccessor()

IMPORT_C CAknEdwinFormAccessor *FormAccessor()const

Gets the form accessor.

The form accessor.

FormCursorModifier()

IMPORT_C CFormCursorModifier *FormCursorModifier()const

FormExtendedInferfaceProvider()

CAknEdwinFormExtendedInterfaceProvider *FormExtendedInferfaceProvider()const

Access to Form's extended interface provider.

HandleNotifyInt(TUint32, TInt)

voidHandleNotifyInt(TUint32aId,
TIntaNewValue
)

Parameters

TUint32 aId
TInt aNewValue

InitPhysicsL()

voidInitPhysicsL()

Initializes physics.

InlineTextSource()

CAknInlineTextSource *InlineTextSource()const

This allows the caller to access the single inline text interface that will be seen by Tagma. All installed inline text source classes are held behind this single interface

pointer to the inline text source object that will be provided to Tagma Null is returned if none is installed.

IsBackgroundDrawingSuppressed()

TBool IsBackgroundDrawingSuppressed()const

Tests if the background drawing is suppressed.

NewL(CEikEdwin *)

CEikEdwinExtension *NewL(CEikEdwin *aEdwin)[static]

Allocates and constructs a CEikEdwinExtension.

A newly constructed edwin extension.

Parameters

CEikEdwin * aEdwinPointer to the CEikEdwin creating the extension.

PictoCallBack()

const TCallBack &PictoCallBack()const

Sets pictograph animation callback.

PictographInterface()

CAknPictographInterface *PictographInterface()const

Returns pointer to pictograph interface.

Pointer to pictograph interface. The value can be NULL if pictographs are not supported.

ScrollBarSetter()

IMPORT_C CIdle *ScrollBarSetter()

Gets the CIdle object which updates scroll bar.

The CIdle object used to perform scroll bar updating.

SetAlignment(TInt)

voidSetAlignment(TIntaAlignment)

Stores the alignment value.

Parameters

TInt aAlignmentEditor alignment to be stored.

SetFormAccessor(CAknEdwinFormAccessor *)

IMPORT_C voidSetFormAccessor(CAknEdwinFormAccessor *aFormAccessor)

Sets the form accessor.

Parameters

CAknEdwinFormAccessor * aFormAccessorThe form accessor.

SetPictoCallBack(TCallBack &)

voidSetPictoCallBack(TCallBack &aCallBack)

Sets pictograph animation callback.

Parameters

TCallBack & aCallBack

SetScrollBarSetter(CIdle *)

IMPORT_C voidSetScrollBarSetter(CIdle *aScrollBarSetter)

Sets the CIdle object to update scroll bar.

Parameters

CIdle * aScrollBarSetter

SetSkinBackgroundControlContext(MAknsControlContext *)

voidSetSkinBackgroundControlContext(MAknsControlContext *aBackgroundControlContext)

Store a locally stored (but externally set) Skins background control context.

Parameters

MAknsControlContext * aBackgroundControlContextControl context to store. Not owned. Can be NULL.

SetSuppressBackgroundDrawing(TBool)

voidSetSuppressBackgroundDrawing(TBoolaSuppress)

Used for suppressing all editor's background drawing.

Parameters

TBool aSuppress

SkinBackgroundControlContext()

MAknsControlContext *SkinBackgroundControlContext()const

Access to locally stored Skins background control context.

Pointer to locally stored control context

SkinBackgroundControlContextHasBeenSet()

TBool SkinBackgroundControlContextHasBeenSet()const

This returns a flag that records whether the background context has ever been set by API.

EFalse iff control context has never been set.

TextWrapper()

IMPORT_C const TAvkonEditorCustomWrap &TextWrapper()

Gets the custom wrapper.

The custom wrapper.

Member Enumerations Documentation

Enum TDrawState

Enumerators

ENotDraw = 0
EDrawn
EDrawing

Enum TFlagIndices

Enumerators

ESkinBackgroundControlContextHasBeenSetIndex = 0
ESuppressBackgroundDrawing
EKineticScrollingEnabled

Member Data Documentation

TInt iAlignment

TInt iAlignment[private]

CEdwinAsyncFormat * iAsyncFormat

CEdwinAsyncFormat *iAsyncFormat

CRepository * iCenRep

CRepository *iCenRep[private]

CCenRepNotifyHandler * iCenRepNotifyHandler

CCenRepNotifyHandler *iCenRepNotifyHandler[private]

TInt iClearDirection

TInt iClearDirection[private]

TBool iCursorWasVisible

TBool iCursorWasVisible

If ETrue, text cursor was visible before drag or flick started. Used to store cursor state so that it is possible to enable cursor again when dragging, flicking or bounce stops.

TBool * iDestroyedPtr

TBool *iDestroyedPtr

iDestroyedPtr is used for the object destruction check. If it has non-null value, the destruction check is turned on, and the value points to a local boolean variable that keeps the destroyed state.

TBool iDisableConvertInFormat

TBool iDisableConvertInFormat

TBool iDragging

TBool iDragging

TInt iDrawInvoked

TInt iDrawInvoked

SAknRgb iEditorBackgroundColor

SAknRgb iEditorBackgroundColor

CEikEdwin * iEdwin

CEikEdwin *iEdwin

Pointer to CEikEdwin. Not own.

TBool iEndBorderExceeded

TBool iEndBorderExceeded

Content has moved up so that empty space below the editor content is visible.

CAknExtendedInputCapabilities * iExtendedInputCapabilities

CAknExtendedInputCapabilities *iExtendedInputCapabilities

TBitFlags iFlags

TBitFlags iFlags[private]

CAknEdwinFormAccessor * iFormAccessor

CAknEdwinFormAccessor *iFormAccessor[private]

CFormCursorModifier * iFormCursorModifier

CFormCursorModifier *iFormCursorModifier[private]

CAknEdwinFormExtendedInterfaceProvider * iFormExtendedInterfaceProvider

CAknEdwinFormExtendedInterfaceProvider *iFormExtendedInterfaceProvider[private]

TBool iInlineEditing

TBool iInlineEditing

CAknNoMatchesIndicatorInlineTextSource * iNoMatchesIndicatorFormatter

CAknNoMatchesIndicatorInlineTextSource *iNoMatchesIndicatorFormatter[private]

CAknInlineTextSource * iPhoneNumberFormatter

CAknInlineTextSource *iPhoneNumberFormatter[private]

CAknEdwinPhysicsHandler * iPhysicsHandler

CAknEdwinPhysicsHandler *iPhysicsHandler

Physics handler. Used only when physics feature is enabled. Own.

TCallBack iPictoCallBack

TCallBack iPictoCallBack[private]

TAknEdwinPictographDrawer iPictographDrawer

TAknEdwinPictographDrawer iPictographDrawer[private]

CAknPictographInterface * iPictographInterface

CAknPictographInterface *iPictographInterface[private]

TInt iPixelsOutOfBorder

TInt iPixelsOutOfBorder

Amount of pixels out of border. In practice width of empty space above or below editor content.

CAknPointerEventSuppressor * iPtSuppressor

CAknPointerEventSuppressor *iPtSuppressor

TInt iRecordCursor

TInt iRecordCursor

TInt iRecordFormattedHeight

TInt iRecordFormattedHeight

Record formatted height of layout

TBool iRecordScroll

TBool iRecordScroll

TRect iScrollRect

TRect iScrollRect

TInt iScrollbarPosition

TInt iScrollbarPosition

Used with each step of dragging scrollbar to record the thumb position before dragging action

TBool iScrolledByScrollBar

TBool iScrolledByScrollBar

If ETrue, ongoing scrolling is caused by moving scrollbar thumb.

TInt iScrolledDelta

TInt iScrolledDelta

Scrolled offset if using rate scroll way.

CIdle * iSetScrollBar

CIdle *iSetScrollBar[private]

MAknsControlContext * iSkinBackgroundControlContext

MAknsControlContext *iSkinBackgroundControlContext[private]

TAknsHighlightStyle iSkinHighlightStyle

TAknsHighlightStyle iSkinHighlightStyle

TInt iSkinIdForText

TInt iSkinIdForText

MAknsSkinInstance * iSkinInstance

MAknsSkinInstance *iSkinInstance

Skins instance. Not own.

CSmileyManager * iSmiley

CSmileyManager *iSmiley

CSmileyCustomWrap * iSmileyWrap

CSmileyCustomWrap *iSmileyWrap

TBool iStartBorderExceeded

TBool iStartBorderExceeded

Content has moved down so that empty space above the editor content is visible.

TInt iTempAnchorPos

TInt iTempAnchorPos

TInt iTempCursorPos

TInt iTempCursorPos

TInt iTempSelect

TInt iTempSelect

TRect iTextLinesRect

TRect iTextLinesRect

TAvkonEditorCustomWrap iTextWrapper

TAvkonEditorCustomWrap iTextWrapper[private]

TInt iThumbPos

TInt iThumbPos

TInt iUpperFullFormattingLength

TInt iUpperFullFormattingLength

TBool iUseRateScroll

TBool iUseRateScroll

If ETrue, uses rate scroll. Otherwise uses original way.

TCursorSelection iVisibleRange

TCursorSelection iVisibleRange