[wxWidgets.git] / interface / wx / choicdlg.h

/////////////////////////////////////////////////////////////////////////////
// Name:        choicdlg.h
// Purpose:     interface of wx[Multi|Single]ChoiceDialog
// Author:      wxWidgets team
// RCS-ID:      $Id$
// Licence:     wxWindows license
/////////////////////////////////////////////////////////////////////////////

/**
    @class wxMultiChoiceDialog

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

    @library{wxbase}
    @category{cmndlg}

    @see @ref overview_cmndlg_multichoice, wxSingleChoiceDialog
*/
class wxMultiChoiceDialog : public wxDialog
{
public:
    //@{
    /**
        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 n
            The number of choices.
        @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,
                        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,
                        const wxArrayString& choices,
                        long style = wxCHOICEDLG_STYLE,
                        const wxPoint& pos = wxDefaultPosition);
    //@}

    /**
        Returns array with indexes of selected items.
    */
    wxArrayInt GetSelection() const;

    /**
        Sets selected items from the array of selected items' indexes.
    */
    void SetSelections(const wxArrayInt& selections);

    /**
        Shows the dialog, returning either wxID_OK or wxID_CANCEL.
    */
    int ShowModal();
};


/**
    @class wxSingleChoiceDialog

    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}
    @category{cmndlg}

    @see @ref overview_cmndlg_singlechoice, wxMultiChoiceDialog
*/
class wxSingleChoiceDialog : public wxDialog
{
public:
    //@{
    /**
        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 n
            The number of choices.
        @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,
                         int n, const wxString* choices,
                         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,
                         const wxArrayString& choices,
                         void** clientData = NULL,
                         long style = wxCHOICEDLG_STYLE,
                         const wxPoint& pos = wxDefaultPosition);
    //@}

    /**
        Returns the index of selected item.
    */
    int GetSelection() const;

    /**
        Returns the client data associated with the selection.
    */
    char* GetSelectionClientData() const;

    /**
        Returns the selected string.
    */
    wxString GetStringSelection() const;

    /**
        Sets the index of the initially selected item.
    */
    void SetSelection(int selection);

    /**
        Shows the dialog, returning either wxID_OK or wxID_CANCEL.
    */
    int ShowModal();
};


// ============================================================================
// Global functions/macros
// ============================================================================

/** @addtogroup group_funcmacro_dialog */
//@{

/**
    Same as wxGetSingleChoice() but returns the index representing the
    selected string. If the user pressed cancel, -1 is returned.

    @header{wx/choicdlg.h}
*/
int wxGetSingleChoiceIndex(const wxString& message,
                           const wxString& caption,
                           const wxArrayString& aChoices,
                           wxWindow* parent = NULL,
                           int x = -1,
                           int y = -1,
                           bool centre = true,
                           int width = 150,
                           int height = 200);
int wxGetSingleChoiceIndex(const wxString& message,
                           const wxString& caption,
                           int n,
                           const wxString& choices[],
                           wxWindow* parent = NULL,
                           int x = -1,
                           int y = -1,
                           bool centre = true,
                           int width = 150,
                           int height = 200);

//@}

/** @addtogroup group_funcmacro_dialog */
//@{

/**
    Pops up a dialog box containing a message, OK/Cancel buttons and a
    single-selection listbox. The user may choose an item and press OK to
    return a string or Cancel to return the empty string. Use
    wxGetSingleChoiceIndex() if empty string is a valid choice and if you want
    to be able to detect pressing Cancel reliably.

    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
    @c aChoices parameter of type wxArrayString.

    If @c centre is @true, the message text (which may include new line
    characters) is centred; if @false, the message is left-justified.

    @header{wx/choicdlg.h}
*/
wxString wxGetSingleChoice(const wxString& message,
                           const wxString& caption,
                           const wxArrayString& aChoices,
                           wxWindow* parent = NULL,
                           int x = -1,
                           int y = -1,
                           bool centre = true,
                           int width = 150,
                           int height = 200);
