Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Related Pages

exotkTree_Tree Class Reference

Describe a Tree Structure. More...

#include <exotkTree_Tree.hxx>

Inheritance diagram for exotkTree_Tree:

[legend]Collaboration diagram for exotkTree_Tree:

[legend]List of all members.

Public Methods
void *	operator new (size_t, void *anAddress)
	OCC new. More...
void *	operator new (size_t size)
	OCC new. More...
void	operator delete (void *anAddress)
	OCC delete. More...
Standard_EXPORT	exotkTree_Tree ()
	Constructor. More...
virtual Standard_EXPORT	~exotkTree_Tree ()
	Destructor. More...
virtual Standard_EXPORT void	SetRoot (const Handle_exotkTree_TreeNode &aRoot)
	Set the root. More...
virtual Standard_EXPORT Handle_exotkTree_TreeNode	Root ()
	Return the Root. More...
virtual Standard_EXPORT void	SetData (const Handle_Standard_Transient &aData)
	Set a data associated to the tree. More...
virtual Standard_EXPORT Handle_Standard_Transient	Data ()
	Return the associated data. More...
virtual Standard_EXPORT Standard_Boolean	HasData ()
	Return True if a data is set. More...
virtual Standard_EXPORT TCollection_AsciiString	Dump ()
	Dump the tree in the returned string. More...
virtual Standard_EXPORT Standard_Boolean	RemoveUpdator (exotkTree_TreeUpdator *anUpdatorToRemove)
	Remove anUpdatorToRemove. More...
virtual Standard_EXPORT Standard_Boolean	AddUpdator (exotkTree_TreeUpdator *anUpdatorToAdd)
	Add anUpdatorToAdd. More...
virtual Standard_EXPORT Standard_Boolean	Expand (const Handle_exotkTree_TreeNode &aNodeToExpand, const Standard_Boolean Recursive)
	Expand aNodeToExpand. More...
virtual Standard_EXPORT Standard_Boolean	Collapse (const Handle_exotkTree_TreeNode &aNodeToCollapse)
	Collapse aNodeToCollapse. More...
virtual Standard_EXPORT Standard_Boolean	ToggleExpansion (const Handle_exotkTree_TreeNode &aNodeToToggle, const Standard_Boolean Recursive)
	Toggle the expansion of aNodeToToggle. More...
virtual Standard_EXPORT Standard_Boolean	SetVisible (const Handle_exotkTree_TreeNode &aNode)
	Set aNode* as visible.* More...
virtual Standard_EXPORT Standard_Boolean	UpdateNode (const Handle_exotkTree_TreeNode &aNodeToUpdate)
	Update aNodeToUpdate. More...
virtual Standard_EXPORT void	NotifyInsertItem (const Handle_exotkTree_TreeNode &aParentNode, const Handle_exotkTree_TreeNode &anInsertedNode, const Handle_exotkTree_TreeNode &aPositionNode)
	Notify to the updators, anInsertedNode* has been inserted.* More...
Standard_EXPORT const Handle_Standard_Type &	DynamicType () const
	Type management. More...
Standard_EXPORT Standard_Boolean	IsKind (const Handle_Standard_Type &) const
	Type management. More...
Protected Methods
virtual Standard_EXPORT Standard_Boolean	UpdatorExists (exotkTree_TreeUpdator *anUpdatorToCheck)
	Returns true if anUpdatorToCheck* exists.* More...
virtual Standard_EXPORT TCollection_AsciiString	DumpRec (const Handle_exotkTree_TreeNode &aNode, const Standard_Integer level=0)
	dump aNode* recursively.* More...
Protected Attributes
Handle_exotkTree_TreeNode	myRoot
Handle_Standard_Transient	myData
std::list< exotkTree_TreeUpdator *>	myUpdators
Friends
Standard_EXPORT friend Handle_Standard_Type &	exotkTree_Tree_Type_ ()
	Type management. More...

Detailed Description

Describe a Tree Structure.

Author:: Stephane Routelous

Definition at line 60 of file exotkTree_Tree.hxx.

Constructor & Destructor Documentation

exotkTree_Tree::exotkTree_Tree ( )

Constructor.

Definition at line 70 of file exotkTree_Tree.cxx.

exotkTree_Tree::~exotkTree_Tree ( ) [virtual]

Destructor.

Definition at line 83 of file exotkTree_Tree.cxx.

Member Function Documentation

exotkTree_Tree::AddUpdator ( exotkTree_TreeUpdator * anUpdatorToAdd ) [virtual]

Add anUpdatorToAdd.

Returns:
Standard_Boolean : false if anUpdatorToAdd already known
Parameters:

anUpdatorToAdd exotkTree_TreeUpdator*

Definition at line 211 of file exotkTree_Tree.cxx.
References myUpdators, and UpdatorExists().

exotkTree_Tree::Collapse ( const Handle_exotkTree_TreeNode & aNodeToCollapse ) [virtual]

Collapse aNodeToCollapse.

Returns:
Standard_Boolean
Parameters:

aNodeToCollapse const Handle_exotkTree_TreeNode&

Definition at line 314 of file exotkTree_Tree.cxx.
References exotkTree_TreeUpdator::CollapseNode(), myUpdators, and exotkMaterial_Datas::theIterator.

exotkTree_Tree::Data ( ) [virtual]

Return the associated data.

Warning:
Can be null
Returns:
Handle_Standard_Transient

Definition at line 135 of file exotkTree_Tree.cxx.
References myData.

exotkTree_Tree::Dump ( ) [virtual]

Dump the tree in the returned string.

Returns:
TCollection_AsciiString

Definition at line 159 of file exotkTree_Tree.cxx.
References DumpRec(), and myRoot.

exotkTree_Tree::DumpRec ( const Handle_exotkTree_TreeNode & aNode,

const Standard_Integer level = 0

) [protected, virtual]

dump aNode recursively.

Returns:
TCollection_AsciiString
Parameters:

aNode const Handle_exotkTree_TreeNode&

level const Standard_Integer = 0

Definition at line 182 of file exotkTree_Tree.cxx.
References exotkTree_ListIteratorOfListOfTreeNode::Initialize(), exotkTree_ListIteratorOfListOfTreeNode::More(), exotkTree_ListIteratorOfListOfTreeNode::Next(), and exotkTree_ListIteratorOfListOfTreeNode::Value().
Referenced by Dump().

Handle_Standard_Type & exotkTree_Tree::DynamicType ( ) const

Type management.

Returns:
const Handle_Standard_Type&

Reimplemented in exotkAIS_InteractiveObjectPopup, and exotkTree_Menu.

exotkTree_Tree::Expand ( const Handle_exotkTree_TreeNode & aNodeToExpand,

const Standard_Boolean Recursive

) [virtual]

Expand aNodeToExpand.

Returns:
Standard_Boolean
Parameters:

aNodeToExpand const Handle_exotkTree_TreeNode&

Recursive const Standard_Boolean

Definition at line 291 of file exotkTree_Tree.cxx.
References exotkTree_TreeUpdator::ExpandNode(), myUpdators, and exotkMaterial_Datas::theIterator.

exotkTree_Tree::HasData ( ) [virtual]

Return True if a data is set.

Returns:
Standard_Boolean

Definition at line 147 of file exotkTree_Tree.cxx.
References myData.

exotkTree_Tree::IsKind ( const Handle_Standard_Type & ) const

Type management.

Returns:
Standard_Boolean
Parameters:

const Handle_Standard_Type&

Reimplemented in exotkAIS_InteractiveObjectPopup, and exotkTree_Menu.

exotkTree_Tree::NotifyInsertItem ( const Handle_exotkTree_TreeNode & aParentNode,

const Handle_exotkTree_TreeNode & anInsertedNode,

const Handle_exotkTree_TreeNode & aPositionNode

) [virtual]

Notify to the updators, anInsertedNode has been inserted.

Parameters:

aParentNode const Handle_exotkTree_TreeNode&

anInsertedNode const Handle_exotkTree_TreeNode&

aPositionNode const Handle_exotkTree_TreeNode&

Definition at line 401 of file exotkTree_Tree.cxx.
References myUpdators, exotkTree_TreeUpdator::NotifyInsertItem(), and exotkMaterial_Datas::theIterator.

void exotkTree_Tree::operator delete ( void * anAddress ) [inline]

OCC delete.

Returns:
inline void
Parameters:

void *anAddress

Reimplemented in exotkAF_ViewPopup, exotkAIS_InteractiveObjectPopup, and exotkTree_Menu.
Definition at line 93 of file exotkTree_Tree.hxx.

void * exotkTree_Tree::operator new ( size_t size ) [inline]

OCC new.

Returns:
inline void*
Parameters:

size_t size

Reimplemented in exotkAF_ViewPopup, exotkAIS_InteractiveObjectPopup, and exotkTree_Menu.
Definition at line 82 of file exotkTree_Tree.hxx.

void * exotkTree_Tree::operator new ( size_t ,

void * anAddress

) [inline]

OCC new.

Returns:
inline void*
Parameters:

size_t

void * anAddress

