.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxTreeEvent 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxTreeEvent \- 
  A tree control event
 
.SH DESCRIPTION

  


   A tree event holds information about events associated with wxTreeCtrl
   objects.
  
 
.SH "PARENTS"

  wxNotifyEvent
   
  wxCommandEvent
   
  wxEvent
   
  wxObject
 
.SH "INCLUDE FILES"
wx/treectrl.h
.SH MEMBERS

  
.SS  wxTreeEvent (WXTYPE commandType = 0int id = 0)

     


      Constructor.
     
    
   
  
.SS int GetKeyCode ()

     


      Returns the key code if the event was is a key event. Use
      GetKeyEvent
      to get the values of the modifier keys for this event (i.e. Shift or
      Ctrl).
     
    
   
  
.SS wxTreeItemId GetItem ()

     


      Returns the item (valid for all events).
     
    
   
  
.SS const wxKeyEvent& GetKeyEvent ()

     


      Returns the key event for
      EVT_TREE_KEY_DOWN
      events.
     
    
   
  
.SS const wxString& GetLabel ()

     


      Returns the label if the event was a begin or end edit label event.
     
    
   
  
.SS wxTreeItemId GetOldItem ()

     


      Returns the old item index (valid for EVT_TREE_ITEM_CHANGING and CHANGED
      events)
     
    
   
  
.SS wxPoint GetPoint ()

     


      Returns the position of the mouse pointer if the event is a drag event.
     
    
   
  
.SS bool IsEditCancelled ()

     


      Returns true if the label edit was cancelled. This should be called from
      within an EVT_TREE_END_LABEL_EDIT handler.
     
    
   
  
.SS void SetToolTip (const wxString& tooltip)

     


      Set the tooltip for the item (valid for EVT_TREE_ITEM_GETTOOLTIP events).
      Windows only.
     
    
 
.SH EVENTS

.SS EVT_TREE_BEGIN_DRAG(id, func)

   The user has started dragging an item with the left mouse button. The event handler must call 
   
    wxTreeEvent::Allow()
   
    for the drag operation to continue.
  
.SS EVT_TREE_BEGIN_RDRAG(id, func)

   The user has started dragging an item with the right mouse button. The event handler must call 
   
    wxTreeEvent::Allow()
   
    for the drag operation to continue.
  
.SS EVT_TREE_BEGIN_LABEL_EDIT(id, func)

   Begin editing a label. This can be prevented by calling 
   Veto()
   .
  
.SS EVT_TREE_END_DRAG(id, func)

   The user has released the mouse after dragging an item.
  
.SS EVT_TREE_END_LABEL_EDIT(id, func)

   The user has finished editing a label. This can be prevented by calling 
   Veto()
   .
  
.SS EVT_TREE_DELETE_ITEM(id, func)

   A tree item has been deleted.
  
.SS EVT_TREE_ITEM_ACTIVATED(id, func)

   An item has been activated (e.g. double clicked).
  
.SS EVT_TREE_ITEM_COLLAPSED(id, func)

   The item has been collapsed.
  
.SS EVT_TREE_ITEM_COLLAPSING(id, func)

   The item is being collapsed. This can be prevented by calling 
   Veto()
   .
  
.SS EVT_TREE_ITEM_EXPANDED(id, func)

   The item has been expanded.
  
.SS EVT_TREE_ITEM_EXPANDING(id, func)

   The item is being expanded. This can be prevented by calling 
   Veto()
   .
  
.SS EVT_TREE_ITEM_RIGHT_CLICK(id, func)

   The user has clicked the item with the right mouse button.
  
.SS EVT_TREE_ITEM_MIDDLE_CLICK(id, func)

   The user has clicked the item with the middle mouse button.
  
.SS EVT_TREE_KEY_DOWN(id, func)

   A key has been pressed.
  
.SS EVT_TREE_SEL_CHANGED(id, func)

   Selection has changed.
  
.SS EVT_TREE_SEL_CHANGING(id, func)

   Selection is changing. This can be prevented by calling 
   Veto()
   .
  
.SS EVT_TREE_KEY_DOWN(id, func)

   A key has been pressed.
  
.SS EVT_TREE_ITEM_GETTOOLTIP(id, func)

   The opportunity to set the item tooltip is being given to the application (call wxTreeEvent::SetToolTip). Windows only.
  
.SS EVT_TREE_ITEM_MENU(id, func)

   The context menu for the selected item has been requested, either by a right click or by using the menu key.
  
.SS EVT_TREE_STATE_IMAGE_CLICK(id, func)

   The state image has been clicked. Windows only.
  
.SH "SEE ALSO"

  wxNotifyEvent
   
  wxCommandEvent
   
  wxEvent
   
  wxObject
 
  wxTreeCtrl
 
.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.