TreeMultiItemWindow Class Reference

#include <TreeMultiItemWindow.h>

Inheritance diagram for TreeMultiItemWindow:

Collaboration diagram for TreeMultiItemWindow:

List of all members.

Public Member Functions

TreeMultiItemWindow (TreeMultiItemNode *parent, const wxString &name=wxEmptyString)

virtual ~TreeMultiItemWindow ()

virtual TreeMultiItemWindow * IsTreeMultiItemWindow () const

void AssignWindow (wxWindow *wnd)

wxWindow * GetWindow ()

void SetFrontSpacing (int frontSpacing)

int GetFrontSpacing () const

void SetTopSpacing (int topSpacing)

int GetTopSpacing () const

void SetHorizontalSpan (bool span)

bool GetHorizontalSpan () const

int GetType () const

TreeMultiItemNode * GetParent () const

wxString GetName () const

void SetName (wxString const &NewName)

virtual TreeMultiItemRoot * IsTreeMultiItemRoot () 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 Attributes

wxString _name

bool _excluded

int _type

int _x

int _y

int _width

int _height

Private Attributes

wxWindow * _window

int _topSpacing

int _frontSpacing

bool _span

Detailed Description

Definition at line 27 of file TreeMultiItemWindow.h.

Constructor & Destructor Documentation

TreeMultiItemWindow::TreeMultiItemWindow	(	TreeMultiItemNode *	parent,
		const wxString &	name = `wxEmptyString`
	)

virtual TreeMultiItemWindow::~TreeMultiItemWindow ( ) [virtual]

Member Function Documentation

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

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

Reimplemented from TreeMultiItemBase.

Definition at line 45 of file TreeMultiItemWindow.h.

00045                                                                    {
00046                 return (TreeMultiItemWindow *)this;
00047         };

void TreeMultiItemWindow::AssignWindow ( wxWindow * wnd )

Assigns the given window to this TreeMultiItemWindow, and also destroys the present window. If the assigned window is 0, this item is not drawn and removed from the tree visually

wxWindow* TreeMultiItemWindow::GetWindow ( ) [inline]

Get window method

Definition at line 55 of file TreeMultiItemWindow.h.

References _window.

00055                               {
00056                 return _window;
00057         };

void TreeMultiItemWindow::SetFrontSpacing ( int frontSpacing ) [inline]

Definition at line 60 of file TreeMultiItemWindow.h.

References _frontSpacing.

00060                                                {
00061                 _frontSpacing = frontSpacing;
00062         };

int TreeMultiItemWindow::GetFrontSpacing ( ) const [inline]

Definition at line 64 of file TreeMultiItemWindow.h.

References _frontSpacing.

00064                                     {
00065                 return _frontSpacing;
00066         };

void TreeMultiItemWindow::SetTopSpacing ( int topSpacing ) [inline]

Definition at line 68 of file TreeMultiItemWindow.h.

References _topSpacing.

00068                                            {
00069                 _topSpacing = topSpacing;
00070         };

int TreeMultiItemWindow::GetTopSpacing ( ) const [inline]

Definition at line 72 of file TreeMultiItemWindow.h.

References _topSpacing.

00072                                   {
00073                 return _topSpacing;
00074         };

void TreeMultiItemWindow::SetHorizontalSpan ( bool span ) [inline]

Definition at line 78 of file TreeMultiItemWindow.h.

References _span.

00078                                           {
00079                 _span = span;
00080         };

bool TreeMultiItemWindow::GetHorizontalSpan ( ) const [inline]

Definition at line 84 of file TreeMultiItemWindow.h.

References _span.

00084                                        {
00085                 return _span;
00086         };

int TreeMultiItemBase::GetType ( ) const [inline, inherited]

Definition at line 66 of file TreeMultiItemBase.h.

References TreeMultiItemBase::_type.

00066 { return _type; };

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

Definition at line 67 of file TreeMultiItemBase.h.

References TreeMultiItemBase::_parent.

Referenced by wxTreeMultiItem::GetParent().

00067 { return _parent; };

Here is the caller graph for this function:

wxString TreeMultiItemBase::GetName ( ) const [inline, inherited]

Get name of this node

Definition at line 70 of file TreeMultiItemBase.h.

References TreeMultiItemBase::_name.

00070                                  {
00071                 return _name;
00072         };

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

Set name of the item

Definition at line 74 of file TreeMultiItemBase.h.

References TreeMultiItemBase::_name.

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

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

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 TreeMultiItemNode* TreeMultiItemBase::IsTreeMultiItemNode ( ) const [inline, virtual, inherited]

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, inherited]

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

Definition at line 101 of file TreeMultiItemBase.h.

References TreeMultiItemBase::_excluded.

00101                                         {
00102                 _excluded = excluded;
00103         };

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

Get / Set routine for X

Definition at line 106 of file TreeMultiItemBase.h.

References TreeMultiItemBase::_x.

00106                          {
00107                 _x = x;
00108         };

int TreeMultiItemBase::GetX ( ) const [inline, inherited]

Definition at line 110 of file TreeMultiItemBase.h.

References TreeMultiItemBase::_x.

00110                          {
00111                 return _x;
00112         };

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

Get / Set routine for Y

Definition at line 115 of file TreeMultiItemBase.h.

References TreeMultiItemBase::_y.

00115                          {
00116                 _y = y;
00117         };

int TreeMultiItemBase::GetY ( ) const [inline, inherited]

