CEikTimeAndDateEditor Class Reference

API published in: S60 1st Ed

Link against: avkon.lib eikctl.lib eikcoctl.lib uiklaf.lib form.lib

Capability Information

Required Capabilities

None

#include <eikmfne.h>

Inherits CEikTTimeEditor, and MEikCalendarObserver.

Detailed Description

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.


Public Member Functions
IMPORT_C  CEikTimeAndDateEditor ()
  Default constructor.
virtual IMPORT_C  ~CEikTimeAndDateEditor ()
  Destructor.
IMPORT_C void  ConstructL (const TTime &aMinimumTimeAndDate, const TTime &aMaximumTimeAndDate, const TTime &aInitialTimeAndDate, TUint32 aFlags, HBufC *aInterveningText=NULL)
  Second phase construction.
IMPORT_C void  SetTimeAndDate (const TTime &aTimeAndDate)
  Sets the values of the time and date editor's fields.
IMPORT_C TTime  TimeAndDate () const
  Gets the time and date editor's value.
IMPORT_C void  SetUninitialised (TBool aUninitialised)
  Sets the uninitialized status of the editor.
IMPORT_C TBool  IsUninitialised () const
  Gets the uninitialized status of the editor.
virtual IMPORT_C void  SetMinimumAndMaximum (const TTime &aMinimumTimeAndDate, const TTime &aMaximumTimeAndDate)
  Sets the range of allowable values.
virtual IMPORT_C void  GetMinimumAndMaximum (TTime &aMinimumTimeAndDate, TTime &aMaximumTimeAndDate) const
  Gets the range of allowable values that may be entered by the user.
virtual IMPORT_C TKeyResponse  OfferKeyEventL (const TKeyEvent &aKeyEvent, TEventCode aType)
  Handles key events.
virtual IMPORT_C void  ConstructFromResourceL (TResourceReader &aResourceReader)
  Second phase construction from a resource.
virtual IMPORT_C void  PrepareForFocusLossL ()
  Prepares the editor for focus loss.
IMPORT_C void  HandlePointerEventL (const TPointerEvent &aPointerEvent)
  From CCoeControl.

Constructor & Destructor Documentation

IMPORT_C CEikTimeAndDateEditor::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).

virtual IMPORT_C CEikTimeAndDateEditor::~CEikTimeAndDateEditor (   )  [virtual]
 

Destructor.

This frees the resources owned by the time and date editor, prior to its destruction.

Member Function Documentation

virtual IMPORT_C void CEikTimeAndDateEditor::ConstructFromResourceL (  TResourceReader &  aResourceReader  )  [virtual]
 

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.

Parameters:
aResourceReader  A resource file reader.
IMPORT_C void CEikTimeAndDateEditor::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.

Parameters:
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.
virtual IMPORT_C void CEikTimeAndDateEditor::GetMinimumAndMaximum (  TTime &  aMinimumTimeAndDate,
TTime &  aMaximumTimeAndDate
)  const [virtual]
 

Gets the range of allowable values that may be entered by the user.

Parameters:
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.

Implements CEikTTimeEditor.

IMPORT_C void CEikTimeAndDateEditor::HandlePointerEventL (  const TPointerEvent &  aPointerEvent  )  [virtual]
 

From CCoeControl.

Handles pointer events.

Parameters:
aPointerEvent  The pointer event.

Reimplemented from CEikMfne.

IMPORT_C TBool CEikTimeAndDateEditor::IsUninitialised (   )  const
 

Gets the uninitialized status of the editor.

Returns:
ETrue, if the editor is set as uninitialized.
virtual IMPORT_C TKeyResponse CEikTimeAndDateEditor::OfferKeyEventL (  const TKeyEvent &  aKeyEvent,
TEventCode  aType
)  [virtual]
 

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.

Parameters:
aKeyEvent  The key event.
aType  The type of key event.
Returns:
Returns EKeyWasConsumed if the control consumes the key.

Reimplemented from CEikMfne.

virtual IMPORT_C void CEikTimeAndDateEditor::PrepareForFocusLossL (   )  [virtual]
 

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.

Reimplemented from CEikMfne.

virtual IMPORT_C void CEikTimeAndDateEditor::SetMinimumAndMaximum (  const TTime &  aMinimumTimeAndDate,
const TTime &  aMaximumTimeAndDate
)  [virtual]
 

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.

Parameters:
aMinimumTimeAndDate  The minimum allowable value.
aMaximumTimeAndDate  The maximum allowable value.

Implements CEikTTimeEditor.

IMPORT_C void CEikTimeAndDateEditor::SetTimeAndDate (  const TTime &  aTimeAndDate  ) 
 

Sets the values of the time and date editor's fields.

Parameters:
aTimeAndDate  The new value for the date and time editor's fields.
IMPORT_C void CEikTimeAndDateEditor::SetUninitialised (  TBool  aUninitialised  ) 
 

Sets the uninitialized status of the editor.

Parameters:
aUninitialised  If ETrue, sets the editor as uninitialized, i.e. it doesn't display anything.
IMPORT_C TTime CEikTimeAndDateEditor::TimeAndDate (   )  const
 

Gets the time and date editor's value.

Returns:
The editor's value.
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top