<?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>wxIconBundle</title>
</header>
<module>wxIconBundle</module>
<modulesummary>Functions for wxIconBundle class</modulesummary>
<description><p>This class contains multiple copies of an icon in different sizes. It is typically used in <c>wxDialog::SetIcons</c> (not implemented in wx) and <seemfa marker="wxTopLevelWindow#setIcons/2"><c>wxTopLevelWindow:setIcons/2</c></seemfa>.
      </p><p>Predefined objects/pointers: ?wxNullIconBundle
      </p>
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_icon_bundle.html">wxIconBundle</url></p>
  </description>
<datatypes><datatype><name name="wxIconBundle"/></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="1" clause_i="1" since=""/>
  
    <name name="new" arity="1" clause_i="2" since=""/>
    <fsummary>Initializes the bundle with the icon(s) found in the file. </fsummary>
    <desc><p>Initializes the bundle with the icon(s) found in the file. 
      </p></desc>
  </func>
  
  <func>
    <name name="new" arity="2" clause_i="1" since=""/>
    <fsummary/>
    <desc/>
  </func>
  
  <func>
    <name name="destroy" arity="1" clause_i="1" since=""/>
    <fsummary>Destructor. </fsummary>
    <desc><p>Destructor. 
      </p></desc>
  </func>
  
  <func>
    <name name="addIcon" arity="2" clause_i="1" since=""/>
  
    <name name="addIcon" arity="2" clause_i="2" since=""/>
    <fsummary>Adds the icon to the collection; if the collection already contains an icon with the same width and height, it is replaced by the new one. </fsummary>
    <desc><p>Adds the icon to the collection; if the collection already contains an icon with the same width and height, it is replaced by the new one. 
      </p></desc>
  </func>
  
  <func>
    <name name="addIcon" arity="3" clause_i="1" since=""/>
    <fsummary/>
    <desc/>
  </func>
  
  <func>
    <name name="getIcon" arity="1" clause_i="1" since=""/>
    <fsummary>See: <c>getIcon/2</c></fsummary>
  </func>
  
  <func>
    <name name="getIcon" arity="2" clause_i="1" since=""/>
  
    <name name="getIcon" arity="2" clause_i="2" since=""/>
    <fsummary>Same as. </fsummary>
    <desc><p>Same as. 
      </p><p>. 
      </p></desc>
  </func>
  
  <func>
    <name name="getIcon" arity="3" clause_i="1" since=""/>
    <fsummary>Returns the icon with the given size. </fsummary>
    <desc><p>Returns the icon with the given size. 
      </p><p>If <c>size</c> is ?wxDefaultSize, it is interpreted as the standard system icon size, i.e. the size returned by <seemfa marker="wxSystemSettings#getMetric/2"><c>wxSystemSettings:getMetric/2</c></seemfa> for <c>wxSYS_ICON_X</c> and <c>wxSYS_ICON_Y</c>.
      </p><p>If the bundle contains an icon with exactly the requested size, it's always returned. Otherwise, the behaviour depends on the flags. If only <c>wxIconBundle::FALLBACK_NONE</c> (not implemented in wx) is given, the function returns an invalid icon. If <c>wxIconBundle::FALLBACK_SYSTEM</c> (not implemented in wx) is given, it tries to find the icon of standard system size, regardless of the size passed as parameter. Otherwise, or if the icon system size is not found neither, but <c>wxIconBundle::FALLBACK_NEAREST_LARGER</c> (not implemented in wx) flag is specified, the function returns the smallest icon of the size larger than the requested one or, if this fails too, just the icon closest to the specified size.
      </p><p>The <c>flags</c> parameter is available only since wxWidgets 2.9.4. 
      </p></desc>
  </func>
  </funcs>
</erlref>
