.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.SingleChoiceDialog:
==========================================================================================================================================
|phoenix_title| **wx.SingleChoiceDialog**
==========================================================================================================================================
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 ``wx.OK``.
.. _SingleChoiceDialog-styles:
|styles| Window Styles
================================
This class supports the following styles:
- ``wx.OK``: Show an ``wx.OK`` button.
- ``wx.CANCEL``: Show a Cancel button.
- ``wx.CENTRE``: Centre the message.
.. seealso:: :ref:`SingleChoiceDialog Overview <singlechoicedialog overview>`, :ref:`wx.MultiChoiceDialog`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>SingleChoiceDialog</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.SingleChoiceDialog_inheritance.svg" alt="Inheritance diagram of SingleChoiceDialog" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.SingleChoiceDialog.html" title="This class represents a dialog that shows a list of strings, and allows the user to select one." alt="" coords="23,466,220,495"/> <area shape="rect" id="node2" href="wx.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="72,389,171,418"/> <area shape="rect" id="node3" href="wx.TopLevelWindow.html" title="wx.TopLevelWindow is a common base class for wx.Dialog and wx.Frame." alt="" coords="34,313,209,341"/> <area shape="rect" id="node4" href="wx.NonOwnedWindow.html" title="Common base class for all non-child windows." alt="" coords="26,236,217,265"/> <area shape="rect" id="node5" href="wx.Window.html" title="wx.Window is the base class for all windows and represents any visible object on screen." alt="" coords="66,159,177,188"/> <area shape="rect" id="node6" href="wx.EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="55,82,188,111"/> <area shape="rect" id="node7" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="5,5,104,34"/> <area shape="rect" id="node8" href="wx.Trackable.html" title="Add-on base class for a trackable object." alt="" coords="128,5,251,34"/> </map>
</p>
</div>
|
|appearance| Control Appearance
===============================
|
.. container:: control-appearance-figures
.. figure:: _static/images/widgets/fullsize/wxmsw/wx.singlechoicedialog.png
:alt: wxMSW
:figclass: appearance-figure
**wxMSW**
.. figure:: _static/images/widgets/fullsize/wxmac/../no_appearance.png
:alt: wxMAC
:figclass: appearance-figure
**wxMAC**
.. figure:: _static/images/widgets/fullsize/wxgtk/wx.singlechoicedialog.png
:alt: wxGTK
:figclass: appearance-figure
**wxGTK**
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.SingleChoiceDialog.__init__` Constructor, taking an array of `String` choices and optional client data.
:meth:`~wx.SingleChoiceDialog.GetClassDefaultAttributes`
:meth:`~wx.SingleChoiceDialog.GetSelection` Returns the index of selected item.
:meth:`~wx.SingleChoiceDialog.GetStringSelection` Returns the selected string.
:meth:`~wx.SingleChoiceDialog.SetSelection` Sets the index of the initially selected item.
:meth:`~wx.SingleChoiceDialog.ShowModal` Shows the dialog, returning either ``wx.ID_OK`` or ``wx.ID_CANCEL``.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.SingleChoiceDialog.Selection` See :meth:`~wx.SingleChoiceDialog.GetSelection` and :meth:`~wx.SingleChoiceDialog.SetSelection`
:attr:`~wx.SingleChoiceDialog.StringSelection` See :meth:`~wx.SingleChoiceDialog.GetStringSelection`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.SingleChoiceDialog(Dialog)
PySingleChoiceDialog(parent, message, caption, choices, style=CHOICEDLG_STYLE, pos=DefaultPosition) . None
This class represents a dialog that shows a list of strings, and
allows the user to select one.
.. method:: __init__(self, parent, message, caption, choices, style=CHOICEDLG_STYLE, pos=DefaultPosition)
Constructor, taking an array of `String` choices and optional client data.
:param `parent`: Parent window.
:type `parent`: wx.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 ``wx.DEFAULT_DIALOG_STYLE`` | ``wx.RESIZE_BORDER`` | ``wx.OK`` | ``wx.CANCEL`` | ``wx.CENTRE``.
:type `style`: long
:param `pos`: Dialog position.
:type `pos`: wx.Point
:rtype: `None`
.. staticmethod:: GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)
:param `variant`:
:type `variant`: wx.WindowVariant
:rtype: :ref:`wx.VisualAttributes`
.. method:: GetSelection(self)
Returns the index of selected item.
:rtype: `int`
.. method:: GetStringSelection(self)
Returns the selected string.
:rtype: `str`
.. method:: SetSelection(self, selection)
Sets the index of the initially selected item.
:param `selection`:
:type `selection`: int
:rtype: `None`
.. method:: ShowModal(self)
Shows the dialog, returning either ``wx.ID_OK`` or ``wx.ID_CANCEL``.
:rtype: `int`
.. attribute:: Selection
See :meth:`~wx.SingleChoiceDialog.GetSelection` and :meth:`~wx.SingleChoiceDialog.SetSelection`
.. attribute:: StringSelection
See :meth:`~wx.SingleChoiceDialog.GetStringSelection`