#include <mw/eikmfne.h>
| class CEikDateEditor : public CEikTTimeEditor |
| Public Member Functions | |
|---|---|
| CEikDateEditor() | |
| virtual | ~CEikDateEditor() |
| virtual IMPORT_C void | ConstructFromResourceL(TResourceReader &) |
| IMPORT_C void | ConstructL(const TTime &, const TTime &, const TTime &, TBool) |
| IMPORT_C TTime | Date() |
| virtual IMPORT_C void | GetMinimumAndMaximum(TTime &, TTime &) |
| virtual IMPORT_C void | HandlePointerEventL(const TPointerEvent &) |
| IMPORT_C TBool | IsUninitialised() |
| virtual IMPORT_C TKeyResponse | OfferKeyEventL(const TKeyEvent &, TEventCode) |
| virtual IMPORT_C void | PrepareForFocusLossL() |
| IMPORT_C void | SetDate(const TTime &) |
| virtual IMPORT_C void | SetMinimumAndMaximum(const TTime &, const TTime &) |
| IMPORT_C void | SetUninitialised(TBool) |
| Inherited Attributes | |
|---|---|
| CCoeControl::iCoeEnv | |
| CCoeControl::iContext | |
| CCoeControl::iPosition | |
| CCoeControl::iSize | |
| CEikBorderedControl::iBorder | |
| Inherited Enumerations | |
|---|---|
| CCoeControl:TZoomType | |
| CEikMfne:TFeatureId | |
| CEikMfne:TFingerSupportParams | |
Date editor.
A date editor has five fields: day, month and year, and two separator characters. The order of the fields varies depending on the locale's date format setting. Locale information, which is set and retrieved using class TLocale, is used to determine field order and the characters used to separate the date components. The upper and lower field bounds are set, and dates outside these bounds are invalid.
The editor can be configured to launch a pop-out calendar dialog, CEikCalendar. This may be used to directly set the day, month and year values.
The editor has an associated resource struct DATE_EDITOR and control factory identifier EEikCtDateEditor.
| IMPORT_C void | ConstructFromResourceL | ( | TResourceReader & | aResourceReader | ) | [virtual] |
Reimplemented from CCoeControl::ConstructFromResourceL(TResourceReader &)
From CCoeControl.
Second-phase construction from a resource file.
The function reads the maximum and minimum date values and whether or not the editor should support a pop-out calendar and/or date icon from a DATE_EDITOR resource. It sets the initial date to be the same as the maximum date and honours the locale's date format and separators.
| Parameter | Description |
|---|---|
| aResourceReader | A resource file reader. |
| IMPORT_C void | ConstructL | ( | const TTime & | aMinimumDate, |
| const TTime & | aMaximumDate, | |||
| const TTime & | aInitialDate, | |||
| TBool | aWithoutPopoutCalendar | |||
| ) | ||||
Handles 2nd phase construction.
This function completes the construction of a newly-allocated date editor. This function should be used instead of ConstructFromResourceL() when not initialising from a resource file. The editor's minimum, maximum and initial date values are set and the date format and date separator characters specified in class TLocale are honoured.
| Parameter | Description |
|---|---|
| aMinimumDate | The minimum allowable date. |
| aMaximumDate | The maximum allowable date. |
| aInitialDate | The initial value. |
| aWithoutPopoutCalendar | If ETrue the editor will not have a pop-out calendar dialog / icon. If EFalse the editor will have a pop-out calendar dialog / icon. |
Reimplemented from CEikTTimeEditor::GetMinimumAndMaximum(TTime &,TTime &)const
From CEikTTimeEditor.
Gets the date editor's minimum and maximum values.
| Parameter | Description |
|---|---|
| aMinimumDate | On return, the minimum allowable value. |
| aMaximumDate | On return, the maximum allowable value. |
| IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
Reimplemented from CEikMfne::HandlePointerEventL(const TPointerEvent &)
From CCoeControl.
Handles pointer events.
| Parameter | Description |
|---|---|
| aPointerEvent | The pointer event. |
| IMPORT_C TBool | IsUninitialised | ( | ) | const |
Tests whether the editor is uninitialised.
Returns: ETrue if uninitialised.
| IMPORT_C TKeyResponse | OfferKeyEventL | ( | const TKeyEvent & | aKeyEvent, |
| TEventCode | aType | |||
| ) | [virtual] | |||
Reimplemented from CEikMfne::OfferKeyEventL(const TKeyEvent &,TEventCode)
From CCoeControl.
Handles key events.
| Parameter | Description |
|---|---|
| aKeyEvent | The key event. |
| aType | The type of key event. |
Returns: EKeyConsumed if the key has beend handled.
| IMPORT_C void | PrepareForFocusLossL | ( | ) | [virtual] |
Reimplemented from CEikMfne::PrepareForFocusLossL()
From CCoeControl.
Editor validation.
This function should be called before an attempt is made to remove focus from a date editor. If the control value is not within the bounds specified by the minimum and maximum date values, it is reset to the nearest allowable value, the function then leaves.
| IMPORT_C void | SetDate | ( | const TTime & | aDate | ) |
Sets the date editor's value.
| Parameter | Description |
|---|---|
| aDate | The editor's value. Time components are ignored. |
Reimplemented from CEikTTimeEditor::SetMinimumAndMaximum(const TTime &,const TTime &)
From CEikTTimeEditor.
Sets the minimum and maximum allowable dates.
If the current date is outside the new bounds it is changed to be within them.
| Parameter | Description |
|---|---|
| aMinimumDate | The minimum allowable value. |
| aMaximumDate | The maximum allowable value. |
| IMPORT_C void | SetUninitialised | ( | TBool | aUninitialised | ) |
Sets date editor to initialised or uninitialised.
| Parameter | Description |
|---|---|
| aUninitialised | If ETrue then the date editor is set to be uninitialised. |