CEikSecretEditor Class Reference

class CEikSecretEditor : public CEikBorderedControl

A single line text editor which displays an asterisk for every character entered.

The editor is suitable for editing confidential information such as a password. You can paste to the editor but no other clipboard functions are available.

The editor has an associated resource struct SECRETED and control factory identifier EEikCtSecretEd.

Public Member Functions
CEikSecretEditor ()
~CEikSecretEditor ()
IMPORT_C void AknSetAlignment (const CGraphicsContext::TTextAlign &)
IMPORT_C void AknSetFont (const CFont &)
IMPORT_C const TDesC & Buffer ()
IMPORT_C void ConstructFromResourceL ( TResourceReader &)
TPoint CursorPos ()
IMPORT_C void EnableCursor ( TBool )
IMPORT_C void EnableSCT ( TBool )
IMPORT_C void FocusChanged ( TDrawNow )
IMPORT_C void GetColorUseListL ( CArrayFix < TCoeColorUse > &)
IMPORT_C TInt GetFeature ( TInt , TInt &)
IMPORT_C void GetText ( TDes &)
IMPORT_C void HandlePointerEventL (const TPointerEvent &)
IMPORT_C void HandleResourceChange ( TInt )
IMPORT_C void InitializeDisplay ( TInt )
IMPORT_C TCoeInputCapabilities InputCapabilities ()
IMPORT_C TInt MaxLength ()
IMPORT_C TSize MinimumSize ()
IMPORT_C TKeyResponse OfferKeyEventL (const TKeyEvent &, TEventCode )
IMPORT_C void Reset ()
IMPORT_C void RevealSecretText ( TBool )
IMPORT_C void SetDefaultInputMode ( TInt )
IMPORT_C TInt SetFeature ( TInt , TInt )
IMPORT_C void SetMaxLength ( TInt )
IMPORT_C void SetSkinBackgroundControlContextL ( MAknsControlContext *)
IMPORT_C void SetSkinTextColorL ( TInt , TInt )
IMPORT_C void SetText (const TDesC &)
void StartTimer ()
IMPORT_C TBool SupportsFeature ( TInt )
Protected Member Functions
IMPORT_C void AppendCharacterL ( TInt )
void InsertSecretChar ()
IMPORT_C void SizeChanged ()
IMPORT_C void Update ()
Private Member Functions
void CalculateAscent ()
IMPORT_C void CancelFepInlineEdit ()
TInt CharsFitOnEditor ()
IMPORT_C MCoeFepAwareTextEditor_Extension1::CState * CreateFepStateL ()
IMPORT_C void DoCommitFepInlineEditL ()
IMPORT_C TInt DocumentLengthForFep ()
IMPORT_C TInt DocumentMaximumLengthForFep ()
IMPORT_C void Draw (const TRect &)
IMPORT_C MCoeFepAwareTextEditor_Extension1 * Extension1 ( TBool &)
IMPORT_C void * ExtensionInterface ( TUid )
IMPORT_C void GetCursorSelectionForFep ( TCursorSelection &)
IMPORT_C void GetEditorContentForFep ( TDes &, TInt , TInt )
IMPORT_C void GetFormatForFep ( TCharFormat &, TInt )
IMPORT_C void GetScreenCoordinatesForFepL ( TPoint &, TInt &, TInt &, TInt )
void InitCRedirectionListenerL ()
void InsertChar ()
IMPORT_C void MCoeFepAwareTextEditor_Extension1_Reserved_2 ()
IMPORT_C void MCoeFepAwareTextEditor_Extension1_Reserved_3 ()
IMPORT_C void MCoeFepAwareTextEditor_Extension1_Reserved_4 ()
IMPORT_C void MCoeFepAwareTextEditor_Reserved_2 ()
void OverflowAlert ()
void ReportUpdate ()
IMPORT_C void Reserved_1 ()
IMPORT_C void Reserved_2 ()
void SetCursorFormat ()
IMPORT_C void SetCursorSelectionForFepL (const TCursorSelection &)
IMPORT_C void SetInlineEditingCursorVisibilityL ( TBool )
IMPORT_C void SetStateTransferingOwnershipL (CState *, TUid )
IMPORT_C void StartFepInlineEditL (const TDesC &, TInt , TBool , const MFormCustomDraw *, MFepInlineTextFormatRetriever &, MFepPointerEventHandlerDuringInlineEdit &)
IMPORT_C CState * State ( TUid )
TInt TimerCallback ( TAny *)
void UpdateCursor ()
IMPORT_C void UpdateFepInlineTextL (const TDesC &, TInt )
Inherited Functions
CAknControl::CAknControl()
CAknControl::~CAknControl()
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()
CCoeControl::AccumulatedZoom()const
CCoeControl::ActivateGc()const
CCoeControl::ActivateL()
CCoeControl::BackedUpWindow()const
CCoeControl::Background()const
CCoeControl::CCoeControl()
CCoeControl::CCoeControl(CCoeEnv *)
CCoeControl::CCoeControl(const CCoeControl &)
CCoeControl::CapturesPointer()const
CCoeControl::ClaimPointerGrab(TBool)
CCoeControl::ClaimPointerGrab(TInt,TBool)
CCoeControl::CloseWindow()
CCoeControl::ComponentArrayExists()const
CCoeControl::ComponentControl(TInt)const
CCoeControl::Components()
CCoeControl::Components()const
CCoeControl::ControlContext()const
CCoeControl::ControlEnv()const
CCoeControl::CopyControlContextFrom(const CCoeControl *)
CCoeControl::CountComponentControls()const
CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &)
CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &,TDisplayMode)
CCoeControl::CreateWindowL()
CCoeControl::CreateWindowL(RWindowGroup *)
CCoeControl::CreateWindowL(RWindowTreeNode &)
CCoeControl::CreateWindowL(const CCoeControl *)
CCoeControl::CustomGc()const
CCoeControl::DeactivateGc()const
CCoeControl::DrawBackground(const TRect &)const
CCoeControl::DrawDeferred()const
CCoeControl::DrawForeground(const TRect &)const
CCoeControl::DrawNow()const
CCoeControl::DrawNow(const TRect &)const
CCoeControl::DrawableWindow()const
CCoeControl::EnableDragEvents()
CCoeControl::EnableReportControlStateChange(TBool)
CCoeControl::EnableWindowTransparency()
CCoeControl::FindBackground()const
CCoeControl::FindFontProvider()const
CCoeControl::GetColor(TInt,TRgb &)const
CCoeControl::GetGc()const
CCoeControl::GetHelpContext(TCoeHelpContext &)const
CCoeControl::GrabbingComponent()const
CCoeControl::GrabbingComponent(TInt)const
CCoeControl::HandleComponentControlsResourceChange(TInt)
CCoeControl::HandleControlArrayEventL(CCoeControlArray::TEvent,const CCoeControlArray *,CCoeControl *,TInt)
CCoeControl::HandlePointerBufferReadyL()
CCoeControl::HandleRedrawEvent(const TRect &)const
CCoeControl::HitTest()const
CCoeControl::IgnoreEventsUntilNextPointerUp()
CCoeControl::Index(const CCoeControl *)const
CCoeControl::InitComponentArrayL()
CCoeControl::IsActivated()const
CCoeControl::IsBackedUp()const
CCoeControl::IsBeingDestroyed()const
CCoeControl::IsBlank()const
CCoeControl::IsDimmed()const
CCoeControl::IsFocused()const
CCoeControl::IsNonFocusing()const
CCoeControl::IsReadyToDraw()const
CCoeControl::IsVisible()const
CCoeControl::LayoutManager()const
CCoeControl::MakeVisible(TBool)
CCoeControl::MaximumWidth()const
CCoeControl::MopSupplyObject(TTypeUid)
CCoeControl::NotifyFontChange(const CCoeFontProvider *)
CCoeControl::Observer()const
CCoeControl::OverrideColorL(TInt,TRgb)
CCoeControl::OwnsWindow()const
CCoeControl::Parent()
CCoeControl::Parent()const
CCoeControl::Position()const
CCoeControl::PositionChanged()
CCoeControl::PositionRelativeToScreen()const
CCoeControl::PrepareForFocusGainL()
CCoeControl::PrepareForFocusLossL()
CCoeControl::ProcessPointerBufferReadyL()
CCoeControl::ProcessPointerEventL(const TPointerEvent &)
CCoeControl::Rect()const
CCoeControl::RecursivelyMergeInputCapabilities(TCoeInputCapabilities &)const
CCoeControl::RecursivelyMergedInputCapabilities()const
CCoeControl::RefetchPixelMappingL()
CCoeControl::RemoveFromParent()
CCoeControl::ReportEventL(MCoeControlObserver::TCoeEvent)
CCoeControl::RequestRelayout(const CCoeControl *)
CCoeControl::ResetGc()const
CCoeControl::ScreenFont(const TCoeFont &)const
CCoeControl::SetAllowStrayPointers()
CCoeControl::SetBackground(const MCoeControlBackground *)
CCoeControl::SetBlank()
CCoeControl::SetCanDrawOutsideRect()
CCoeControl::SetComponentsToInheritVisibility(TBool)
CCoeControl::SetContainerWindowL(RBackedUpWindow &)
CCoeControl::SetContainerWindowL(RWindow &)
CCoeControl::SetContainerWindowL(const CCoeControl &)
CCoeControl::SetControlContext(MCoeControlContext *)
CCoeControl::SetCornerAndSize(TGulAlignment,const TSize &)
CCoeControl::SetCustomGc(CWindowGc *)
CCoeControl::SetDimmed(TBool)
CCoeControl::SetExtent(const TPoint &,const TSize &)
CCoeControl::SetExtentToWholeScreen()
CCoeControl::SetFocus(TBool,TDrawNow)
CCoeControl::SetFocusing(TBool)
CCoeControl::SetFontProviderL(const CCoeFontProvider &)
CCoeControl::SetGc(CWindowGc *)const
CCoeControl::SetGloballyCapturing(TBool)
CCoeControl::SetHitTest(const MCoeControlHitTest *)
CCoeControl::SetLayoutManagerL(MCoeLayoutManager *)
CCoeControl::SetMaximumWidth(TInt)
CCoeControl::SetMopParent(MObjectProvider *)
CCoeControl::SetNeighbor(CCoeControl *)
CCoeControl::SetNonFocusing()
CCoeControl::SetObserver(MCoeControlObserver *)
CCoeControl::SetParent(CCoeControl *)
CCoeControl::SetPointerCapture(TBool)
CCoeControl::SetPosition(const TPoint &)
CCoeControl::SetRect(const TRect &)
CCoeControl::SetSize(const TSize &)
CCoeControl::SetSizeWithoutNotification(const TSize &)
CCoeControl::SetTextBaselineSpacing(TInt)
CCoeControl::SetUniqueHandle(TInt)
CCoeControl::SetZoomFactorL(TInt,TZoomType)
CCoeControl::Size()const
CCoeControl::SystemGc()const
CCoeControl::TextBaselineOffset(const TSize &)const
CCoeControl::TextDrawer(TInt)const
CCoeControl::UniqueHandle()const
CCoeControl::Window()const
CCoeControl::WriteInternalStateNowL(RWriteStream &)const
CCoeControl::ZoomWithType()const
CCoeControl::operator=(const CCoeControl &)
CCoeControl::~CCoeControl()
CEikBorderedControl::Border()const
CEikBorderedControl::CEikBorderedControl()
CEikBorderedControl::CEikBorderedControl(const TGulBorder &)
CEikBorderedControl::HasBorder()const
CEikBorderedControl::SetAdjacent(TInt)
CEikBorderedControl::SetBorder(TGulBorder::TBorderType)
CEikBorderedControl::SetBorder(TInt)
CEikBorderedControl::WriteInternalStateL(RWriteStream &)const
Public Member Enumerations
enum anonymous { EMaxSecEdBufLength  = 32, EMaxSecEdSecArrayLength  = 255 }
enum TFeatureId { EDisablePenInput , ELaunchPenInputAutomatic , EPartialScreenInput , ELockQuerySCT }
Inherited Enumerations
CCoeControl:TZoomType
Private Member Type Definitions
typedef TBuf < EMaxSecEdBufLength > TSecEdBuf
Protected Attributes
TInt iAscent
TSecEdBuf iBuf
TBool iBufferFull
TInt iCharWidth
TInt iMaxLen
HBufC * iSecCharArr
TInt iSecPos
Private Attributes
CGraphicsContext::TTextAlign iAlign
CEikSecretEditorExtension * iExtension
CState * iFepState
const CFont * iFont
HBufC * iInlineEditText
TBool iRevealSecretText
CPeriodic * iTimer
Inherited Attributes
CCoeControl::iCoeEnv
CCoeControl::iContext
CCoeControl::iPosition
CCoeControl::iSize
CEikBorderedControl::iBorder

