CAknQueryValueTimeArray Class Reference

API published in: S60 1st Ed

Link against: avkon.lib

Capability Information

Required Capabilities

None

#include <aknqueryvaluetime.h>

Detailed Description

Wraps an array of TTime, adapts it into a descriptor array.

Public Types
typedef CArrayFix< TTime >  TimeArray
  Typedef for array containing TTime items.
enum   { KSafeSizeOfDescriptorForTTimeFormat = 128 }

Public Member Functions
IMPORT_C  ~CAknQueryValueTimeArray ()
IMPORT_C void  SetArray (TimeArray &aArray)
  Set the array of values.
IMPORT_C TimeArray *  Array () const
  Get the array of values as a TArray.
IMPORT_C const HBufC *  FormatString () const
  Return the TTime format string that is used to generate MDesCArray values.
IMPORT_C TInt  FormattedStringSize () const
  Return the size of a maximal time string formated using the format string that was supplied during construction of this instance.
virtual IMPORT_C TInt  MdcaCount () const
virtual IMPORT_C TPtrC  MdcaPoint (TInt aIndex) const
  Returns array element, converting value to text.

Static Public Member Functions
static IMPORT_C CAknQueryValueTimeArray *  NewL (TInt aResourceId)
  NewL.
static IMPORT_C CAknQueryValueTimeArray *  NewLC (TInt aResourceId)
  See NewL.

Protected Member Functions
  CAknQueryValueTimeArray ()
void  ConstructL (TInt aResourceId)
  ConstructL.

Member Typedef Documentation

typedef CArrayFix<TTime> CAknQueryValueTimeArray::TimeArray
 

Typedef for array containing TTime items.

Member Enumeration Documentation

anonymous enum
 
Enumerator:
KSafeSizeOfDescriptorForTTimeFormat 

Constructor & Destructor Documentation

IMPORT_C CAknQueryValueTimeArray::~CAknQueryValueTimeArray (   ) 
 
CAknQueryValueTimeArray::CAknQueryValueTimeArray (   )  [protected]
 

Member Function Documentation

IMPORT_C TimeArray* CAknQueryValueTimeArray::Array (   )  const
 

Get the array of values as a TArray.

Note that client can use any implementation of array class, but the array is treated as a TArray.

Returns:
array of values, ownership is not passed
void CAknQueryValueTimeArray::ConstructL (  TInt  aResourceId  )  [protected]
 

ConstructL.

Parameters:
aResourceId  id of a resource containing a time format string
IMPORT_C const HBufC* CAknQueryValueTimeArray::FormatString (   )  const
 

Return the TTime format string that is used to generate MDesCArray values.

Returns:
format string
IMPORT_C TInt CAknQueryValueTimeArray::FormattedStringSize (   )  const
 

Return the size of a maximal time string formated using the format string that was supplied during construction of this instance.

Two versions to eliminate compiler warnings.

Returns:
length of formatted string.
virtual IMPORT_C TInt CAknQueryValueTimeArray::MdcaCount (   )  const [virtual]
 
Returns:
count of contained array
virtual IMPORT_C TPtrC CAknQueryValueTimeArray::MdcaPoint (  TInt  aIndex  )  const [virtual]
 

Returns array element, converting value to text.

WARNING: the returned pointer is only valid until the next time this method is invoked.

Parameters:
aIndex  index of element to return
Returns:
descriptor representing array element, ownership is not passed
static IMPORT_C CAknQueryValueTimeArray* CAknQueryValueTimeArray::NewL (  TInt  aResourceId  )  [static]
 

NewL.

Parameters:
aResourceId  Recource id of a TBUF containing a TTime format string. Client can use R_AVKON_TBUF_POPUP_FIELD_DEFAULT_TIME_FORMAT if desired, or provide its own resource.
static IMPORT_C CAknQueryValueTimeArray* CAknQueryValueTimeArray::NewLC (  TInt  aResourceId  )  [static]
 

See NewL.

IMPORT_C void CAknQueryValueTimeArray::SetArray (  TimeArray &  aArray  ) 
 

Set the array of values.

Note that client can use any implementation of array class, but must pass in a TArray generated from it (by calling the Array() method on the array class)

Parameters:
aArray  array of values, ownership is not passed
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top