TreeMultiItemBase Class Reference

Inheritance diagram for TreeMultiItemBase:

Public Member Functions
int	GetType () const
TreeMultiItemNode *	GetParent () const
wxString	GetName () const
void	SetName (wxString const &NewName)
virtual TreeMultiItemRoot *	IsTreeMultiItemRoot () const
virtual TreeMultiItemWindow *	IsTreeMultiItemWindow () const
virtual TreeMultiItemNode *	IsTreeMultiItemNode () const
void	SetExcluded (bool excluded)
void	SetX (int x)
int	GetX () const
void	SetY (int y)
int	GetY () const
void	SetHeight (int height)
int	GetHeight () const
void	SetWidth (int width)
int	GetWidth () const
bool	IsVisible ()
bool	IsExcluded () const
bool	IsSelected (void) const
void	Select (void)
void	ToggleSelection (void)
void	Unselect (void)

Protected Member Functions
	TreeMultiItemBase (TreeMultiItemNode *parent)

Protected Attributes
wxString	_name
bool	_excluded
int	_type
int	_x
int	_y
int	_width
int	_height

Constructor & Destructor Documentation

TreeMultiItemBase()

TreeMultiItemBase::TreeMultiItemBase ( TreeMultiItemNode *  parent )

protected

TreeMultiItemBase This class is the node of the whole tree. All the other classes in the tree descend from this node. It contains the type of the class without using RTTI. NOTE: this class cannot be constructed directly

Member Function Documentation

GetName()

wxString TreeMultiItemBase::GetName ( ) const

inline

Get name of this node

IsSelected()

bool TreeMultiItemBase::IsSelected ( void  ) const

inline

checks if the item is selected

IsTreeMultiItemNode()

virtual TreeMultiItemNode * TreeMultiItemBase::IsTreeMultiItemNode ( ) const

inlinevirtual

returns the instance pointer if the current node is a TreeMultiItemNode, and nullptr when it's not.

Reimplemented in TreeMultiItemNode.

IsTreeMultiItemRoot()

virtual TreeMultiItemRoot * TreeMultiItemBase::IsTreeMultiItemRoot ( ) const

inlinevirtual

returns the instance pointer if the current node is a TreeMultiItemRoot, and nullptr when it's not.

Reimplemented in TreeMultiItemRoot.

IsTreeMultiItemWindow()

virtual TreeMultiItemWindow * TreeMultiItemBase::IsTreeMultiItemWindow ( ) const

inlinevirtual

returns the instance pointer if the current node is a TreeMultiItemWindow, and nullptr when it's not.

Reimplemented in TreeMultiItemWindow.

IsVisible()

bool TreeMultiItemBase::IsVisible

(

)

Returns true when this item is drawn somewhere in the tree. Whenever a parent of this node is collapsed, it is not visible and it is not necessary to perform i.e. redraw actions.

It also returns false when this node is excluded from the tree.

See also

wxTreeMultiCtrl::Exclude(), wxTreeMultiCtrl::Include())

Select()

void TreeMultiItemBase::Select ( void  )

inline

mark the current item as selected

SetExcluded()

void TreeMultiItemBase::SetExcluded ( bool  excluded )

inline

Sets or resets the excluded flag. When excluded node is not visible

SetHeight()

void TreeMultiItemBase::SetHeight ( int  height )

inline

Get / Set routine for height

SetName()

void TreeMultiItemBase::SetName ( wxString const &  NewName )

inline

Set name of the item

SetWidth()

void TreeMultiItemBase::SetWidth ( int  width )

inline

Get / Set routine for width

SetX()

void TreeMultiItemBase::SetX ( int  x )

inline

Get / Set routine for X

SetY()

void TreeMultiItemBase::SetY ( int  y )

inline

Get / Set routine for Y

ToggleSelection()

void TreeMultiItemBase::ToggleSelection ( void  )

inline

toggle the selection status

Unselect()

void TreeMultiItemBase::Unselect ( void  )

inline

unmark the item

Member Data Documentation

_excluded

bool TreeMultiItemBase::_excluded

protected

Flag to indicate that this node is visible or not. The Node can be temporarily excluded by flagging it. This has also consequences for all the children of this node (if any)

_name

wxString TreeMultiItemBase::_name

protected

Name property of this item, useful for assigning / coupling external variable reference to this item. It is not mandatory

_type

int TreeMultiItemBase::_type

protected

Type of instanced class

_width

int TreeMultiItemBase::_width

protected

Calculated width, height

_x

int TreeMultiItemBase::_x

protected

Calculated X, Y position

---

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

• /github/workspace/src/components/wxtreemultictrl/TreeMultiItemBase.h
• /github/workspace/src/components/wxtreemultictrl/TreeMultiItemBase.cpp