<?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>wxListItem</title>
</header>
<module>wxListItem</module>
<modulesummary>Functions for wxListItem class</modulesummary>
<description><p>This class stores information about a <seeerl marker="wxListCtrl"><c>wxListCtrl</c></seeerl> item or column.
      </p><p><seeerl marker="wxListItem"><c>wxListItem</c></seeerl> is a class which contains information about:
      </p><p>The <seeerl marker="wxListItem"><c>wxListItem</c></seeerl> object can also contain item-specific colour and font information: for this you need to call one of <seemfa marker="#setTextColour/2"><c>setTextColour/2</c></seemfa>, <seemfa marker="#setBackgroundColour/2"><c>setBackgroundColour/2</c></seemfa> or <seemfa marker="#setFont/2"><c>setFont/2</c></seemfa> functions on it passing it the colour/font to use. If the colour/font is not specified, the default list control colour/font is used.
      </p><p>See: <seeerl marker="wxListCtrl"><c>wxListCtrl</c></seeerl>
      </p>
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_list_item.html">wxListItem</url></p>
  </description>
<datatypes><datatype><name name="wxListItem"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="0" clause_i="1" since=""/>
    <fsummary>Constructor. </fsummary>
    <desc><p>Constructor. 
      </p></desc>
  </func>
  
  <func>
    <name name="new" arity="1" clause_i="1" since=""/>
    <fsummary/>
    <desc/>
  </func>
  
  <func>
    <name name="clear" arity="1" clause_i="1" since=""/>
    <fsummary>Resets the item state to the default. </fsummary>
    <desc><p>Resets the item state to the default. 
      </p></desc>
  </func>
  
  <func>
    <name name="getAlign" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the alignment for this item. </fsummary>
    <desc><p>Returns the alignment for this item. 
      </p><p>Can be one of <c>wxLIST_FORMAT_LEFT</c>, <c>wxLIST_FORMAT_RIGHT</c> or <c>wxLIST_FORMAT_CENTRE</c>. 
      </p></desc>
  </func>
  
  <func>
    <name name="getBackgroundColour" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the background colour for this item. </fsummary>
    <desc><p>Returns the background colour for this item. 
      </p></desc>
  </func>
  
  <func>
    <name name="getColumn" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the zero-based column; meaningful only in report mode. </fsummary>
    <desc><p>Returns the zero-based column; meaningful only in report mode. 
      </p></desc>
  </func>
  
  <func>
    <name name="getFont" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the font used to display the item. </fsummary>
    <desc><p>Returns the font used to display the item. 
      </p></desc>
  </func>
  
  <func>
    <name name="getId" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the zero-based item position. </fsummary>
    <desc><p>Returns the zero-based item position. 
      </p></desc>
  </func>
  
  <func>
    <name name="getImage" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the zero-based index of the image associated with the item into the image list. </fsummary>
    <desc><p>Returns the zero-based index of the image associated with the item into the image list. 
      </p></desc>
  </func>
  
  <func>
    <name name="getMask" arity="1" clause_i="1" since=""/>
    <fsummary>Returns a bit mask indicating which fields of the structure are valid. </fsummary>
    <desc><p>Returns a bit mask indicating which fields of the structure are valid. 
      </p><p>Can be any combination of the following values:
      </p></desc>
  </func>
  
  <func>
    <name name="getState" arity="1" clause_i="1" since=""/>
    <fsummary>Returns a bit field representing the state of the item. </fsummary>
    <desc><p>Returns a bit field representing the state of the item. 
      </p><p>Can be any combination of:
      </p></desc>
  </func>
  
  <func>
    <name name="getText" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the label/header text. </fsummary>
    <desc><p>Returns the label/header text. 
      </p></desc>
  </func>
  
  <func>
    <name name="getTextColour" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the text colour. </fsummary>
    <desc><p>Returns the text colour. 
      </p></desc>
  </func>
  
  <func>
    <name name="getWidth" arity="1" clause_i="1" since=""/>
    <fsummary>Meaningful only for column headers in report mode. </fsummary>
    <desc><p>Meaningful only for column headers in report mode. 
      </p><p>Returns the column width. 
      </p></desc>
  </func>
  
  <func>
    <name name="setAlign" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the alignment for the item. </fsummary>
    <desc><p>Sets the alignment for the item. 
      </p><p>See also <seemfa marker="#getAlign/1"><c>getAlign/1</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="setBackgroundColour" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the background colour for the item. </fsummary>
    <desc><p>Sets the background colour for the item. 
      </p></desc>
  </func>
  
  <func>
    <name name="setColumn" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the zero-based column. </fsummary>
    <desc><p>Sets the zero-based column. 
      </p><p>Meaningful only in report mode. 
      </p></desc>
  </func>
  
  <func>
    <name name="setFont" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the font for the item. </fsummary>
    <desc><p>Sets the font for the item. 
      </p></desc>
  </func>
  
  <func>
    <name name="setId" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the zero-based item position. </fsummary>
    <desc><p>Sets the zero-based item position. 
      </p></desc>
  </func>
  
  <func>
    <name name="setImage" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the zero-based index of the image associated with the item into the image list. </fsummary>
    <desc><p>Sets the zero-based index of the image associated with the item into the image list. 
      </p></desc>
  </func>
  
  <func>
    <name name="setMask" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the mask of valid fields. </fsummary>
    <desc><p>Sets the mask of valid fields. 
      </p><p>See <seemfa marker="#getMask/1"><c>getMask/1</c></seemfa>. 
      </p></desc>
  </func>
  
  <func>
    <name name="setState" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the item state flags (note that the valid state flags are influenced by the value of the state mask, see <c>setStateMask/2</c>). </fsummary>
    <desc><p>Sets the item state flags (note that the valid state flags are influenced by the value of the state mask, see <seemfa marker="#setStateMask/2"><c>setStateMask/2</c></seemfa>). 
      </p><p>See <seemfa marker="#getState/1"><c>getState/1</c></seemfa> for valid flag values. 
      </p></desc>
  </func>
  
  <func>
    <name name="setStateMask" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the bitmask that is used to determine which of the state flags are to be set. </fsummary>
    <desc><p>Sets the bitmask that is used to determine which of the state flags are to be set. 
      </p><p>See also <seemfa marker="#setState/2"><c>setState/2</c></seemfa>. 
      </p></desc>
  </func>
  
  <func>
    <name name="setText" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the text label for the item. </fsummary>
    <desc><p>Sets the text label for the item. 
      </p></desc>
  </func>
  
  <func>
    <name name="setTextColour" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the text colour for the item. </fsummary>
    <desc><p>Sets the text colour for the item. 
      </p></desc>
  </func>
  
  <func>
    <name name="setWidth" arity="2" clause_i="1" since=""/>
    <fsummary>Meaningful only for column headers in report mode. </fsummary>
    <desc><p>Meaningful only for column headers in report mode. 
      </p><p>Sets the column width. 
      </p></desc>
  </func>
  
  <func>
    <name name="destroy" arity="1" clause_i="1" since=""/>
    <fsummary>Destructor</fsummary>
    <desc><p>Destroys the object.</p></desc>
  </func>
  </funcs>
</erlref>