wxString wxGetSingleChoice(const wxString& message,
                           const wxString& caption,
                           int n,
                           const wxString& choices[],
                           wxWindow* parent = NULL,
                           int x = -1,
                           int y = -1,
                           bool centre = true,
                           int width = 150,
                           int height = 200);

//@}

/** @addtogroup group_funcmacro_dialog */
//@{

/**
    Same as wxGetSingleChoice but takes an array of client data pointers
    corresponding to the strings, and returns one of these pointers or @NULL
    if Cancel was pressed. The @c client_data array must have the same number
    of elements as @c choices or @c aChoices!

    @header{wx/choicdlg.h}
*/
wxString wxGetSingleChoiceData(const wxString& message,
                               const wxString& caption,
                               const wxArrayString& aChoices,
                               const wxString& client_data[],
                               wxWindow* parent = NULL,
                               int x = -1,
                               int y = -1,
                               bool centre = true,
                               int width = 150,
                               int height = 200);
wxString wxGetSingleChoiceData(const wxString& message,
                               const wxString& caption,
                               int n,
                               const wxString& choices[],
                               const wxString& client_data[],
                               wxWindow* parent = NULL,
                               int x = -1,
                               int y = -1,
                               bool centre = true,
                               int width = 150,
                               int height = 200);

//@}

/** @addtogroup group_funcmacro_dialog */
//@{

/**
    Pops up a dialog box containing a message, OK/Cancel buttons and a
    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. 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
    @c aChoices parameter of type wxArrayString.

    If @c centre is @true, the message text (which may include new line
    characters) is centred; if @false, the message is left-justified.

    @header{wx/choicdlg.h}
*/
int wxGetSelectedChoices(wxArrayInt& selections,
                            const wxString& message,
                            const wxString& caption,
                            const wxArrayString& aChoices,
                            wxWindow* parent = NULL,
                            int x = -1,
                            int y = -1,
                            bool centre = true,
                            int width = 150,
                            int height = 200);
int wxGetSelectedChoices(wxArrayInt& selections,
                            const wxString& message,
                            const wxString& caption,
                            int n,
                            const wxString& choices[],
                            wxWindow* parent = NULL,
                            int x = -1,
                            int y = -1,
                            bool centre = true,
                            int width = 150,
                            int height = 200);

//@}
Commit	Line	Data
23324ae1 FM	1	/////////////////////////////////////////////////////////////////////////////
23324ae1 FM	2	// Name: choicdlg.h
ba2874ff	3	// Purpose: interface of wx[Multi\|Single]ChoiceDialog
23324ae1 FM	4	// Author: wxWidgets team
	5	// RCS-ID: $Id$
	6	// Licence: wxWindows license
	7	/////////////////////////////////////////////////////////////////////////////
	8
	9	/**
	10	@class wxMultiChoiceDialog
7c913512	11
bfac6166 BP	12	This class represents a dialog that shows a list of strings, and allows the
bfac6166 BP	13	user to select one or more.
7c913512	14
23324ae1 FM	15	@library{wxbase}
23324ae1 FM	16	@category{cmndlg}
7c913512	17
ba2874ff	18	@see @ref overview_cmndlg_multichoice, wxSingleChoiceDialog
23324ae1 FM	19	*/
	20	class wxMultiChoiceDialog : public wxDialog
	21	{
	22	public:
	23	//@{
	24	/**
	25	Constructor taking an array of wxString choices.
ba2874ff	26
7c913512	27	@param parent
4cc4bfaf	28	Parent window.
7c913512	29	@param message
4cc4bfaf	30	Message to show on the dialog.
7c913512	31	@param caption
4cc4bfaf	32	The dialog caption.
7c913512	33	@param n
4cc4bfaf	34	The number of choices.
7c913512	35	@param choices
4cc4bfaf	36	An array of strings, or a string list, containing the choices.
7c913512	37	@param style
4cc4bfaf	38	A dialog style (bitlist) containing flags chosen from standard
ba2874ff BP	39	dialog style and the ones listed below. The default value is
	40	equivalent to wxDEFAULT_DIALOG_STYLE \| wxRESIZE_BORDER \| wxOK \|
	41	wxCANCEL \| wxCENTRE.
	42	@param pos
	43	Dialog position. Not Windows.
	44
	45	@beginStyleTable
8c6791e4	46	@style{wxOK}
4cc4bfaf	47	Show an OK button.
8c6791e4	48	@style{wxCANCEL}
4cc4bfaf	49	Show a Cancel button.
8c6791e4	50	@style{wxCENTRE}
4cc4bfaf	51	Centre the message. Not Windows.
ba2874ff BP	52	@endStyleTable
ba2874ff BP	53
23324ae1	54	@remarks Use ShowModal() to show the dialog.
bfac6166 BP	55
	56	@beginWxPythonOnly
	57
	58	For Python the two parameters @a n and @a choices are collapsed into a
	59	multi parameter @a choices which is expected to be a Python list of
	60	strings.
	61
	62	@endWxPythonOnly
23324ae1 FM	63	*/
	64	wxMultiChoiceDialog(wxWindow* parent, const wxString& message,
	65	const wxString& caption,
bfac6166	66	int n, const wxString* choices,
23324ae1 FM	67	long style = wxCHOICEDLG_STYLE,
23324ae1 FM	68	const wxPoint& pos = wxDefaultPosition);
792255cc VZ	69	/**
	70	Constructor taking an array of wxString choices.
	71
	72	@param parent
	73	Parent window.
	74	@param message
	75	Message to show on the dialog.
	76	@param caption
	77	The dialog caption.
	78	@param choices
	79	An array of strings, or a string list, containing the choices.
	80	@param style
	81	A dialog style (bitlist) containing flags chosen from standard
	82	dialog style and the ones listed below. The default value is
	83	equivalent to wxDEFAULT_DIALOG_STYLE \| wxRESIZE_BORDER \| wxOK \|
	84	wxCANCEL \| wxCENTRE.
	85	@param pos
	86	Dialog position. Not Windows.
	87
	88	@beginStyleTable
	89	@style{wxOK}
	90	Show an OK button.
	91	@style{wxCANCEL}
	92	Show a Cancel button.
	93	@style{wxCENTRE}
	94	Centre the message. Not Windows.
	95	@endStyleTable
	96
	97	@remarks Use ShowModal() to show the dialog.
	98
	99	@beginWxPythonOnly
	100
	101	For Python the two parameters @a n and @a choices are collapsed into a
	102	multi parameter @a choices which is expected to be a Python list of
	103	strings.
	104
	105	@endWxPythonOnly
	106	*/
7c913512 FM	107	wxMultiChoiceDialog(wxWindow* parent,
	108	const wxString& message,
	109	const wxString& caption,
	110	const wxArrayString& choices,
	111	long style = wxCHOICEDLG_STYLE,
	112	const wxPoint& pos = wxDefaultPosition);
23324ae1 FM	113	//@}
	114
	115	/**
	116	Returns array with indexes of selected items.
	117	*/
328f5751	118	wxArrayInt GetSelection() const;
23324ae1 FM	119
	120	/**
	121	Sets selected items from the array of selected items' indexes.
	122	*/
b7e94bd7	123	void SetSelections(const wxArrayInt& selections);
23324ae1 FM	124
	125	/**
	126	Shows the dialog, returning either wxID_OK or wxID_CANCEL.
	127	*/
	128	int ShowModal();
	129	};
	130
	131
