<?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>wxListView</title>
</header>
<module>wxListView</module>
<modulesummary>Functions for wxListView class</modulesummary>
<description><p>This class currently simply presents a simpler to use interface for the <seeerl marker="wxListCtrl"><c>wxListCtrl</c></seeerl> - it can be thought of as a <c>façade</c> for that complicated class.
      </p><p>Using it is preferable to using <seeerl marker="wxListCtrl"><c>wxListCtrl</c></seeerl> directly whenever possible because in the future some ports might implement <seeerl marker="wxListView"><c>wxListView</c></seeerl> but not the full set of <seeerl marker="wxListCtrl"><c>wxListCtrl</c></seeerl> features.
      </p><p>Other than different interface, this class is identical to <seeerl marker="wxListCtrl"><c>wxListCtrl</c></seeerl>. In particular, it uses the same events, same window styles and so on.
      </p><p>See: <seemfa marker="#setColumnImage/3"><c>setColumnImage/3</c></seemfa>
      </p>
  <p>This class is derived (and can use functions) from: 
    <seeerl marker="wxControl"><c>wxControl</c></seeerl> <seeerl marker="wxWindow"><c>wxWindow</c></seeerl> <seeerl marker="wxEvtHandler"><c>wxEvtHandler</c></seeerl></p>
  
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_list_view.html">wxListView</url></p>
  </description>
<datatypes><datatype><name name="wxListView"/></datatype></datatypes>

<funcs>
  <func>
    <name name="clearColumnImage" arity="2" clause_i="1" since=""/>
    <fsummary>Resets the column image -- after calling this function, no image will be shown. </fsummary>
    <desc><p>Resets the column image - after calling this function, no image will be shown. 
      </p><p>See: <seemfa marker="#setColumnImage/3"><c>setColumnImage/3</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="focus" arity="2" clause_i="1" since=""/>
    <fsummary>Sets focus to the item with the given <c>index</c>. </fsummary>
    <desc><p>Sets focus to the item with the given <c>index</c>. 
      </p></desc>
  </func>
  
  <func>
    <name name="getFirstSelected" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the first selected item in a (presumably) multiple selection control. </fsummary>
    <desc><p>Returns the first selected item in a (presumably) multiple selection control. 
      </p><p>Together with <seemfa marker="#getNextSelected/2"><c>getNextSelected/2</c></seemfa> it can be used to iterate over all selected items in the control.
      </p><p>Return: The first selected item, if any, -1 otherwise. 
      </p></desc>
  </func>
  
  <func>
    <name name="getFocusedItem" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the currently focused item or -1 if none. </fsummary>
    <desc><p>Returns the currently focused item or -1 if none. 
      </p><p>See: <seemfa marker="#isSelected/2"><c>isSelected/2</c></seemfa>, <seemfa marker="#focus/2"><c>focus/2</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="getNextSelected" arity="2" clause_i="1" since=""/>
    <fsummary>Used together with <c>getFirstSelected/1</c> to iterate over all selected items in the control. </fsummary>
    <desc><p>Used together with <seemfa marker="#getFirstSelected/1"><c>getFirstSelected/1</c></seemfa> to iterate over all selected items in the control. 
      </p><p>Return: Returns the next selected item or -1 if there are no more of them. 
      </p></desc>
  </func>
  
  <func>
    <name name="isSelected" arity="2" clause_i="1" since=""/>
    <fsummary>Returns true if the item with the given <c>index</c> is selected, false otherwise. </fsummary>
    <desc><p>Returns true if the item with the given <c>index</c> is selected, false otherwise. 
      </p><p>See: <seemfa marker="#getFirstSelected/1"><c>getFirstSelected/1</c></seemfa>, <seemfa marker="#getNextSelected/2"><c>getNextSelected/2</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="select" arity="2" clause_i="1" since=""/>
    <fsummary>See: <c>select/3</c></fsummary>
  </func>
  
  <func>
    <name name="select" arity="3" clause_i="1" since=""/>
    <fsummary>Selects or unselects the given item. </fsummary>
    <desc><p>Selects or unselects the given item. 
      </p><p>Notice that this method inherits the unusual behaviour of <seemfa marker="wxListCtrl#setItemState/4"><c>wxListCtrl:setItemState/4</c></seemfa> which sends a wxEVT_LIST_ITEM_SELECTED event when it is used to select an item, contrary to the usual rule that only the user actions result in selection.
      </p></desc>
  </func>
  
  <func>
    <name name="setColumnImage" arity="3" clause_i="1" since=""/>
    <fsummary>Sets the column image for the specified column. </fsummary>
    <desc><p>Sets the column image for the specified column. 
      </p><p>To use the column images, the control must have a valid image list with at least one image.
      </p></desc>
  </func>
  </funcs>
</erlref>
