********************
wx.MultiChoiceDialog
********************

Inheritance diagram for `wx.MultiChoiceDialog`:

|

.. inheritance-diagram:: wx.MultiChoiceDialog

|

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

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


.. seealso:: `wx.SingleChoiceDialog <wx.SingleChoiceDialog.html>`_


Derived From
^^^^^^^^^^^^^

* `wx.Dialog <wx.Dialog.html>`_ 
* `wx.Window <wx.Window.html>`_ 
* `wx.EvtHandler <wx.EvtHandler.html>`_ 
* `wx.Object <wx.Object.html>`_ 


Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `GetSelections <#GetSelections>`_ 
* `SetSelections <#SetSelections>`_ 
* `ShowModal <#ShowModal>`_ 

Properties Summary
^^^^^^^^^^^^^^^^^^

* `Selections <#Selections>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(parent, message, caption, choices=[], style=wx.CHOICEDLG_STYLE, pos=wx.DefaultPosition)

   Constructor. Use the `ShowModal <#ShowModal>`_ method to show the dialog.
   
   **Parameters:**:

   * `parent` (`wx.Window <wx.Window.html>`_): The parent window.
   * `message` (string): Text to display above the list of selections.
   * `caption` (string): Text to use in the title bar of the dialog.
   * `choices` (list of strings): A list of strings or unicode objects that the user is allowed to choose from.
   * `style` (int): Styles to apply to the dialog.  The default value is equivallent to ``wx.DEFAULT_DIALOG_STYLE`` | ``wx.RESIZE_BORDER`` | ``wx.OK`` | ``wx.CANCEL`` | ``wx.CENTER``.
   * `pos` (`wx.Point <wx.Point.html>`_): Where to position the dialog (not used on Windows)
   
   |

   **Returns:**

   `wx.MultiChoiceDialog <wx.MultiChoiceDialog.html>`_
 

--------

.. method:: GetSelections()

   Returns array with indexes of selected items.

   |  

   **Returns:**

   `list of integers` 

--------

.. method:: SetSelections(selections)

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

   **Parameters:**

   * `selections` (list of integers) 

--------

.. method:: ShowModal()

   Shows the dialog, returning one of ``wx.ID_OK`` or ``wx.ID_CANCEL``.

   |

   **Returns:**

   `int`

--------


Properties
^^^^^^^^^^


.. attribute:: Selections

   See `GetSelections <#GetSelections>`_ and `SetSelections <#SetSelections>`_