Reimplemented in exotkAF_ViewPopup, exotkAIS_InteractiveObjectPopup, and exotkTree_Menu.
Definition at line 71 of file exotkTree_Tree.hxx.

exotkTree_Tree::RemoveUpdator ( exotkTree_TreeUpdator * anUpdatorToRemove ) [virtual]

Remove anUpdatorToRemove.

Returns:
Standard_Boolean : false if anUpdatorToRemove is unknown
Parameters:

anUpdatorToRemove exotkTree_TreeUpdator*

Definition at line 233 of file exotkTree_Tree.cxx.
References myUpdators, and exotkMaterial_Datas::theIterator.

exotkTree_Tree::Root ( ) [virtual]

Return the Root.

Warning:
it can be null
Returns:
Handle_exotkTree_TreeNode

Definition at line 96 of file exotkTree_Tree.cxx.
References myRoot.

exotkTree_Tree::SetData ( const Handle_Standard_Transient & aData ) [virtual]

Set a data associated to the tree.

Parameters:

aData const Handle_Standard_Transient&

Definition at line 123 of file exotkTree_Tree.cxx.
References myData.

exotkTree_Tree::SetRoot ( const Handle_exotkTree_TreeNode & aRoot ) [virtual]

Set the root.

Parameters:

aRoot const Handle_exotkTree_TreeNode&

Definition at line 110 of file exotkTree_Tree.cxx.
References myRoot.
Referenced by exotkAIS_InteractiveObjectPopup::Create(), and exotkAF_ViewPopup::Create().

exotkTree_Tree::SetVisible ( const Handle_exotkTree_TreeNode & aNode ) [virtual]

Set aNode as visible.

Returns:
Standard_Boolean
Parameters:

aNode const Handle_exotkTree_TreeNode&

Definition at line 362 of file exotkTree_Tree.cxx.
References myUpdators, exotkTree_TreeUpdator::SetVisible(), and exotkMaterial_Datas::theIterator.

exotkTree_Tree::ToggleExpansion ( const Handle_exotkTree_TreeNode & aNodeToToggle,

const Standard_Boolean Recursive

) [virtual]

Toggle the expansion of aNodeToToggle.

Returns:
Standard_Boolean
Parameters:

aNodeToToggle const Handle_exotkTree_TreeNode&

Recursive const Standard_Boolean

Definition at line 338 of file exotkTree_Tree.cxx.
References myUpdators, exotkMaterial_Datas::theIterator, and exotkTree_TreeUpdator::ToggleExpansion().

exotkTree_Tree::UpdateNode ( const Handle_exotkTree_TreeNode & aNodeToUpdate ) [virtual]

Update aNodeToUpdate.

Returns:
Standard_Boolean
Parameters:

aNodeToUpdate const Handle_exotkTree_TreeNode&

Definition at line 386 of file exotkTree_Tree.cxx.
References myUpdators, exotkMaterial_Datas::theIterator, and exotkTree_TreeUpdator::UpdateNode().

exotkTree_Tree::UpdatorExists ( exotkTree_TreeUpdator * anUpdatorToCheck ) [protected, virtual]

Returns true if anUpdatorToCheck exists.

Returns:
Standard_Boolean
Parameters:

anUpdatorToCheck exotkTree_TreeUpdator*

Definition at line 264 of file exotkTree_Tree.cxx.
References myUpdators, and exotkMaterial_Datas::theIterator.
Referenced by AddUpdator().

Friends And Related Function Documentation

Handle_Standard_Type & exotkTree_Tree::exotkTree_Tree_Type_ ( ) [friend]

Type management.

Returns:
friend Handle_Standard_Type&

Member Data Documentation

Handle_Standard_Transient exotkTree_Tree::myData [protected]

the associated data
Definition at line 272 of file exotkTree_Tree.hxx.
Referenced by Data(), HasData(), and SetData().

Handle_exotkTree_TreeNode exotkTree_Tree::myRoot [protected]

the Root node
Definition at line 270 of file exotkTree_Tree.hxx.
Referenced by Dump(), Root(), and SetRoot().

std::list<exotkTree_TreeUpdator*> exotkTree_Tree::myUpdators [protected]

the updators
Definition at line 275 of file exotkTree_Tree.hxx.
Referenced by AddUpdator(), Collapse(), Expand(), NotifyInsertItem(), RemoveUpdator(), SetVisible(), ToggleExpansion(), UpdateNode(), and UpdatorExists().

The documentation for this class was generated from the following files:

Generated on Wed Jan 23 12:18:42 2002 for exotk by

exotkTree_Tree Class Reference

Public Methods

Protected Methods

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation