.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. currentmodule:: wx.lib.combotreebox
.. highlight:: python
.. _wx.lib.combotreebox.MSWComboTreeBox:
==========================================================================================================================================
|phoenix_title| **wx.lib.combotreebox.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| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
MSWComboTreeBox:
|
|super_classes| Known Superclasses
==================================
:class:`wx.lib.combotreebox.NativeComboTreeBox`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.combotreebox.MSWComboTreeBox.NotifyNoItemSelected` Restore the value copied previously, because the user has
:meth:`~wx.lib.combotreebox.MSWComboTreeBox.OnSelectionChangedInTree`
:meth:`~wx.lib.combotreebox.MSWComboTreeBox.Popup` Extend Popup to store a copy of the current value, so we can
:meth:`~wx.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