Constructor & Destructor Documentation

CEikSecretEditor()

IMPORT_C CEikSecretEditor ( )

Default constructor.

This constructs a editor with a border type of TGulBorder::ESingleGray .

This function should be used as the first stage in two stage construction, followed by a call to either ConstructFromResourceL() or SetMaxLength() .

~CEikSecretEditor()

IMPORT_C ~CEikSecretEditor ( )

Destructor.

Member Functions Documentation

AknSetAlignment(const CGraphicsContext::TTextAlign &)

IMPORT_C void AknSetAlignment ( const CGraphicsContext::TTextAlign & aAlign )

Sets the alignment of the editor.

Parameters

const CGraphicsContext::TTextAlign & aAlign The editor's alignment.

AknSetFont(const CFont &)

IMPORT_C void AknSetFont ( const CFont & aFont )

Sets the font that is used to draw the text in this editor.

Parameters

const CFont & aFont A pointer to a CFont object that is used to draw the text in this editor.

AppendCharacterL(TInt)

IMPORT_C void AppendCharacterL ( TInt aKeyCode ) [protected, virtual]

Appends a character to the editor.

Parameters

TInt aKeyCode The character to append.

Buffer()

IMPORT_C const TDesC & Buffer ( ) const

Access method for getting at the buffer without copying out from it.

