<?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>wxBitmapButton</title>
</header>
<module>wxBitmapButton</module>
<modulesummary>Functions for wxBitmapButton class</modulesummary>
<description><p>A bitmap button is a control that contains a bitmap.
      </p><p>Notice that since wxWidgets 2.9.1 bitmap display is supported by the base <seeerl marker="wxButton"><c>wxButton</c></seeerl> class itself and the only tiny advantage of using this class is that it allows specifying the bitmap in its constructor, unlike <seeerl marker="wxButton"><c>wxButton</c></seeerl>. Please see the base class documentation for more information about images support in <seeerl marker="wxButton"><c>wxButton</c></seeerl>.
      </p><p>Styles</p><p>This class supports the following styles:
      </p><p>See: <seeerl marker="wxButton"><c>wxButton</c></seeerl>
      </p>
  <p>This class is derived (and can use functions) from: 
    <seeerl marker="wxButton"><c>wxButton</c></seeerl> <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_bitmap_button.html">wxBitmapButton</url></p>
  </description><section><title>Events</title><p>Event types emitted from this class: <seeerl marker="wxCommandEvent"><c>command_button_clicked</c></seeerl></p></section>
<datatypes><datatype><name name="wxBitmapButton"/></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="3" clause_i="1" since=""/>
    <fsummary>See: <c>new/4</c></fsummary>
  </func>
  
  <func>
    <name name="new" arity="4" clause_i="1" since=""/>
    <fsummary>Constructor, creating and showing a button. </fsummary>
    <desc><p>Constructor, creating and showing a button. 
      </p><p>Remark: The bitmap parameter is normally the only bitmap you need to provide, and wxWidgets will draw the button correctly in its different states. If you want more control, call any of the functions <c>SetBitmapPressed()</c> (not implemented in wx), <seemfa marker="wxButton#setBitmapFocus/2"><c>wxButton:setBitmapFocus/2</c></seemfa>, <seemfa marker="wxButton#setBitmapDisabled/2"><c>wxButton:setBitmapDisabled/2</c></seemfa>.
      </p><p>See: <seemfa marker="#create/5"><c>create/5</c></seemfa>, <c>wxValidator</c> (not implemented in wx)
      </p></desc>
  </func>
  
  <func>
    <name name="create" arity="4" clause_i="1" since=""/>
    <fsummary>See: <c>create/5</c></fsummary>
  </func>
  
  <func>
    <name name="create" arity="5" clause_i="1" since=""/>
    <fsummary>Button creation function for two-step creation. </fsummary>
    <desc><p>Button creation function for two-step creation. 
      </p><p>For more details, see <seemfa marker="#new/4"><c>new/4</c></seemfa>. 
      </p></desc>
  </func>
  
  <func>
    <name name="newCloseButton" arity="2" clause_i="1" since=""/>
    <fsummary>Helper function creating a standard-looking "Close" button. </fsummary>
    <desc><p>Helper function creating a standard-looking "Close" button. 
      </p><p>To get the best results, platform-specific code may need to be used to create a small, title bar-like "Close" button. This function is provided to avoid the need to test for the current platform and creates the button with as native look as possible.
      </p><p>Return: The new button.
      </p><p>Since: 2.9.5 
      </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>
