Symbian^3 Application 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 void AddSubKeyL ( CHnMdBaseKey *)
CHnMdBaseKey * CopyLC ()
IMPORT_C CHnMdBaseKey * EvaluateLC (const CLiwGenericParamList &, TInt )
void GetKeyContent ( TInt &)
void GetKeyContent ( TInt64 &)
const TDesC & KeyContent ()
const TDesC8 & KeyName ()
const RPointerArray < CHnMdBaseKey > & SubKeys ()
IMPORT_C void ToGenericParamListL ( CLiwGenericParamList &)
IMPORT_C void ToVariantL ( TLiwVariant &)
Protected Member Functions
CHnMdBaseKey ()
void BaseConstructL ( TXmlEngElement )
void BaseConstructL (const CHnMdBaseKey *)
void DoEvaluateL (const CLiwGenericParamList &, TInt )
void EvaluateKeyValueL (const CLiwGenericParamList &, TInt )
void SetKeyContentL (const TXmlEngAttr &)
void SetKeyNameL (const TXmlEngAttr &)
void SetKeyNameL (const TDesC8 &)
void SetKeyOrNameL (const TXmlEngElement &)
void SetSubKeysL (const TXmlEngElement &)
void SetSubKeysL (const CHnMdBaseKey *)
void SetValueL (const TXmlEngElement &)
void SetValueL (const TDesC8 &)
void SetValueL (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 void AddSubKeyL ( CHnMdBaseKey * aKey )

Adds a sub key.

Since
S60 v5.0

Parameters

CHnMdBaseKey * aKey New key.

BaseConstructL(TXmlEngElement)

void BaseConstructL ( TXmlEngElement aElement ) [protected]

Symbian constructor for performing 2nd stage construction.

Since
S60 v5.0

Parameters

TXmlEngElement aElement XML DOM Element.

BaseConstructL(const CHnMdBaseKey *)

void BaseConstructL ( const CHnMdBaseKey * aKey ) [protected]

Symbian constructor for performing 2nd stage construction.

Since
S60 v5.0

Parameters

const CHnMdBaseKey * aKey Key.

CopyLC()

CHnMdBaseKey * CopyLC ( ) [pure virtual]

Factory method.

since S60 v5.0

DoEvaluateL(const CLiwGenericParamList &, TInt)

void DoEvaluateL ( const CLiwGenericParamList & aParamList,
TInt aPos = 0
) [protected]

Evaluates key - sets params.

Since
S60 v5.0

Parameters

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

EvaluateKeyValueL(const CLiwGenericParamList &, TInt)

void EvaluateKeyValueL ( const CLiwGenericParamList & aParamList,
TInt aPos = 0
) [protected, virtual]

Evaluates the key value.

Since
S60 v5.0

Parameters

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

EvaluateLC(const CLiwGenericParamList &, TInt)

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

Evaluates key - sets params.

Since
S60 v5.0

Parameters

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

GetKeyContent(TInt &)

void GetKeyContent ( TInt & aContent ) const [virtual]

Getter - key content.

Since
S60 v5.0

Parameters

TInt & aContent Output content.

GetKeyContent(TInt64 &)

void GetKeyContent ( TInt64 & aContent ) const [virtual]

Getter - key content.

Since
S60 v5.0

Parameters

TInt64 & aContent Output 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 &)

void SetKeyContentL ( const TXmlEngAttr & aContent ) [protected]

Sets key content.

Since
S60 v5.0

Parameters

const TXmlEngAttr & aContent XML Attribute.

SetKeyNameL(const TXmlEngAttr &)

void SetKeyNameL ( const TXmlEngAttr & aName ) [protected]

Sets key name.

Since
S60 v5.0

Parameters

const TXmlEngAttr & aName Name of new key.

SetKeyNameL(const TDesC8 &)

void SetKeyNameL ( const TDesC8 & aName ) [protected]

Sets key name.

Since
S60 v5.0

Parameters

const TDesC8 & aName New key name.

SetKeyOrNameL(const TXmlEngElement &)

void SetKeyOrNameL ( const TXmlEngElement & aElement ) [protected]

Sets key or name.

Since
S60 v5.0

Parameters

const TXmlEngElement & aElement XML DOM Element.

SetSubKeysL(const TXmlEngElement &)

void SetSubKeysL ( const TXmlEngElement & aElement ) [protected]

Sets sub keys.

Since
S60 v5.0

Parameters

const TXmlEngElement & aElement XML DOM Element.

SetSubKeysL(const CHnMdBaseKey *)

void SetSubKeysL ( const CHnMdBaseKey * aKey ) [protected]

Sets sub keys.

Since
S60 v5.0

Parameters

const CHnMdBaseKey * aKey New key.

SetValueL(const TXmlEngElement &)

void SetValueL ( const TXmlEngElement & aElement ) [protected]

Sets value.

Since
S60 v5.0

Parameters

const TXmlEngElement & aElement XML DOM Element.

SetValueL(const TDesC8 &)

void SetValueL ( const TDesC8 & aValue ) [protected]

Sets value.

Since
S60 v5.0

Parameters

const TDesC8 & aValue New value.

SetValueL(const TDesC &)

void SetValueL ( const TDesC & aValue ) [protected]

Sets value.

Since
S60 v5.0

Parameters

const TDesC & aValue New value.

SubKeys()

const RPointerArray < CHnMdBaseKey > & SubKeys ( ) const

Getter - sub keys.

Since
S60 v5.0

ToGenericParamListL(CLiwGenericParamList &)

IMPORT_C void ToGenericParamListL ( CLiwGenericParamList & aRet ) const [virtual]

Change to generic param list.

Since
S60 v5.0

Parameters

CLiwGenericParamList & aRet Output generic param list.

ToVariantL(TLiwVariant &)

IMPORT_C void ToVariantL ( TLiwVariant & aRet ) const [virtual]

Change to variant.

Since
S60 v5.0

Parameters

TLiwVariant & aRet Output 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.