.. include:: headings.inc

.. module:: lib.agw.aquabutton

.. currentmodule:: lib.agw.aquabutton

.. highlight:: python



.. _lib.agw.aquabutton:

==========================================================================================================================================
|phoenix_title|  **aquabutton**
==========================================================================================================================================

:class:`AquaButton` is another custom-drawn button class which *approximatively* mimics
the behaviour of Aqua buttons on the Mac.


Description
===========

:class:`AquaButton` is another custom-drawn button class which *approximatively* mimics
the behaviour of Aqua buttons on the Mac. At the moment this class supports:

* Bubble and shadow effects;
* Customizable background, foreground and hover colours;
* Rounded-corners buttons;
* Text-only or image+text buttons;
* Pulse effect on gaining focus.

And a lot more. Check the demo for an almost complete review of the functionalities.


Usage
=====

Sample usage::

    import wx
    import wx.lib.agw.aquabutton as AB

    app = wx.App(0)

    frame = wx.Frame(None, -1, "AquaButton Test")
    
    mainPanel = wx.Panel(frame)
    mainPanel.SetBackgroundColour(wx.WHITE)
    
    # Initialize AquaButton 1 (with image)
    bitmap = wx.Bitmap("my_button_bitmap.png", wx.BITMAP_TYPE_PNG)
    btn1 = AB.AquaButton(mainPanel, -1, bitmap, "AquaButton")
    
    # Initialize AquaButton 2 (no image)
    btn2 = AB.AquaButton(mainPanel, -1, None, "Hello World!")

    frame.Show()
    
    app.MainLoop()


Supported Platforms
===================

AquaButton has been tested on the following platforms:
  * Windows (Windows XP);
  * Linux Ubuntu (10.10).


Window Styles
=============

`No particular window styles are available for this class.`


Events Processing
=================

This class processes the following events:

================= ==================================================
Event Name        Description
================= ==================================================
``EVT_BUTTON``    Process a `wxEVT_COMMAND_BUTTON_CLICKED` event, when the button is clicked.
================= ==================================================


License And Version
===================

:class:`AquaButton` control is distributed under the wxPython license.

Latest Revision: Andrea Gavana @ 22 Nov 2011, 22.00 GMT

Version 0.4



|

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

Inheritance diagram for module **aquabutton**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.agw.aquabutton_inheritance.png" alt="Inheritance diagram of aquabutton" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node16" href="lib.agw.aquabutton.AquaButton.html" title="This is the main class implementation of AquaButton." alt="" coords="1075,18,1264,49"/> <area shape="rect" id="node2" href="Control.html" title="This is the base class for a control or 'widget'." alt="" coords="620,5,695,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="423,5,503,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,58,197,89"/> <area shape="rect" id="node24" href="Event.html" title="An event is a structure holding information about an event passed to a callback or member function." alt="" coords="260,58,332,89"/> <area shape="rect" id="node10" href="lib.agw.aquabutton.__ToggleMixin.html" title="A mixin that allows to transform AquaButton in the corresponding toggle button." alt="" coords="1064,85,1275,115"/> <area shape="rect" id="node18" href="lib.agw.aquabutton.AquaToggleButton.html" title="An AquaButton toggle button." alt="" coords="1324,51,1561,82"/> <area shape="rect" id="node22" href="lib.agw.aquabutton.AquaButtonEvent.html" title="Event sent from the AquaButton buttons when the button is activated." alt="" coords="785,58,1015,89"/> <area shape="rect" id="node14" href="CommandEvent.html" title="This event class contains information about command events, which originate from a variety of simple controls." alt="" coords="395,58,531,89"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:ref:`lib.agw.aquabutton.__ToggleMixin`                                          A mixin that allows to transform :class:`AquaButton` in the corresponding toggle button.
:ref:`lib.agw.aquabutton.AquaButton`                                             This is the main class implementation of :class:`AquaButton`.
:ref:`lib.agw.aquabutton.AquaButtonEvent`                                        Event sent from the :class:`AquaButton` buttons when the button is activated.
:ref:`lib.agw.aquabutton.AquaToggleButton`                                       An :class:`AquaButton` toggle button.
================================================================================ ================================================================================


|


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

   lib.agw.aquabutton.__ToggleMixin
   lib.agw.aquabutton.AquaButton
   lib.agw.aquabutton.AquaButtonEvent
   lib.agw.aquabutton.AquaToggleButton