Symbian^3 Product Developer Library >

Alf::AlfBranch Class Reference

class Alf::AlfBranch : public Alf::IAlfBranch
Concrete implementation of the variant data type interface. IAlfBranchalfwidgetmodel.lib
Since
S60 ?S60_version Draft

Inherits from

Public Member Functions
AlfBranch(IAlfMap *, IAlfMap *)
AlfBranch()
~AlfBranch()
OSN_IMPORT boolboolean()
OSN_IMPORT IAlfBranch *branch()
OSN_IMPORT IAlfVariantType *childData(int)
OSN_IMPORT IAlfMap *childData()
OSN_IMPORT const UString &childName(int)
OSN_IMPORT uintchildrenCount()
OSN_IMPORT IAlfBranch *clone()
OSN_IMPORT IAlfContainer *container()
OSN_IMPORT IAlfModelBase *customData()
OSN_IMPORT IAlfMap *data()
OSN_IMPORT intinteger()
OSN_IMPORT IAlfMap *map()
OSN_IMPORT booloperator==(const IAlfVariantType &)
OSN_IMPORT doublereal()
OSN_IMPORT voidset(IAlfVariantType &)
OSN_IMPORT voidsetChildData(IAlfMap *)
OSN_IMPORT voidsetData(IAlfMap *)
OSN_IMPORT voidsort(const IAlfSortFunction &)
OSN_IMPORT const UString &string()
OSN_IMPORT IAlfVariantType::Typetype()
OSN_IMPORT uintuinteger()
Private Member Functions
voidconstruct(IAlfMap *, IAlfMap *)
Inherited Functions
Alf::IAlfBranch::~IAlfBranch()
Alf::IAlfVariantType::~IAlfVariantType()
Inherited Enumerations
Alf::IAlfVariantType:Type
Private Attributes
auto_ptr< AlfBranchDataImpl >mBranchData

Constructor & Destructor Documentation

AlfBranch(IAlfMap *, IAlfMap *)

OSN_IMPORTAlfBranch(IAlfMap *aData,
IAlfMap *aChildData
)
Parameterized Constructor
Exceptions
std::bad_alloc

Since
S60 ?S60_version

Parameters

IAlfMap * aData
IAlfMap * aChildData

AlfBranch()

OSN_IMPORTAlfBranch()
Default Constructor
Exceptions
std::bad_alloc

Since
S60 ?S60_version

~AlfBranch()

OSN_IMPORT~AlfBranch()
Destructor
Since
S60 ?S60_version

Member Functions Documentation

boolean()

OSN_IMPORT boolboolean()const [virtual]
Get the data value as an bool .From IAlfVariantType Interface Always throws an exception.
Exceptions
osncore::AlfDataException

Thrown with error code osncore::EInvalidVariantDataType always since AlfBranch is not boolean.

Since
S60 ?S60_version

branch()

OSN_IMPORT IAlfBranch *branch()[virtual]

Get the data value as Branch. From IAlfVariantType Interface

Since
S60 ?S60_version

childData(int)

OSN_IMPORT IAlfVariantType *childData(intaIndex)[virtual]
Since
S60 ?S60_version

Parameters

int aIndex-

childData()

OSN_IMPORT IAlfMap *childData()[virtual]
Since
S60 ?S60_version

childName(int)

OSN_IMPORT const UString &childName(intaIndex)[virtual]
Since
S60 ?S60_version

Parameters

int aIndex-

childrenCount()

OSN_IMPORT uintchildrenCount()[virtual]
Since
S60 ?S60_version

clone()

OSN_IMPORT IAlfBranch *clone()[virtual]
Function to Clone the Branch
Exceptions
std::bad_alloc

osncore::AlfDataException

Thrown with error code osncore::EInvalidBranchOperation if cloning fails.
Since
S60 ?S60_version

construct(IAlfMap *, IAlfMap *)

voidconstruct(IAlfMap *aData,
IAlfMap *aChildData
)[private]
2nd Phase Constructor
Since
S60 ?S60_version

Parameters

IAlfMap * aData
IAlfMap * aChildData

container()