CalculateAscent()

void CalculateAscent ( ) [private]

CancelFepInlineEdit()

IMPORT_C void CancelFepInlineEdit ( ) [private]

CharsFitOnEditor()

TInt CharsFitOnEditor ( ) const [private]

ConstructFromResourceL(TResourceReader &)

IMPORT_C void ConstructFromResourceL ( TResourceReader & aReader ) [virtual]

Second-phase construction from a resource file.

This function reads the number of characters which may be entered by the user into the editor from a SECRETED resource. You should call either this function or SetMaxLength() before drawing the editor and offering key events, otherwise the editor will not accept text input.

panic
EIKCTL 13 If the value read from resource is greater than EMaxSecEdLength.

Parameters

TResourceReader & aReader A resource file reader.

CreateFepStateL()

IMPORT_C MCoeFepAwareTextEditor_Extension1::CState * CreateFepStateL ( ) [private, virtual]

CursorPos()

TPoint CursorPos ( )

DoCommitFepInlineEditL()

IMPORT_C void DoCommitFepInlineEditL ( ) [private]

DocumentLengthForFep()

IMPORT_C TInt DocumentLengthForFep ( ) const [private]

DocumentMaximumLengthForFep()

IMPORT_C TInt DocumentMaximumLengthForFep ( ) const [private]

