<?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>wxListEvent</title>
</header>
<module>wxListEvent</module>
<modulesummary>Functions for wxListEvent class</modulesummary>
<description><p>A list event holds information about events associated with <seeerl marker="wxListCtrl"><c>wxListCtrl</c></seeerl> objects.
      </p><p>See: <seeerl marker="wxListCtrl"><c>wxListCtrl</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_list_event.html">wxListEvent</url></p>
  </description><section><title>Events</title><p>Use <seemfa marker="wxEvtHandler#connect/3"><c>wxEvtHandler:connect/3</c></seemfa> with <seetype marker="#wxListEventType"><c>wxListEventType</c></seetype> to subscribe to events of this type.</p></section>
<datatypes>
    <datatype><name name="wxListEvent"/></datatype>
    <datatype><name name="wxList"/></datatype>
    <datatype><name name="wxListEventType"/></datatype></datatypes>

<funcs>
  <func>
    <name name="getCacheFrom" arity="1" clause_i="1" since=""/>
    <fsummary>For <c>EVT_LIST_CACHE_HINT</c> event only: return the first item which the list control advises us to cache. </fsummary>
    <desc><p>For <c>EVT_LIST_CACHE_HINT</c> event only: return the first item which the list control advises us to cache. 
      </p></desc>
  </func>
  
  <func>
    <name name="getCacheTo" arity="1" clause_i="1" since=""/>
    <fsummary>For <c>EVT_LIST_CACHE_HINT</c> event only: return the last item (inclusive) which the list control advises us to cache. </fsummary>
    <desc><p>For <c>EVT_LIST_CACHE_HINT</c> event only: return the last item (inclusive) which the list control advises us to cache. 
      </p></desc>
  </func>
  
  <func>
    <name name="getKeyCode" arity="1" clause_i="1" since=""/>
    <fsummary>Key code if the event is a keypress event. </fsummary>
    <desc><p>Key code if the event is a keypress event. 
      </p></desc>
  </func>
  
  <func>
    <name name="getIndex" arity="1" clause_i="1" since=""/>
    <fsummary>The item index. </fsummary>
    <desc><p>The item index. 
      </p></desc>
  </func>
  
  <func>
    <name name="getColumn" arity="1" clause_i="1" since=""/>
    <fsummary>The column position: it is only used with <c>COL</c> events. </fsummary>
    <desc><p>The column position: it is only used with <c>COL</c> events. 
      </p><p>For the column dragging events, it is the column to the left of the divider being dragged, for the column click events it may be -1 if the user clicked in the list control header outside any column. 
      </p></desc>
  </func>
  
  <func>
    <name name="getPoint" arity="1" clause_i="1" since=""/>
    <fsummary>The position of the mouse pointer if the event is a drag event. </fsummary>
    <desc><p>The position of the mouse pointer if the event is a drag event. 
      </p></desc>
  </func>
  
  <func>
    <name name="getLabel" arity="1" clause_i="1" since=""/>
    <fsummary>The (new) item label for <c>EVT_LIST_END_LABEL_EDIT</c> event. </fsummary>
    <desc><p>The (new) item label for <c>EVT_LIST_END_LABEL_EDIT</c> event. 
      </p></desc>
  </func>
  
  <func>
    <name name="getText" arity="1" clause_i="1" since=""/>
    <fsummary>The text. </fsummary>
    <desc><p>The text. 
      </p></desc>
  </func>
  
  <func>
    <name name="getImage" arity="1" clause_i="1" since=""/>
    <fsummary>The image. </fsummary>
    <desc><p>The image. 
      </p></desc>
  </func>
  
  <func>
    <name name="getData" arity="1" clause_i="1" since=""/>
    <fsummary>The data. </fsummary>
    <desc><p>The data. 
      </p></desc>
  </func>
  
  <func>
    <name name="getMask" arity="1" clause_i="1" since=""/>
    <fsummary>The mask. </fsummary>
    <desc><p>The mask. 
      </p></desc>
  </func>
  
  <func>
    <name name="getItem" arity="1" clause_i="1" since=""/>
    <fsummary>An item object, used by some events. </fsummary>
    <desc><p>An item object, used by some events. 
      </p><p>See also <seemfa marker="wxListCtrl#setItem/5"><c>wxListCtrl:setItem/5</c></seemfa>. 
      </p></desc>
  </func>
  
  <func>
    <name name="isEditCancelled" arity="1" clause_i="1" since=""/>
    <fsummary>This method only makes sense for <c>EVT_LIST_END_LABEL_EDIT</c> message and returns true if it the label editing has been cancelled by the user (<c>getLabel/1</c> returns an empty string in this case but it doesn't allow the application to distinguish between really cancelling the edit and the admittedly rare case when the user wants to rename it to an empty string). </fsummary>
    <desc><p>This method only makes sense for <c>EVT_LIST_END_LABEL_EDIT</c> message and returns true if it the label editing has been cancelled by the user (<seemfa marker="#getLabel/1"><c>getLabel/1</c></seemfa> returns an empty string in this case but it doesn't allow the application to distinguish between really cancelling the edit and the admittedly rare case when the user wants to rename it to an empty string). 
      </p></desc>
  </func>
  </funcs>
</erlref>
