.. include:: headings.inc



.. _PySingleChoiceDialog:

==========================================================================================================================================
|phoenix_title|  **PySingleChoiceDialog**
==========================================================================================================================================

This class represents a dialog that shows a list of strings, and allows the user to select one.          

Double-clicking on a list item is equivalent to single-clicking and then pressing ``OK``. 





.. _PySingleChoiceDialog-styles:

|styles| Window Styles
================================

This class supports the following styles: 

- ``OK``: Show an ``OK`` button.  
- ``CANCEL``: Show a Cancel button.  
- ``CENTRE``: Centre the message. Not Windows.  








         



.. seealso:: :ref:`SingleChoiceDialog Overview <singlechoicedialog overview>`, :ref:`MultiChoiceDialog`    







|

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

Inheritance diagram for class **PySingleChoiceDialog**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/SingleChoiceDialog_inheritance.png" alt="Inheritance diagram of PySingleChoiceDialog" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="SingleChoiceDialog.html" title="SingleChoiceDialog" alt="" coords="949,31,1115,62"/> <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="829,31,901,62"/> <area shape="rect" id="node4" href="Trackable.html" title="Add-on base class for a trackable object." alt="" coords="5,5,99,35"/> <area shape="rect" id="node11" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="148,31,247,62"/> <area shape="rect" id="node5" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="16,58,88,89"/> <area shape="rect" id="node6" href="NonOwnedWindow.html" title="Common base class for all non-child windows." alt="" coords="427,31,587,62"/> <area shape="rect" id="node9" href="TopLevelWindow.html" title="TopLevelWindow  is a common base class for Dialog  and Frame." alt="" coords="636,31,780,62"/> <area shape="rect" id="node7" href="Window.html" title="Window  is the base class for all windows and represents any visible object on screen." alt="" coords="297,31,377,62"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~PySingleChoiceDialog.__init__`                                           Constructor, taking an array of `String`  choices and optional client data.
:meth:`~PySingleChoiceDialog.GetSelection`                                       Returns the index of selected item.
:meth:`~PySingleChoiceDialog.GetStringSelection`                                 Returns the selected string.
:meth:`~PySingleChoiceDialog.SetSelection`                                       Sets the index of the initially selected item.
:meth:`~PySingleChoiceDialog.ShowModal`                                          Shows the dialog, returning either ``ID_OK`` or ``ID_CANCEL``.
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~PySingleChoiceDialog.Selection`                                          See :meth:`~PySingleChoiceDialog.GetSelection` and :meth:`~PySingleChoiceDialog.SetSelection`
:attr:`~PySingleChoiceDialog.StringSelection`                                    See :meth:`~PySingleChoiceDialog.GetStringSelection`
================================================================================ ================================================================================


|


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

.. class:: PySingleChoiceDialog(Dialog)

   This class represents a dialog that shows a list of strings, and allows the user to select one.
   
   **Possible constructors**::

       PySingleChoiceDialog(parent, message, caption, choices,
                            style=CHOICEDLG_STYLE, pos=DefaultPosition)
       



   .. method:: __init__(self, *args, **kw)

      Constructor, taking an array of `String`  choices and optional client data.                  




      :param `parent`: Parent window.   
      :type `parent`: Window
      :param `message`: Message to show on the dialog.   
      :type `message`: string
      :param `caption`: The dialog caption.   
      :type `caption`: string
      :param `choices`: An array of strings, or a string list, containing the choices.   
      :type `choices`: list of strings
      :param `style`: A dialog style (bitlist) containing flags chosen from standard dialog styles and the ones listed in the class documentation. The default value is equivalent to ``DEFAULT_DIALOG_STYLE`` | ``RESIZE_BORDER`` | ``OK`` | ``CANCEL`` | ``CENTRE``.   
      :type `style`: long
      :param `pos`: Dialog position. Not Windows.  
      :type `pos`: Point












      An array of client data to be associated with the items. See :meth:`GetSelectionData` .  








      .. note:: 

         Use :meth:`ShowModal`   to show the dialog.  








   .. method:: GetSelection(self)

      Returns the index of selected item.                  

      :rtype: `int`








   .. method:: GetStringSelection(self)

      Returns the selected string.                  

      :rtype: `string`








   .. method:: SetSelection(self, selection)

      Sets the index of the initially selected item.                  


      :param `selection`: 
      :type `selection`: int







   .. method:: ShowModal(self)

      Shows the dialog, returning either ``ID_OK`` or ``ID_CANCEL``.                  

      :rtype: `int`








   .. attribute:: Selection

      See :meth:`~PySingleChoiceDialog.GetSelection` and :meth:`~PySingleChoiceDialog.SetSelection`


   .. attribute:: StringSelection

      See :meth:`~PySingleChoiceDialog.GetStringSelection`