Draw(const TRect &)

IMPORT_C void Draw ( const TRect & aRect ) const [private, virtual]

From CCoeControl . Draws the border around the control. This function also clears the central area if the IsBlank() method returns ETrue .

From CCoeControl

CCoeControl::IsBlank() Border()

Parameters

const TRect & aRect Not used.

EnableCursor(TBool)

IMPORT_C void EnableCursor ( TBool aEnable )

Parameters

TBool aEnable

EnableSCT(TBool)

IMPORT_C void EnableSCT ( TBool aEnable = ETrue )

Method for enabling/disabling special character table from the secret editor. By default the SCT is enabled in the secret editors. ConstructFromResourceL need to be called before this method.

Since
3.2

Parameters

TBool aEnable = ETrue Boolean value for enabling or disabling the special character table.

Extension1(TBool &)

IMPORT_C MCoeFepAwareTextEditor_Extension1 * Extension1 ( TBool & aSetToTrue ) [private]

Parameters

TBool & aSetToTrue

ExtensionInterface(TUid)

IMPORT_C void * ExtensionInterface ( TUid aInterface ) [private, virtual]

Parameters

TUid aInterface

FocusChanged(TDrawNow)

IMPORT_C void FocusChanged ( TDrawNow aDrawNow ) [virtual]

Parameters

TDrawNow aDrawNow

GetColorUseListL(CArrayFix< TCoeColorUse > &)

IMPORT_C void GetColorUseListL ( CArrayFix < TCoeColorUse > & aColorUseList ) const [virtual]

Gets the list of logical colours used to draw the editor.

