.. include:: headings.inc

.. module:: lib.buttons

.. currentmodule:: lib.buttons

.. highlight:: python



.. _lib.buttons:

==========================================================================================================================================
|phoenix_title|  **buttons**
==========================================================================================================================================

This module implements various forms of generic buttons, meaning that
they are not built on native controls but are self-drawn.  They act
like normal buttons but you are able to better control how they look,
bevel width, colours, etc.



|

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

Inheritance diagram for module **buttons**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.buttons_inheritance.png" alt="Inheritance diagram of buttons" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="lib.buttons.ThemedGenBitmapTextToggleButton.html" title="A themed generic toggle bitmap button with text label" alt="" coords="2145,138,2484,169"/> <area shape="rect" id="node2" href="lib.buttons.__ThemedMixin.html" title="Use the native renderer to draw the bezel, also handle mouse-overs" alt="" coords="1513,217,1705,247"/> <area shape="rect" id="node6" href="lib.buttons.ThemedGenToggleButton.html" title="A themed generic toggle button" alt="" coords="1809,5,2071,35"/> <area shape="rect" id="node10" href="lib.buttons.ThemedGenBitmapButton.html" title="A themed generic bitmap button." alt="" coords="1809,269,2071,299"/> <area shape="rect" id="node30" href="lib.buttons.ThemedGenBitmapToggleButton.html" title="A themed generic toggle bitmap button" alt="" coords="1785,111,2095,142"/> <area shape="rect" id="node35" href="lib.buttons.ThemedGenBitmapTextButton.html" title="A themed generic bitmapped button with text label" alt="" coords="1795,165,2085,195"/> <area shape="rect" id="node40" href="lib.buttons.ThemedGenButton.html" title="A themed generic button" alt="" coords="1833,322,2047,353"/> <area shape="rect" id="node4" href="lib.buttons.GenBitmapTextToggleButton.html" title="A generic toggle bitmap button with text label" alt="" coords="1799,58,2081,89"/> <area shape="rect" id="node8" href="lib.buttons.GenToggleButton.html" title="A generic toggle button" alt="" coords="1508,6,1711,37"/> <area shape="rect" id="node12" href="lib.buttons.GenBitmapButton.html" title="A generic bitmap button." alt="" coords="1229,163,1435,194"/> <area shape="rect" id="node32" href="lib.buttons.GenBitmapToggleButton.html" title="A generic toggle bitmap button" alt="" coords="1483,110,1736,141"/> <area shape="rect" id="node37" href="lib.buttons.GenBitmapTextButton.html" title="A generic bitmapped button with text label" alt="" coords="1492,163,1727,194"/> <area shape="rect" id="node14" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="247,163,345,194"/> <area shape="rect" id="node46" href="Window.html" title="Window  is the base class for all windows and represents any visible object on screen." alt="" coords="423,163,503,194"/> <area shape="rect" id="node15" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="125,190,197,221"/> <area shape="rect" id="node23" href="Event.html" title="An event is a structure holding information about an event passed to a callback or member function." alt="" coords="260,217,332,247"/> <area shape="rect" id="node17" href="lib.buttons.__ToggleMixin.html" title="buttons.__ToggleMixin" alt="" coords="1241,58,1423,89"/> <area shape="rect" id="node19" href="lib.buttons.GenButton.html" title="A generic button, and base class for the other generic buttons." alt="" coords="1027,163,1181,194"/> <area shape="rect" id="node26" href="CommandEvent.html" title="This event class contains information about command events, which originate from a variety of simple controls." alt="" coords="395,217,531,247"/> <area shape="rect" id="node28" href="lib.buttons.GenButtonEvent.html" title="Event sent from the generic buttons when the button is activated." alt="" coords="784,217,979,247"/> <area shape="rect" id="node44" href="Control.html" title="This is the base class for a control or 'widget'." alt="" coords="620,163,695,194"/> </map> 
   </p>

|


|class_summary| Classes Summary
===============================

================================================================================ ================================================================================
:ref:`lib.buttons.__ThemedMixin`                                                 Use the native renderer to draw the bezel, also handle mouse-overs
:ref:`lib.buttons.__ToggleMixin`                                                 
:ref:`lib.buttons.GenBitmapButton`                                               A generic bitmap button.
:ref:`lib.buttons.GenBitmapTextButton`                                           A generic bitmapped button with text label
:ref:`lib.buttons.GenBitmapTextToggleButton`                                     A generic toggle bitmap button with text label
:ref:`lib.buttons.GenBitmapToggleButton`                                         A generic toggle bitmap button
:ref:`lib.buttons.GenButton`                                                     A generic button, and base class for the other generic buttons.
:ref:`lib.buttons.GenButtonEvent`                                                Event sent from the generic buttons when the button is activated.
:ref:`lib.buttons.GenToggleButton`                                               A generic toggle button
:ref:`lib.buttons.ThemedGenBitmapButton`                                         A themed generic bitmap button.
:ref:`lib.buttons.ThemedGenBitmapTextButton`                                     A themed generic bitmapped button with text label
:ref:`lib.buttons.ThemedGenBitmapTextToggleButton`                               A themed generic toggle bitmap button with text label
:ref:`lib.buttons.ThemedGenBitmapToggleButton`                                   A themed generic toggle bitmap button
:ref:`lib.buttons.ThemedGenButton`                                               A themed generic button
:ref:`lib.buttons.ThemedGenToggleButton`                                         A themed generic toggle button
================================================================================ ================================================================================


|


.. toctree::
   :maxdepth: 1
   :hidden:

   lib.buttons.__ThemedMixin
   lib.buttons.__ToggleMixin
   lib.buttons.GenBitmapButton
   lib.buttons.GenBitmapTextButton
   lib.buttons.GenBitmapTextToggleButton
   lib.buttons.GenBitmapToggleButton
   lib.buttons.GenButton
   lib.buttons.GenButtonEvent
   lib.buttons.GenToggleButton
   lib.buttons.ThemedGenBitmapButton
   lib.buttons.ThemedGenBitmapTextButton
   lib.buttons.ThemedGenBitmapTextToggleButton
   lib.buttons.ThemedGenBitmapToggleButton
   lib.buttons.ThemedGenButton
   lib.buttons.ThemedGenToggleButton