.. include:: headings.inc

.. currentmodule:: lib.mvctree

.. highlight:: python



.. _lib.mvctree.MVCTree:

==========================================================================================================================================
|phoenix_title|  **MVCTree**
==========================================================================================================================================

The main mvc tree class.



|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **MVCTree**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.mvctree.MVCTree_inheritance.png" alt="Inheritance diagram of MVCTree" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="Window.html" title="Window  is the base class for all windows and represents any visible object on screen." alt="" coords="407,6,487,37"/> <area shape="rect" id="node9" href="Panel.html" title="A panel is a window on which controls are placed." alt="" coords="536,6,608,37"/> <area shape="rect" id="node2" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="252,5,351,35"/> <area shape="rect" id="node4" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="125,6,197,37"/> <area shape="rect" id="node11" href="lib.mvctree.MVCTree.html" title="The main mvc tree class." alt="" coords="847,33,999,63"/> </map> 
   </p>

|


|super_classes| Known Superclasses
==================================

:class:`ScrolledWindow`

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~lib.mvctree.MVCTree.__init__`                                            
:meth:`~lib.mvctree.MVCTree.AddEditor`                                           
:meth:`~lib.mvctree.MVCTree.AddToSelection`                                      
:meth:`~lib.mvctree.MVCTree.Edit`                                                
:meth:`~lib.mvctree.MVCTree.EndEdit`                                             
:meth:`~lib.mvctree.MVCTree.GetAssumeChildren`                                   
:meth:`~lib.mvctree.MVCTree.GetBackgroundColour`                                 
:meth:`~lib.mvctree.MVCTree.GetCurrentRoot`                                      
:meth:`~lib.mvctree.MVCTree.GetDisplayText`                                      
:meth:`~lib.mvctree.MVCTree.GetFont`                                             
:meth:`~lib.mvctree.MVCTree.GetForegroundColour`                                 
:meth:`~lib.mvctree.MVCTree.GetLayoutEngine`                                     
:meth:`~lib.mvctree.MVCTree.GetModel`                                            
:meth:`~lib.mvctree.MVCTree.GetPainter`                                          
:meth:`~lib.mvctree.MVCTree.GetSelection`                                        Returns a tuple of selected nodes.
:meth:`~lib.mvctree.MVCTree.GetTransform`                                        
:meth:`~lib.mvctree.MVCTree.IsDoubleBuffered`                                    
:meth:`~lib.mvctree.MVCTree.IsExpanded`                                          
:meth:`~lib.mvctree.MVCTree.IsMultiSelect`                                       
:meth:`~lib.mvctree.MVCTree.IsSelected`                                          
:meth:`~lib.mvctree.MVCTree.LoadChildren`                                        
:meth:`~lib.mvctree.MVCTree.NodeAdded`                                           
:meth:`~lib.mvctree.MVCTree.NodeInserted`                                        
:meth:`~lib.mvctree.MVCTree.NodeRemoved`                                         
:meth:`~lib.mvctree.MVCTree.OnEraseBackground`                                   
:meth:`~lib.mvctree.MVCTree.OnKeyDown`                                           
:meth:`~lib.mvctree.MVCTree.OnKnobClick`                                         
:meth:`~lib.mvctree.MVCTree.OnMouse`                                             
:meth:`~lib.mvctree.MVCTree.OnNodeClick`                                         
:meth:`~lib.mvctree.MVCTree.OnPaint`                                             Ensures that the tree has been laid out and transformed, then calls the painter
:meth:`~lib.mvctree.MVCTree.OnSize`                                              
:meth:`~lib.mvctree.MVCTree.Refresh`                                             
:meth:`~lib.mvctree.MVCTree.RemoveEditor`                                        
:meth:`~lib.mvctree.MVCTree.RemoveFromSelection`                                 
:meth:`~lib.mvctree.MVCTree.SetAssumeChildren`                                   
:meth:`~lib.mvctree.MVCTree.SetBackgroundColour`                                 
:meth:`~lib.mvctree.MVCTree.SetDoubleBuffered`                                   By default MVCTree is double-buffered.
:meth:`~lib.mvctree.MVCTree.SetExpanded`                                         
:meth:`~lib.mvctree.MVCTree.SetFont`                                             
:meth:`~lib.mvctree.MVCTree.SetForegroundColour`                                 
:meth:`~lib.mvctree.MVCTree.SetModel`                                            Completely change the data to be displayed.
:meth:`~lib.mvctree.MVCTree.SetMultiSelect`                                      
:meth:`~lib.mvctree.MVCTree.SetSelection`                                        
================================================================================ ================================================================================


|


|api| Class API
===============
   

.. class:: MVCTree(ScrolledWindow)

   The main mvc tree class.

   .. method:: __init__(self, parent, id, model = None, layout = None, transform = None, painter = None, \*args, \*\*kwargs)


   .. method:: AddEditor(self, editor)


   .. method:: AddToSelection(self, nodeOrTuple, enableMulti = True, shiftMulti = False)


   .. method:: Edit(self, node)


   .. method:: EndEdit(self)


   .. method:: GetAssumeChildren(self)


   .. method:: GetBackgroundColour(self)


   .. method:: GetCurrentRoot(self)


   .. method:: GetDisplayText(self, node)


   .. method:: GetFont(self)


   .. method:: GetForegroundColour(self)


   .. method:: GetLayoutEngine(self)


   .. method:: GetModel(self)


   .. method:: GetPainter(self)


   .. method:: GetSelection(self)

      Returns a tuple of selected nodes.


   .. method:: GetTransform(self)


   .. method:: IsDoubleBuffered(self)


   .. method:: IsExpanded(self, node)


   .. method:: IsMultiSelect(self)


   .. method:: IsSelected(self, node)


   .. method:: LoadChildren(self, layoutNode)


   .. method:: NodeAdded(self, parent, child)


   .. method:: NodeInserted(self, parent, child, index)


   .. method:: NodeRemoved(self, node)


   .. method:: OnEraseBackground(self, evt)


   .. method:: OnKeyDown(self, evt)


   .. method:: OnKnobClick(self, node)


   .. method:: OnMouse(self, evt)


   .. method:: OnNodeClick(self, node, mouseEvent)


   .. method:: OnPaint(self, evt)

      Ensures that the tree has been laid out and transformed, then calls the painter
      to paint the control.


   .. method:: OnSize(self, evt)


   .. method:: Refresh(self)


   .. method:: RemoveEditor(self, editor)


   .. method:: RemoveFromSelection(self, nodeTuple)


   .. method:: SetAssumeChildren(self, bool)


   .. method:: SetBackgroundColour(self, color)


   .. method:: SetDoubleBuffered(self, bool)

      By default MVCTree is double-buffered.


   .. method:: SetExpanded(self, node, bool)


   .. method:: SetFont(self, font)


   .. method:: SetForegroundColour(self, color)


   .. method:: SetModel(self, model)

      Completely change the data to be displayed.


   .. method:: SetMultiSelect(self, bool)


   .. method:: SetSelection(self, nodeTuple)