Symbian^3 Product Developer Library >

CHnMdBaseKey Class Reference

class CHnMdBaseKey : public CBase

Abstract Class representing keys used in XML configuration. These keys can become parameters for LIW requests for example. Deriving classes defines particular key types like integers or strings.

hierarchynavigatorengine
Since
S60 v5.0

Inherits from

Public Member Functions
~CHnMdBaseKey()
IMPORT_C voidAddSubKeyL(CHnMdBaseKey *)
CHnMdBaseKey *CopyLC()
IMPORT_C CHnMdBaseKey *EvaluateLC(const CLiwGenericParamList &, TInt)
voidGetKeyContent(TInt &)
voidGetKeyContent(TInt64 &)
const TDesC &KeyContent()
const TDesC8 &KeyName()
const RPointerArray< CHnMdBaseKey > &SubKeys()
IMPORT_C voidToGenericParamListL(CLiwGenericParamList &)
IMPORT_C voidToVariantL(TLiwVariant &)
Protected Member Functions
CHnMdBaseKey()
voidBaseConstructL(TXmlEngElement)
voidBaseConstructL(const CHnMdBaseKey *)
voidDoEvaluateL(const CLiwGenericParamList &, TInt)
voidEvaluateKeyValueL(const CLiwGenericParamList &, TInt)
voidSetKeyContentL(const TXmlEngAttr &)
voidSetKeyNameL(const TXmlEngAttr &)
voidSetKeyNameL(const TDesC8 &)
voidSetKeyOrNameL(const TXmlEngElement &)
voidSetSubKeysL(const TXmlEngElement &)
voidSetSubKeysL(const CHnMdBaseKey *)
voidSetValueL(const TXmlEngElement &)
voidSetValueL(const TDesC8 &)
voidSetValueL(const TDesC &)
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Protected Attributes
RBuf iContent
RBuf8 iKeyName
RPointerArray< CHnMdBaseKey >iSubKeys

Constructor & Destructor Documentation

CHnMdBaseKey()

CHnMdBaseKey()[protected]

Standard constructor.

Since
S60 v5.0

~CHnMdBaseKey()

~CHnMdBaseKey()[virtual]

Standard destructor.

Member Functions Documentation

AddSubKeyL(CHnMdBaseKey *)

IMPORT_C voidAddSubKeyL(CHnMdBaseKey *aKey)

Adds a sub key.

Since
S60 v5.0

Parameters

CHnMdBaseKey * aKeyNew key.

BaseConstructL(TXmlEngElement)

voidBaseConstructL(TXmlEngElementaElement)[protected]

Symbian constructor for performing 2nd stage construction.

Since
S60 v5.0

Parameters

TXmlEngElement aElementXML DOM Element.

BaseConstructL(const CHnMdBaseKey *)

voidBaseConstructL(const CHnMdBaseKey *aKey)[protected]

Symbian constructor for performing 2nd stage construction.

Since
S60 v5.0

Parameters

const CHnMdBaseKey * aKeyKey.

CopyLC()

CHnMdBaseKey *CopyLC()[pure virtual]

Factory method.

since S60 v5.0

DoEvaluateL(const CLiwGenericParamList &, TInt)

voidDoEvaluateL(const CLiwGenericParamList &aParamList,
TIntaPos = 0
)[protected]

Evaluates key - sets params.

Since
S60 v5.0

Parameters

const CLiwGenericParamList & aParamListList of parameters.
TInt aPos = 0Position in the param list. Default is 0.

EvaluateKeyValueL(const CLiwGenericParamList &, TInt)

voidEvaluateKeyValueL(const CLiwGenericParamList &aParamList,
TIntaPos = 0
)[protected, virtual]

Evaluates the key value.

Since
S60 v5.0

Parameters

const CLiwGenericParamList & aParamListList of parameters.
TInt aPos = 0Position in the param list. Default is 0.

EvaluateLC(const CLiwGenericParamList &, TInt)

