#include <mw/eikmfne.h>
| class CEikMfne : public CEikBorderedControl |
| Public Member Enumerations | |
|---|---|
| enum | TFeatureId { EClipGcToRect, EDisablePenInput, EFingerSupport, ELaunchPenInputAutomatic, ..., EChangeAmPm } |
| enum | TFingerSupportParams { EDisaleFingerSupport, EnableFingerSupport, EnableWithAllHighlight } |
| Protected Member Functions | |
|---|---|
| virtual IMPORT_C void | FieldIsAboutToBeDeHighlighted(CEikMfneField *, TBool &) |
| virtual 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) |
| virtual IMPORT_C void | SizeChanged() |
| virtual IMPORT_C void | WriteInternalStateL(RWriteStream &) |
| Inherited Attributes | |
|---|---|
| CCoeControl::iCoeEnv | |
| CCoeControl::iContext | |
| CCoeControl::iPosition | |
| CCoeControl::iSize | |
| CEikBorderedControl::iBorder | |
| Inherited Enumerations | |
|---|---|
| CCoeControl:TZoomType | |
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.
Settable features for MFNE. See SetFeature().
| Enumerator | Value | Description |
|---|---|---|
| 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 | ||
| EChangeAmPm |
| 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.
| 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.
| Parameter | Description |
|---|---|
| aField | A field. |
| IMPORT_C TMargins | BorderMargins | ( | ) | const |
Gets the control's border margins.
Returns: The control's margins.
| IMPORT_C TTimeIntervalSeconds | Convert | ( | const TTime & | aTime | ) | [static] |
Converts a time duration to seconds.
| Parameter | Description |
|---|---|
| aTime | The date and time to be converted. |
Returns: The time duration in seconds.
| IMPORT_C TTime | Convert | ( | const TTimeIntervalSeconds & | aTimeIntervalSeconds | ) | [static] |
Converts a time duration in seconds to hours, minutes and seconds.
| Parameter | Description |
|---|---|
| aTimeIntervalSeconds | The number of seconds to be converted. |
Returns: The date/time duration.
| 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.
| Parameter | Description |
|---|---|
| aNumFields | The number of fields. |
| TInt | CurrentField | ( | ) | const [inline] |
Gets the index into the field array of the current field.
Returns: The current field's index.
| 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.
| Parameter | Description |
|---|---|
| aResourceId | The resource containing the time/date format. See TTime::FormatL(). |
| aTimeDate | The object containing the time/date to be displayed. |
| IMPORT_C CEikMfneField * | Field | ( | TInt | aField | ) | const |
Gets the CEikMfneField at the specified index.
| Parameter | Description |
|---|---|
| aField | The field index. |
Returns: The requested field, or NULL if the index is less than zero or greater than the number of fields.
| 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.
| Parameter | Description |
|---|---|
| aField | The current field. |
| aDrawAllFields | On return, whether all fields have changed and need to be redrawn. |
| IMPORT_C void | FocusChanged | ( | TDrawNow | aDrawNow | ) | [protected, virtual] |
Reimplemented from CCoeControl::FocusChanged(TDrawNow)
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.
| Parameter | Description |
|---|---|
| aDrawNow | Whether to draw the control immediately. |
| IMPORT_C void | GetColorUseListL | ( | CArrayFix< TCoeColorUse > & | aColorUseList | ) | const [virtual] |
Reimplemented from CEikBorderedControl::GetColorUseListL(CArrayFix< TCoeColorUse > &)const
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.
| Parameter | Description |
|---|---|
| aColorUseList | On return, the colour list. |
Used to getting feature statuses.
| Parameter | Description |
|---|---|
| aFeatureId | The feature id, see TFeatureId |
| aFeatureParam | On return, the parameter for the feature (usually non-zero for an enabled feature and zero for disabled) |
Returns: KErrNone if the feature is supported and fetching its value succeeded
| 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().
| Parameter | Description |
|---|---|
| aHandleDeHighlight | ETrue if the current field has changed so requires de-highlighting. |
| aNewCurrentField | The index of the field to which the user has moved. |
| aOldWidthInPixelsOfOldCurrentField | The width in pixels of the previous current field. |
| aOldHighlightTypeOfOldCurrentField | The highlight type of the previously current field. |
| aDataAltered | ETrue if the data has been changed. |
| aError | On return, ETrue if successful, EFalse if not successful. |
| 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.
| Parameter | Description |
|---|---|
| aCommand | Command ID defined in MAknMfneCommandObserver::TMfneCommand |
| IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
Reimplemented from CEikBorderedControl::HandlePointerEventL(const TPointerEvent &)
From CCoeControl.
Handles pointer events.
| Parameter | Description |
|---|---|
| aPointerEvent | The pointer event. |
| IMPORT_C void | HandleResourceChange | ( | TInt | aType | ) | [virtual] |
Reimplemented from CEikBorderedControl::HandleResourceChange(TInt)
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.
| Parameter | Description |
|---|---|
| aType | A message UID value. |
| IMPORT_C TCoeInputCapabilities | InputCapabilities | ( | ) | const [virtual] |
Reimplemented from CCoeControl::InputCapabilities()const
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.
Returns: The control's input capabilities.
| void | InvalidFieldAlert | ( | ) | [static] |
| void | LeaveWithAlert | ( | TInt | aResourceId | ) | [static] |
| IMPORT_C void | MakeVisible | ( | TBool | aVisible | ) | [virtual] |
Reimplemented from CCoeControl::MakeVisible(TBool)
| 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.
Returns: The size of the multi-field numeric editor.
Gets the size of the multi-field numeric editor.
The width is the sum of the maximum widths of every field.
| Parameter | Description |
|---|---|
| aShrinkToMinimumSize | ETrue to shrink the width to the minimum required for each field. |
Returns: The size of the multi-field numeric editor.
| IMPORT_C TSize | MinimumSize | ( | ) | [virtual] |
Reimplemented from CCoeControl::MinimumSize()
Gets the minimum size of the control.
Overrides CCoeControl::MinimumSize().
Returns: The minimum control size.
| IMPORT_C TTypeUid::Ptr | MopSupplyObject | ( | TTypeUid | aId | ) | [virtual] |
Reimplemented from CCoeControl::MopSupplyObject(TTypeUid)
Retrieves an object of the same type as that encapsulated in aId.
Overrides CCoeControl::MopSupplyObject().
| Parameter | Description |
|---|---|
| aId | An encapsulated object type ID. |
Returns: Encapsulates the pointer to the object provided. Note that the encapsulated pointer may be NULL.
| TInt | NumFields | ( | ) | const [inline] |
Gets the number of fields.
Returns: The number of fields in the editor.
| IMPORT_C TKeyResponse | OfferKeyEventL | ( | const TKeyEvent & | aKeyEvent, |
| TEventCode | aType | |||
| ) | [virtual] | |||
Reimplemented from CCoeControl::OfferKeyEventL(const TKeyEvent &,TEventCode)
Handles key events.
Overrides CCoeControl::OfferKeyEventL(). The key event is passed onto the current field to handle.
| Parameter | Description |
|---|---|
| aKeyEvent | The key event. |
| aType | The type of key event. |
Returns: Indicates whether or not the key event was used by this control.
| IMPORT_C void | PrepareForFocusLossL | ( | ) | [virtual] |
Reimplemented from CCoeControl::PrepareForFocusLossL()
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.
| 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.
| Parameter | Description |
|---|---|
| aResourceReader | A resource reader. |
Returns: The date value read from the resource. The hours, minutes, seconds values are set to zero.
| IMPORT_C TTimeIntervalSeconds | ReadDuration | ( | TResourceReader & | aResourceReader | ) | [static] |
Reads a duration value from a resource.
| Parameter | Description |
|---|---|
| aResourceReader | A resource reader. |
Returns: The duration, in seconds.
| 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.
| Parameter | Description |
|---|---|
| aResourceReader | A resource reader. |
Returns: The time value read from the resource.
| 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.
| Parameter | Description |
|---|---|
| aResourceReader | A resource reader. |
Returns: The time/date value read from the resource.
| 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.
| Parameter | Description |
|---|---|
| aResourceReader | A resource reader. |
Returns: The duration, in seconds.
| IMPORT_C void | ResetFieldArray | ( | ) |
Deletes the editor's field and the field array.
After a call to this, CreateFieldArrayL() can be called again.
Used for setting various flag-like features to the editor.
| Parameter | Description |
|---|---|
| aFeatureId | The feature id, see TFeatureId |
| aFeatureParam | The feature parameter. This is usually enabled or disabled. For more info, see the feature documentation in TFeatureId. |
Returns: KErrNone if the feature modification succeeded
| IMPORT_C void | SetFont | ( | const CFont * | aFont | ) |
Sets the font that is used to draw the fields in this editor.
| Parameter | Description |
|---|---|
| aFont | A pointer to a CFont object that is used to draw the fields in this editor. |
| 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.
| Parameter | Description |
|---|---|
| aAlignment | The editor's alignment |
| 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.
| 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
| Parameter | Description |
|---|---|
| aAknSkinIDForTextColor | ID for text color. |
| aAknSkinIDForBgColor | ID for background color. |
| 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.
| Parameter | Description |
|---|---|
| aSuppress | If ETrue, suppress background drawing |
| 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.
| Parameter | Description |
|---|---|
| aConsume | If EFalse, OfferKeyEventL() returns EKeyWasNotConsumed when up and down key events are received. |
| 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.
| Parameter | Description |
|---|---|
| aUseOverrideColors | ETrue to make the MFNE use overridden colors. |
| IMPORT_C void | SizeChanged | ( | ) | [protected, virtual] |
Reimplemented from CCoeControl::SizeChanged()
| IMPORT_C void | WriteInternalStateL | ( | RWriteStream & | aWriteStream | ) | const [protected, virtual] |
Reimplemented from CEikBorderedControl::WriteInternalStateL(RWriteStream &)const
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.