CAknTimeOrDateSettingItem Class Reference

API published in: S60 1st Ed

Link against: avkon.lib

Capability Information

Required Capabilities

None

#include <aknsettingitemlist.h>

Inherits CAknSettingItem.

Detailed Description

Time or Date Setting Item.

This class combines the time and the date functionality, as determined by a mode passed to the constructor.

Time or Date setting pages are launched from here, which use Time or date editor MFNEs to do the editing.


Public Types
enum   TAknTimeOrDateSettingItemMode { ETime, EDate }

Public Member Functions
IMPORT_C  CAknTimeOrDateSettingItem (TInt aIdentifier, enum TAknTimeOrDateSettingItemMode aMode, TTime &aTime)
IMPORT_C  ~CAknTimeOrDateSettingItem ()
  Destructor.
IMPORT_C void  CompleteConstructionL ()
  Method called by framework to complete the construction.
virtual IMPORT_C void  StoreL ()
  This command externalizes the current setting.
virtual IMPORT_C void  LoadL ()
virtual IMPORT_C const TDesC &  SettingTextL ()
virtual IMPORT_C void  EditItemL (TBool aCalledFromMenu)
  This launches the setting page for Time or Date editing.
IMPORT_C void  SetTimeFormatStringL (const TDesC &aTimeFormat)
  Set the time or date format string.
IMPORT_C const TPtrC  TimeFormatString ()
  Obtain the time format string.

Member Enumeration Documentation

enum CAknTimeOrDateSettingItem::TAknTimeOrDateSettingItemMode
 
Enumerator:
ETime 
EDate 

Constructor & Destructor Documentation

IMPORT_C CAknTimeOrDateSettingItem::CAknTimeOrDateSettingItem (  TInt  aIdentifier,
enum TAknTimeOrDateSettingItemMode  aMode,
TTime &  aTime
) 
 
IMPORT_C CAknTimeOrDateSettingItem::~CAknTimeOrDateSettingItem (   ) 
 

Destructor.

Member Function Documentation

IMPORT_C void CAknTimeOrDateSettingItem::CompleteConstructionL (   )  [virtual]
 

Method called by framework to complete the construction.

Extra allocations of memory or extra resource reading can happen here.

Reimplemented from CAknSettingItem.

virtual IMPORT_C void CAknTimeOrDateSettingItem::EditItemL (  TBool  aCalledFromMenu  )  [virtual]
 

This launches the setting page for Time or Date editing.

Parameters:
aCalledFromMenu  - ignored in this class

Reimplemented from CAknSettingItem.

virtual IMPORT_C void CAknTimeOrDateSettingItem::LoadL (   )  [virtual]
 

Reimplemented from CAknSettingItem.

IMPORT_C void CAknTimeOrDateSettingItem::SetTimeFormatStringL (  const TDesC &  aTimeFormat  ) 
 

Set the time or date format string.

If this is not called, then a localized, default string is used

virtual IMPORT_C const TDesC& CAknTimeOrDateSettingItem::SettingTextL (   )  [virtual]
 

Reimplemented from CAknSettingItem.

virtual IMPORT_C void CAknTimeOrDateSettingItem::StoreL (   )  [virtual]
 

This command externalizes the current setting.

The displayed (internal) copy is transferred to the external copy (the one referenced in the constructor).

This must be called by the client if he wants this to happen. Note that StoreAllL() on the setting item list will call this for each setting item.

Reimplemented from CAknSettingItem.

IMPORT_C const TPtrC CAknTimeOrDateSettingItem::TimeFormatString (   ) 
 

Obtain the time format string.

Returns:
A pointer descriptor to the date/time format string
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top