#include <mw/eikmfne.h>
| class CEikTimeAndDateEditor : public CEikTTimeEditor |
| Public Member Functions | |
|---|---|
| CEikTimeAndDateEditor() | |
| virtual | ~CEikTimeAndDateEditor() |
| virtual IMPORT_C void | ConstructFromResourceL(TResourceReader &) |
| IMPORT_C void | ConstructL(const TTime &, const TTime &, const TTime &, TUint32, HBufC *) |
| 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() |
| virtual IMPORT_C void | SetMinimumAndMaximum(const TTime &, const TTime &) |
| IMPORT_C void | SetTimeAndDate(const TTime &) |
| IMPORT_C void | SetUninitialised(TBool) |
| IMPORT_C TTime | TimeAndDate() |
| Inherited Attributes | |
|---|---|
| CCoeControl::iCoeEnv | |
| CCoeControl::iContext | |
| CCoeControl::iPosition | |
| CCoeControl::iSize | |
| CEikBorderedControl::iBorder | |
| Inherited Enumerations | |
|---|---|
| CCoeControl:TZoomType | |
| CEikMfne:TFeatureId | |
| CEikMfne:TFingerSupportParams | |
Time and date editor.
This control allows both a time and date to be displayed and edited. It contains the following time fields: hours, minutes and seconds, two time separator characters and am/pm text, and the following date fields: year, month and day, with two date separator characters. The seconds and hours fields are optional and the order of the date fields and the separator characters are locale-dependent. The upper and lower field bounds are set, and dates and times outside these bounds are invalid.
Date field values may be edited directly or via a pop-out calendar dialog.
The editor has an associated resource struct TIME_AND_DATE_EDITOR and control factory identifier EEikCtTimeAndDateEditor.
| IMPORT_C | CEikTimeAndDateEditor | ( | ) |
Default constructor.
This function should be used as the first stage in two stage construction, followed by a call to either ConstructFromResourceL() to initialise the editor's field values from a resource file, or ConstructL() (if no resource file is used).
| IMPORT_C | ~CEikTimeAndDateEditor | ( | ) | [virtual] |
Destructor.
This frees the resources owned by the time and date editor, prior to its destruction.
| IMPORT_C void | ConstructFromResourceL | ( | TResourceReader & | aResourceReader | ) | [virtual] |
Reimplemented from CCoeControl::ConstructFromResourceL(TResourceReader &)
Second phase construction from a resource.
This function completes the construction of a newly-allocated date/time editor from a TIME_AND_DATE_EDITOR resource. The minimum and maximum date/times, the date and time flag settings, and the intervening text are read from the resource, and ConstructL() is called with these settings. The initial date/time is set to the maximum date/time value.
| Parameter | Description |
|---|---|
| aResourceReader | A resource file reader. |
| IMPORT_C void | ConstructL | ( | const TTime & | aMinimumTimeAndDate, |
| const TTime & | aMaximumTimeAndDate, | |||
| const TTime & | aInitialTimeAndDate, | |||
| TUint32 | aFlags, | |||
| HBufC * | aInterveningText = NULL | |||
| ) | ||||
Second phase construction.
This function completes construction of a newly-allocated date and time editor, by setting the minimum, maximum and initial date and time values. It should be called by the container only if the control is not constructed from a resource file.
The aFlags parameter is used to set whether the seconds or hours fields are not required. The minutes field is always present. It may also be used to specify whether or not to force 24 hour time format, overriding the locale's setting, and whether the editor should have a pop-out calendar dialog.
The locale-dependant date and time settings specified in class TLocale are honoured.
If the initial date/time is outside the bounds specified by the minimum and maximum, it is set to the nearest valid setting.
A panic will occur if the minimum date/time is later than the maximum date/time.
| Parameter | Description |
|---|---|
| aMinimumTimeAndDate | The minimum date and time value. |
| aMaximumTimeAndDate | The maximum date and time value. |
| aInitialTimeAndDate | The initial date and time value. |
| aFlags | A bitmask of flags. See eikon.hrh file, EEikTime, EEikDate etc. |
| aInterveningText | Descriptor containing the text to use to separate the time and date portions of the editor. |
| IMPORT_C void | GetMinimumAndMaximum | ( | TTime & | aMinimumTimeAndDate, |
| TTime & | aMaximumTimeAndDate | |||
| ) | const [virtual] | |||
Reimplemented from CEikTTimeEditor::GetMinimumAndMaximum(TTime &,TTime &)const
Gets the range of allowable values that may be entered by the user.
| Parameter | Description |
|---|---|
| aMinimumTimeAndDate | On return, contains the time and date editor's minimum allowable value. |
| aMaximumTimeAndDate | On return, contains the time and date editor's 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 |
Gets the uninitialized status of the editor.
Returns: ETrue, if the editor is set as uninitialized.
| IMPORT_C TKeyResponse | OfferKeyEventL | ( | const TKeyEvent & | aKeyEvent, |
| TEventCode | aType | |||
| ) | [virtual] | |||
Reimplemented from CEikMfne::OfferKeyEventL(const TKeyEvent &,TEventCode)
Handles key events.
For example, the Tab key validates and launches a calendar popout.
Calls CEikMfne::OfferKeyEventL() if the control does not consume the key.
| Parameter | Description |
|---|---|
| aKeyEvent | The key event. |
| aType | The type of key event. |
Returns: Returns EKeyWasConsumed if the control consumes the key.
| IMPORT_C void | PrepareForFocusLossL | ( | ) | [virtual] |
Reimplemented from CEikMfne::PrepareForFocusLossL()
Prepares the editor for focus loss.
This function should be called to validate the editor's contents when an attempt is made to remove focus from the control. If the control value is not within the bounds specified by the minimum and maximum date/time values, it is reset to the nearest allowable value, the function will leave and display an appropriate message.
| IMPORT_C void | SetMinimumAndMaximum | ( | const TTime & | aMinimumTimeAndDate, |
| const TTime & | aMaximumTimeAndDate | |||
| ) | [virtual] | |||
Reimplemented from CEikTTimeEditor::SetMinimumAndMaximum(const TTime &,const TTime &)
Sets the range of allowable values.
These define the maximum and minimum time/date values that may be entered by the user.
If the existing date/time value is outside the new bounds, it is reset to the nearest allowable value.
| Parameter | Description |
|---|---|
| aMinimumTimeAndDate | The minimum allowable value. |
| aMaximumTimeAndDate | The maximum allowable value. |
| IMPORT_C void | SetTimeAndDate | ( | const TTime & | aTimeAndDate | ) |
Sets the values of the time and date editor's fields.
| Parameter | Description |
|---|---|
| aTimeAndDate | The new value for the date and time editor's fields. |
| IMPORT_C void | SetUninitialised | ( | TBool | aUninitialised | ) |
Sets the uninitialized status of the editor.
| Parameter | Description |
|---|---|
| aUninitialised | If ETrue, sets the editor as uninitialized, i.e. it doesn't display anything. |
| IMPORT_C TTime | TimeAndDate | ( | ) | const |
Gets the time and date editor's value.
Returns: The editor's value.