e54c96f1	132
23324ae1 FM	133	/**
23324ae1 FM	134	@class wxSingleChoiceDialog
7c913512	135
bfac6166 BP	136	This class represents a dialog that shows a list of strings, and allows the
bfac6166 BP	137	user to select one. Double-clicking on a list item is equivalent to
23324ae1	138	single-clicking and then pressing OK.
7c913512	139
23324ae1 FM	140	@library{wxbase}
23324ae1 FM	141	@category{cmndlg}
7c913512	142
ba2874ff	143	@see @ref overview_cmndlg_singlechoice, wxMultiChoiceDialog
23324ae1 FM	144	*/
	145	class wxSingleChoiceDialog : public wxDialog
	146	{
	147	public:
	148	//@{
	149	/**
ba2874ff BP	150	Constructor, taking an array of wxString choices and optional client
	151	data.
	152
7c913512	153	@param parent
4cc4bfaf	154	Parent window.
7c913512	155	@param message
4cc4bfaf	156	Message to show on the dialog.
7c913512	157	@param caption
4cc4bfaf	158	The dialog caption.
7c913512	159	@param n
4cc4bfaf	160	The number of choices.
7c913512	161	@param choices
4cc4bfaf	162	An array of strings, or a string list, containing the choices.
7c913512	163	@param clientData
bfac6166 BP	164	An array of client data to be associated with the items. See
bfac6166 BP	165	GetSelectionClientData().
7c913512	166	@param style
4cc4bfaf	167	A dialog style (bitlist) containing flags chosen from standard
ba2874ff BP	168	dialog styles and the ones listed below. The default value is
	169	equivalent to wxDEFAULT_DIALOG_STYLE \| wxRESIZE_BORDER \| wxOK \|
	170	wxCANCEL \| wxCENTRE.
	171	@param pos
	172	Dialog position. Not Windows.
	173
	174	@beginStyleTable
8c6791e4	175	@style{wxOK}
4cc4bfaf	176	Show an OK button.
8c6791e4	177	@style{wxCANCEL}
4cc4bfaf	178	Show a Cancel button.
8c6791e4	179	@style{wxCENTRE}
4cc4bfaf	180	Centre the message. Not Windows.
ba2874ff BP	181	@endStyleTable
ba2874ff BP	182
23324ae1	183	@remarks Use ShowModal() to show the dialog.
bfac6166 BP	184
	185	@beginWxPythonOnly
	186
	187	For Python the two parameters @a n and @a choices are collapsed into a
	188	multi parameter @a choices which is expected to be a Python list of
	189	strings.
	190
	191	@endWxPythonOnly
23324ae1 FM	192	*/
	193	wxSingleChoiceDialog(wxWindow* parent, const wxString& message,
	194	const wxString& caption,
bfac6166	195	int n, const wxString* choices,
4cc4bfaf	196	void** clientData = NULL,
23324ae1 FM	197	long style = wxCHOICEDLG_STYLE,
23324ae1 FM	198	const wxPoint& pos = wxDefaultPosition);
792255cc VZ	199	/**
	200	Constructor, taking an array of wxString choices and optional client
	201	data.
	202
	203	@param parent
	204	Parent window.
	205	@param message
	206	Message to show on the dialog.
	207	@param caption
	208	The dialog caption.
	209	@param choices
	210	An array of strings, or a string list, containing the choices.
	211	@param clientData
	212	An array of client data to be associated with the items. See
	213	GetSelectionClientData().
	214	@param style
	215	A dialog style (bitlist) containing flags chosen from standard
	216	dialog styles and the ones listed below. The default value is
	217	equivalent to wxDEFAULT_DIALOG_STYLE \| wxRESIZE_BORDER \| wxOK \|
	218	wxCANCEL \| wxCENTRE.
	219	@param pos
	220	Dialog position. Not Windows.
	221
	222	@beginStyleTable
	223	@style{wxOK}
	224	Show an OK button.
	225	@style{wxCANCEL}
	226	Show a Cancel button.
	227	@style{wxCENTRE}
	228	Centre the message. Not Windows.
	229	@endStyleTable
	230
	231	@remarks Use ShowModal() to show the dialog.
	232
	233	@beginWxPythonOnly
	234
	235	For Python the two parameters @a n and @a choices are collapsed into a
	236	multi parameter @a choices which is expected to be a Python list of
	237	strings.
	238
	239	@endWxPythonOnly
	240	*/
7c913512 FM	241	wxSingleChoiceDialog(wxWindow* parent,
	242	const wxString& message,
	243	const wxString& caption,
	244	const wxArrayString& choices,
4cc4bfaf	245	void** clientData = NULL,
7c913512 FM	246	long style = wxCHOICEDLG_STYLE,
7c913512 FM	247	const wxPoint& pos = wxDefaultPosition);
23324ae1 FM	248	//@}
	249
	250	/**
	251	Returns the index of selected item.
	252	*/
328f5751	253	int GetSelection() const;
23324ae1 FM	254
	255	/**
	256	Returns the client data associated with the selection.
	257	*/
328f5751	258	char* GetSelectionClientData() const;
23324ae1 FM	259
	260	/**
	261	Returns the selected string.
	262	*/
328f5751	263	wxString GetStringSelection() const;
23324ae1 FM	264
	265	/**
	266	Sets the index of the initially selected item.
	267	*/
b7e94bd7	268	void SetSelection(int selection);
23324ae1 FM	269
	270	/**
	271	Shows the dialog, returning either wxID_OK or wxID_CANCEL.
	272	*/
	273	int ShowModal();
	274	};
	275
	276
