TreeMultiItemBase Class Reference

#include <TreeMultiItemBase.h>

Inheritance diagram for TreeMultiItemBase:

Collaboration diagram for TreeMultiItemBase:

List of all members.

Public Member Functions

virtual ~TreeMultiItemBase ()

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

Private Attributes

TreeMultiItemNode * _parent

bool m_Selected

Detailed Description

Definition at line 28 of file TreeMultiItemBase.h.

Constructor & Destructor Documentation

TreeMultiItemBase::TreeMultiItemBase ( TreeMultiItemNode * parent ) [protected]

virtual TreeMultiItemBase::~TreeMultiItemBase ( ) [virtual]

Member Function Documentation

int TreeMultiItemBase::GetType ( ) const [inline]

Definition at line 66 of file TreeMultiItemBase.h.

References _type.

00066 { return _type; };

TreeMultiItemNode* TreeMultiItemBase::GetParent ( ) const [inline]

Definition at line 67 of file TreeMultiItemBase.h.

References _parent.

Referenced by wxTreeMultiItem::GetParent().

00067 { return _parent; };

Here is the caller graph for this function:

wxString TreeMultiItemBase::GetName ( ) const [inline]

Get name of this node

Definition at line 70 of file TreeMultiItemBase.h.

References _name.

00070                                  {
00071                 return _name;
00072         };

void TreeMultiItemBase::SetName ( wxString const & NewName ) [inline]

Set name of the item

Definition at line 74 of file TreeMultiItemBase.h.

References _name.

00075   {
00076     this->_name = NewName;
00077   }

virtual TreeMultiItemRoot* TreeMultiItemBase::IsTreeMultiItemRoot ( ) const [inline, virtual]

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

Reimplemented in TreeMultiItemRoot.

Definition at line 82 of file TreeMultiItemBase.h.

Referenced by wxTreeMultiItem::IsNodeItem(), and wxTreeMultiItem::IsRootItem().

00082                                                                {
00083                 return 0;
00084         };

Here is the caller graph for this function:

virtual TreeMultiItemWindow* TreeMultiItemBase::IsTreeMultiItemWindow ( ) const [inline, virtual]

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

Reimplemented in TreeMultiItemWindow.

Definition at line 89 of file TreeMultiItemBase.h.

Referenced by wxTreeMultiItem::IsWindowItem().

00089                                                                    {
00090                 return 0;
00091         };

Here is the caller graph for this function:

virtual TreeMultiItemNode* TreeMultiItemBase::IsTreeMultiItemNode ( ) const [inline, virtual]

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

Reimplemented in TreeMultiItemNode.

Definition at line 96 of file TreeMultiItemBase.h.

Referenced by wxTreeMultiItem::IsExpanded(), and wxTreeMultiItem::IsNodeItem().

00096                                                                {
00097                 return 0;
00098         };

Here is the caller graph for this function:

void TreeMultiItemBase::SetExcluded ( bool excluded ) [inline]

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

Definition at line 101 of file TreeMultiItemBase.h.

References _excluded.

00101                                         {
00102                 _excluded = excluded;
00103         };

void TreeMultiItemBase::SetX ( int x ) [inline]

Get / Set routine for X

Definition at line 106 of file TreeMultiItemBase.h.

References _x.

00106                          {
00107                 _x = x;
00108         };

int TreeMultiItemBase::GetX ( ) const [inline]

Definition at line 110 of file TreeMultiItemBase.h.

References _x.

00110                          {
00111                 return _x;
00112         };

void TreeMultiItemBase::SetY ( int y ) [inline]

Get / Set routine for Y

Definition at line 115 of file TreeMultiItemBase.h.

References _y.

00115                          {
00116                 _y = y;
00117         };

int TreeMultiItemBase::GetY ( ) const [inline]

Definition at line 119 of file TreeMultiItemBase.h.

References _y.

00119                          {
00120                 return _y;
00121         };

void TreeMultiItemBase::SetHeight ( int height ) [inline]