OSN_IMPORT IAlfContainer *container()[virtual]
Get the data value as an Conatiner. From IAlfVariantType Interface
Exceptions
osncore::AlfDataException

Thrown with error code osncore::EInvalidVariantDataType always since AlfBranch is not a container.
Since
S60 ?S60_version

customData()

OSN_IMPORT IAlfModelBase *customData()[virtual]
Get the data value as a User Defined Data Pointer.
Exceptions
osncore::AlfDataException

Thrown with error code osncore::EInvalidVariantDataType always since AlfBranch is not a custom value.
Since
S60 ?S60_version

data()

OSN_IMPORT IAlfMap *data()[virtual]
Since
S60 ?S60_version

integer()

OSN_IMPORT intinteger()const [virtual]
Get the data value as an Integer .From IAlfVariantType Interface Always throws an exception.
Exceptions
osncore::AlfDataException

Thrown with error code osncore::EInvalidVariantDataType always since AlfBranch is not an integer.
Since
S60 ?S60_version

map()

OSN_IMPORT IAlfMap *map()[virtual]
Get the data value as Map. From IAlfVariantType Interface
Exceptions
osncore::AlfDataException

Thrown with error code osncore::EInvalidVariantDataType always since AlfBranch is not a map.
Since
S60 ?S60_version

operator==(const IAlfVariantType &)

OSN_IMPORT booloperator==(const IAlfVariantType &aOther)const
Equality comparison operator. Always throws an exception.
Exceptions
osncore::AlfDataException

Thrown with error code osncore::EInvalidBranchOperation always.
Since
S60 ?S60_version

Parameters

const IAlfVariantType & aOtherobject to compare against.

real()

OSN_IMPORT doublereal()const [virtual]
Get the data value as an bool .From IAlfVariantType Interface Always throws an exception.
Exceptions
osncore::AlfDataException

Thrown with error code osncore::EInvalidVariantDataType always since AlfBranch is not a real value.
Since
S60 ?S60_version

set(IAlfVariantType &)

OSN_IMPORT voidset(IAlfVariantType &aValue)[virtual]
Set the Data the variantData. From IAlfVariantType Interface Always throws an exception always.
Exceptions
osncore::AlfDataException

Thrown with error code osncore::EInvalidBranchOperation always. Use the setData API.
Since
S60 ?S60_version

Parameters

IAlfVariantType & aValueThe new value.

setChildData(IAlfMap *)

OSN_IMPORT voidsetChildData(IAlfMap *aChildData)[virtual]
Since
S60 ?S60_version

Parameters

IAlfMap * aChildData-

setData(IAlfMap *)

OSN_IMPORT voidsetData(IAlfMap *aData)[virtual]
Since
S60 ?S60_version

Parameters

IAlfMap * aData-

sort(const IAlfSortFunction &)

OSN_IMPORT voidsort(const IAlfSortFunction &aSortFunction)[virtual]
sorts the branch using user defined sort function.
Exceptions
osncore::AlfDataException

Thrown with error code osncore::EInvalidBranchOperation if sorting fails.
Since
S60 ?S60_version

Parameters

const IAlfSortFunction & aSortFunction- sort function. return void

string()

OSN_IMPORT const UString &string()const [virtual]
Get the data value as an Descriptor .From IAlfVariantType Interface
Exceptions
osncore::AlfDataException

Thrown with error code osncore::EInvalidVariantDataType always since AlfBranch is not a string value.
Since
S60 ?S60_version

type()

OSN_IMPORT IAlfVariantType::Typetype()const [virtual]

Get the data type.From IAlfVariantType Interface

Since
S60 ?S60_version

uinteger()

OSN_IMPORT uintuinteger()const [virtual]
Get the data value as unsigned int.From IAlfVariantType Interface Always throws an exception.
Exceptions
osncore::AlfDataException

Thrown with error code osncore::EInvalidVariantDataType always since AlfBranch is not an unsigned integer.
Since
S60 ?S60_version

Member Data Documentation

auto_ptr< AlfBranchDataImpl > mBranchData

auto_ptr< AlfBranchDataImpl >mBranchData[private]

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.