CEikMfne Class Reference

class CEikMfne : public CEikBorderedControl

Multi-field numeric editor abstract base class.

This is a set of fields, where a field can be a number, a symbol or a separator. Field classes are derived from CEikMfneField .

Concrete multi-field numeric editors are derived from this class and should provide the following:

* A virtual destructor if the class introduces new data members which are allocated on the heap.

* A ConstructL() function; this is used to initialise a multi-field numeric editor.

* A ConstructFromResourceL() function; this is used to initialise a multi-field numeric editor from a resource.

* A data member to store the editor's value.

* Functions to set and get the editor's value.

* Functions to set the minimum and maximum allowable values.

Public Member Functions
CEikMfne ()
~CEikMfne ()
IMPORT_C void AddField ( CEikMfneField *)
IMPORT_C TMargins BorderMargins ()
IMPORT_C TTimeIntervalSeconds Convert (const TTime &)
IMPORT_C TTime Convert (const TTimeIntervalSeconds &)
IMPORT_C void CreateFieldArrayL ( TInt )
TInt CurrentField ()
IMPORT_C void DrawNowAndLeaveWithTimeDateFormatInfoMsgL ( TInt , const TTime &)
IMPORT_C CEikMfneField * Field ( TInt )
IMPORT_C const CFont * Font ()
IMPORT_C void GetColorUseListL ( CArrayFix < TCoeColorUse > &)
void GetCursorInfo ( TPoint &, TInt &, TInt &, TInt &)
IMPORT_C TInt GetFeature ( TInt , TInt &)
IMPORT_C void HandleMfneCommandL ( TInt )
IMPORT_C void HandlePointerEventL (const TPointerEvent &)
IMPORT_C void HandleResourceChange ( TInt )
void HighlightField ( TInt )
IMPORT_C TCoeInputCapabilities InputCapabilities ()
void InvalidFieldAlert ()
void LeaveWithAlert ( TInt )
IMPORT_C void MakeVisible ( TBool )
IMPORT_C TSize MinimumSize ()
IMPORT_C TTypeUid::Ptr MopSupplyObject ( TTypeUid )
TInt NumFields ()
IMPORT_C TKeyResponse OfferKeyEventL (const TKeyEvent &, TEventCode )
IMPORT_C void PrepareForFocusLossL ()
IMPORT_C TTime ReadDate ( TResourceReader &)
IMPORT_C TTimeIntervalSeconds ReadDuration ( TResourceReader &)
IMPORT_C TTime ReadTime ( TResourceReader &)
IMPORT_C TTime ReadTimeAndDate ( TResourceReader &)
IMPORT_C TTimeIntervalSeconds ReadTimeOffset ( TResourceReader &)
void ReportStateChangeEventL ()
void ReportUpdate ()
IMPORT_C void ResetFieldArray ()
void SetCurrentField ( TInt )
IMPORT_C TInt SetFeature ( TInt , TInt )
void SetFirstEditableField ()
IMPORT_C void SetFont (const CFont *)
IMPORT_C void SetMfneAlignment ( TInt )
IMPORT_C void SetSkinBackgroundControlContextL ( MAknsControlContext *)
IMPORT_C void SetSkinTextColorL ( TInt , TInt )
IMPORT_C void SetSuppressBackgroundDrawing ( TBool )
IMPORT_C void SetUpAndDownKeysConsumed ( TBool )
IMPORT_C void SetUseOverrideColors ( TBool )
void SetValidateCallBack ( TCallBack )
IMPORT_C TBool SupportsFeature ( TInt )
Protected Member Functions
IMPORT_C void FieldIsAboutToBeDeHighlighted ( CEikMfneField *, TBool &)
IMPORT_C void FocusChanged ( TDrawNow )
IMPORT_C void HandleInteraction ( TBool , TInt , TInt , CEikMfneField::THighlightType , TBool &, TBool &)
IMPORT_C TSize MfneSize ()
IMPORT_C TSize MfneSize ( TBool )
IMPORT_C void SizeChanged ()
IMPORT_C void WriteInternalStateL ( RWriteStream &)
Private Member Functions
IMPORT_C void CEikMfne_Reserved ()
TBool ConsumesUpAndDownKeys ()
void CreateExtensionIfRequiredL ()
IMPORT_C void CreatePopoutIfRequiredL ()
IMPORT_C void Draw (const TRect &)
void DrawCursor ()
void DrawRange ( CWindowGc &, TInt , TInt , TBool )
void EvaluateSkinningBackground ()
IMPORT_C void * ExtensionInterface ( TUid )
void HideCursor ()
void LaunchPenInputL ()
CWindowGc & PreparedGc ()
IMPORT_C void Reserved_2 ()
void SetGcToDimmedVideo ( CWindowGc &)
void SetGcToInverseVideo ( CWindowGc &)
void SetGcToNormalVideo ( CWindowGc &)
MAknsControlContext * SkinBackgroundControlContext ()
TBool SkinningBackground ()
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::ConstructFromResourceL(TResourceReader &)
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::MaximumWidth()const
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::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)
Public Member Enumerations
enum TFeatureId { EClipGcToRect , EDisablePenInput , EFingerSupport , ELaunchPenInputAutomatic , EPartialScreenInput }
enum TFingerSupportParams { EDisaleFingerSupport , EnableFingerSupport , EnableWithAllHighlight }
Inherited Enumerations
CCoeControl:TZoomType
Private Attributes
TInt iAlignment
TInt iCurrentField
CEikMfneExtension * iExtension
CEikMfneField ** iFields
TBitFlags iFlags
const CFont * iFont
TInt iNumFields
Inherited Attributes
CCoeControl::iCoeEnv
CCoeControl::iContext
CCoeControl::iPosition
CCoeControl::iSize
CEikBorderedControl::iBorder

