// Purpose: interface of wx[Multi|Single]ChoiceDialog
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
strings.
@endWxPythonOnly
+
+ @beginWxPerlOnly
+ Not supported by wxPerl.
+ @endWxPerlOnly
*/
wxMultiChoiceDialog(wxWindow* parent, const wxString& message,
const wxString& caption,
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
+
+ @beginWxPerlOnly
+ Use an array reference for the @a choices parameter.
+ @endWxPerlOnly
+ */
wxMultiChoiceDialog(wxWindow* parent,
const wxString& message,
const wxString& caption,
/**
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.
strings.
@endWxPythonOnly
+
+ @beginWxPerlOnly
+ Not supported by wxPerl.
+ @endWxPerlOnly
*/
wxSingleChoiceDialog(wxWindow* parent, const wxString& message,
const wxString& caption,
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
+
+ @beginWxPerlOnly
+ Use an array reference for the @a choices parameter.
+ @endWxPerlOnly
+ */
wxSingleChoiceDialog(wxWindow* parent,
const wxString& message,
const wxString& caption,
/**
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.
// Global functions/macros
// ============================================================================
-/** @ingroup group_funcmacro_dialog */
+/** @addtogroup group_funcmacro_dialog */
//@{
/**
selected string. If the user pressed cancel, -1 is returned.
@header{wx/choicdlg.h}
+
+ @beginWxPerlOnly
+ Use an array reference for the @a aChoices parameter.
+ @endWxPerlOnly
*/
int wxGetSingleChoiceIndex(const wxString& message,
const wxString& caption,
int y = -1,
bool centre = true,
int width = 150,
- int height = 200);
+ int height = 200,
+ int initialSelection = 0);
+
int wxGetSingleChoiceIndex(const wxString& message,
const wxString& caption,
int n,
int y = -1,
bool centre = true,
int width = 150,
- int height = 200);
+ int height = 200,
+ int initialSelection = 0);
+
+
+int wxGetSingleChoiceIndex(const wxString& message,
+ const wxString& caption,
+ const wxArrayString& choices,
+ int initialSelection,
+ wxWindow *parent = NULL);
+int wxGetSingleChoiceIndex(const wxString& message,
+ const wxString& caption,
+ int n, const wxString *choices,
+ int initialSelection,
+ wxWindow *parent = NULL);
//@}
-/** @ingroup group_funcmacro_dialog */
+/** @addtogroup group_funcmacro_dialog */
//@{
/**
characters) is centred; if @false, the message is left-justified.
@header{wx/choicdlg.h}
+
+ @beginWxPerlOnly
+ Use an array reference for the @a choices parameter.
+ @endWxPerlOnly
*/
wxString wxGetSingleChoice(const wxString& message,
const wxString& caption,
int y = -1,
bool centre = true,
int width = 150,
- int height = 200);
+ int height = 200
+ int initialSelection = 0);
wxString wxGetSingleChoice(const wxString& message,
const wxString& caption,
int n,
int y = -1,
bool centre = true,
int width = 150,
- int height = 200);
+ int height = 200
+ int initialSelection = 0);
+
+
+wxString wxGetSingleChoice(const wxString& message,
+ const wxString& caption,
+ const wxArrayString& choices,
+ int initialSelection,
+ wxWindow *parent = NULL);
+
+wxString wxGetSingleChoice(const wxString& message,
+ const wxString& caption,
+ int n, const wxString *choices,
+ int initialSelection,
+ wxWindow *parent = NULL);
//@}
-/** @ingroup group_funcmacro_dialog */
+/** @addtogroup group_funcmacro_dialog */
//@{
/**
of elements as @c choices or @c aChoices!
@header{wx/choicdlg.h}
+
+ @beginWxPerlOnly
+ Use an array reference for the @a aChoices and @a client_data parameters.
+ @endWxPerlOnly
*/
wxString wxGetSingleChoiceData(const wxString& message,
const wxString& caption,
int y = -1,
bool centre = true,
int width = 150,
- int height = 200);
+ int height = 200
+ int initialSelection = 0);
+
wxString wxGetSingleChoiceData(const wxString& message,
const wxString& caption,
int n,
int y = -1,
bool centre = true,
int width = 150,
- int height = 200);
+ int height = 200
+ int initialSelection = 0);
+
+void* wxGetSingleChoiceData(const wxString& message,
+ const wxString& caption,
+ const wxArrayString& choices,
+ void **client_data,
+ int initialSelection,
+ wxWindow *parent = NULL);
+
+void* wxGetSingleChoiceData(const wxString& message,
+ const wxString& caption,
+ int n, const wxString *choices,
+ void **client_data,
+ int initialSelection,
+ wxWindow *parent = NULL);
//@}
-/** @ingroup group_funcmacro_dialog */
+/** @addtogroup group_funcmacro_dialog */
//@{
/**
multiple-selection listbox. The user may choose an arbitrary (including 0)
number of items in the listbox whose indices will be returned in
@c selections array. The initial contents of this array will be used to
- select the items when the dialog is shown.
+ select the items when the dialog is shown. If the user cancels the dialog,
+ the function returns -1 and @c selections array is left unchanged.
You may pass the list of strings to choose from either using @c choices
which is an array of @a n strings for the listbox or by using a single
characters) is centred; if @false, the message is left-justified.
@header{wx/choicdlg.h}
+
+ @beginWxPerlOnly
+ Use an array reference for the @a choices parameter.
+ In wxPerl there is no @a selections parameter; the function
+ returns an array containing the user selections.
+ @endWxPerlOnly
*/
-size_t wxGetMultipleChoices(wxArrayInt& selections,
+int wxGetSelectedChoices(wxArrayInt& selections,
const wxString& message,
const wxString& caption,
const wxArrayString& aChoices,
bool centre = true,
int width = 150,
int height = 200);
-size_t wxGetMultipleChoices(wxArrayInt& selections,
+
+int wxGetSelectedChoices(wxArrayInt& selections,
const wxString& message,
const wxString& caption,
int n,
projects / wxWidgets.git / blobdiff