.. include:: headings.inc



.. _MultiChoiceDialog:

==========================================================================================================================================
|phoenix_title|  **MultiChoiceDialog**
==========================================================================================================================================

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





.. _MultiChoiceDialog-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:`MultiChoiceDialog Overview <multichoicedialog overview>`, `SingleChoiceDialog`    







|

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

Inheritance diagram for class **MultiChoiceDialog**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/MultiChoiceDialog_inheritance.png" alt="Inheritance diagram of MultiChoiceDialog" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="Trackable.html" title="Add-on base class for a trackable object." alt="" coords="5,5,99,35"/> <area shape="rect" id="node8" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="148,31,247,62"/> <area shape="rect" id="node2" 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="node3" href="NonOwnedWindow.html" title="Common base class for all non-child windows." alt="" coords="427,31,587,62"/> <area shape="rect" id="node6" href="TopLevelWindow.html" title="TopLevelWindow  is a common base class for Dialog  and Frame." alt="" coords="636,31,780,62"/> <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="297,31,377,62"/> <area shape="rect" id="node12" 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="node11" href="MultiChoiceDialog.html" title="This class represents a dialog that shows a list of strings, and allows the user to select one or more." alt="" coords="951,31,1103,62"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~MultiChoiceDialog.__init__`                                              Constructor taking an array of `String`  choices.
:meth:`~MultiChoiceDialog.GetSelections`                                         Returns array with indexes of selected items.
:meth:`~MultiChoiceDialog.SetSelections`                                         Sets selected items from the array of selected items' indexes.
:meth:`~MultiChoiceDialog.ShowModal`                                             Shows the dialog, returning either ``ID_OK`` or ``ID_CANCEL``.
================================================================================ ================================================================================


|


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

================================================================================ ================================================================================
:attr:`~MultiChoiceDialog.Selections`                                            See :meth:`~MultiChoiceDialog.GetSelections` and :meth:`~MultiChoiceDialog.SetSelections`
================================================================================ ================================================================================


|


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

.. class:: MultiChoiceDialog(Dialog)

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

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



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



      |overload| **Overloaded Implementations**:

      **~~~**

      
      **__init__** `(self, parent, message, caption, n, choices, style=CHOICEDLG_STYLE, pos=DefaultPosition)`
      
      Constructor taking an array of `String`  choices.                  
      
      
      
      
      :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 `n`: The number of choices.   
      :type `n`: int
      :param `choices`: An array of strings, or a string list, containing the choices.   
      :type `choices`: string
      :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
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      .. note:: 
      
         Use :meth:`ShowModal`   to show the dialog.  
      
      
      
      
      
      
      
      **~~~**

      
      **__init__** `(self, parent, message, caption, choices, style=CHOICEDLG_STYLE, pos=DefaultPosition)`
      
      Constructor taking an array of `String`  choices.                  
      
      
      
      
      :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
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      .. note:: 
      
         Use :meth:`ShowModal`   to show the dialog.  
      
      
      
      
      
      
      
      **~~~**






   .. method:: GetSelections(self)

      Returns array with indexes of selected items.                  

      :rtype: `list of integers`








   .. method:: SetSelections(self, selections)

      Sets selected items from the array of selected items' indexes.                  


      :param `selections`: 
      :type `selections`: list of integers







   .. method:: ShowModal(self)

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

      :rtype: `int`








   .. attribute:: Selections

      See :meth:`~MultiChoiceDialog.GetSelections` and :meth:`~MultiChoiceDialog.SetSelections`