.. include:: headings.inc

.. currentmodule:: lib.combotreebox

.. highlight:: python



.. _lib.combotreebox.MSWComboTreeBox:

==========================================================================================================================================
|phoenix_title|  **MSWComboTreeBox**
==========================================================================================================================================

MSWComboTreeBox adds one piece of functionality as compared to
NativeComboTreeBox: when the user browses through the tree, the
ComboTreeBox's text field is continuously updated to show the
currently selected item in the tree. If the user cancels
selecting a new item from the tree, e.g. by hitting escape, the
previous value (the one that was selected before the PopupFrame
was popped up) is restored.



|

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

Inheritance diagram for class **MSWComboTreeBox**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.combotreebox.MSWComboTreeBox_inheritance.png" alt="Inheritance diagram of MSWComboTreeBox" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="Control.html" title="This is the base class for a control or 'widget'." alt="" coords="804,110,879,141"/> <area shape="rect" id="node5" href="ControlWithItems.html" title="This is convenience class that derives from both Control  and ItemContainer." alt="" coords="952,85,1099,115"/> <area shape="rect" id="node2" href="Window.html" title="Window  is the base class for all windows and represents any visible object on screen." alt="" coords="551,109,631,139"/> <area shape="rect" id="node4" href="Choice.html" title="A choice item is used to select one of a list of strings." alt="" coords="1147,85,1221,115"/> <area shape="rect" id="node19" href="ComboBox.html" title="A combobox is like a combination of an edit control and a listbox." alt="" coords="1269,85,1371,115"/> <area shape="rect" id="node7" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="303,109,401,139"/> <area shape="rect" id="node8" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="153,109,225,139"/> <area shape="rect" id="node11" href="lib.combotreebox.MSWComboTreeBox.html" title="MSWComboTreeBox adds one piece of functionality as compared to" alt="" coords="1752,123,2035,154"/> <area shape="rect" id="node12" href="lib.combotreebox.NativeComboTreeBox.html" title="NativeComboTreeBox, and any subclass, uses the native ComboBox as basis," alt="" coords="1419,123,1704,154"/> <area shape="rect" id="node14" href="ItemContainer.html" title="This class is an abstract base class for some wxWidgets controls which contain several items such as ListBox, CheckListBox, ComboBox  or Choice." alt="" coords="780,57,903,87"/> <area shape="rect" id="node17" href="lib.combotreebox.BaseComboTreeBox.html" title="BaseComboTreeBox is the base class for platform specific versions of the" alt="" coords="452,162,729,193"/> <area shape="rect" id="node21" href="TextEntry.html" title="Common base class for single line text entry fields." alt="" coords="980,18,1071,49"/> </map> 
   </p>

|


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

:class:`lib.combotreebox.NativeComboTreeBox`

|


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

================================================================================ ================================================================================
:meth:`~lib.combotreebox.MSWComboTreeBox.NotifyNoItemSelected`                   Restore the value copied previously, because the user has
:meth:`~lib.combotreebox.MSWComboTreeBox.OnSelectionChangedInTree`               
:meth:`~lib.combotreebox.MSWComboTreeBox.Popup`                                  Extend Popup to store a copy of the current value, so we can
:meth:`~lib.combotreebox.MSWComboTreeBox.SetValue`                               Extend SetValue to also select the text in the
================================================================================ ================================================================================


|


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

.. class:: MSWComboTreeBox(NativeComboTreeBox)

   MSWComboTreeBox adds one piece of functionality as compared to
   NativeComboTreeBox: when the user browses through the tree, the
   ComboTreeBox's text field is continuously updated to show the
   currently selected item in the tree. If the user cancels
   selecting a new item from the tree, e.g. by hitting escape, the
   previous value (the one that was selected before the PopupFrame
   was popped up) is restored.

   .. method:: NotifyNoItemSelected(self, \*args, \*\*kwargs)

      Restore the value copied previously, because the user has
      not selected a new value.


   .. method:: OnSelectionChangedInTree(self, event)


   .. method:: Popup(self, \*args, \*\*kwargs)

      Extend Popup to store a copy of the current value, so we can
      restore it later (in NotifyNoItemSelected). This is necessary
      because MSWComboTreeBox will change the value as the user
      browses through the items in the popped up tree.


   .. method:: SetValue(self, value)

      Extend SetValue to also select the text in the
      ComboTreeBox's text field.
      
      :param string `value`: set the value and select it