Phoenix Logo

phoenix_title wx.MultiChoiceDialog

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

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. Not Windows.

class_hierarchy Class Hierarchy

Inheritance diagram for class MultiChoiceDialog:


method_summary Methods Summary

__init__ Constructor taking an array of String choices.
GetSelections Returns array with indexes of selected items.
SetSelections Sets selected items from the array of selected items’ indexes.
ShowModal Shows the dialog, returning either wx.ID_OK or wx.ID_CANCEL.

property_summary Properties Summary

Selections See GetSelections and SetSelections

api Class API



class wx.MultiChoiceDialog(Dialog)

Possible constructors:

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

MultiChoiceDialog(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 or more.


Methods



__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.

Parameters:
  • parent (wx.Window) – Parent window.
  • message (string) – Message to show on the dialog.
  • caption (string) – The dialog caption.
  • n (int) – The number of choices.
  • choices (string) – 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. Not Windows.



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

Constructor taking an array of String choices.

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. Not Windows.





GetSelections(self)

Returns array with indexes of selected items.

Return type:list of integers


SetSelections(self, selections)

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

Parameters:selections (list of integers) –


ShowModal(self)

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

Return type:int

Properties



Selections

See GetSelections and SetSelections