Overrides CCoeControl::GetColorUseListL() .

Gets the list of logical colors employed in the drawing of the control, paired with an explanation of how they are used. Appends the list to aColorUseList.

Since
ER5U

Parameters

CArrayFix < TCoeColorUse > & aColorUseList On return, the colour list.

GetCursorSelectionForFep(TCursorSelection &)

IMPORT_C void GetCursorSelectionForFep ( TCursorSelection & aCursorSelection ) const [private]

Parameters

TCursorSelection & aCursorSelection

GetEditorContentForFep(TDes &, TInt, TInt)

IMPORT_C void GetEditorContentForFep ( TDes & aEditorContent,
TInt aDocumentPosition,
TInt aLengthToRetrieve
) const [private]

Parameters

TDes & aEditorContent
TInt aDocumentPosition
TInt aLengthToRetrieve

GetFeature(TInt, TInt &)

IMPORT_C TInt GetFeature ( TInt aFeatureId,
TInt & aFeatureParam
) const

Used to getting feature statuses.

Since
S60 5.0

Parameters

TInt aFeatureId The feature id, see TFeatureId
TInt & aFeatureParam On return, the parameter for the feature (usually non-zero for an enabled feature and zero for disabled)

GetFormatForFep(TCharFormat &, TInt)

IMPORT_C void GetFormatForFep ( TCharFormat & aFormat,
TInt aDocumentPosition
) const [private]

Parameters

TCharFormat & aFormat
TInt aDocumentPosition

GetScreenCoordinatesForFepL(TPoint &, TInt &, TInt &, TInt)

IMPORT_C void GetScreenCoordinatesForFepL ( TPoint & aLeftSideOfBaseLine,
TInt & aHeight,
TInt & aAscent,
TInt aDocumentPosition
) const [private]

Parameters

TPoint & aLeftSideOfBaseLine
TInt & aHeight
TInt & aAscent
TInt aDocumentPosition

GetText(TDes &)

IMPORT_C void GetText ( TDes & aText ) const

Gets the editor's text string.

This may be called from the container class when the model data should be updated according to the text contained in the editor.

Parameters

TDes & aText On return, the editor's text. This is what is stored in memory, not what is displayed. This descriptor must be capable of holding the maxlength of the internal buffer.

HandlePointerEventL(const TPointerEvent &)

IMPORT_C void HandlePointerEventL ( const TPointerEvent & aPointerEvent ) [virtual]

From CCoeControl .

Handles pointer events.

Parameters

const TPointerEvent & aPointerEvent The pointer event.

HandleResourceChange(TInt)

IMPORT_C void HandleResourceChange ( TInt aType ) [virtual]

Handles a change to the editor's resources.

The types of resources handled are those which are shared across the environment, e.g. colours or fonts.

Calls CEikBorderedControl::HandleResourceChange() .

Handles a change to the control's resources of type aType which are shared across the environment, e.g. colors or fonts.

Since
ER5U

Parameters

TInt aType A message UID value.

InitCRedirectionListenerL()

void InitCRedirectionListenerL ( ) [private]

InitializeDisplay(TInt)

IMPORT_C void InitializeDisplay ( TInt aNumberOfChars ) [virtual]

Set the initial display of the secret editor. Calling this routine doesn't affect the actual character buffer.

Parameters

TInt aNumberOfChars

InputCapabilities()

IMPORT_C TCoeInputCapabilities InputCapabilities ( ) const [virtual]

Gets the editor's input capabilities.

Overrides CCoeControl::InputCapabilities() .

If this function is overrided in a subclass, the subclass should obtain this class' InputCapabilities' object provider through TCoeInputCapabilities::ObjectProvider() and set that as a part of the subclass' InputCapabilities object provider chain to ensure maximum functionality.

InsertChar()

void InsertChar ( ) [private]

InsertSecretChar()

void InsertSecretChar ( ) [protected]

MCoeFepAwareTextEditor_Extension1_Reserved_2()

IMPORT_C void MCoeFepAwareTextEditor_Extension1_Reserved_2 ( ) [private, virtual]

MCoeFepAwareTextEditor_Extension1_Reserved_3()

IMPORT_C void MCoeFepAwareTextEditor_Extension1_Reserved_3 ( ) [private, virtual]

MCoeFepAwareTextEditor_Extension1_Reserved_4()