Constructor & Destructor Documentation

CEikMfne()

IMPORT_C CEikMfne ( )

Default constructor.

~CEikMfne()

IMPORT_C ~CEikMfne ( ) [virtual]

Destructor.

This function is virtual which ensures that if delete is explicitly called on a CEikMfne pointer which points to a derived class instance, the derived class destructor is called.

Member Functions Documentation

AddField(CEikMfneField *)

IMPORT_C void AddField ( CEikMfneField * aField )

Adds a field.

The field is added as the first empty element in the field array or, if there is no current field, aField becomes the current field.

This should be called by the container only if a derived control is not constructed from a resource.

Ownership of aField is transferred to this multi-field numeric editor.

panic
22 If the field array has not been allocated.

Parameters

CEikMfneField * aField A field.

BorderMargins()

IMPORT_C TMargins BorderMargins ( ) const

Gets the control's border margins.

CEikMfne_Reserved()

IMPORT_C void CEikMfne_Reserved ( ) [private, virtual]

ConsumesUpAndDownKeys()

TBool ConsumesUpAndDownKeys ( ) const [private]

Access to state of whether up/down keys are eaten and used to increment/decrement. If these keys are not consumed, then the events are passed on.

Convert(const TTime &)

IMPORT_C TTimeIntervalSeconds Convert ( const TTime & aTime ) [static]

Converts a time duration to seconds.

Parameters

const TTime & aTime The date and time to be converted.

Convert(const TTimeIntervalSeconds &)

IMPORT_C TTime Convert ( const TTimeIntervalSeconds & aTimeIntervalSeconds ) [static]

Converts a time duration in seconds to hours, minutes and seconds.

Parameters

const TTimeIntervalSeconds & aTimeIntervalSeconds The number of seconds to be converted.

CreateExtensionIfRequiredL()

void CreateExtensionIfRequiredL ( ) [private]

Check for the existence of the extension and create if required.

CreateFieldArrayL(TInt)

IMPORT_C void CreateFieldArrayL ( TInt aNumFields )

Allocates a field array containing aNumFields elements.

This should be called by the container only if a derived control is not constructed from a resource.

panic
20 In debug builds, if there is already a field in the editor.

