<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">

<!-- THIS FILE IS GENERATED DO NOT EDIT -->


<erlref>
<header>
  <copyright>
    <year>2020</year>
    <holder>Ericsson AB. All Rights Reserved.</holder></copyright>
  <legalnotice>
      Licensed under the Apache License, Version 2.0 (the "License");
      you may not use this file except in compliance with the License.
      You may obtain a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      See the License for the specific language governing permissions and
      limitations under the License.

  </legalnotice>
  <title>wxTreeEvent</title>
</header>
<module>wxTreeEvent</module>
<modulesummary>Functions for wxTreeEvent class</modulesummary>
<description><p>A tree event holds information about events associated with <seeerl marker="wxTreeCtrl"><c>wxTreeCtrl</c></seeerl> objects.
      </p><p>To process input from a tree control, use these event handler macros to direct input to member functions that take a <seeerl marker="wxTreeEvent"><c>wxTreeEvent</c></seeerl> argument.
      </p><p>See: <seeerl marker="wxTreeCtrl"><c>wxTreeCtrl</c></seeerl>
      </p>
  <p>This class is derived (and can use functions) from: 
    <seeerl marker="wxNotifyEvent"><c>wxNotifyEvent</c></seeerl> <seeerl marker="wxCommandEvent"><c>wxCommandEvent</c></seeerl> <seeerl marker="wxEvent"><c>wxEvent</c></seeerl></p>
  
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_tree_event.html">wxTreeEvent</url></p>
  </description><section><title>Events</title><p>Use <seemfa marker="wxEvtHandler#connect/3"><c>wxEvtHandler:connect/3</c></seemfa> with <seetype marker="#wxTreeEventType"><c>wxTreeEventType</c></seetype> to subscribe to events of this type.</p></section>
<datatypes>
    <datatype><name name="wxTreeEvent"/></datatype>
    <datatype><name name="wxTree"/></datatype>
    <datatype><name name="wxTreeEventType"/></datatype></datatypes>

<funcs>
  <func>
    <name name="getKeyCode" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the key code if the event is a key event. </fsummary>
    <desc><p>Returns the key code if the event is a key event. 
      </p><p>Use <seemfa marker="#getKeyEvent/1"><c>getKeyEvent/1</c></seemfa> to get the values of the modifier keys for this event (i.e. Shift or Ctrl). 
      </p></desc>
  </func>
  
  <func>
    <name name="getItem" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the item (valid for all events). </fsummary>
    <desc><p>Returns the item (valid for all events). 
      </p></desc>
  </func>
  
  <func>
    <name name="getKeyEvent" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the key event for <c>EVT_TREE_KEY_DOWN</c> events. </fsummary>
    <desc><p>Returns the key event for <c>EVT_TREE_KEY_DOWN</c> events. 
      </p></desc>
  </func>
  
  <func>
    <name name="getLabel" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the label if the event is a begin or end edit label event. </fsummary>
    <desc><p>Returns the label if the event is a begin or end edit label event. 
      </p></desc>
  </func>
  
  <func>
    <name name="getOldItem" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the old item index (valid for <c>EVT_TREE_SEL_CHANGING</c> and <c>EVT_TREE_SEL_CHANGED</c> events). </fsummary>
    <desc><p>Returns the old item index (valid for <c>EVT_TREE_SEL_CHANGING</c> and <c>EVT_TREE_SEL_CHANGED</c> events). 
      </p></desc>
  </func>
  
  <func>
    <name name="getPoint" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the position of the mouse pointer if the event is a drag or menu-context event. </fsummary>
    <desc><p>Returns the position of the mouse pointer if the event is a drag or menu-context event. 
      </p><p>In both cases the position is in client coordinates - i.e. relative to the <seeerl marker="wxTreeCtrl"><c>wxTreeCtrl</c></seeerl> window (so that you can pass it directly to e.g. <seemfa marker="wxWindow#popupMenu/4"><c>wxWindow:popupMenu/4</c></seemfa>). 
      </p></desc>
  </func>
  
  <func>
    <name name="isEditCancelled" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the label edit was cancelled. </fsummary>
    <desc><p>Returns true if the label edit was cancelled. 
      </p><p>This should be called from within an <c>EVT_TREE_END_LABEL_EDIT</c> handler. 
      </p></desc>
  </func>
  
  <func>
    <name name="setToolTip" arity="2" clause_i="1" since=""/>
    <fsummary>Set the tooltip for the item (valid for <c>EVT_TREE_ITEM_GETTOOLTIP</c> events). </fsummary>
    <desc><p>Set the tooltip for the item (valid for <c>EVT_TREE_ITEM_GETTOOLTIP</c> events). 
      </p><p>Windows only. 
      </p></desc>
  </func>
  </funcs>
</erlref>
