TreeMultiItemNode Class Reference

#include <TreeMultiItemNode.h>

Inheritance diagram for TreeMultiItemNode:

Inheritance graph
[legend]
Collaboration diagram for TreeMultiItemNode:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 TreeMultiItemNode (TreeMultiItemNode *parent, const wxString &caption=wxEmptyString, const wxString &name=wxEmptyString)
virtual ~TreeMultiItemNode ()
virtual TreeMultiItemNode * IsTreeMultiItemNode () const
void AddNode (TreeMultiItemBase *node)
void InsertNode (TreeMultiItemBase *NodePtr, size_t Position)
void Clear ()
void DeleteNode (TreeMultiItemBase *node)
void DeleteNode (int index)
TreeMultiItemBase * RemoveNode (TreeMultiItemBase *node)
TreeMultiItemBase * RemoveNode (int index)
int GetNodeCount () const
TreeMultiItemBase * GetNode (int index) const
int Index (TreeMultiItemBase *node, bool searchFromEnd=false) const
TreeMultiItemBase * GetNodeNext (int &cookie) const
TreeMultiItemBase * First () const
TreeMultiItemBase * Last () const
void Fold (bool expand)
const wxString & GetCaption () const
bool IsExpanded () const
int GetType () const
TreeMultiItemNode * GetParent () const
wxString GetName () const
void SetName (wxString const &NewName)
virtual TreeMultiItemRoot * IsTreeMultiItemRoot () const
virtual TreeMultiItemWindow * IsTreeMultiItemWindow () 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

TreeMultiItemBaseArray _items
wxString _caption
bool _nodeExpanded
wxTreeItemAttr m_Attributes

Detailed Description

Definition at line 42 of file TreeMultiItemNode.h.

Constructor & Destructor Documentation

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

virtual TreeMultiItemNode::~TreeMultiItemNode (  )  [virtual]

Member Function Documentation

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

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

Reimplemented from TreeMultiItemBase.

Definition at line 61 of file TreeMultiItemNode.h.

00061                                                                {
00062                 return (TreeMultiItemNode *)this;
00063         };

void TreeMultiItemNode::AddNode ( TreeMultiItemBase *  node  ) 

void TreeMultiItemNode::InsertNode ( TreeMultiItemBase *  NodePtr,
size_t  Position 
)

void TreeMultiItemNode::Clear (  ) 

Referenced by wxTreeMultiCtrl::DeleteAllItems().

Here is the caller graph for this function:

void TreeMultiItemNode::DeleteNode ( TreeMultiItemBase *  node  ) 

void TreeMultiItemNode::DeleteNode ( int  index  ) 

TreeMultiItemBase* TreeMultiItemNode::RemoveNode ( TreeMultiItemBase *  node  ) 

TreeMultiItemBase* TreeMultiItemNode::RemoveNode ( int  index  ) 

int TreeMultiItemNode::GetNodeCount (  )  const

Referenced by wxTreeMultiCtrl::GetChildrenCount().

Here is the caller graph for this function:

TreeMultiItemBase* TreeMultiItemNode::GetNode ( int  index  )  const

int TreeMultiItemNode::Index ( TreeMultiItemBase *  node,
bool  searchFromEnd = false 
) const

TreeMultiItemBase* TreeMultiItemNode::GetNodeNext ( int &  cookie  )  const

TreeMultiItemBase* TreeMultiItemNode::First (  )  const

Referenced by wxTreeMultiCtrl::GetFirstRoot().

Here is the caller graph for this function:

TreeMultiItemBase* TreeMultiItemNode::Last (  )  const

Referenced by wxTreeMultiCtrl::GetLastRoot().

Here is the caller graph for this function:

void TreeMultiItemNode::Fold ( bool  expand  )  [inline]

Fold function sets or clears the expanded flag. Note when excluded from drawing, this will have no effect on redraw

Definition at line 87 of file TreeMultiItemNode.h.

References _nodeExpanded.

00087                                {
00088                 if(_nodeExpanded != expand)
00089                         _nodeExpanded = expand;
00090         };

const wxString& TreeMultiItemNode::GetCaption (  )  const [inline]

Return caption

Definition at line 93 of file TreeMultiItemNode.h.

References _caption.

00093                                            {
00094                 return _caption;
00095         };

bool TreeMultiItemNode::IsExpanded (  )  const [inline]

Returns true if the node is expanded. Subnodes can still be collapsed though

Definition at line 98 of file TreeMultiItemNode.h.

References _nodeExpanded.

Referenced by wxTreeMultiItem::IsExpanded().

00098                                 {
00099                 return _nodeExpanded;
00100         };

Here is the caller graph for this function:

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

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:

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

TreeMultiItemBaseArray TreeMultiItemNode::_items [private]

Definition at line 45 of file TreeMultiItemNode.h.

wxString TreeMultiItemNode::_caption [private]

Caption of this node.

Definition at line 48 of file TreeMultiItemNode.h.

Referenced by GetCaption().

bool TreeMultiItemNode::_nodeExpanded [private]

Indicates if this node is expanded (true) or collapsed (false)

Definition at line 51 of file TreeMultiItemNode.h.

Referenced by Fold(), and IsExpanded().

wxTreeItemAttr TreeMultiItemNode::m_Attributes [private]

visual attributes of the node

Definition at line 54 of file TreeMultiItemNode.h.

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:
Generated on Wed Nov 12 11:38:16 2008 for BBTK by  doxygen 1.5.6