Parameters

TInt aNumFields The number of fields.

CreatePopoutIfRequiredL()

IMPORT_C void CreatePopoutIfRequiredL ( ) [private, virtual]

CurrentField()

TInt CurrentField ( ) const [inline]

Gets the index into the field array of the current field.

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.

DrawCursor()

void DrawCursor ( ) [private]

DrawNowAndLeaveWithTimeDateFormatInfoMsgL(TInt, const TTime &)

IMPORT_C void DrawNowAndLeaveWithTimeDateFormatInfoMsgL ( TInt aResourceId,
const TTime & aTimeDate
) const

Draws immediately, and then leaves with an info message containing a formatted time/date string.

The time/date is passed to the function, as is the resource which contains the format string which defines how it is to be formatted.

Parameters

TInt aResourceId The resource containing the time/date format. See TTime::FormatL().
const TTime & aTimeDate The object containing the time/date to be displayed.

DrawRange(CWindowGc &, TInt, TInt, TBool)

void DrawRange ( CWindowGc & aGc,
TInt aFirstField,
TInt aLastField,
TBool aSkipBackgroundDrawer = EFalse
) const [private]

Draws the specified fields within the MFNE. All fields between and including the aFirstField and aLastField will be drawn.

Parameters

CWindowGc & aGc The graphics context to draw to.
TInt aFirstField First field to be drawn.
TInt aLastField Last field to be drawn.
TBool aSkipBackgroundDrawer = EFalse ETrue to skip the background drawing with a background drawer if it's used for the MFNE.

EvaluateSkinningBackground()

void EvaluateSkinningBackground ( ) [private]

Checks if app is skin enabled and that the current control context has bitmap. If so, then state is set true. This should be called at constuction and when HandleResourceChange is called

ExtensionInterface(TUid)

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

Parameters

TUid aInterface

Field(TInt)

IMPORT_C CEikMfneField * Field ( TInt aField ) const

Gets the CEikMfneField at the specified index.

Parameters

TInt aField The field index.

FieldIsAboutToBeDeHighlighted(CEikMfneField *, TBool &)

IMPORT_C void FieldIsAboutToBeDeHighlighted ( CEikMfneField * aField,
TBool & aDrawAllFields
) [protected, virtual]

Empty virtual function.

Called by HandleInteraction() when switching from the current field. Can be implemented by derived classes to maintain consistency between fields, e.g. in a range editor.

Parameters

CEikMfneField * aField The current field.
TBool & aDrawAllFields On return, whether all fields have changed and need to be redrawn.

FocusChanged(TDrawNow)

IMPORT_C void FocusChanged ( TDrawNow aDrawNow ) [protected, virtual]

Redraws the current field, so removing or displaying the cursor.

If the editor has lost focus, the current field is reset to the first editable field.

Parameters

TDrawNow aDrawNow Whether to draw the control immediately.

Font()

IMPORT_C const CFont * Font ( ) const

Gets a pointer to the CFont object that is used to draw the fields in this editor.

GetColorUseListL(CArrayFix< TCoeColorUse > &)

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

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

The colours are appended to aColorUseList.

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.

GetCursorInfo(TPoint &, TInt &, TInt &, TInt &)

void GetCursorInfo ( TPoint & aPos,
TInt & aHeight,
TInt & aWidth,
TInt & aAscent
)

Parameters

TPoint & aPos
TInt & aHeight
TInt & aWidth
TInt & aAscent

GetFeature(TInt, TInt &)

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

Used to getting feature statuses.

Since
S60 3.2

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)

HandleInteraction(TBool, TInt, TInt, CEikMfneField::THighlightType, TBool &, TBool &)

IMPORT_C void HandleInteraction ( TBool aHandleDeHighlight,
TInt aNewCurrentField,
TInt aOldWidthInPixelsOfOldCurrentField,
CEikMfneField::THighlightType aOldHighlightTypeOfOldCurrentField,
TBool & aDataAltered,
TBool & aError
) [protected]

Handles the redrawing associated with a change to the current field.

