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 voidAddField(CEikMfneField *)
IMPORT_C TMarginsBorderMargins()
IMPORT_C TTimeIntervalSecondsConvert(const TTime &)
IMPORT_C TTimeConvert(const TTimeIntervalSeconds &)
IMPORT_C voidCreateFieldArrayL(TInt)
TInt CurrentField()
IMPORT_C voidDrawNowAndLeaveWithTimeDateFormatInfoMsgL(TInt, const TTime &)
IMPORT_C CEikMfneField *Field(TInt)
IMPORT_C const CFont *Font()
IMPORT_C voidGetColorUseListL(CArrayFix< TCoeColorUse > &)
voidGetCursorInfo(TPoint &, TInt &, TInt &, TInt &)
IMPORT_C TIntGetFeature(TInt, TInt &)
IMPORT_C voidHandleMfneCommandL(TInt)
IMPORT_C voidHandlePointerEventL(const TPointerEvent &)
IMPORT_C voidHandleResourceChange(TInt)
voidHighlightField(TInt)
IMPORT_C TCoeInputCapabilitiesInputCapabilities()
voidInvalidFieldAlert()
voidLeaveWithAlert(TInt)
IMPORT_C voidMakeVisible(TBool)
IMPORT_C TSizeMinimumSize()
IMPORT_C TTypeUid::PtrMopSupplyObject(TTypeUid)
TInt NumFields()
IMPORT_C TKeyResponseOfferKeyEventL(const TKeyEvent &, TEventCode)
IMPORT_C voidPrepareForFocusLossL()
IMPORT_C TTimeReadDate(TResourceReader &)
IMPORT_C TTimeIntervalSecondsReadDuration(TResourceReader &)
IMPORT_C TTimeReadTime(TResourceReader &)
IMPORT_C TTimeReadTimeAndDate(TResourceReader &)
IMPORT_C TTimeIntervalSecondsReadTimeOffset(TResourceReader &)
voidReportStateChangeEventL()
voidReportUpdate()
IMPORT_C voidResetFieldArray()
voidSetCurrentField(TInt)
IMPORT_C TIntSetFeature(TInt, TInt)
voidSetFirstEditableField()
IMPORT_C voidSetFont(const CFont *)
IMPORT_C voidSetMfneAlignment(TInt)
IMPORT_C voidSetSkinBackgroundControlContextL(MAknsControlContext *)
IMPORT_C voidSetSkinTextColorL(TInt, TInt)
IMPORT_C voidSetSuppressBackgroundDrawing(TBool)
IMPORT_C voidSetUpAndDownKeysConsumed(TBool)
IMPORT_C voidSetUseOverrideColors(TBool)
voidSetValidateCallBack(TCallBack)
IMPORT_C TBoolSupportsFeature(TInt)
Protected Member Functions
IMPORT_C voidFieldIsAboutToBeDeHighlighted(CEikMfneField *, TBool &)
IMPORT_C voidFocusChanged(TDrawNow)
IMPORT_C voidHandleInteraction(TBool, TInt, TInt, CEikMfneField::THighlightType, TBool &, TBool &)
IMPORT_C TSizeMfneSize()
IMPORT_C TSizeMfneSize(TBool)
IMPORT_C voidSizeChanged()
IMPORT_C voidWriteInternalStateL(RWriteStream &)
Private Member Functions
IMPORT_C voidCEikMfne_Reserved()
TBool ConsumesUpAndDownKeys()
voidCreateExtensionIfRequiredL()
IMPORT_C voidCreatePopoutIfRequiredL()
IMPORT_C voidDraw(const TRect &)
voidDrawCursor()
voidDrawRange(CWindowGc &, TInt, TInt, TBool)
voidEvaluateSkinningBackground()
IMPORT_C void *ExtensionInterface(TUid)
voidHideCursor()
voidLaunchPenInputL()
CWindowGc &PreparedGc()
IMPORT_C voidReserved_2()
voidSetGcToDimmedVideo(CWindowGc &)
voidSetGcToInverseVideo(CWindowGc &)
voidSetGcToNormalVideo(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
enumTFeatureId { EClipGcToRect, EDisablePenInput, EFingerSupport, ELaunchPenInputAutomatic, EPartialScreenInput }
enumTFingerSupportParams { 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_CCEikMfne()

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 voidAddField(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 * aFieldA field.

BorderMargins()

IMPORT_C TMarginsBorderMargins()const

Gets the control's border margins.

The control's margins.

CEikMfne_Reserved()

IMPORT_C voidCEikMfne_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.

EFalse iff Up and Down keys are not consumed (and acted upon)

Convert(const TTime &)

IMPORT_C TTimeIntervalSecondsConvert(const TTime &aTime)[static]

Converts a time duration to seconds.

The time duration in seconds.

Parameters

const TTime & aTimeThe date and time to be converted.

Convert(const TTimeIntervalSeconds &)

IMPORT_C TTimeConvert(const TTimeIntervalSeconds &aTimeIntervalSeconds)[static]

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

The date/time duration.

Parameters

const TTimeIntervalSeconds & aTimeIntervalSecondsThe number of seconds to be converted.

CreateExtensionIfRequiredL()

voidCreateExtensionIfRequiredL()[private]

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

CreateFieldArrayL(TInt)

IMPORT_C voidCreateFieldArrayL(TIntaNumFields)

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 aNumFieldsThe number of fields.

CreatePopoutIfRequiredL()

IMPORT_C voidCreatePopoutIfRequiredL()[private, virtual]

CurrentField()

TInt CurrentField()const [inline]

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

The current field's index.

Draw(const TRect &)

IMPORT_C voidDraw(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 & aRectNot used.

DrawCursor()

voidDrawCursor()[private]

DrawNowAndLeaveWithTimeDateFormatInfoMsgL(TInt, const TTime &)

IMPORT_C voidDrawNowAndLeaveWithTimeDateFormatInfoMsgL(TIntaResourceId,
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 aResourceIdThe resource containing the time/date format. See TTime::FormatL().
const TTime & aTimeDateThe object containing the time/date to be displayed.

DrawRange(CWindowGc &, TInt, TInt, TBool)

voidDrawRange(CWindowGc &aGc,
TIntaFirstField,
TIntaLastField,
TBoolaSkipBackgroundDrawer = EFalse
)const [private]

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

Parameters

CWindowGc & aGcThe graphics context to draw to.
TInt aFirstFieldFirst field to be drawn.
TInt aLastFieldLast field to be drawn.
TBool aSkipBackgroundDrawer = EFalseETrue to skip the background drawing with a background drawer if it's used for the MFNE.

EvaluateSkinningBackground()

voidEvaluateSkinningBackground()[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(TUidaInterface)[private, virtual]

Parameters

TUid aInterface

Field(TInt)

IMPORT_C CEikMfneField *Field(TIntaField)const

Gets the CEikMfneField at the specified index.

The requested field, or NULL if the index is less than zero or greater than the number of fields.

Parameters

TInt aFieldThe field index.

FieldIsAboutToBeDeHighlighted(CEikMfneField *, TBool &)

IMPORT_C voidFieldIsAboutToBeDeHighlighted(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 * aFieldThe current field.
TBool & aDrawAllFieldsOn return, whether all fields have changed and need to be redrawn.

FocusChanged(TDrawNow)

IMPORT_C voidFocusChanged(TDrawNowaDrawNow)[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 aDrawNowWhether 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.

A pointer to the CFont object used to draw the fields in this editor.

GetColorUseListL(CArrayFix< TCoeColorUse > &)

IMPORT_C voidGetColorUseListL(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().

Parameters

CArrayFix< TCoeColorUse > & aColorUseListOn return, the colour list.

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

voidGetCursorInfo(TPoint &aPos,
TInt &aHeight,
TInt &aWidth,
TInt &aAscent
)

Parameters

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

GetFeature(TInt, TInt &)

IMPORT_C TIntGetFeature(TIntaFeatureId,
TInt &aFeatureParam
)const

Used to getting feature statuses.

KErrNone if the feature is supported and fetching its value succeeded

S60 3.2

Parameters

TInt aFeatureIdThe feature id, see TFeatureId
TInt & aFeatureParamOn 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 voidHandleInteraction(TBoolaHandleDeHighlight,
TIntaNewCurrentField,
TIntaOldWidthInPixelsOfOldCurrentField,
CEikMfneField::THighlightTypeaOldHighlightTypeOfOldCurrentField,
TBool &aDataAltered,
TBool &aError
)[protected]

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

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

Parameters

TBool aHandleDeHighlightETrue if the current field has changed so requires de-highlighting.
TInt aNewCurrentFieldThe index of the field to which the user has moved.
TInt aOldWidthInPixelsOfOldCurrentFieldThe width in pixels of the previous current field.
CEikMfneField::THighlightType aOldHighlightTypeOfOldCurrentFieldThe highlight type of the previously current field.
TBool & aDataAlteredETrue if the data has been changed.
TBool & aErrorOn return, ETrue if successful, EFalse if not successful.

HandleMfneCommandL(TInt)

IMPORT_C voidHandleMfneCommandL(TIntaCommand)

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 aCommandCommand ID defined in MAknMfneCommandObserver::TMfneCommand

HandlePointerEventL(const TPointerEvent &)

IMPORT_C voidHandlePointerEventL(const TPointerEvent &aPointerEvent)[virtual]

From CCoeControl.

Handles pointer events.

Parameters

const TPointerEvent & aPointerEventThe pointer event.

HandleResourceChange(TInt)

IMPORT_C voidHandleResourceChange(TIntaType)[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().

Parameters

TInt aTypeA message UID value.

HideCursor()

voidHideCursor()[private]

HighlightField(TInt)

voidHighlightField(TIntaFieldPosition)

Parameters

TInt aFieldPosition

InputCapabilities()

IMPORT_C TCoeInputCapabilitiesInputCapabilities()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.

The control's input capabilities.

InvalidFieldAlert()

voidInvalidFieldAlert()[static]

LaunchPenInputL()

voidLaunchPenInputL()[private]

LeaveWithAlert(TInt)

voidLeaveWithAlert(TIntaResourceId)[static]

Parameters

TInt aResourceId

MakeVisible(TBool)

IMPORT_C voidMakeVisible(TBoolaVisible)[virtual]

Parameters

TBool aVisible

MfneSize()

IMPORT_C TSizeMfneSize()const [protected]

Gets the size of the multi-field numeric editor.

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

The size of the multi-field numeric editor.

MfneSize(TBool)

IMPORT_C TSizeMfneSize(TBoolaShrinkToMinimumSize)[protected]

Gets the size of the multi-field numeric editor.

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

The size of the multi-field numeric editor.

Parameters

TBool aShrinkToMinimumSizeETrue to shrink the width to the minimum required for each field.

MinimumSize()

IMPORT_C TSizeMinimumSize()[virtual]

Gets the minimum size of the control.

Overrides CCoeControl::MinimumSize().

The minimum control size.

MopSupplyObject(TTypeUid)

IMPORT_C TTypeUid::PtrMopSupplyObject(TTypeUidaId)[virtual]

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

Overrides CCoeControl::MopSupplyObject().

Encapsulates the pointer to the object provided. Note that the encapsulated pointer may be NULL.

Parameters

TTypeUid aIdAn encapsulated object type ID.

NumFields()

TInt NumFields()const [inline]

Gets the number of fields.

The number of fields in the editor.

OfferKeyEventL(const TKeyEvent &, TEventCode)

IMPORT_C TKeyResponseOfferKeyEventL(const TKeyEvent &aKeyEvent,
TEventCodeaType
)[virtual]

Handles key events.

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

Indicates whether or not the key event was used by this control.

Parameters

const TKeyEvent & aKeyEventThe key event.
TEventCode aTypeThe type of key event.

PrepareForFocusLossL()

IMPORT_C voidPrepareForFocusLossL()[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 TTimeReadDate(TResourceReader &aResourceReader)[static]

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

The date value read from the resource. The hours, minutes, seconds values are set to zero.

Parameters

TResourceReader & aResourceReaderA resource reader.

ReadDuration(TResourceReader &)

IMPORT_C TTimeIntervalSecondsReadDuration(TResourceReader &aResourceReader)[static]

Reads a duration value from a resource.

The duration, in seconds.

Parameters

TResourceReader & aResourceReaderA resource reader.

ReadTime(TResourceReader &)

IMPORT_C TTimeReadTime(TResourceReader &aResourceReader)[static]

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

The time value read from the resource.

Parameters

TResourceReader & aResourceReaderA resource reader.

ReadTimeAndDate(TResourceReader &)

IMPORT_C TTimeReadTimeAndDate(TResourceReader &aResourceReader)[static]

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

The time/date value read from the resource.

Parameters

TResourceReader & aResourceReaderA resource reader.

ReadTimeOffset(TResourceReader &)

IMPORT_C TTimeIntervalSecondsReadTimeOffset(TResourceReader &aResourceReader)[static]

Reads a time offset from a resource.

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

The duration, in seconds.

Parameters

TResourceReader & aResourceReaderA resource reader.

ReportStateChangeEventL()

voidReportStateChangeEventL()

ReportUpdate()

voidReportUpdate()

Reserved_2()

IMPORT_C voidReserved_2()[private, virtual]

ResetFieldArray()

IMPORT_C voidResetFieldArray()

Deletes the editor's field and the field array.

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

SetCurrentField(TInt)

voidSetCurrentField(TIntaCurrentField)

Parameters

TInt aCurrentField

SetFeature(TInt, TInt)

IMPORT_C TIntSetFeature(TIntaFeatureId,
TIntaFeatureParam
)

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

KErrNone if the feature modification succeeded

S60 3.2

Parameters

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

SetFirstEditableField()

voidSetFirstEditableField()

SetFont(const CFont *)

IMPORT_C voidSetFont(const CFont *aFont)

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

Parameters

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

SetGcToDimmedVideo(CWindowGc &)

voidSetGcToDimmedVideo(CWindowGc &aGc)const [private]

Parameters

CWindowGc & aGc

SetGcToInverseVideo(CWindowGc &)

voidSetGcToInverseVideo(CWindowGc &aGc)const [private]

Parameters

CWindowGc & aGc

SetGcToNormalVideo(CWindowGc &)

voidSetGcToNormalVideo(CWindowGc &aGc)const [private]

Parameters

CWindowGc & aGc

SetMfneAlignment(TInt)

IMPORT_C voidSetMfneAlignment(TIntaAlignment)

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

Parameters

TInt aAlignmentThe editor's alignment

SetSkinBackgroundControlContextL(MAknsControlContext *)

IMPORT_C voidSetSkinBackgroundControlContextL(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 voidSetSkinTextColorL(TIntaAknSkinIDForTextColor,
TIntaAknSkinIDForBgColor =  KErrNotFound
)

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

3.0

Parameters

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

SetSuppressBackgroundDrawing(TBool)

IMPORT_C voidSetSuppressBackgroundDrawing(TBoolaSuppress)

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 aSuppressIf ETrue, suppress background drawing

SetUpAndDownKeysConsumed(TBool)

IMPORT_C voidSetUpAndDownKeysConsumed(TBoolaConsume)

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 aConsumeIf EFalse, OfferKeyEventL() returns EKeyWasNotConsumed when up and down key events are received.

SetUseOverrideColors(TBool)

IMPORT_C voidSetUseOverrideColors(TBoolaUseOverrideColors)

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

S60 v3.2

Parameters

TBool aUseOverrideColorsETrue to make the MFNE use overridden colors.

SetValidateCallBack(TCallBack)

voidSetValidateCallBack(TCallBackaCallBack)

Parameters

TCallBack aCallBack

SizeChanged()

IMPORT_C voidSizeChanged()[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.

Pointer to control context potentially in use, or NULL.

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

EFalse iff background skin will not be drawn.

SupportsFeature(TInt)

IMPORT_C TBoolSupportsFeature(TIntaFeatureId)const

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

ETrue if the feature is supported

S60 3.2

Parameters

TInt aFeatureId

WriteInternalStateL(RWriteStream &)

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

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

This function is empty in release builds.

Parameters

RWriteStream & aWriteStream

Member Enumerations Documentation

Enum TFeatureId

Settable features for MFNE. See SetFeature().

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]