.. include:: headings.inc

.. module:: lib.agw.genericmessagedialog

.. currentmodule:: lib.agw.genericmessagedialog

.. highlight:: python



.. _lib.agw.genericmessagedialog:

==========================================================================================================================================
|phoenix_title|  **genericmessagedialog**
==========================================================================================================================================

This class is a possible, fancy replacement for :class:`MessageDialog`.


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

This class represents a dialog that shows a single or multi-line message,
with a choice of ``OK``, ``Yes``, ``No``, ``Cancel`` and ``Help`` buttons. It is a possible
replacement for the standard :class:`MessageDialog`, with these extra functionalities:

* Possibility to modify the dialog position;
* Custom themed generic bitmap & text buttons;
* Support for normal and extended message (in different fonts);
* Custom labels for the ``OK``, ``Yes``, ``No``, ``Cancel`` and ``Help`` buttons;
* Custom icons for the ``OK``, ``Yes``, ``No``, ``Cancel`` and ``Help`` buttons;
* Possibility to set an icon to the dialog;
* More visibility to the button getting the focus;
* Support for Aqua buttons or Gradient buttons instead of themed ones (see :class:`AquaButton`
  and :class:`GradientButton`);
* Possibility to automatically wrap long lines of text;
* Good old Python code :-D .

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


Usage
=====

Usage example::

    import wx
    import wx.lib.agw.genericmessagedialog as GMD

    # Our normal wxApp-derived class, as usual
    app = wx.App(0)
    
    main_message = "Hello world! I am the main message."
    
    dlg = GMD.GenericMessageDialog(None, main_message, "A Nice Message Box",
                                   agwStyle=wx.ICON_INFORMATION|wx.OK)
                                   
    dlg.ShowModal()
    dlg.Destroy()

    app.MainLoop()



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

:class:`GenericMessageDialog` has been tested on the following platforms:
  * Windows (Windows XP).


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

This class supports the following window styles:

=========================== =========== ==================================================
Window Styles               Hex Value   Description
=========================== =========== ==================================================
``GMD_DEFAULT``                     0x0 Uses generic buttons.
``GMD_USE_AQUABUTTONS``            0x20 Uses :mod:`lib.agw.aquabutton` buttons instead of generic buttons.
``GMD_USE_GRADIENTBUTTONS``        0x40 Uses :mod:`lib.agw.gradientbutton` buttons instead of generic buttons.
=========================== =========== ==================================================

The styles above are mutually exclusive. The style chosen above can be combined with a
bitlist containing flags chosen from the following:

=========================== =========== ==================================================
Window Styles               Hex Value   Description
=========================== =========== ==================================================
``OK``                              0x4 Shows an ``OK`` button.  
``CANCEL``                         0x10 Shows a ``Cancel`` button.  
``YES_NO``                          0xA Show ``Yes`` and ``No`` buttons.
``YES_DEFAULT``                     0x0 Used with ``YES_NO``   , makes ``Yes`` button the default - which is the default behaviour.  
``NO_DEFAULT``                     0x80 Used with ``YES_NO``   , makes ``No`` button the default.  
``ICON_EXCLAMATION``              0x100 Shows an exclamation mark icon.  
``ICON_HAND``                     0x200 Shows an error icon.  
``ICON_ERROR``                    0x200 Shows an error icon - the same as ``ICON_HAND``   .  
``ICON_QUESTION``                 0x400 Shows a question mark icon.  
``ICON_INFORMATION``              0x800 Shows an information icon.  
=========================== =========== ==================================================


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

`No custom events are available for this class.`


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

:class:`GenericMessageDialog` is distributed under the wxPython license.

Latest Revision: Andrea Gavana @ 14 Mar 2012, 21.00 GMT

Version 0.7



|

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

Inheritance diagram for module **genericmessagedialog**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.agw.genericmessagedialog_inheritance.png" alt="Inheritance diagram of genericmessagedialog" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="Window.html" title="Window  is the base class for all windows and represents any visible object on screen." alt="" coords="399,5,479,35"/> <area shape="rect" id="node17" href="TopLevelWindow.html" title="TopLevelWindow  is a common base class for Dialog  and Frame." alt="" coords="631,5,775,35"/> <area shape="rect" id="node2" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="247,5,345,35"/> <area shape="rect" id="node4" href="lib.agw.genericmessagedialog.GenericMessageDialog.html" title="Main class implementation, GenericMessageDialog is a possible replacement" alt="" coords="1044,5,1401,35"/> <area shape="rect" id="node5" href="Dialog.html" title="A dialog box is a window with a title bar and sometimes a system menu, which can be moved around the screen." alt="" coords="923,5,995,35"/> <area shape="rect" id="node7" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="125,31,197,62"/> <area shape="rect" id="node10" href="Sizer.html" title="Sizer  is the abstract base class used for laying out subwindows in a window." alt="" coords="260,58,332,89"/> <area shape="rect" id="node9" href="BoxSizer.html" title="The basic idea behind a box sizer is that windows will most often be laid out in rather simple basic geometry, typically in a row or a column or several hierarchies of either." alt="" coords="396,58,481,89"/> <area shape="rect" id="node12" href="lib.agw.genericmessagedialog.StdDialogButtonSizer.html" title="wxWidgets standard dialog button sizer." alt="" coords="531,58,875,89"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:ref:`lib.agw.genericmessagedialog.GenericMessageDialog`                         Main class implementation, :class:`GenericMessageDialog` is a possible replacement
:ref:`lib.agw.genericmessagedialog.StdDialogButtonSizer`                         wxWidgets standard dialog button sizer.
================================================================================ ================================================================================


|


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

   lib.agw.genericmessagedialog.GenericMessageDialog
   lib.agw.genericmessagedialog.StdDialogButtonSizer