X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ba2874ff3038f096bcdc0db1b93b4e67a71c8d89..3201a1046ba71ba8e5ef2ed694fde34d12f743f3:/interface/choicdlg.h diff --git a/interface/choicdlg.h b/interface/choicdlg.h index 9fdc3d1a15..734cecc83c 100644 --- a/interface/choicdlg.h +++ b/interface/choicdlg.h @@ -10,8 +10,8 @@ @class wxMultiChoiceDialog @wxheader{choicdlg.h} - This class represents a dialog that shows a list of strings, and allows - the user to select one or more. + This class represents a dialog that shows a list of strings, and allows the + user to select one or more. @library{wxbase} @category{cmndlg} @@ -44,20 +44,27 @@ public: Dialog position. Not Windows. @beginStyleTable - @style{wxOK}: + @style{wxOK} Show an OK button. - @style{wxCANCEL}: + @style{wxCANCEL} Show a Cancel button. - @style{wxCENTRE}: + @style{wxCENTRE} Centre the message. Not Windows. @endStyleTable @remarks Use ShowModal() to show the dialog. + + @beginWxPythonOnly + + For Python the two parameters @a n and @a choices are collapsed into a + multi parameter @a choices which is expected to be a Python list of + strings. + + @endWxPythonOnly */ wxMultiChoiceDialog(wxWindow* parent, const wxString& message, const wxString& caption, - int n, - const wxString* choices, + int n, const wxString* choices, long style = wxCHOICEDLG_STYLE, const wxPoint& pos = wxDefaultPosition); wxMultiChoiceDialog(wxWindow* parent, @@ -90,8 +97,8 @@ public: @class wxSingleChoiceDialog @wxheader{choicdlg.h} - 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 + 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 OK. @library{wxbase} @@ -118,8 +125,8 @@ public: @param choices An array of strings, or a string list, containing the choices. @param clientData - An array of client data to be associated with the items. - See GetSelectionClientData. + An array of client data to be associated with the items. See + GetSelectionClientData(). @param style A dialog style (bitlist) containing flags chosen from standard dialog styles and the ones listed below. The default value is @@ -129,20 +136,27 @@ public: Dialog position. Not Windows. @beginStyleTable - @style{wxOK}: + @style{wxOK} Show an OK button. - @style{wxCANCEL}: + @style{wxCANCEL} Show a Cancel button. - @style{wxCENTRE}: + @style{wxCENTRE} Centre the message. Not Windows. @endStyleTable @remarks Use ShowModal() to show the dialog. + + @beginWxPythonOnly + + For Python the two parameters @a n and @a choices are collapsed into a + multi parameter @a choices which is expected to be a Python list of + strings. + + @endWxPythonOnly */ wxSingleChoiceDialog(wxWindow* parent, const wxString& message, const wxString& caption, - int n, - const wxString* choices, + int n, const wxString* choices, void** clientData = NULL, long style = wxCHOICEDLG_STYLE, const wxPoint& pos = wxDefaultPosition);