Called by OfferKeyEventL() , HandlePointerEventL() and PrepareForFocusLossL() .

Parameters

TBool aHandleDeHighlight ETrue if the current field has changed so requires de-highlighting.
TInt aNewCurrentField The index of the field to which the user has moved.
TInt aOldWidthInPixelsOfOldCurrentField The width in pixels of the previous current field.
CEikMfneField::THighlightType aOldHighlightTypeOfOldCurrentField The highlight type of the previously current field.
TBool & aDataAltered ETrue if the data has been changed.
TBool & aError On return, ETrue if successful, EFalse if not successful.

HandleMfneCommandL(TInt)

IMPORT_C void HandleMfneCommandL ( TInt aCommand )

From MAknMfneCommandObserver . Allows owning controls to give commands to MFNE editors. This is interface was added to enable modifying the current field value with touch buttons.

Parameters

TInt aCommand Command ID defined in MAknMfneCommandObserver::TMfneCommand

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 control's resources.

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

Overrides CCoeControl::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.

HideCursor()

void HideCursor ( ) [private]

HighlightField(TInt)

void HighlightField ( TInt aFieldPosition )

Parameters

TInt aFieldPosition

InputCapabilities()

IMPORT_C TCoeInputCapabilities InputCapabilities ( ) const [virtual]

Gets the total of the input capabilities of all the editor's fields.

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.

InvalidFieldAlert()

void InvalidFieldAlert ( ) [static]
Display alert to user, when input is not a valid number (too big or too small etc). Current implementation is to play a sound alert.
Since
2.0

LaunchPenInputL()

void LaunchPenInputL ( ) [private]

LeaveWithAlert(TInt)

void LeaveWithAlert ( TInt aResourceId ) [static]
This is to aid the old code in the derived classes which called LeaveWithInfoMsg(). Now they leave and play warning sound to indicate a problem/correction made by the editor.
Since
2.0

Parameters

TInt aResourceId

MakeVisible(TBool)

IMPORT_C void MakeVisible ( TBool aVisible ) [virtual]

Parameters

TBool aVisible

MfneSize()

IMPORT_C TSize MfneSize ( ) const [protected]

Gets the size of the multi-field numeric editor.

The width is the sum of the maximum widths of every field.

MfneSize(TBool)

IMPORT_C TSize MfneSize ( TBool aShrinkToMinimumSize ) [protected]

Gets the size of the multi-field numeric editor.

The width is the sum of the maximum widths of every field.

Parameters

TBool aShrinkToMinimumSize ETrue to shrink the width to the minimum required for each field.

MinimumSize()

IMPORT_C TSize MinimumSize ( ) [virtual]

Gets the minimum size of the control.

Overrides CCoeControl::MinimumSize() .

MopSupplyObject(TTypeUid)

IMPORT_C TTypeUid::Ptr MopSupplyObject ( TTypeUid aId ) [virtual]

Retrieves an object of the same type as that encapsulated in aId.

Overrides CCoeControl::MopSupplyObject() .

Parameters

TTypeUid aId An encapsulated object type ID.

NumFields()

TInt NumFields ( ) const [inline]

Gets the number of fields.

OfferKeyEventL(const TKeyEvent &, TEventCode)

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

Handles key events.

Overrides CCoeControl::OfferKeyEventL() . The key event is passed onto the current field to handle.

Parameters

const TKeyEvent & aKeyEvent The key event.
TEventCode aType The type of key event.

PrepareForFocusLossL()

IMPORT_C void PrepareForFocusLossL ( ) [virtual]

Prepares for focus loss.

Overrides CCoeControl::PrepareForFocusLossL() .

This function should be called when an attempt is made to remove focus from a multi-field numeric editor. It redraws the control, removing highlighting from the current field.

It may be overridden in derived classes to test the validity of information entered into the editor. Derived class versions should include a base function call.

PreparedGc()

CWindowGc & PreparedGc ( ) const [private]

ReadDate(TResourceReader &)

