Symbian^3 Product Developer Library >

CXCFWTree Class Reference

class CXCFWTree : public CBase

CXCFWTree implements MXCFWTree interface. It owns the actual tree nodes.

XCFW.lib
Since
Series 60 3.1

Inherits from

Public Member Functions
~CXCFWTree()
IMPORT_C MXCFWNode *AddNodeL(CGECOObjectBase *, MXCFWNode *, MXCFWNode *)
IMPORT_C MXCFWNode *AddNodeL(CGECOObjectBase *, MXCFWNode *)
IMPORT_C MXCFWNode *AddNodeL(CGECOObjectBase *)
const TDesC &DTDName()
IMPORT_C voidGetChildNodesL(MXCFWNode *, RNodeArray &)
IMPORT_C voidGetNodesOfTypeL(const TDesC &, RNodeArray &, MXCFWNode *, TBool)
IMPORT_C TBoolIsLocked()
IMPORT_C voidMoveNodeL(MXCFWNode *, MXCFWNode *, MXCFWNode *)
IMPORT_C CXCFWTree *NewL()
IMPORT_C RNodeArray &Nodes()
IMPORT_C voidRemoveNodeL(MXCFWNode *)
IMPORT_C MXCFWNode *Root()
voidSetDTDNameL(const TDesC &)
IMPORT_C voidSetLocked(TBool)
Private Member Functions
CXCFWTree()
voidConstructL()
voidRemoveFromNodeList(MXCFWNode *)
voidRemoveNodeRecursiveL(MXCFWNode *)
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()
Private Attributes
TBool iClientListDirty
HBufC *iDTDName
TBool iLocked
RInternalNodeArray iNodeList
RNodeArray iNodeListForClient
CXCFWNode *iRoot

Constructor & Destructor Documentation

CXCFWTree()

CXCFWTree()[private]

C++ default constructor.

~CXCFWTree()

IMPORT_C~CXCFWTree()[virtual]

Destructor.

Member Functions Documentation

AddNodeL(CGECOObjectBase *, MXCFWNode *, MXCFWNode *)

IMPORT_C MXCFWNode *AddNodeL(CGECOObjectBase *aData,
MXCFWNode *aParent,
MXCFWNode *aInsertBefore
)

From MXCFWTree. Adds a node to tree. aData ownership is transferred at the beginning of the method!

Parameters

CGECOObjectBase * aData
MXCFWNode * aParent
MXCFWNode * aInsertBefore

AddNodeL(CGECOObjectBase *, MXCFWNode *)

IMPORT_C MXCFWNode *AddNodeL(CGECOObjectBase *aData,
MXCFWNode *aParent
)

From MXCFWTree. Adds a node to tree. aData ownership is transferred at the beginning of the method!

Parameters

CGECOObjectBase * aData
MXCFWNode * aParent

AddNodeL(CGECOObjectBase *)

IMPORT_C MXCFWNode *AddNodeL(CGECOObjectBase *aData)

From MXCFWTree. Adds a node to tree. aData ownership is transferred at the beginning of the method!

Parameters

CGECOObjectBase * aData

ConstructL()

voidConstructL()[private]

By default Symbian 2nd phase constructor is private.

DTDName()

const TDesC &DTDName()

From MXCFWTree. Returns default DTD name for this tree's content

GetChildNodesL(MXCFWNode *, RNodeArray &)

IMPORT_C voidGetChildNodesL(MXCFWNode *aParent,
RNodeArray &aNodeList
)

From MXCFWTree. Gets list of child nodes for a parent

Parameters

MXCFWNode * aParent
RNodeArray & aNodeList

GetNodesOfTypeL(const TDesC &, RNodeArray &, MXCFWNode *, TBool)

IMPORT_C voidGetNodesOfTypeL(const TDesC &aType,
RNodeArray &aNodeList,
MXCFWNode *aParent,
TBoolaRecursive
)

From MXCFWTree. Gets list of certain type nodes.

Parameters

const TDesC & aType
RNodeArray & aNodeList
MXCFWNode * aParent
TBool aRecursive

IsLocked()

IMPORT_C TBoolIsLocked()

From MXCFWTree. Returns lock status

MoveNodeL(MXCFWNode *, MXCFWNode *, MXCFWNode *)

IMPORT_C voidMoveNodeL(MXCFWNode *aNodeToMove,
MXCFWNode *aNewParent,
MXCFWNode *aInsertBefore
)

From MXCFWTree. Moves a node in tree to another position.

Parameters

MXCFWNode * aNodeToMove
MXCFWNode * aNewParent
MXCFWNode * aInsertBefore

NewL()

IMPORT_C CXCFWTree *NewL()[static]

Two-phased constructor.

Nodes()

IMPORT_C RNodeArray &Nodes()

From MXCFWTree. Returns tree nodes in an MXCFWNode pointer array

RemoveFromNodeList(MXCFWNode *)

voidRemoveFromNodeList(MXCFWNode *aNode)[private]
Removes a tree node branch starting from given node recursively
Since
Series 60 3.1

Parameters

MXCFWNode * aNode

RemoveNodeL(MXCFWNode *)

IMPORT_C voidRemoveNodeL(MXCFWNode *aNodeToRemove)

From MXCFWTree. Removes a node from tree.

Parameters

MXCFWNode * aNodeToRemove

RemoveNodeRecursiveL(MXCFWNode *)

voidRemoveNodeRecursiveL(MXCFWNode *aNode)[private]
Removes a tree node branch starting from given node recursively
Since
Series 60 3.1

Parameters

MXCFWNode * aNode

Root()

IMPORT_C MXCFWNode *Root()

From MXCFWTree. Returns tree root node.

SetDTDNameL(const TDesC &)

voidSetDTDNameL(const TDesC &aName)

From MXCFWTree. Sets DTD name for this tree content

Parameters

const TDesC & aName

SetLocked(TBool)

IMPORT_C voidSetLocked(TBoolaLockStatus)

From MXCFWTree. Sets tree structure lock status

Parameters

TBool aLockStatus

Member Data Documentation

TBool iClientListDirty

TBool iClientListDirty[private]

HBufC * iDTDName

HBufC *iDTDName[private]

TBool iLocked

TBool iLocked[private]

RInternalNodeArray iNodeList

RInternalNodeArray iNodeList[private]

RNodeArray iNodeListForClient

RNodeArray iNodeListForClient[private]

CXCFWNode * iRoot

CXCFWNode *iRoot[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.