IMPORT_C CHnMdBaseKey *EvaluateLC(const CLiwGenericParamList &aParamList,
TIntaPos = 0
)

Evaluates key - sets params.

Since
S60 v5.0

Parameters

const CLiwGenericParamList & aParamListList of parameters.
TInt aPos = 0Position of the item in the items group.

GetKeyContent(TInt &)

voidGetKeyContent(TInt &aContent)const [virtual]

Getter - key content.

Since
S60 v5.0

Parameters

TInt & aContentOutput content.

GetKeyContent(TInt64 &)

voidGetKeyContent(TInt64 &aContent)const [virtual]

Getter - key content.

Since
S60 v5.0

Parameters

TInt64 & aContentOutput content.

KeyContent()

const TDesC &KeyContent()const [virtual]

Getter - key content. since S60 v5.0

KeyName()

const TDesC8 &KeyName()const

Getter - key name. since S60 v5.0

SetKeyContentL(const TXmlEngAttr &)

voidSetKeyContentL(const TXmlEngAttr &aContent)[protected]

Sets key content.

Since
S60 v5.0

Parameters

const TXmlEngAttr & aContentXML Attribute.

SetKeyNameL(const TXmlEngAttr &)

voidSetKeyNameL(const TXmlEngAttr &aName)[protected]

Sets key name.

Since
S60 v5.0

Parameters

const TXmlEngAttr & aNameName of new key.

SetKeyNameL(const TDesC8 &)

voidSetKeyNameL(const TDesC8 &aName)[protected]

Sets key name.

Since
S60 v5.0

Parameters

const TDesC8 & aNameNew key name.

SetKeyOrNameL(const TXmlEngElement &)

voidSetKeyOrNameL(const TXmlEngElement &aElement)[protected]

Sets key or name.

Since
S60 v5.0

Parameters

const TXmlEngElement & aElementXML DOM Element.

SetSubKeysL(const TXmlEngElement &)

voidSetSubKeysL(const TXmlEngElement &aElement)[protected]

Sets sub keys.

Since
S60 v5.0

Parameters

const TXmlEngElement & aElementXML DOM Element.

SetSubKeysL(const CHnMdBaseKey *)

voidSetSubKeysL(const CHnMdBaseKey *aKey)[protected]

Sets sub keys.

Since
S60 v5.0

Parameters

const CHnMdBaseKey * aKeyNew key.

SetValueL(const TXmlEngElement &)

voidSetValueL(const TXmlEngElement &aElement)[protected]

Sets value.

Since
S60 v5.0

Parameters

const TXmlEngElement & aElementXML DOM Element.

SetValueL(const TDesC8 &)

voidSetValueL(const TDesC8 &aValue)[protected]

Sets value.

Since
S60 v5.0

Parameters

const TDesC8 & aValueNew value.

SetValueL(const TDesC &)

voidSetValueL(const TDesC &aValue)[protected]

Sets value.

Since
S60 v5.0

Parameters

const TDesC & aValueNew value.

SubKeys()

const RPointerArray< CHnMdBaseKey > &SubKeys()const

Getter - sub keys.

Since
S60 v5.0

ToGenericParamListL(CLiwGenericParamList &)

IMPORT_C voidToGenericParamListL(CLiwGenericParamList &aRet)const [virtual]

Change to generic param list.

Since
S60 v5.0

Parameters

CLiwGenericParamList & aRetOutput generic param list.

ToVariantL(TLiwVariant &)

IMPORT_C voidToVariantL(TLiwVariant &aRet)const [virtual]

Change to variant.

Since
S60 v5.0

Parameters

TLiwVariant & aRetOutput variant.

Member Data Documentation

RBuf iContent

RBuf iContent[protected]

Key content. Own.

RBuf8 iKeyName

RBuf8 iKeyName[protected]

Key name (8-bit descriptor). Own.

RPointerArray< CHnMdBaseKey > iSubKeys

RPointerArray< CHnMdBaseKey >iSubKeys[protected]

Subkeys (i.e. to handle with actions). Own.

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.