Get / Set routine for height

Definition at line 124 of file TreeMultiItemBase.h.

References _height.

00124                                    {
00125                 _height = height;
00126         };

int TreeMultiItemBase::GetHeight ( ) const [inline]

Definition at line 128 of file TreeMultiItemBase.h.

References _height.

00128                               {
00129                 return _height;
00130         };

void TreeMultiItemBase::SetWidth ( int width ) [inline]

Get / Set routine for width

Definition at line 133 of file TreeMultiItemBase.h.

References _width.

00133                                  {
00134                 _width = width;
00135         };

int TreeMultiItemBase::GetWidth ( ) const [inline]

Definition at line 137 of file TreeMultiItemBase.h.

References _width.

00137                              {
00138                 return _width;
00139         };

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())

Referenced by wxTreeMultiItem::IsVisible().

Here is the caller graph for this function:

bool TreeMultiItemBase::IsExcluded ( ) const [inline]

Definition at line 155 of file TreeMultiItemBase.h.

References _excluded.

Referenced by wxTreeMultiItem::IsExcluded().

00155                                 {
00156                 return _excluded;
00157         };

Here is the caller graph for this function:

bool TreeMultiItemBase::IsSelected ( void ) const [inline]

checks if the item is selected

Definition at line 163 of file TreeMultiItemBase.h.

References m_Selected.

Referenced by wxTreeMultiItem::IsSelected().

00164   {
00165     return this->m_Selected;
00166   }

Here is the caller graph for this function:

void TreeMultiItemBase::Select ( void ) [inline]

mark the current item as selected

Definition at line 169 of file TreeMultiItemBase.h.

References m_Selected.

00170   {
00171     this->m_Selected = true;
00172   }

void TreeMultiItemBase::ToggleSelection ( void ) [inline]

toggle the selection status

Definition at line 175 of file TreeMultiItemBase.h.

References m_Selected.

00176   {
00177     this->m_Selected = !(this->m_Selected);
00178   }

void TreeMultiItemBase::Unselect ( void ) [inline]

unmark the item

Definition at line 181 of file TreeMultiItemBase.h.

References m_Selected.

00182   {
00183     this->m_Selected = false;
00184   }

Member Data Documentation

wxString TreeMultiItemBase::_name [protected]

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

Definition at line 35 of file TreeMultiItemBase.h.

Referenced by GetName(), and SetName().

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)

Definition at line 40 of file TreeMultiItemBase.h.

Referenced by IsExcluded(), and SetExcluded().

int TreeMultiItemBase::_type [protected]

Type of instanced class

Definition at line 43 of file TreeMultiItemBase.h.

Referenced by GetType().

int TreeMultiItemBase::_x [protected]

Calculated X, Y position

Definition at line 46 of file TreeMultiItemBase.h.

Referenced by GetX(), and SetX().

int TreeMultiItemBase::_y [protected]

Definition at line 46 of file TreeMultiItemBase.h.

Referenced by GetY(), and SetY().

int TreeMultiItemBase::_width [protected]

Calculated width, height

Definition at line 49 of file TreeMultiItemBase.h.

Referenced by GetWidth(), and SetWidth().

int TreeMultiItemBase::_height [protected]

Definition at line 49 of file TreeMultiItemBase.h.

Referenced by GetHeight(), and SetHeight().

TreeMultiItemNode* TreeMultiItemBase::_parent [private]

Definition at line 210 of file TreeMultiItemBase.h.

Referenced by GetParent().

bool TreeMultiItemBase::m_Selected [private]

Definition at line 213 of file TreeMultiItemBase.h.

Referenced by IsSelected(), Select(), ToggleSelection(), and Unselect().

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

/home/guigues/bbtk-build-tmp/bbtk/kernel/src/ThirdParty/wx/treemultictrl/TreeMultiItemBase.h


Public Member Functions
virtual	~TreeMultiItemBase ()
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
Private Attributes
TreeMultiItemNode *	_parent
bool	m_Selected