Symbian^3 Application Developer Library >

Alf::AlfBranch Class Reference

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

Inherits from

Public Member Functions
AlfBranch ( IAlfMap *, IAlfMap *)
AlfBranch ()
~AlfBranch ()
OSN_IMPORT bool boolean ()
OSN_IMPORT IAlfBranch * branch ()
OSN_IMPORT IAlfVariantType * childData (int)
OSN_IMPORT IAlfMap * childData ()
OSN_IMPORT const UString & childName (int)
OSN_IMPORT uint childrenCount ()
OSN_IMPORT IAlfBranch * clone ()
OSN_IMPORT IAlfContainer * container ()
OSN_IMPORT IAlfModelBase * customData ()
OSN_IMPORT IAlfMap * data ()
OSN_IMPORT int integer ()
OSN_IMPORT IAlfMap * map ()
OSN_IMPORT bool operator== (const IAlfVariantType &)
OSN_IMPORT double real ()
OSN_IMPORT void set ( IAlfVariantType &)
OSN_IMPORT void setChildData ( IAlfMap *)
OSN_IMPORT void setData ( IAlfMap *)
OSN_IMPORT void sort (const IAlfSortFunction &)
OSN_IMPORT const UString & string ()
OSN_IMPORT IAlfVariantType::Type type ()
OSN_IMPORT uint uinteger ()
Private Member Functions
void construct ( 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_IMPORT AlfBranch ( IAlfMap * aData,
IAlfMap * aChildData
)
Parameterized Constructor
Exceptions
std::bad_alloc

Since
S60 ?S60_version

Parameters

IAlfMap * aData
IAlfMap * aChildData

AlfBranch()

OSN_IMPORT AlfBranch ( )
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 bool boolean ( ) 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 ( int aIndex ) [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 ( int aIndex ) [virtual]
Since
S60 ?S60_version

Parameters

int aIndex -

childrenCount()

OSN_IMPORT uint childrenCount ( ) [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 *)

void construct ( 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 int integer ( ) 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 bool operator== ( 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 & aOther object to compare against.

real()

OSN_IMPORT double real ( ) 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 void set ( 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 & aValue The new value.

setChildData(IAlfMap *)

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

Parameters

IAlfMap * aChildData -

setData(IAlfMap *)

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

Parameters

IAlfMap * aData -

sort(const IAlfSortFunction &)

OSN_IMPORT void sort ( 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::Type type ( ) const [virtual]

Get the data type.From IAlfVariantType Interface

Since
S60 ?S60_version

uinteger()

OSN_IMPORT uint uinteger ( ) 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.