IMPORT_C TTime ReadDate ( TResourceReader & aResourceReader ) [static]

A utility function which reads days, months and years from a resource and returns the corresponding TTime value.

Parameters

TResourceReader & aResourceReader A resource reader.

ReadDuration(TResourceReader &)

IMPORT_C TTimeIntervalSeconds ReadDuration ( TResourceReader & aResourceReader ) [static]

Reads a duration value from a resource.

Parameters

TResourceReader & aResourceReader A resource reader.

ReadTime(TResourceReader &)

IMPORT_C TTime ReadTime ( TResourceReader & aResourceReader ) [static]

A utility function which reads seconds, minutes and hours from a resource and returns the corresponding TTime value.

Parameters

TResourceReader & aResourceReader A resource reader.

ReadTimeAndDate(TResourceReader &)

IMPORT_C TTime ReadTimeAndDate ( TResourceReader & aResourceReader ) [static]

A utility function which reads seconds, minutes, hours, days, months and years from a resource and returns the corresponding TTime value.

Parameters

TResourceReader & aResourceReader A resource reader.

ReadTimeOffset(TResourceReader &)

IMPORT_C TTimeIntervalSeconds ReadTimeOffset ( TResourceReader & aResourceReader ) [static]

Reads a time offset from a resource.

This is identical to ReadDuration() , except that negative offsets are allowed.

Parameters

TResourceReader & aResourceReader A resource reader.

ReportStateChangeEventL()

void ReportStateChangeEventL ( )

ReportUpdate()

void ReportUpdate ( )

Reserved_2()

IMPORT_C void Reserved_2 ( ) [private, virtual]

ResetFieldArray()

IMPORT_C void ResetFieldArray ( )

Deletes the editor's field and the field array.

After a call to this, CreateFieldArrayL() can be called again.

SetCurrentField(TInt)

void SetCurrentField ( TInt aCurrentField )

Parameters

TInt aCurrentField

SetFeature(TInt, TInt)

IMPORT_C TInt SetFeature ( TInt aFeatureId,
TInt aFeatureParam
)

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

Since
S60 3.2

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.

SetFirstEditableField()

void SetFirstEditableField ( )

SetFont(const CFont *)

IMPORT_C void SetFont ( const CFont * aFont )

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

Parameters

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

SetGcToDimmedVideo(CWindowGc &)

void SetGcToDimmedVideo ( CWindowGc & aGc ) const [private]

Parameters

CWindowGc & aGc

SetGcToInverseVideo(CWindowGc &)

void SetGcToInverseVideo ( CWindowGc & aGc ) const [private]

Parameters

CWindowGc & aGc

SetGcToNormalVideo(CWindowGc &)

void SetGcToNormalVideo ( CWindowGc & aGc ) const [private]

Parameters

CWindowGc & aGc

SetMfneAlignment(TInt)

IMPORT_C void SetMfneAlignment ( TInt aAlignment )

Sets the alignment of the editor. The editor alignments, defined in avkon.hrh, are EAknEditorAlignNone, EAknEditorAlignCenter, EAknEditorAlignLeft, EAknEditorAlignRight or EAknEditorAlignBidi.

Parameters

TInt aAlignment The editor's alignment

SetSkinBackgroundControlContextL(MAknsControlContext *)

IMPORT_C void SetSkinBackgroundControlContextL ( MAknsControlContext * aControlContext )

Sets within in the editor an externally owned Skins background control context. This background control context will then be used by the editor to draw background.

If this API is not called, then the editor IS skin enabled, (that is CEikMfnes are skin enabled by default) but it will try to find a control context with which to perform background drawing from the Control Environment, via the Object Provider.

Setting this control context to NULL will have the effect of turning off background skinning.

Parameters

MAknsControlContext * aControlContext

SetSkinTextColorL(TInt, TInt)

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

Sets the colors for text and background as skin IDs. Please note that bgcolor overrides skinned draw if set

Since
3.0

Parameters

TInt aAknSkinIDForTextColor ID for text color.
TInt aAknSkinIDForBgColor =  KErrNotFound ID for background color.

