Collapse all Symbian^3 Product Developer Library

MNcdQueryItem Class Reference

class MNcdQueryItem : public MCatalogsBase

Describes a query item.

A common interface for all query items. A query item defines one element of a whole query e.g. credit card number in a purchase information query.

All query items that are not optional must be answered/filled before completing a query.

MNcdQuery

Inherits from

MNcdQueryItem
- MCatalogsBase

Public Member Functions
const TDesC &	Description()
TBool	IsOptional()
const TDesC &	Label()
const TDesC &	Message()
TSemantics	Semantics()
TNcdInterfaceId	Type()

Protected Member Functions
	~MNcdQueryItem()

Public Member Enumerations
enum	TSemantics { ESemanticsNone, ESemanticsUnknown, ESemanticsMsisdn, ESemanticsEmailAddress, ESemanticsCreditCardNumber, ESemanticsCreditCardExpirationYear, ESemanticsCreditCardExpirationMonth, ESemanticsCreditCardOwner, ESemanticsCreditCardVerificationCode, ESemanticsCreditCardType, ESemanticsAddressStreet, ESemanticsAddressZipCode, ESemanticsAddressCity, ESemanticsAddressCountry, ESemanticsUserName, ESemanticsPassword, ESemanticsPinCode, ESemanticsImei }

Public Member Enumerations

enum

TSemantics {
ESemanticsNone, ESemanticsUnknown, ESemanticsMsisdn, ESemanticsEmailAddress, ESemanticsCreditCardNumber, ESemanticsCreditCardExpirationYear, ESemanticsCreditCardExpirationMonth, ESemanticsCreditCardOwner, ESemanticsCreditCardVerificationCode, ESemanticsCreditCardType, ESemanticsAddressStreet, ESemanticsAddressZipCode, ESemanticsAddressCity, ESemanticsAddressCountry, ESemanticsUserName, ESemanticsPassword, ESemanticsPinCode, ESemanticsImei
}

Constructor & Destructor Documentation

~MNcdQueryItem()

~MNcdQueryItem

(

)

[protected, inline, virtual]

Destructor.

MCatalogsBase::~MCatalogsBase

Member Functions Documentation

Description()

const TDesC &

Description

(

)

const [pure virtual]

Getter for query item description. Additional longer description text about the query element, intended for context help

IsOptional()

TBool

IsOptional

(

)

const [pure virtual]

Checks whether this query item is optional i.e. does not need to be answered/filled before the query is accepted.

Label()

const TDesC &

Label

(

)

const [pure virtual]

Getter for query item label. Labels are used to identify the what the query item is e.g. "username" or "credit card owner". Typically displayed next to the actual item.

Message()

const TDesC &

Message

(

)

const [pure virtual]

Getter for query item message. Optionally displayed in a question dialog body close to the query item. Can offer information/advice on what the user should input e.g. "Please enter the cardholder's name".

Semantics()

TSemantics

Semantics

(

)

const [pure virtual]

Semantics of the query item.

This can be used to act differently for semantically different query items that have the same basic type (as indicated by Type()).

Type()

TNcdInterfaceId

Type

(

)

const [pure virtual]

Type of the query.

Member Enumerations Documentation

Enum TSemantics

Query item semantics

Enumerators

ESemanticsNone	No specific semantics specified
ESemanticsUnknown	Unknown/unsupported semantics specified
ESemanticsMsisdn	MSISDN (phone number)
ESemanticsEmailAddress	Email address
ESemanticsCreditCardNumber	Credit card number
ESemanticsCreditCardExpirationYear	Credit card expiration year
ESemanticsCreditCardExpirationMonth	Credit card expiration month
ESemanticsCreditCardOwner	Credit card owner
ESemanticsCreditCardVerificationCode	Credit card verification code
ESemanticsCreditCardType	Credit card type
ESemanticsAddressStreet	Street address
ESemanticsAddressZipCode	ZIP code
ESemanticsAddressCity	City
ESemanticsAddressCountry	Country
ESemanticsUserName	User name
ESemanticsPassword	Password
ESemanticsPinCode	PIN code
ESemanticsImei	IMEI