IMPORT_C void MCoeFepAwareTextEditor_Extension1_Reserved_4 ( ) [private, virtual]

MCoeFepAwareTextEditor_Reserved_2()

IMPORT_C void MCoeFepAwareTextEditor_Reserved_2 ( ) [private]

MaxLength()

IMPORT_C TInt MaxLength ( ) const

Returns the current maximum length of the internal buffer.

MinimumSize()

IMPORT_C TSize MinimumSize ( ) [virtual]

Gets the editor's minimum size in pixels.

Overrides CCoeControl::MinimumSize() .

OfferKeyEventL(const TKeyEvent &, TEventCode)

IMPORT_C TKeyResponse OfferKeyEventL ( const TKeyEvent & aKeyEvent,
TEventCode aType
) [virtual]

Responds to key presses.

Overrides CCoeControl::OfferKeyEventL() .

Parameters

const TKeyEvent & aKeyEvent The key event.
TEventCode aType Not used.

OverflowAlert()

void OverflowAlert ( ) [private]

Display alert to user, when character is entered but there is no more room in the field. Current implementation is to play a sound alert.

ReportUpdate()

void ReportUpdate ( ) [private]

Reserved_1()

IMPORT_C void Reserved_1 ( ) [private]

Reserved_2()

IMPORT_C void Reserved_2 ( ) [private, virtual]

Reset()

IMPORT_C void Reset ( )

Clears the editor's text string removing any trace of it from memory.

RevealSecretText(TBool)

IMPORT_C void RevealSecretText ( TBool aReveal )

Method to reveal (or hide) the currently input editor contents.

Parameters

TBool aReveal - if ETrue, reveals the contents; if EFalse hides them.

SetCursorFormat()

void SetCursorFormat ( ) [private]

SetCursorSelectionForFepL(const TCursorSelection &)

IMPORT_C void SetCursorSelectionForFepL ( const TCursorSelection & aCursorSelection ) [private]

Parameters

const TCursorSelection & aCursorSelection

SetDefaultInputMode(TInt)

IMPORT_C void SetDefaultInputMode ( TInt aInputMode )

Changes default and current input mode of a secret editor. By default input mode in the secret editor is alpha input mode (EAknEditorSecretAlphaInputMode). By using this method the default input mode can be changed to numeric input mode (EAknEditorNumericInputMode).

Since
2.1

Parameters

TInt aInputMode Default input mode in the secret editor. Only EAknEditorNumericInputMode and EAknEditorSecretAlphaInputMode are supported.

SetFeature(TInt, TInt)

IMPORT_C TInt SetFeature ( TInt aFeatureId,
TInt aFeatureParam
)

Used for setting various flag-like features to the editor.

Since
S60 5.0

Parameters

TInt aFeatureId The feature id, see TFeatureId
TInt aFeatureParam The feature parameter. This is usually enabled or disabled. For more info, see the feature documentation in TFeatureId.

SetInlineEditingCursorVisibilityL(TBool)

IMPORT_C void SetInlineEditingCursorVisibilityL ( TBool aCursorVisibility ) [private]

Parameters

TBool aCursorVisibility

SetMaxLength(TInt)

IMPORT_C void SetMaxLength ( TInt aMaxLength )

Set the maximum length of the editor.

This is the maximum number of characters which may be entered by the user into the editor.

panic
EIKCTL 13 If aMaxLength is greater than EMaxSecEdLength.

Parameters

TInt aMaxLength The maximum number of characters which may be entered.

SetSkinBackgroundControlContextL(MAknsControlContext *)

IMPORT_C void SetSkinBackgroundControlContextL ( MAknsControlContext * aContext )

Set the skin control context to be used with this secret editor. If this method is not called, the control context available through MOP (if any) is used. If NULL control context is specified, no control context is used at all.

Since
2.0

Parameters

MAknsControlContext * aContext The background control context used to draw the background of this editor or NULL. Ownership is not transferred.

SetSkinTextColorL(TInt, TInt)

IMPORT_C void SetSkinTextColorL ( TInt aAknSkinIDForTextColor,
TInt aAknSkinIdForBgColor =  KErrNotFound
)

Sets the colors for text and background as skin IDs.

Since
3.0

Parameters

TInt aAknSkinIDForTextColor ID for text color.
TInt aAknSkinIdForBgColor =  KErrNotFound

