.. 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



.. _wx.TreeEvent:

==========================================================================================================================================
|phoenix_title|  **wx.TreeEvent**
==========================================================================================================================================

A tree event holds information about events associated with :ref:`wx.TreeCtrl`  objects.          

To process input from a tree control, use these event handler macros to direct input to member functions that take a :ref:`wx.TreeEvent`  argument. 

^^ 





.. _TreeEvent-events:

|events| Events Emitted by this Class
=====================================

Handlers bound for the following event types will receive a :ref:`wx.TreeEvent` parameter.

 

- EVT_TREE_BEGIN_DRAG: Begin dragging with the left mouse button. If you want to enable left-dragging you need to intercept this event and explicitly call :meth:`wx.TreeEvent.Allow <wx.NotifyEvent.Allow>` , as it's vetoed by default. Also notice that the control must have an associated image list (see SetImageList()) to drag its items under MSW.  
- EVT_TREE_BEGIN_RDRAG: Begin dragging with the right mouse button. If you want to enable right-dragging you need to intercept this event and explicitly call :meth:`wx.TreeEvent.Allow <wx.NotifyEvent.Allow>` , as it's vetoed by default.  
- EVT_TREE_END_DRAG: End dragging with the left or right mouse button.  
- EVT_TREE_BEGIN_LABEL_EDIT: Begin editing a label. This can be prevented by calling :meth:`~wx.NotifyEvent.Veto`  
- EVT_TREE_END_LABEL_EDIT: Finish editing a label. This can be prevented by calling :meth:`~wx.NotifyEvent.Veto`  
- EVT_TREE_DELETE_ITEM: Delete an item.  
- EVT_TREE_GET_INFO: Request information from the application.  
- EVT_TREE_SET_INFO: Information is being supplied.  
- EVT_TREE_ITEM_ACTIVATED: The item has been activated, i.e. chosen by double clicking it with mouse or from keyboard.  
- EVT_TREE_ITEM_COLLAPSED: The item has been collapsed.  
- EVT_TREE_ITEM_COLLAPSING: The item is being collapsed. This can be prevented by calling :meth:`~wx.NotifyEvent.Veto`  
- EVT_TREE_ITEM_EXPANDED: The item has been expanded.  
- EVT_TREE_ITEM_EXPANDING: The item is being expanded. This can be prevented by calling :meth:`~wx.NotifyEvent.Veto`  
- EVT_TREE_ITEM_RIGHT_CLICK: The user has clicked the item with the right mouse button.  
- EVT_TREE_ITEM_MIDDLE_CLICK: The user has clicked the item with the middle mouse button.  
- EVT_TREE_SEL_CHANGED: Selection has changed.  
- EVT_TREE_SEL_CHANGING: Selection is changing. This can be prevented by calling :meth:`~wx.NotifyEvent.Veto`  
- EVT_TREE_KEY_DOWN: A key has been pressed.  
- EVT_TREE_ITEM_GETTOOLTIP: The opportunity to set the item tooltip is being given to the application (call :meth:`~wx.TreeEvent.SetToolTip`). Windows only.  
- EVT_TREE_ITEM_MENU: The context menu for the selected item has been requested, either by a right click or by using the menu key.  
- EVT_TREE_STATE_IMAGE_CLICK: The state image has been clicked. ^^ 






         



.. seealso:: :ref:`wx.TreeCtrl`    







|

|class_hierarchy| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>TreeEvent</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.TreeEvent_inheritance.png" alt="Inheritance diagram of TreeEvent" usemap="#dummy" class="inheritance"/></center>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.TreeEvent.html" title="A tree event holds information about events associated with wx.TreeCtrl  objects." alt="" coords="25,315,131,344"/> <area shape="rect" id="node2" href="wx.NotifyEvent.html" title="This class is not used by the event handlers by itself, but is a base class for other event classes (such as wx.BookCtrlEvent)." alt="" coords="21,237,135,267"/> <area shape="rect" id="node3" href="wx.CommandEvent.html" title="This event class contains information about command events, which originate from a variety of simple controls." alt="" coords="5,160,151,189"/> <area shape="rect" id="node4" href="wx.Event.html" title="An event is a structure holding information about an event passed to a callback or member function." alt="" coords="39,83,117,112"/> <area shape="rect" id="node5" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="37,5,119,35"/> </map> 
   </p>
   </div>

|


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

