S60 3rd Edition API Reference: CAknQueryValue Class Reference

CAknQueryValue Class Reference

API published in: S60 1st Ed

Link against: avkon.lib

Capability Information

Required Capabilities

None

#include <aknqueryvalue.h>

Inherits MAknQueryValue.

Inherited by CAknQueryValueDate, CAknQueryValueDuration, CAknQueryValueNumber, CAknQueryValuePhone, CAknQueryValueText, and CAknQueryValueTime.

Detailed Description

Pure virtual class that adds some standard functionality for queries.

Public Member Functions

virtual IMPORT_C void SetQueryMode (MAknQueryValue::TMode aMode)
 Set QueryMode to be whether query or settingpage -mode.
virtual IMPORT_C void SetSettingPageResourceIds (TInt aSettingPageResourceId, TInt aSettingPageEditorResourceId)
 Override the default resource IDs used if a Setting Page mode query is put up.
virtual IMPORT_C void SetAutoAppend (TBool aAppend)
 Set the QueryValue to append a new user value, if distinct from former value.
virtual IMPORT_C void AppendValueIfNewL ()
 Method to add the current value to the QueryValueArray if it is new.

Protected Member Functions

TBool IsValidIndex (TInt aIndex)
 Check if given index is valid within descriptor array.

Protected Attributes

TBitFlags16 iFlags
 Flags that determine behavior.
TInt iSettingPageResourceId
 Resource id for setting page.
TInt iSettingPageEditorResourceId
 Resource id for editor in setting page.

Member Function Documentation

virtual IMPORT_C void CAknQueryValue::AppendValueIfNewL (   )  [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"

Implements MAknQueryValue.

Reimplemented in CAknQueryValueDate, CAknQueryValueDuration, CAknQueryValueNumber, CAknQueryValuePhone, CAknQueryValueText, and CAknQueryValueTime.

TBool CAknQueryValue::IsValidIndex ( TInt  aIndex  )  [inline, protected]
 

Check if given index is valid within descriptor array.

virtual IMPORT_C void CAknQueryValue::SetAutoAppend ( TBool  aAppend  )  [virtual]
 

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

Implements MAknQueryValue.

virtual IMPORT_C void CAknQueryValue::SetQueryMode ( MAknQueryValue::TMode  aMode  )  [virtual]
 

Set QueryMode to be whether query or settingpage -mode.

Implements MAknQueryValue.

virtual IMPORT_C void CAknQueryValue::SetSettingPageResourceIds ( TInt  aSettingPageResourceId,
TInt  aSettingPageEditorResourceId
)  [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:
aSettingPageResourceId AVKON_SETTING_PAGE resource ID to use
aSettingPageEditorResourceId Editor resource ID to use (takes precedence)

Implements MAknQueryValue.

Field Documentation

TBitFlags16 CAknQueryValue::iFlags [protected]
 

Flags that determine behavior.

TInt CAknQueryValue::iSettingPageEditorResourceId [protected]
 

Resource id for editor in setting page.

TInt CAknQueryValue::iSettingPageResourceId [protected]
 

Resource id for setting page.

The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top