SetStateTransferingOwnershipL(CState *, TUid)

IMPORT_C void SetStateTransferingOwnershipL ( CState * aState,
TUid aTypeSafetyUid
) [private]

Parameters

CState * aState
TUid aTypeSafetyUid

SetText(const TDesC &)

IMPORT_C void SetText ( const TDesC & aText ) [virtual]

Set the contents of the character buffer.

Parameters

const TDesC & aText The text to be set as the contents of the character buffer.

SizeChanged()

IMPORT_C void SizeChanged ( ) [protected, virtual]

Responds to changes to the size and position of the contents of this control.

Overrides CCoeControl::SizeChanged() .

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

IMPORT_C void StartFepInlineEditL ( const TDesC & aInitialInlineText,
TInt aPositionOfInsertionPointInInlineText,
TBool aCursorVisibility,
const MFormCustomDraw * aCustomDraw,
MFepInlineTextFormatRetriever & aInlineTextFormatRetriever,
MFepPointerEventHandlerDuringInlineEdit & aPointerEventHandlerDuringInlineEdit
) [private]

Parameters

const TDesC & aInitialInlineText
TInt aPositionOfInsertionPointInInlineText
TBool aCursorVisibility
const MFormCustomDraw * aCustomDraw
MFepInlineTextFormatRetriever & aInlineTextFormatRetriever
MFepPointerEventHandlerDuringInlineEdit & aPointerEventHandlerDuringInlineEdit

StartTimer()

void StartTimer ( )

State(TUid)

IMPORT_C CState * State ( TUid aTypeSafetyUid ) [private]

Parameters

TUid aTypeSafetyUid

SupportsFeature(TInt)

IMPORT_C TBool SupportsFeature ( TInt aFeatureId ) const

Used for checking if the editor supports a feature. For features, see TFeatureId.

Since
S60 5.0

Parameters

TInt aFeatureId

TimerCallback(TAny *)

TInt TimerCallback ( TAny * aThis ) [private, static]

Parameters

TAny * aThis

Update()

IMPORT_C void Update ( ) [protected, virtual]

Updates and redraws the editor.

UpdateCursor()

void UpdateCursor ( ) [private]

UpdateFepInlineTextL(const TDesC &, TInt)

IMPORT_C void UpdateFepInlineTextL ( const TDesC & aNewInlineText,
TInt aPositionOfInsertionPointInInlineText
) [private]

Parameters

const TDesC & aNewInlineText
TInt aPositionOfInsertionPointInInlineText

Member Enumerations Documentation

Enum anonymous

Enumerators

EMaxSecEdBufLength = 32

The maximum number of characters in the displayed text buffer.

EMaxSecEdSecArrayLength = 255

Indicates the maximum number of characters which may be entered into the editor.

Editors additionally have a maximum length, see SetMaxLength() , which must not exceed this value.

Enum TFeatureId

Settable features for Secret Editor. See SetFeature() .

Since
S60 5.0

Enumerators

EDisablePenInput

Disables VKB. Non-zero (or ETrue) parameter disables VKB, 0 (or EFalse) enables VKB. When disabled, editor doesn't request PenInputServer to start VKB

ELaunchPenInputAutomatic
EPartialScreenInput
ELockQuerySCT

Member Type Definitions Documentation

Typedef TSecEdBuf

typedef TBuf < EMaxSecEdBufLength > TSecEdBuf [private]

Member Data Documentation

CGraphicsContext::TTextAlign iAlign

CGraphicsContext::TTextAlign iAlign [private]

TInt iAscent

TInt iAscent [protected]

TSecEdBuf iBuf

TSecEdBuf iBuf [protected]

TBool iBufferFull

TBool iBufferFull [protected]

TInt iCharWidth

TInt iCharWidth [protected]

CEikSecretEditorExtension * iExtension

CEikSecretEditorExtension * iExtension [private]

CState * iFepState

CState * iFepState [private]

const CFont * iFont

const CFont * iFont [private]

HBufC * iInlineEditText

HBufC * iInlineEditText [private]

TInt iMaxLen

TInt iMaxLen [protected]

TBool iRevealSecretText

TBool iRevealSecretText [private]

HBufC * iSecCharArr

HBufC * iSecCharArr [protected]

TInt iSecPos

TInt iSecPos [protected]

CPeriodic * iTimer

CPeriodic * iTimer [private]