CAknQueryValueNumberArray Class Reference

API published in: S60 1st Ed

Link against: avkon.lib

Capability Information

Required Capabilities

None

#include <aknqueryvaluenumber.h>

Detailed Description

Wraps an array of numeric values, adapts it into a descriptor array.


Public Types
typedef CArrayFix< TInt >	NumberArray
	Typedef for array containing TInt items.
enum	{ KSafeSizeOfDescriptorForNumberFormat = 32 }
Public Member Functions
IMPORT_C	~CAknQueryValueNumberArray ()
IMPORT_C void	SetArray (NumberArray &aArray)
	Set the array of values.
IMPORT_C NumberArray *	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 CAknQueryValueNumberArray *	NewL (TInt aResourceId)
	Two-phased constructor.
static IMPORT_C CAknQueryValueNumberArray *	NewLC (TInt aResourceId)
	See NewL.
Protected Member Functions
	CAknQueryValueNumberArray ()
void	ConstructL (TInt aResourceId)
	ConstructL.

Member Typedef Documentation

typedef CArrayFix<TInt> CAknQueryValueNumberArray::NumberArray

Typedef for array containing TInt items.

Member Enumeration Documentation

anonymous enum

Enumerator:

KSafeSizeOfDescriptorForNumberFormat

Constructor & Destructor Documentation

IMPORT_C CAknQueryValueNumberArray::~CAknQueryValueNumberArray

(

)

CAknQueryValueNumberArray::CAknQueryValueNumberArray ( ) [protected]

Member Function Documentation

IMPORT_C NumberArray* CAknQueryValueNumberArray::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 CAknQueryValueNumberArray::ConstructL ( TInt aResourceId ) [protected]

ConstructL.

Parameters:

aResourceId

id of a resource containing a time format string

IMPORT_C const HBufC* CAknQueryValueNumberArray::FormatString

(

)

const

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

Returns:: format string

IMPORT_C TInt CAknQueryValueNumberArray::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 CAknQueryValueNumberArray::MdcaCount ( ) const [virtual]

Returns:: count of contained array

virtual IMPORT_C TPtrC CAknQueryValueNumberArray::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 CAknQueryValueNumberArray* CAknQueryValueNumberArray::NewL ( TInt aResourceId ) [static]

Two-phased constructor.

Parameters:

aResourceId

Recource id of a TBUF containing a number format string. Client can use R_AVKON_TBUF_POPUP_FIELD_DEFAULT_NUMBER_FORMAT if desired, or provide its own resource.

static IMPORT_C CAknQueryValueNumberArray* CAknQueryValueNumberArray::NewLC ( TInt aResourceId ) [static]

See NewL.

IMPORT_C void CAknQueryValueNumberArray::SetArray

(

NumberArray &

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:

aknqueryvaluenumber.h

CAknQueryValueNumberArray Class Reference

Capability Information

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation