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.

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.


class_hierarchy Class Hierarchy

Inheritance diagram for class SingleChoiceDialog:

appearance Control Appearance


wxMSW

wxMSW

wxMAC

wxMAC

wxGTK

wxGTK


method_summary Methods Summary

__init__

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

GetClassDefaultAttributes

GetSelection

Returns the index of selected item.

GetStringSelection

Returns the selected string.

SetSelection

Sets the index of the initially selected item.

ShowModal

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


api Class API

class wx.SingleChoiceDialog(Dialog)

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

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


Methods

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

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

Parameters
  • parent (wx.Window) – Parent window.

  • message (string) – Message to show on the dialog.

  • caption (string) – The dialog caption.

  • choices (list of strings) – An array of strings, or a string list, containing the choices.

  • style (long) – 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.

  • pos (wx.Point) – Dialog position.



static GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)
Parameters

variant (WindowVariant) –

Return type

wx.VisualAttributes



GetSelection(self)

Returns the index of selected item.

Return type

int



GetStringSelection(self)

Returns the selected string.

Return type

string



SetSelection(self, selection)

Sets the index of the initially selected item.

Parameters

selection (int) –



ShowModal(self)

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

Return type

int


Properties

Selection

See GetSelection and SetSelection



StringSelection

See GetStringSelection