makVrv::DtElementIDHierarchyNode Class Reference

The DtElementIDHierarchyNode class will contain information about an element, its children and its parent. More...

Public Types
enum	DisplayState {   Unknown = -1, Collapsed = 0, Shown = 1, Ghosted = 2,   Expanded = 3, InitiallyShown = 4, InitiallyExpanded = 5, Hidden = 6 }
	Used to keep track of state of item as it should appear visually in the hierarchy. More...
enum	Flags { ShouldHaveChildren = 0x00000001, CollapseIfNoChildren = 0x00000002 }
typedef std::vector < DtElementIDHierarchyNode * >	ChildHierarchyNodes

Public Member Functions
	DtElementIDHierarchyNode ()
	DtElementIDHierarchyNode (DtElementID id, const DtElementIDHierarchyState &)
	If created from a change attribute, will allocate and delete children in destructor.
	DtElementIDHierarchyNode (DtElementID)
	DtElementIDHierarchyNode (const DtElementIDHierarchyNode &orig)
virtual	~DtElementIDHierarchyNode ()
DtElementIDHierarchyNode &	operator= (const DtElementIDHierarchyNode &)
bool	operator== (const DtElementIDHierarchyNode &) const
bool	operator!= (const DtElementIDHierarchyNode &rhs) const
bool	hasChild (DtElementID child) const
bool	addChild (DtElementIDHierarchyNode *)
void	removeChild (DtElementID child)
void	copyOriginal (const DtElementIDHierarchyNode &orig)
const makVrv::DtElementID &	uniqueId () const
const ChildHierarchyNodes &	children () const
void	removeAllChildren ()
void	setParent (DtElementIDHierarchyNode *p)
DtElementIDHierarchyNode *	parent ()
const DtElementIDHierarchyNode *	parent () const
virtual bool	childInHierarchy (DtElementID id) const
	Returns true if the child is in the hierarchy node tree.
void	setFlags (int flags)
int	flags () const
void	setDisplayState (DisplayState)
DisplayState	displayState () const

Protected Attributes
DtElementIDHierarchyNode *	myParent
ChildHierarchyNodes	myChildren
DtElementID	myId
bool	myCleanupChildren
int	myFlags
DisplayState	myDisplayState

Detailed Description

The DtElementIDHierarchyNode class will contain information about an element, its children and its parent.

Member Typedef Documentation

typedef std::vector<DtElementIDHierarchyNode*> makVrv::DtElementIDHierarchyNode::ChildHierarchyNodes

Member Enumeration Documentation

enum makVrv::DtElementIDHierarchyNode::DisplayState

Used to keep track of state of item as it should appear visually in the hierarchy.

Enumerator:

Unknown
Collapsed
Shown
Ghosted
Expanded
InitiallyShown
InitiallyExpanded	This will be set in the case of no children or parent. If this continues to be the case, the item should be shown, else, if this item gets children in the future, it will be changed to expanded
Hidden	Special state to keep initially expanded first shown.

enum makVrv::DtElementIDHierarchyNode::Flags

Enumerator:

ShouldHaveChildren
CollapseIfNoChildren	Set this flag if the item should have children, but does not yet.

Constructor & Destructor Documentation

makVrv::DtElementIDHierarchyNode::DtElementIDHierarchyNode

(

)

makVrv::DtElementIDHierarchyNode::DtElementIDHierarchyNode	(	DtElementID	id,
		const DtElementIDHierarchyState &
	)

If created from a change attribute, will allocate and delete children in destructor.

makVrv::DtElementIDHierarchyNode::DtElementIDHierarchyNode

(

DtElementID

)

makVrv::DtElementIDHierarchyNode::DtElementIDHierarchyNode

(

const DtElementIDHierarchyNode &

orig

)

virtual makVrv::DtElementIDHierarchyNode::~DtElementIDHierarchyNode ( )

virtual

Member Function Documentation

DtElementIDHierarchyNode& makVrv::DtElementIDHierarchyNode::operator=

(

const DtElementIDHierarchyNode &

)

bool makVrv::DtElementIDHierarchyNode::operator==

(

const DtElementIDHierarchyNode &

)

const

bool makVrv::DtElementIDHierarchyNode::operator!= ( const DtElementIDHierarchyNode &  rhs ) const

inline

bool makVrv::DtElementIDHierarchyNode::hasChild

(

DtElementID

child

)

const

bool makVrv::DtElementIDHierarchyNode::addChild

(

DtElementIDHierarchyNode *

)

void makVrv::DtElementIDHierarchyNode::removeChild

(

DtElementID

child

)

void makVrv::DtElementIDHierarchyNode::copyOriginal

(

const DtElementIDHierarchyNode &

orig

)

const makVrv::DtElementID& makVrv::DtElementIDHierarchyNode::uniqueId

(

)

const

const ChildHierarchyNodes& makVrv::DtElementIDHierarchyNode::children

(

)

const

void makVrv::DtElementIDHierarchyNode::removeAllChildren

(

)

void makVrv::DtElementIDHierarchyNode::setParent

(

DtElementIDHierarchyNode *

p

)

DtElementIDHierarchyNode* makVrv::DtElementIDHierarchyNode::parent

(

)

const DtElementIDHierarchyNode* makVrv::DtElementIDHierarchyNode::parent

(

)

const

virtual bool makVrv::DtElementIDHierarchyNode::childInHierarchy ( DtElementID  id ) const

virtual

Returns true if the child is in the hierarchy node tree.

void makVrv::DtElementIDHierarchyNode::setFlags

(

int

flags

)

int makVrv::DtElementIDHierarchyNode::flags

(

)

const

void makVrv::DtElementIDHierarchyNode::setDisplayState

(

DisplayState

)

DisplayState makVrv::DtElementIDHierarchyNode::displayState

(

)

const

Member Data Documentation

DtElementIDHierarchyNode* makVrv::DtElementIDHierarchyNode::myParent

protected

ChildHierarchyNodes makVrv::DtElementIDHierarchyNode::myChildren

protected

DtElementID makVrv::DtElementIDHierarchyNode::myId

protected

bool makVrv::DtElementIDHierarchyNode::myCleanupChildren

protected

int makVrv::DtElementIDHierarchyNode::myFlags

protected

DisplayState makVrv::DtElementIDHierarchyNode::myDisplayState

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-4-branch/include/vrvCore/DtElementIDHierarchy.h