================================================================================ ================================================================================
:meth:`~wx.TreeEvent.__init__`                                                   Constructor, used by wxWidgets itself only.
:meth:`~wx.TreeEvent.GetItem`                                                    Returns the item.
:meth:`~wx.TreeEvent.GetKeyCode`                                                 Returns the key code if the event is a key event.
:meth:`~wx.TreeEvent.GetKeyEvent`                                                Returns the key event for  ``EVT_TREE_KEY_DOWN``   events.
:meth:`~wx.TreeEvent.GetLabel`                                                   Returns the label if the event is a begin or end edit label event.
:meth:`~wx.TreeEvent.GetOldItem`                                                 Returns the old item index (valid for  ``EVT_TREE_SEL_CHANGING``   and   ``EVT_TREE_SEL_CHANGED``   events).
:meth:`~wx.TreeEvent.GetPoint`                                                   Returns the position of the mouse pointer if the event is a drag or menu-context event.
:meth:`~wx.TreeEvent.IsEditCancelled`                                            Returns ``True`` if the label edit was cancelled.
:meth:`~wx.TreeEvent.SetToolTip`                                                 Set the tooltip for the item (valid for  ``EVT_TREE_ITEM_GETTOOLTIP``   events).
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~wx.TreeEvent.Item`                                                       See :meth:`~wx.TreeEvent.GetItem`
:attr:`~wx.TreeEvent.KeyCode`                                                    See :meth:`~wx.TreeEvent.GetKeyCode`
:attr:`~wx.TreeEvent.KeyEvent`                                                   See :meth:`~wx.TreeEvent.GetKeyEvent`
:attr:`~wx.TreeEvent.Label`                                                      See :meth:`~wx.TreeEvent.GetLabel`
:attr:`~wx.TreeEvent.OldItem`                                                    See :meth:`~wx.TreeEvent.GetOldItem`
:attr:`~wx.TreeEvent.Point`                                                      See :meth:`~wx.TreeEvent.GetPoint`
================================================================================ ================================================================================


|


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


.. class:: wx.TreeEvent(NotifyEvent)

   **Possible constructors**::

       TreeEvent(commandType, tree, item=TreeItemId())
       
   
   A tree event holds information about events associated with TreeCtrl
   objects.



   .. method:: __init__(self, commandType, tree, item=TreeItemId())

      Constructor, used by wxWidgets itself only.                  


      :param `commandType`: 
      :type `commandType`: wx.EventType
      :param `tree`: 
      :type `tree`: wx.TreeCtrl
      :param `item`: 
      :type `item`: wx.TreeItemId







   .. method:: GetItem(self)

      Returns the item.                  

      Note that the item may be invalid for wxEVT_TREE_SEL_CHANGED events when the previously selected item has been deselected and there is no new selection any longer, as it notably happens when deleting all tree control items.                  

      :rtype: :ref:`wx.TreeItemId`








   .. method:: GetKeyCode(self)

      Returns the key code if the event is a key event.                  

      Use :meth:`GetKeyEvent`   to get the values of the modifier keys for this event (i.e. Shift or Ctrl).                  

      :rtype: `int`








   .. method:: GetKeyEvent(self)

      Returns the key event for  ``EVT_TREE_KEY_DOWN``   events.                   

      :rtype: :ref:`wx.KeyEvent`








   .. method:: GetLabel(self)

      Returns the label if the event is a begin or end edit label event.                  

      :rtype: `string`








   .. method:: GetOldItem(self)

      Returns the old item index (valid for  ``EVT_TREE_SEL_CHANGING``   and   ``EVT_TREE_SEL_CHANGED``   events).                   

      :rtype: :ref:`wx.TreeItemId`








   .. method:: GetPoint(self)

      Returns the position of the mouse pointer if the event is a drag or menu-context event.                  

      In both cases the position is in client coordinates - i.e. relative to the :ref:`wx.TreeCtrl`  window (so that you can pass it directly to e.g. :meth:`wx.Window.PopupMenu` ).                  

      :rtype: :ref:`wx.Point`








   .. method:: IsEditCancelled(self)

      Returns ``True`` if the label edit was cancelled.                  

      This should be called from within an  ``EVT_TREE_END_LABEL_EDIT``   handler.                   

      :rtype: `bool`








   .. method:: SetToolTip(self, tooltip)

      Set the tooltip for the item (valid for  ``EVT_TREE_ITEM_GETTOOLTIP``   events).                   

      Windows only.                  


      :param `tooltip`: 
      :type `tooltip`: string







   .. attribute:: Item

      See :meth:`~wx.TreeEvent.GetItem`


   .. attribute:: KeyCode

      See :meth:`~wx.TreeEvent.GetKeyCode`


   .. attribute:: KeyEvent

      See :meth:`~wx.TreeEvent.GetKeyEvent`


   .. attribute:: Label

      See :meth:`~wx.TreeEvent.GetLabel`


   .. attribute:: OldItem

      See :meth:`~wx.TreeEvent.GetOldItem`


   .. attribute:: Point

      See :meth:`~wx.TreeEvent.GetPoint`