Collapse all Symbian^3 Application Developer Library

MAknQueryValue Class Reference

class MAknQueryValue

Mixin class representing a value that is accessed as text.

The Value can be changed by creating an editor dialog, which may be either a query or a setting page or optionally by choosing an entry from an array of values. The array can be accessed as a descriptor array, and the value can be accessed as a descriptor.

Public Member Functions
	~MAknQueryValue ()
TBool	CreateEditorL ()
TInt	CurrentValueIndex ()
HBufC *	CurrentValueTextLC ()
const MDesCArray *	MdcArray ()
void	SetAutoAppend ( TBool )
void	SetCurrentValueIndex (const TInt )
void	SetQueryMode ( MAknQueryValue::TMode )
void	SetSettingPageResourceIds ( TInt , TInt )

Protected Member Functions
void	AppendValueIfNewL ()

Private Member Functions
IMPORT_C void	Reserved_MAknQueryValue ()

Public Member Enumerations
enum	TMode { EQueryMode , ESettingPageMode }

Protected Member Enumerations
enum	TFlagBits { ESettingPageModeBitIndex = 0, EAutoAppendBitIndex }

Constructor & Destructor Documentation

~MAknQueryValue()

~MAknQueryValue

(

)

[inline, virtual]

Member Functions Documentation

AppendValueIfNewL()

void

AppendValueIfNewL

(

)

[protected, pure virtual]

Method to add the current value to the QueryValueArray if it is new. The new value is not owned by QueryValue object, but is "given away"

CreateEditorL()

TBool

CreateEditorL

(

)

[pure virtual]

Creates an editor within context. If the value is edited and OK'd, the new value will be set as the current value. Otherwise the current value remains unchanged.

CurrentValueIndex()

TInt

CurrentValueIndex

(

)

const [pure virtual]

Returns the index in the array of the current value. If no matches, returns zero

CurrentValueTextLC()

HBufC *

CurrentValueTextLC

(

)

[pure virtual]

This should be implemented so that it returns the current value as text

MdcArray()

const MDesCArray *

MdcArray

(

)

const [pure virtual]

Returns the array as a descriptor array, ownership will be not passed

Reserved_MAknQueryValue()

IMPORT_C void

Reserved_MAknQueryValue

(

)

[private, virtual]

SetAutoAppend(TBool)

void

SetAutoAppend

(

TBool

aAppend

)

[pure virtual]

Set the QueryValue to append a new user value, if distinct from former value

Parameters

TBool aAppend

set/unset flag EAutoAppendBitIndex

SetCurrentValueIndex(const TInt)

void

SetCurrentValueIndex

(

const TInt

aIndex

)

[pure virtual]

Changes the current value to correspond to a value in the array.

Parameters

const TInt aIndex

index in array of value to set as current

SetQueryMode(MAknQueryValue::TMode)

void

SetQueryMode

(

MAknQueryValue::TMode

aMode

)

[pure virtual]

Set QueryMode to be whether query or settingpage -mode

TMode

Parameters

MAknQueryValue::TMode aMode

value from

SetSettingPageResourceIds(TInt, TInt)

void	SetSettingPageResourceIds	(	TInt	aSettingPageResourceId,
			TInt	aSettingPageEditorResourceId
		)	[pure virtual]

Override the default resource IDs used if a Setting Page mode query is put up. All Queryvalue implementations should have default resource set up. Hence this need not be called unless non-default resource is required.

THE IMPLEMENTATION OF THESE RESOURCE OVERRIDES IS RESERVED FOR FUTURE VERSIONS OF SERIES 60. NOT CURRENTLY FUNCTIONAL. DO NOT USE.

The rules for usage of these ids is the same as that for the CAknSettingPage constructors that take both these resources Editor Resource Setting Page Resource present present Both are used (but text & number overridden) = 0 present Editor resource is used via SP resource present = 0 default SP resource for the query type is used + this editor resource

The type of the editor resource is fixed. If editor resource override is being used, then the resource must be for that control type of editor used in the CAknQueryValueXXXX class.

Parameters

TInt aSettingPageResourceId	AVKON_SETTING_PAGE resource ID to use
TInt aSettingPageEditorResourceId	Editor resource ID to use (takes precedence)

Member Enumerations Documentation

Enum TFlagBits

If EAutoAppendBitIndex is set, the query value auto appends new values

Enumerators

ESettingPageModeBitIndex = 0
EAutoAppendBitIndex

Enum TMode

Possible modes are query & setting page

Enumerators

EQueryMode
ESettingPageMode