.. include:: headings.inc

.. module:: lib.dialogs

.. currentmodule:: lib.dialogs

.. highlight:: python



.. _lib.dialogs:

==========================================================================================================================================
|phoenix_title|  **dialogs**
==========================================================================================================================================





|

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

Inheritance diagram for module **dialogs**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.dialogs_inheritance.png" alt="Inheritance diagram of dialogs" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="lib.dialogs.MultiMessageDialog.html" title="A dialog like wx.MessageDialog, but with an optional 2nd message string" alt="" coords="957,5,1179,35"/> <area shape="rect" id="node2" 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="824,58,896,89"/> <area shape="rect" id="node9" href="lib.dialogs.MultipleChoiceDialog.html" title="dialogs.MultipleChoiceDialog" alt="" coords="953,58,1183,89"/> <area shape="rect" id="node11" href="lib.dialogs.ScrolledMessageDialog.html" title="dialogs.ScrolledMessageDialog" alt="" coords="944,111,1192,142"/> <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="500,58,580,89"/> <area shape="rect" id="node16" href="TopLevelWindow.html" title="TopLevelWindow  is a common base class for Dialog  and Frame." alt="" coords="631,58,775,89"/> <area shape="rect" id="node5" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="351,58,449,89"/> <area shape="rect" id="node7" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="229,58,301,89"/> <area shape="rect" id="node13" href="lib.dialogs.DialogResults.html" title="dialogs.DialogResults" alt="" coords="5,5,181,35"/> </map> 
   </p>

|


|function_summary| Functions Summary
====================================

================================================================================ ================================================================================
:func:`~lib.dialogs.alertDialog`                                                 
:func:`~lib.dialogs.colorDialog`                                                 
:func:`~lib.dialogs.colourDialog`                                                
:func:`~lib.dialogs.dirDialog`                                                   
:func:`~lib.dialogs.fileDialog`                                                  
:func:`~lib.dialogs.findDialog`                                                  
:func:`~lib.dialogs.fontDialog`                                                  
:func:`~lib.dialogs.messageDialog`                                               
:func:`~lib.dialogs.MultiMessageBox`                                             A function like wx.MessageBox which uses MultiMessageDialog.
:func:`~lib.dialogs.multipleChoiceDialog`                                        
:func:`~lib.dialogs.openFileDialog`                                              
:func:`~lib.dialogs.returnedString`                                              
:func:`~lib.dialogs.saveFileDialog`                                              
:func:`~lib.dialogs.scrolledMessageDialog`                                       
:func:`~lib.dialogs.singleChoiceDialog`                                          
:func:`~lib.dialogs.textEntryDialog`                                             
================================================================================ ================================================================================


|


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

================================================================================ ================================================================================
:ref:`lib.dialogs.DialogResults`                                                 
:ref:`lib.dialogs.MultiMessageDialog`                                            A dialog like wx.MessageDialog, but with an optional 2nd message string
:ref:`lib.dialogs.MultipleChoiceDialog`                                          
:ref:`lib.dialogs.ScrolledMessageDialog`                                         
================================================================================ ================================================================================


|


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

   lib.dialogs.DialogResults
   lib.dialogs.MultiMessageDialog
   lib.dialogs.MultipleChoiceDialog
   lib.dialogs.ScrolledMessageDialog





Functions
------------

.. function:: alertDialog(parent=None, message='', title='Alert', pos=DefaultPosition)


.. function:: colorDialog(parent=None, colorData=None, color=None)


.. function:: colourDialog(parent=None, colourData=None, colour=None)


.. function:: dirDialog(parent=None, message='Choose a directory', path='', style=0, pos=DefaultPosition, size=DefaultSize)


.. function:: fileDialog(parent=None, title='Open', directory='', filename='', wildcard='\*.\*', style=OPEN | MULTIPLE)


.. function:: findDialog(parent=None, searchText='', wholeWordsOnly=0, caseSensitive=0)


.. function:: fontDialog(parent=None, fontData=None, font=None)


.. function:: messageDialog(parent=None, message='', title='Message box', aStyle = OK | CANCEL | CENTRE, pos=DefaultPosition)


.. function:: MultiMessageBox(message, caption, msg2="", style=OK, parent=None, icon=None, btnLabels=None)

   A function like wx.MessageBox which uses MultiMessageDialog.


.. function:: multipleChoiceDialog(parent=None, message='', title='', lst=[], pos=DefaultPosition, size=DefaultSize)


.. function:: openFileDialog(parent=None, title='Open', directory='', filename='', wildcard='All Files (\*.\*)|\*.\*', style=OPEN | MULTIPLE)


.. function:: returnedString(ret)


.. function:: saveFileDialog(parent=None, title='Save', directory='', filename='', wildcard='All Files (\*.\*)|\*.\*', style=SAVE | OVERWRITE_PROMPT)


.. function:: scrolledMessageDialog(parent=None, message='', title='', pos=DefaultPosition, size=(500,300))


.. function:: singleChoiceDialog(parent=None, message='', title='', lst=[], style=OK | CANCEL | CENTRE)


.. function:: textEntryDialog(parent=None, message='', title='', defaultText='', style=OK | CANCEL)