SetSuppressBackgroundDrawing(TBool)

IMPORT_C void SetSuppressBackgroundDrawing ( TBool aSuppress )

Used for suppressing all editor's background drawing. This is intended for internal use.

Note that when this is set, the background is not drawn with skin nor cleared, so the background MUST be drawn by the parent control every time the editor changes.

Parameters

TBool aSuppress If ETrue, suppress background drawing

SetUpAndDownKeysConsumed(TBool)

IMPORT_C void SetUpAndDownKeysConsumed ( TBool aConsume )

Sets whether the editor consumes up and down key events. If this is set to EFalse, the editor returns EKeyWasNotConsumed upon receiving EKeyDownArrow or EKeyUpArrow key event and doesn't send the key event to the current field.

Parameters

TBool aConsume If EFalse, OfferKeyEventL() returns EKeyWasNotConsumed when up and down key events are received.

SetUseOverrideColors(TBool)

IMPORT_C void SetUseOverrideColors ( TBool aUseOverrideColors )

Sets the MFNE to use the CCoeControl::OverrideColorL() defined color in drawing. If this is set, no skinning will be used in drawing.

Since
S60 v3.2

Parameters

TBool aUseOverrideColors ETrue to make the MFNE use overridden colors.

SetValidateCallBack(TCallBack)

void SetValidateCallBack ( TCallBack aCallBack )

Parameters

TCallBack aCallBack

SizeChanged()

IMPORT_C void SizeChanged ( ) [protected, virtual]

SkinBackgroundControlContext()

MAknsControlContext * SkinBackgroundControlContext ( ) const [private]

Access to Skins background control context that is potentially being used by the Editor.

This API will first check to see if an control context has been set by API, and if so, return that. If the background control context has been set to NULL by API, then it will return NULL. If the background control context has never been set by API, then this returns the control context (if one exists) that the object obtains from Object Provider.

SkinningBackground()

TBool SkinningBackground ( ) const [private]
This state of enabling means that skinning will actually be drawn It is a combination of
  • application is skin enabled

  • current skin has a background or frame bitmap It is set during construction and does not change its value after except if the Skin is changed, whereupon the control context is re-accessed and checked for bitmaps present

SupportsFeature(TInt)

IMPORT_C TBool SupportsFeature ( TInt aFeatureId ) const

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

Since
S60 3.2

Parameters

TInt aFeatureId

WriteInternalStateL(RWriteStream &)

IMPORT_C void WriteInternalStateL ( RWriteStream & aWriteStream ) const [protected, virtual]

Writes the internal state of the control and its components to aStream.

This function is empty in release builds.

Writes the internal state of the control and its components to aStream. Does nothing in release mode. Designed to be overidden and base called by subclasses.

Parameters

RWriteStream & aWriteStream

Member Enumerations Documentation

Enum TFeatureId

Settable features for MFNE. See SetFeature() .

Since
S60 3.2

Enumerators

EClipGcToRect

Tries to prevent MFNE drawing outside its rect, event if it smaller than MinimumSize() . 0 (or EFalse) parameter disables this, non-zero (or ETrue) enables the feature.

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

EFingerSupport

Support finger input. Paramter is TFingerSupportParams.

ELaunchPenInputAutomatic
EPartialScreenInput

Enum TFingerSupportParams

Parameter for finger support feature: 0 means disable the suppor; 1 means enable the support; 2 means enable the support with highlight of whole text.

Enumerators

EDisaleFingerSupport
EnableFingerSupport
EnableWithAllHighlight

Member Data Documentation

TInt iAlignment

TInt iAlignment [private]

TInt iCurrentField

TInt iCurrentField [private]

CEikMfneExtension * iExtension

CEikMfneExtension * iExtension [private]

CEikMfneField ** iFields

CEikMfneField ** iFields [private]

TBitFlags iFlags

TBitFlags iFlags [private]

const CFont * iFont

const CFont * iFont [private]

TInt iNumFields

TInt iNumFields [private]