<?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>wxImageList</title>
</header>
<module>wxImageList</module>
<modulesummary>Functions for wxImageList class</modulesummary>
<description><p>A <seeerl marker="wxImageList"><c>wxImageList</c></seeerl> contains a list of images, which are stored in an unspecified form. Images can have masks for transparent drawing, and can be made from a variety of sources including bitmaps and icons.
      </p><p><seeerl marker="wxImageList"><c>wxImageList</c></seeerl> is used principally in conjunction with <seeerl marker="wxTreeCtrl"><c>wxTreeCtrl</c></seeerl> and <seeerl marker="wxListCtrl"><c>wxListCtrl</c></seeerl> classes.
      </p><p>See: <seeerl marker="wxTreeCtrl"><c>wxTreeCtrl</c></seeerl>, <seeerl marker="wxListCtrl"><c>wxListCtrl</c></seeerl>
      </p>
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_image_list.html">wxImageList</url></p>
  </description>
<datatypes><datatype><name name="wxImageList"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="0" clause_i="1" since=""/>
    <fsummary>Default ctor. </fsummary>
    <desc><p>Default ctor. 
      </p></desc>
  </func>
  
  <func>
    <name name="new" arity="2" clause_i="1" since=""/>
    <fsummary>See: <c>new/3</c></fsummary>
  </func>
  
  <func>
    <name name="new" arity="3" clause_i="1" since=""/>
    <fsummary>Constructor specifying the image size, whether image masks should be created, and the initial size of the list. </fsummary>
    <desc><p>Constructor specifying the image size, whether image masks should be created, and the initial size of the list. 
      </p><p>See: <seemfa marker="#create/4"><c>create/4</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="add" arity="2" clause_i="1" since=""/>
    <fsummary>Adds a new image using an icon. </fsummary>
    <desc><p>Adds a new image using an icon. 
      </p><p>Return: The new zero-based image index.
      </p><p>Remark: The original bitmap or icon is not affected by the <seemfa marker="#add/3"><c>add/3</c></seemfa> operation, and can be deleted afterwards. If the bitmap is wider than the images in the list, then the bitmap will automatically be split into smaller images, each matching the dimensions of the image list. This does not apply when adding icons.
      </p><p>Only for:wxmsw,wxosx</p></desc>
  </func>
  
  <func>
    <name name="add" arity="3" clause_i="1" since=""/>
  
    <name name="add" arity="3" clause_i="2" since=""/>
    <fsummary>Adds a new image or images using a bitmap and optional mask bitmap. </fsummary>
    <desc><p>Adds a new image or images using a bitmap and optional mask bitmap. 
      </p><p>Return: The new zero-based image index.
      </p><p>Remark: The original bitmap or icon is not affected by the <seemfa marker="#add/3"><c>add/3</c></seemfa> operation, and can be deleted afterwards. If the bitmap is wider than the images in the list, then the bitmap will automatically be split into smaller images, each matching the dimensions of the image list. This does not apply when adding icons. 
      </p></desc>
  </func>
  
  <func>
    <name name="create" arity="3" clause_i="1" since=""/>
    <fsummary>See: <c>create/4</c></fsummary>
  </func>
  
  <func>
    <name name="create" arity="4" clause_i="1" since=""/>
    <fsummary>Initializes the list. </fsummary>
    <desc><p>Initializes the list. 
      </p><p>See <seemfa marker="#new/3"><c>new/3</c></seemfa> for details. 
      </p></desc>
  </func>
  
  <func>
    <name name="draw" arity="5" clause_i="1" since=""/>
    <fsummary>See: <c>draw/6</c></fsummary>
  </func>
  
  <func>
    <name name="draw" arity="6" clause_i="1" since=""/>
    <fsummary>Draws a specified image onto a device context. </fsummary>
    <desc><p>Draws a specified image onto a device context. 
      </p></desc>
  </func>
  
  <func>
    <name name="getBitmap" arity="2" clause_i="1" since=""/>
    <fsummary>Returns the bitmap corresponding to the given index. </fsummary>
    <desc><p>Returns the bitmap corresponding to the given index. 
      </p></desc>
  </func>
  
  <func>
    <name name="getIcon" arity="2" clause_i="1" since=""/>
    <fsummary>Returns the icon corresponding to the given index. </fsummary>
    <desc><p>Returns the icon corresponding to the given index. 
      </p></desc>
  </func>
  
  <func>
    <name name="getImageCount" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the number of images in the list. </fsummary>
    <desc><p>Returns the number of images in the list. 
      </p></desc>
  </func>
  
  <func>
    <name name="getSize" arity="2" clause_i="1" since=""/>
    <fsummary>Retrieves the size of the images in the list. </fsummary>
    <desc><p>Retrieves the size of the images in the list. 
      </p><p>Currently, the <c>index</c> parameter is ignored as all images in the list have the same size.
      </p><p>Return: true if the function succeeded, false if it failed (for example, if the image list was not yet initialized). 
      </p></desc>
  </func>
  
  <func>
    <name name="remove" arity="2" clause_i="1" since=""/>
    <fsummary>Removes the image at the given position. </fsummary>
    <desc><p>Removes the image at the given position. 
      </p></desc>
  </func>
  
  <func>
    <name name="removeAll" arity="1" clause_i="1" since=""/>
    <fsummary>Removes all the images in the list. </fsummary>
    <desc><p>Removes all the images in the list. 
      </p></desc>
  </func>
  
  <func>
    <name name="replace" arity="3" clause_i="1" since=""/>
    <fsummary>Replaces the existing image with the new image. </fsummary>
    <desc><p>Replaces the existing image with the new image. 
      </p><p>Return: true if the replacement was successful, false otherwise.
      </p><p>Remark: The original bitmap or icon is not affected by the <seemfa marker="#replace/4"><c>replace/4</c></seemfa> operation, and can be deleted afterwards.
      </p><p>Only for:wxmsw,wxosx</p></desc>
  </func>
  
  <func>
    <name name="replace" arity="4" clause_i="1" since=""/>
    <fsummary>Replaces the existing image with the new image. </fsummary>
    <desc><p>Replaces the existing image with the new image. 
      </p><p>Windows only.
      </p><p>Return: true if the replacement was successful, false otherwise.
      </p><p>Remark: The original bitmap or icon is not affected by the <seemfa marker="#replace/4"><c>replace/4</c></seemfa> operation, and can be deleted afterwards. 
      </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>