Definition at line 119 of file TreeMultiItemBase.h.

References TreeMultiItemBase::_y.

00119                          {
00120                 return _y;
00121         };

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

Get / Set routine for height

Definition at line 124 of file TreeMultiItemBase.h.

References TreeMultiItemBase::_height.

00124                                    {
00125                 _height = height;
00126         };

int TreeMultiItemBase::GetHeight ( ) const [inline, inherited]

Definition at line 128 of file TreeMultiItemBase.h.

References TreeMultiItemBase::_height.

00128                               {
00129                 return _height;
00130         };

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

Get / Set routine for width

Definition at line 133 of file TreeMultiItemBase.h.

References TreeMultiItemBase::_width.

00133                                  {
00134                 _width = width;
00135         };

int TreeMultiItemBase::GetWidth ( ) const [inline, inherited]

Definition at line 137 of file TreeMultiItemBase.h.

References TreeMultiItemBase::_width.

00137                              {
00138                 return _width;
00139         };

bool TreeMultiItemBase::IsVisible ( ) [inherited]

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, inherited]

Definition at line 155 of file TreeMultiItemBase.h.

References TreeMultiItemBase::_excluded.

Referenced by wxTreeMultiItem::IsExcluded().

00155                                 {
00156                 return _excluded;
00157         };

Here is the caller graph for this function:

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

checks if the item is selected

Definition at line 163 of file TreeMultiItemBase.h.

References TreeMultiItemBase::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, inherited]

mark the current item as selected

Definition at line 169 of file TreeMultiItemBase.h.

References TreeMultiItemBase::m_Selected.

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

void TreeMultiItemBase::ToggleSelection ( void ) [inline, inherited]

toggle the selection status

Definition at line 175 of file TreeMultiItemBase.h.

References TreeMultiItemBase::m_Selected.

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

void TreeMultiItemBase::Unselect ( void ) [inline, inherited]

unmark the item

Definition at line 181 of file TreeMultiItemBase.h.

References TreeMultiItemBase::m_Selected.

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

Member Data Documentation

wxWindow* TreeMultiItemWindow::_window [private]

The simple control, or complex sizer that represents this window in the TreeMultiCtrl

Definition at line 32 of file TreeMultiItemWindow.h.

Referenced by GetWindow().

int TreeMultiItemWindow::_topSpacing [private]

Top and front extra spacings, added to X, Y

Definition at line 35 of file TreeMultiItemWindow.h.

Referenced by GetTopSpacing(), and SetTopSpacing().

int TreeMultiItemWindow::_frontSpacing [private]

Definition at line 35 of file TreeMultiItemWindow.h.

Referenced by GetFrontSpacing(), and SetFrontSpacing().

bool TreeMultiItemWindow::_span [private]

Spanning flag

Definition at line 38 of file TreeMultiItemWindow.h.

Referenced by GetHorizontalSpan(), and SetHorizontalSpan().

wxString TreeMultiItemBase::_name [protected, inherited]

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 TreeMultiItemBase::GetName(), and TreeMultiItemBase::SetName().

bool TreeMultiItemBase::_excluded [protected, inherited]

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 TreeMultiItemBase::IsExcluded(), and TreeMultiItemBase::SetExcluded().

int TreeMultiItemBase::_type [protected, inherited]

Type of instanced class

Definition at line 43 of file TreeMultiItemBase.h.

Referenced by TreeMultiItemBase::GetType().

int TreeMultiItemBase::_x [protected, inherited]

Calculated X, Y position

Definition at line 46 of file TreeMultiItemBase.h.

Referenced by TreeMultiItemBase::GetX(), and TreeMultiItemBase::SetX().

int TreeMultiItemBase::_y [protected, inherited]

Definition at line 46 of file TreeMultiItemBase.h.

Referenced by TreeMultiItemBase::GetY(), and TreeMultiItemBase::SetY().

int TreeMultiItemBase::_width [protected, inherited]

Calculated width, height

Definition at line 49 of file TreeMultiItemBase.h.

Referenced by TreeMultiItemBase::GetWidth(), and TreeMultiItemBase::SetWidth().

int TreeMultiItemBase::_height [protected, inherited]

Definition at line 49 of file TreeMultiItemBase.h.

Referenced by TreeMultiItemBase::GetHeight(), and TreeMultiItemBase::SetHeight().

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

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


Public Member Functions
	TreeMultiItemWindow (TreeMultiItemNode *parent, const wxString &name=wxEmptyString)
virtual	~TreeMultiItemWindow ()
virtual TreeMultiItemWindow *	IsTreeMultiItemWindow () const
void	AssignWindow (wxWindow *wnd)
wxWindow *	GetWindow ()
void	SetFrontSpacing (int frontSpacing)
int	GetFrontSpacing () const
void	SetTopSpacing (int topSpacing)
int	GetTopSpacing () const
void	SetHorizontalSpan (bool span)
bool	GetHorizontalSpan () const
int	GetType () const
TreeMultiItemNode *	GetParent () const
wxString	GetName () const
void	SetName (wxString const &NewName)
virtual TreeMultiItemRoot *	IsTreeMultiItemRoot () 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 Attributes
wxString	_name
bool	_excluded
int	_type
int	_x
int	_y
int	_width
int	_height
Private Attributes
wxWindow *	_window
int	_topSpacing
int	_frontSpacing
bool	_span