.. include:: headings.inc

.. currentmodule:: lib.buttons

.. highlight:: python



.. _lib.buttons.GenBitmapButton:

==========================================================================================================================================
|phoenix_title|  **GenBitmapButton**
==========================================================================================================================================

A generic bitmap button.



|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **GenBitmapButton**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.buttons.GenBitmapButton_inheritance.png" alt="Inheritance diagram of GenBitmapButton" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node13" href="lib.buttons.GenButton.html" title="A generic button, and base class for the other generic buttons." alt="" coords="792,5,947,35"/> <area shape="rect" id="node2" href="Control.html" title="This is the base class for a control or 'widget'." alt="" coords="525,5,600,35"/> <area shape="rect" id="node4" href="Window.html" title="Window  is the base class for all windows and represents any visible object on screen." alt="" coords="396,5,476,35"/> <area shape="rect" id="node6" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="247,5,345,35"/> <area shape="rect" id="node8" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="125,5,197,35"/> <area shape="rect" id="node12" href="lib.buttons.GenBitmapButton.html" title="A generic bitmap button." alt="" coords="995,5,1200,35"/> </map> 
   </p>

|


|sub_classes| Known Subclasses
==============================

:class:`lib.buttons.GenBitmapTextButton`, :class:`lib.buttons.GenBitmapToggleButton`, :class:`lib.buttons.ThemedGenBitmapButton`

|


|super_classes| Known Superclasses
==================================

:class:`lib.buttons.GenButton`

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~lib.buttons.GenBitmapButton.__init__`                                    
:meth:`~lib.buttons.GenBitmapButton.DrawLabel`                                   
:meth:`~lib.buttons.GenBitmapButton.GetBitmapDisabled`                           
:meth:`~lib.buttons.GenBitmapButton.GetBitmapFocus`                              
:meth:`~lib.buttons.GenBitmapButton.GetBitmapLabel`                              
:meth:`~lib.buttons.GenBitmapButton.GetBitmapSelected`                           
:meth:`~lib.buttons.GenBitmapButton.SetBitmapDisabled`                           Set bitmap to display when the button is disabled
:meth:`~lib.buttons.GenBitmapButton.SetBitmapFocus`                              Set bitmap to display when the button has the focus
:meth:`~lib.buttons.GenBitmapButton.SetBitmapLabel`                              Set the bitmap to display normally.
:meth:`~lib.buttons.GenBitmapButton.SetBitmapSelected`                           Set bitmap to display when the button is selected (pressed down)
================================================================================ ================================================================================


|


|api| Class API
===============
   

.. class:: GenBitmapButton(GenButton)

   A generic bitmap button.

   .. method:: __init__(self, parent, id=-1, bitmap=NullBitmap, pos = DefaultPosition, size = DefaultSize, style = 0, validator = DefaultValidator, name = "genbutton")


   .. method:: DrawLabel(self, dc, width, height, dx=0, dy=0)


   .. method:: GetBitmapDisabled(self)


   .. method:: GetBitmapFocus(self)


   .. method:: GetBitmapLabel(self)


   .. method:: GetBitmapSelected(self)


   .. method:: SetBitmapDisabled(self, bitmap)

      Set bitmap to display when the button is disabled


   .. method:: SetBitmapFocus(self, bitmap)

      Set bitmap to display when the button has the focus


   .. method:: SetBitmapLabel(self, bitmap, createOthers=True)

      Set the bitmap to display normally.
      This is the only one that is required. If
      createOthers is True, then the other bitmaps
      will be generated on the fly.  Currently,
      only the disabled bitmap is generated.


   .. method:: SetBitmapSelected(self, bitmap)

      Set bitmap to display when the button is selected (pressed down)