e54c96f1	277
23324ae1 FM	278	// ============================================================================
	279	// Global functions/macros
	280	// ============================================================================
	281
b21126db	282	/** @addtogroup group_funcmacro_dialog */
23324ae1	283	//@{
ba2874ff	284
23324ae1	285	/**
ba2874ff BP	286	Same as wxGetSingleChoice() but returns the index representing the
	287	selected string. If the user pressed cancel, -1 is returned.
	288
	289	@header{wx/choicdlg.h}
23324ae1 FM	290	*/
	291	int wxGetSingleChoiceIndex(const wxString& message,
	292	const wxString& caption,
	293	const wxArrayString& aChoices,
4cc4bfaf	294	wxWindow* parent = NULL,
23324ae1 FM	295	int x = -1,
23324ae1 FM	296	int y = -1,
4cc4bfaf FM	297	bool centre = true,
	298	int width = 150,
	299	int height = 200);
7c913512 FM	300	int wxGetSingleChoiceIndex(const wxString& message,
	301	const wxString& caption,
	302	int n,
	303	const wxString& choices[],
4cc4bfaf	304	wxWindow* parent = NULL,
7c913512 FM	305	int x = -1,
7c913512 FM	306	int y = -1,
4cc4bfaf FM	307	bool centre = true,
	308	int width = 150,
	309	int height = 200);
ba2874ff	310
23324ae1 FM	311	//@}
23324ae1 FM	312
b21126db	313	/** @addtogroup group_funcmacro_dialog */
23324ae1	314	//@{
ba2874ff	315
23324ae1 FM	316	/**
23324ae1 FM	317	Pops up a dialog box containing a message, OK/Cancel buttons and a
ba2874ff BP	318	single-selection listbox. The user may choose an item and press OK to
	319	return a string or Cancel to return the empty string. Use
	320	wxGetSingleChoiceIndex() if empty string is a valid choice and if you want
	321	to be able to detect pressing Cancel reliably.
	322
	323	You may pass the list of strings to choose from either using @c choices
4cc4bfaf	324	which is an array of @a n strings for the listbox or by using a single
ba2874ff BP	325	@c aChoices parameter of type wxArrayString.
	326
	327	If @c centre is @true, the message text (which may include new line
23324ae1	328	characters) is centred; if @false, the message is left-justified.
ba2874ff BP	329
ba2874ff BP	330	@header{wx/choicdlg.h}
23324ae1 FM	331	*/
	332	wxString wxGetSingleChoice(const wxString& message,
	333	const wxString& caption,
	334	const wxArrayString& aChoices,
4cc4bfaf	335	wxWindow* parent = NULL,
23324ae1 FM	336	int x = -1,
23324ae1 FM	337	int y = -1,
4cc4bfaf FM	338	bool centre = true,
	339	int width = 150,
	340	int height = 200);
