X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ae3c17b4013e80b99976c750c19fca47729517f6..6b03a638a437316e47f02a896d3ad664d59c6ddb:/interface/wx/choicdlg.h?ds=sidebyside diff --git a/interface/wx/choicdlg.h b/interface/wx/choicdlg.h index 734cecc83c..b0c5779f1b 100644 --- a/interface/wx/choicdlg.h +++ b/interface/wx/choicdlg.h @@ -8,7 +8,6 @@ /** @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. @@ -67,6 +66,44 @@ public: int n, const wxString* choices, long style = wxCHOICEDLG_STYLE, const wxPoint& pos = wxDefaultPosition); + /** + Constructor taking an array of wxString choices. + + @param parent + Parent window. + @param message + Message to show on the dialog. + @param caption + The dialog caption. + @param choices + An array of strings, or a string list, containing the choices. + @param style + A dialog style (bitlist) containing flags chosen from standard + dialog style and the ones listed below. The default value is + equivalent to wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER | wxOK | + wxCANCEL | wxCENTRE. + @param pos + Dialog position. Not Windows. + + @beginStyleTable + @style{wxOK} + Show an OK button. + @style{wxCANCEL} + Show a Cancel button. + @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, @@ -83,7 +120,7 @@ public: /** Sets selected items from the array of selected items' indexes. */ - void SetSelections(const wxArrayInt& selections) const; + void SetSelections(const wxArrayInt& selections); /** Shows the dialog, returning either wxID_OK or wxID_CANCEL. @@ -95,7 +132,6 @@ 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 @@ -160,6 +196,48 @@ public: void** clientData = NULL, long style = wxCHOICEDLG_STYLE, const wxPoint& pos = wxDefaultPosition); + /** + Constructor, taking an array of wxString choices and optional client + data. + + @param parent + Parent window. + @param message + Message to show on the dialog. + @param caption + The dialog caption. + @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(). + @param style + A dialog style (bitlist) containing flags chosen from standard + dialog styles and the ones listed below. The default value is + equivalent to wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER | wxOK | + wxCANCEL | wxCENTRE. + @param pos + Dialog position. Not Windows. + + @beginStyleTable + @style{wxOK} + Show an OK button. + @style{wxCANCEL} + Show a Cancel button. + @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, @@ -187,7 +265,7 @@ public: /** Sets the index of the initially selected item. */ - void SetSelection(int selection) const; + void SetSelection(int selection); /** Shows the dialog, returning either wxID_OK or wxID_CANCEL.