7c913512 FM	341	wxString wxGetSingleChoice(const wxString& message,
	342	const wxString& caption,
	343	int n,
	344	const wxString& choices[],
4cc4bfaf	345	wxWindow* parent = NULL,
7c913512 FM	346	int x = -1,
7c913512 FM	347	int y = -1,
4cc4bfaf FM	348	bool centre = true,
	349	int width = 150,
	350	int height = 200);
ba2874ff	351
23324ae1 FM	352	//@}
23324ae1 FM	353
b21126db	354	/** @addtogroup group_funcmacro_dialog */
23324ae1	355	//@{
ba2874ff	356
23324ae1	357	/**
ba2874ff BP	358	Same as wxGetSingleChoice but takes an array of client data pointers
	359	corresponding to the strings, and returns one of these pointers or @NULL
	360	if Cancel was pressed. The @c client_data array must have the same number
	361	of elements as @c choices or @c aChoices!
	362
	363	@header{wx/choicdlg.h}
23324ae1 FM	364	*/
	365	wxString wxGetSingleChoiceData(const wxString& message,
	366	const wxString& caption,
	367	const wxArrayString& aChoices,
	368	const wxString& client_data[],
4cc4bfaf	369	wxWindow* parent = NULL,
23324ae1 FM	370	int x = -1,
23324ae1 FM	371	int y = -1,
4cc4bfaf FM	372	bool centre = true,
	373	int width = 150,
	374	int height = 200);
7c913512 FM	375	wxString wxGetSingleChoiceData(const wxString& message,
	376	const wxString& caption,
	377	int n,
	378	const wxString& choices[],
	379	const wxString& client_data[],
4cc4bfaf	380	wxWindow* parent = NULL,
7c913512 FM	381	int x = -1,
7c913512 FM	382	int y = -1,
4cc4bfaf FM	383	bool centre = true,
	384	int width = 150,
	385	int height = 200);
ba2874ff	386
23324ae1 FM	387	//@}
23324ae1 FM	388
b21126db	389	/** @addtogroup group_funcmacro_dialog */
23324ae1	390	//@{
ba2874ff	391
23324ae1 FM	392	/**
	393	Pops up a dialog box containing a message, OK/Cancel buttons and a
	394	multiple-selection listbox. The user may choose an arbitrary (including 0)
	395	number of items in the listbox whose indices will be returned in
ba2874ff	396	@c selections array. The initial contents of this array will be used to
e5cfb314 VZ	397	select the items when the dialog is shown. If the user cancels the dialog,
e5cfb314 VZ	398	the function returns -1 and @c selections array is left unchanged.
ba2874ff BP	399
ba2874ff BP	400	You may pass the list of strings to choose from either using @c choices
4cc4bfaf	401	which is an array of @a n strings for the listbox or by using a single
ba2874ff BP	402	@c aChoices parameter of type wxArrayString.
	403
	404	If @c centre is @true, the message text (which may include new line
23324ae1	405	characters) is centred; if @false, the message is left-justified.
ba2874ff BP	406
ba2874ff BP	407	@header{wx/choicdlg.h}
23324ae1	408	*/
e5cfb314	409	int wxGetSelectedChoices(wxArrayInt& selections,
23324ae1 FM	410	const wxString& message,
	411	const wxString& caption,
	412	const wxArrayString& aChoices,
4cc4bfaf	413	wxWindow* parent = NULL,
23324ae1 FM	414	int x = -1,
23324ae1 FM	415	int y = -1,
4cc4bfaf FM	416	bool centre = true,
	417	int width = 150,
	418	int height = 200);
e5cfb314	419	int wxGetSelectedChoices(wxArrayInt& selections,
7c913512 FM	420	const wxString& message,
	421	const wxString& caption,
	422	int n,
	423	const wxString& choices[],
4cc4bfaf	424	wxWindow* parent = NULL,
7c913512 FM	425	int x = -1,
7c913512 FM	426	int y = -1,
4cc4bfaf FM	427	bool centre = true,
	428	int width = 150,
	429	int height = 200);
ba2874ff	430
23324ae1 FM	431	//@}
23324ae1 FM	432