[wxWidgets.git] / include / wx / generic / choicdgg.h

/////////////////////////////////////////////////////////////////////////////
// Name:        wx/generic/choicdgg.h
// Purpose:     Generic choice dialogs
// Author:      Julian Smart
// Modified by: 03.11.00: VZ to add wxArrayString and multiple sel functions
// Created:     01/02/97
// RCS-ID:      $Id$
// Copyright:   (c) wxWindows team
// Licence:     wxWindows licence
/////////////////////////////////////////////////////////////////////////////

#ifndef __CHOICEDLGH_G__
#define __CHOICEDLGH_G__

#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
    #pragma interface "choicdgg.h"
#endif

#include "wx/dynarray.h"
#include "wx/dialog.h"

class WXDLLEXPORT wxListBox;

// ----------------------------------------------------------------------------
// some (ugly...) constants
// ----------------------------------------------------------------------------

#define wxCHOICE_HEIGHT 150
#define wxCHOICE_WIDTH 200

#define wxCHOICEDLG_STYLE \
    (wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER | wxOK | wxCANCEL | wxCENTRE)

// ----------------------------------------------------------------------------
// wxAnyChoiceDialog: a base class for dialogs containing a listbox
// ----------------------------------------------------------------------------

class WXDLLEXPORT wxAnyChoiceDialog : public wxDialog
{
public:
    wxAnyChoiceDialog() { }

    wxAnyChoiceDialog(wxWindow *parent,
                      const wxString& message,
                      const wxString& caption,
                      int n, const wxString *choices,
                      long styleDlg = wxCHOICEDLG_STYLE,
                      const wxPoint& pos = wxDefaultPosition,
                      long styleLbox = wxLB_ALWAYS_SB)
    {
        (void)Create(parent, message, caption, n, choices,
                     styleDlg, pos, styleLbox);
    }
    wxAnyChoiceDialog(wxWindow *parent,
                      const wxString& message,
                      const wxString& caption,
                      const wxArrayString& choices,
                      long styleDlg = wxCHOICEDLG_STYLE,
                      const wxPoint& pos = wxDefaultPosition,
                      long styleLbox = wxLB_ALWAYS_SB)
    {
        (void)Create(parent, message, caption, choices,
                     styleDlg, pos, styleLbox);
    }

    bool Create(wxWindow *parent,
                const wxString& message,
                const wxString& caption,
                int n, const wxString *choices,
                long styleDlg = wxCHOICEDLG_STYLE,
                const wxPoint& pos = wxDefaultPosition,
                long styleLbox = wxLB_ALWAYS_SB);
    bool Create(wxWindow *parent,
                const wxString& message,
                const wxString& caption,
                const wxArrayString& choices,
                long styleDlg = wxCHOICEDLG_STYLE,
                const wxPoint& pos = wxDefaultPosition,
                long styleLbox = wxLB_ALWAYS_SB);

protected:
    wxListBox  *m_listbox;

    DECLARE_NO_COPY_CLASS(wxAnyChoiceDialog)
};

// ----------------------------------------------------------------------------
// wxSingleChoiceDialog: a dialog with single selection listbox
// ----------------------------------------------------------------------------

class WXDLLEXPORT wxSingleChoiceDialog : public wxAnyChoiceDialog
{
public:
    wxSingleChoiceDialog()
    {
        m_selection = -1;
    }

    wxSingleChoiceDialog(wxWindow *parent,
                         const wxString& message,
                         const wxString& caption,
                         int n,
                         const wxString *choices,
                         char **clientData = (char **)NULL,
                         long style = wxCHOICEDLG_STYLE,
                         const wxPoint& pos = wxDefaultPosition);
    wxSingleChoiceDialog(wxWindow *parent,
                         const wxString& message,
                         const wxString& caption,
                         const wxArrayString& choices,
                         char **clientData = (char **)NULL,
                         long style = wxCHOICEDLG_STYLE,
                         const wxPoint& pos = wxDefaultPosition);

    bool Create(wxWindow *parent,
                const wxString& message,
                const wxString& caption,
                int n,
                const wxString *choices,
                char **clientData = (char **)NULL,
                long style = wxCHOICEDLG_STYLE,
                const wxPoint& pos = wxDefaultPosition);
    bool Create(wxWindow *parent,
                const wxString& message,
                const wxString& caption,
                const wxArrayString& choices,
                char **clientData = (char **)NULL,
                long style = wxCHOICEDLG_STYLE,
                const wxPoint& pos = wxDefaultPosition);

    void SetSelection(int sel);
    int GetSelection() const { return m_selection; }
    wxString GetStringSelection() const { return m_stringSelection; }

    // obsolete function (NB: no need to make it return wxChar, it's untyped)
    char *GetSelectionClientData() const { return (char *)m_clientData; }

    // implementation from now on
    void OnOK(wxCommandEvent& event);
    void OnListBoxDClick(wxCommandEvent& event);

protected:
    int         m_selection;
    wxString    m_stringSelection;

private:
    DECLARE_DYNAMIC_CLASS_NO_COPY(wxSingleChoiceDialog)
    DECLARE_EVENT_TABLE()
};

// ----------------------------------------------------------------------------
// wxMultiChoiceDialog: a dialog with multi selection listbox
// ----------------------------------------------------------------------------

class WXDLLEXPORT wxMultiChoiceDialog : public wxAnyChoiceDialog
{
public:
    wxMultiChoiceDialog() { }

    wxMultiChoiceDialog(wxWindow *parent,
                        const wxString& message,
                        const wxString& caption,
                        int n,
                        const wxString *choices,
                        long style = wxCHOICEDLG_STYLE,
                        const wxPoint& pos = wxDefaultPosition)
    {
        (void)Create(parent, message, caption, n, choices, style, pos);
    }
    wxMultiChoiceDialog(wxWindow *parent,
                        const wxString& message,
                        const wxString& caption,
                        const wxArrayString& choices,
                        long style = wxCHOICEDLG_STYLE,
                        const wxPoint& pos = wxDefaultPosition)
    {
        (void)Create(parent, message, caption, choices, style, pos);
    }

    bool Create(wxWindow *parent,
                const wxString& message,
                const wxString& caption,
                int n,
                const wxString *choices,
                long style = wxCHOICEDLG_STYLE,
                const wxPoint& pos = wxDefaultPosition);
    bool Create(wxWindow *parent,
                const wxString& message,
                const wxString& caption,
                const wxArrayString& choices,
                long style = wxCHOICEDLG_STYLE,
                const wxPoint& pos = wxDefaultPosition);

    void SetSelections(const wxArrayInt& selections);
    wxArrayInt GetSelections() const { return m_selections; }

    // implementation from now on
    virtual bool TransferDataFromWindow();

protected:
    wxArrayInt m_selections;

private:
    DECLARE_DYNAMIC_CLASS_NO_COPY(wxMultiChoiceDialog)
};

// ----------------------------------------------------------------------------
// wrapper functions which can be used to get selection(s) from the user
// ----------------------------------------------------------------------------

// get the user selection as a string
WXDLLEXPORT wxString wxGetSingleChoice(const wxString& message,
                                       const wxString& caption,
                                       const wxArrayString& choices,
                                       wxWindow *parent = (wxWindow *) NULL,
                                       int x = -1,
                                       int y = -1,
                                       bool centre = TRUE,
                                       int width = wxCHOICE_WIDTH,
                                       int height = wxCHOICE_HEIGHT);

WXDLLEXPORT wxString wxGetSingleChoice(const wxString& message,
                                       const wxString& caption,
                                       int n, const wxString *choices,
                                       wxWindow *parent = (wxWindow *) NULL,
                                       int x = -1,
                                       int y = -1,
                                       bool centre = TRUE,
                                       int width = wxCHOICE_WIDTH,
                                       int height = wxCHOICE_HEIGHT);

// Same as above but gets position in list of strings, instead of string,
// or -1 if no selection
WXDLLEXPORT int wxGetSingleChoiceIndex(const wxString& message,
                                       const wxString& caption,
                                       const wxArrayString& choices,
                                       wxWindow *parent = (wxWindow *) NULL,
                                       int x = -1,
                                       int y = -1,
                                       bool centre = TRUE,
                                       int width = wxCHOICE_WIDTH,
                                       int height = wxCHOICE_HEIGHT);

WXDLLEXPORT int wxGetSingleChoiceIndex(const wxString& message,
                                       const wxString& caption,
                                       int n, const wxString *choices,
                                       wxWindow *parent = (wxWindow *) NULL,
                                       int x = -1,
                                       int y = -1,
                                       bool centre = TRUE,
                                       int width = wxCHOICE_WIDTH,
                                       int height = wxCHOICE_HEIGHT);

// Return client data instead or NULL if cancelled
WXDLLEXPORT void* wxGetSingleChoiceData(const wxString& message,
                                        const wxString& caption,
                                        const wxArrayString& choices,
                                        void **client_data,
                                        wxWindow *parent = (wxWindow *) NULL,
                                        int x = -1, int y = -1,
                                        bool centre = TRUE,
                                        int width = wxCHOICE_WIDTH,
                                        int height = wxCHOICE_HEIGHT);

WXDLLEXPORT void* wxGetSingleChoiceData(const wxString& message,
                                        const wxString& caption,
                                        int n, const wxString *choices,
                                        void **client_data,
                                        wxWindow *parent = (wxWindow *) NULL,
                                        int x = -1, int y = -1,
                                        bool centre = TRUE,
                                        int width = wxCHOICE_WIDTH,
                                        int height = wxCHOICE_HEIGHT);

// fill the array with the indices of the chosen items, it will be empty
// if no items were selected or Cancel was pressed - return the number of
// selections
WXDLLEXPORT size_t wxGetMultipleChoices(wxArrayInt& selections,
                                        const wxString& message,
                                        const wxString& caption,
                                        int n, const wxString *choices,
                                        wxWindow *parent = (wxWindow *) NULL,
                                        int x = -1,
                                        int y = -1,
                                        bool centre = TRUE,
                                        int width = wxCHOICE_WIDTH,
                                        int height = wxCHOICE_HEIGHT);

WXDLLEXPORT size_t wxGetMultipleChoices(wxArrayInt& selections,
                                        const wxString& message,
                                        const wxString& caption,
                                        const wxArrayString& choices,
                                        wxWindow *parent = (wxWindow *) NULL,
                                        int x = -1,
                                        int y = -1,
                                        bool centre = TRUE,
                                        int width = wxCHOICE_WIDTH,
                                        int height = wxCHOICE_HEIGHT);

#endif // __CHOICEDLGH_G__
Commit	Line	Data
c801d85f	1	/////////////////////////////////////////////////////////////////////////////
d6c9c1b7	2	// Name: wx/generic/choicdgg.h
c801d85f KB	3	// Purpose: Generic choice dialogs
c801d85f KB	4	// Author: Julian Smart
d6c9c1b7	5	// Modified by: 03.11.00: VZ to add wxArrayString and multiple sel functions
c801d85f KB	6	// Created: 01/02/97
c801d85f KB	7	// RCS-ID: $Id$
d6c9c1b7	8	// Copyright: (c) wxWindows team
c50f1fb9	9	// Licence: wxWindows licence
c801d85f KB	10	/////////////////////////////////////////////////////////////////////////////
	11
	12	#ifndef __CHOICEDLGH_G__
	13	#define __CHOICEDLGH_G__
	14
12028905	15	#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
257bf510	16	#pragma interface "choicdgg.h"
c801d85f KB	17	#endif
c801d85f KB	18
d6c9c1b7	19	#include "wx/dynarray.h"
c801d85f	20	#include "wx/dialog.h"
8ee9d618 VZ	21
8ee9d618 VZ	22	class WXDLLEXPORT wxListBox;
c801d85f	23
d6c9c1b7 VZ	24	// ----------------------------------------------------------------------------
	25	// some (ugly...) constants
	26	// ----------------------------------------------------------------------------
	27
c801d85f KB	28	#define wxCHOICE_HEIGHT 150
	29	#define wxCHOICE_WIDTH 200
	30
abd9b10e VZ	31	#define wxCHOICEDLG_STYLE \
abd9b10e VZ	32	(wxDEFAULT_DIALOG_STYLE \| wxRESIZE_BORDER \| wxOK \| wxCANCEL \| wxCENTRE)
c801d85f	33
d6c9c1b7 VZ	34	// ----------------------------------------------------------------------------
	35	// wxAnyChoiceDialog: a base class for dialogs containing a listbox
	36	// ----------------------------------------------------------------------------
	37
	38	class WXDLLEXPORT wxAnyChoiceDialog : public wxDialog
c801d85f	39	{
d6c9c1b7	40	public:
6463b9f5	41	wxAnyChoiceDialog() { }
d6c9c1b7 VZ	42
	43	wxAnyChoiceDialog(wxWindow *parent,
	44	const wxString& message,
	45	const wxString& caption,
	46	int n, const wxString *choices,
	47	long styleDlg = wxCHOICEDLG_STYLE,
	48	const wxPoint& pos = wxDefaultPosition,
6463b9f5 JS	49	long styleLbox = wxLB_ALWAYS_SB)
	50	{
	51	(void)Create(parent, message, caption, n, choices,
	52	styleDlg, pos, styleLbox);
	53	}
584ad2a3 MB	54	wxAnyChoiceDialog(wxWindow *parent,
	55	const wxString& message,
	56	const wxString& caption,
	57	const wxArrayString& choices,
	58	long styleDlg = wxCHOICEDLG_STYLE,
	59	const wxPoint& pos = wxDefaultPosition,
	60	long styleLbox = wxLB_ALWAYS_SB)
	61	{
	62	(void)Create(parent, message, caption, choices,
	63	styleDlg, pos, styleLbox);
	64	}
d6c9c1b7 VZ	65
	66	bool Create(wxWindow *parent,
	67	const wxString& message,
	68	const wxString& caption,
	69	int n, const wxString *choices,
	70	long styleDlg = wxCHOICEDLG_STYLE,
	71	const wxPoint& pos = wxDefaultPosition,
	72	long styleLbox = wxLB_ALWAYS_SB);
584ad2a3 MB	73	bool Create(wxWindow *parent,
	74	const wxString& message,
	75	const wxString& caption,
	76	const wxArrayString& choices,
	77	long styleDlg = wxCHOICEDLG_STYLE,
	78	const wxPoint& pos = wxDefaultPosition,
	79	long styleLbox = wxLB_ALWAYS_SB);
d6c9c1b7 VZ	80
	81	protected:
	82	wxListBox *m_listbox;
22f3361e VZ	83
22f3361e VZ	84	DECLARE_NO_COPY_CLASS(wxAnyChoiceDialog)
d6c9c1b7	85	};
257bf510	86
d6c9c1b7 VZ	87	// ----------------------------------------------------------------------------
	88	// wxSingleChoiceDialog: a dialog with single selection listbox
	89	// ----------------------------------------------------------------------------
	90
	91	class WXDLLEXPORT wxSingleChoiceDialog : public wxAnyChoiceDialog
	92	{
c801d85f	93	public:
6463b9f5 JS	94	wxSingleChoiceDialog()
	95	{
	96	m_selection = -1;
	97	}
d6c9c1b7	98
257bf510 VZ	99	wxSingleChoiceDialog(wxWindow *parent,
	100	const wxString& message,
	101	const wxString& caption,
	102	int n,
	103	const wxString *choices,
	104	char clientData = (char )NULL,
	105	long style = wxCHOICEDLG_STYLE,
	106	const wxPoint& pos = wxDefaultPosition);
584ad2a3 MB	107	wxSingleChoiceDialog(wxWindow *parent,
	108	const wxString& message,
	109	const wxString& caption,
	110	const wxArrayString& choices,
	111	char clientData = (char )NULL,
	112	long style = wxCHOICEDLG_STYLE,
	113	const wxPoint& pos = wxDefaultPosition);
257bf510	114
d6c9c1b7 VZ	115	bool Create(wxWindow *parent,
	116	const wxString& message,
	117	const wxString& caption,
	118	int n,
	119	const wxString *choices,
	120	char clientData = (char )NULL,
	121	long style = wxCHOICEDLG_STYLE,
	122	const wxPoint& pos = wxDefaultPosition);
584ad2a3 MB	123	bool Create(wxWindow *parent,
	124	const wxString& message,
	125	const wxString& caption,
	126	const wxArrayString& choices,
	127	char clientData = (char )NULL,
	128	long style = wxCHOICEDLG_STYLE,
	129	const wxPoint& pos = wxDefaultPosition);
d6c9c1b7 VZ	130
	131	void SetSelection(int sel);
	132	int GetSelection() const { return m_selection; }
	133	wxString GetStringSelection() const { return m_stringSelection; }
	134
	135	// obsolete function (NB: no need to make it return wxChar, it's untyped)
	136	char GetSelectionClientData() const { return (char )m_clientData; }
	137
	138	// implementation from now on
	139	void OnOK(wxCommandEvent& event);
	140	void OnListBoxDClick(wxCommandEvent& event);
	141
d6c9c1b7 VZ	142	protected:
	143	int m_selection;
	144	wxString m_stringSelection;
	145
	146	private:
fc7a2a60	147	DECLARE_DYNAMIC_CLASS_NO_COPY(wxSingleChoiceDialog)
d6c9c1b7 VZ	148	DECLARE_EVENT_TABLE()
	149	};
	150
	151	// ----------------------------------------------------------------------------
	152	// wxMultiChoiceDialog: a dialog with multi selection listbox
	153	// ----------------------------------------------------------------------------
	154
	155	class WXDLLEXPORT wxMultiChoiceDialog : public wxAnyChoiceDialog
	156	{
	157	public:
6463b9f5	158	wxMultiChoiceDialog() { }
d6c9c1b7 VZ	159
	160	wxMultiChoiceDialog(wxWindow *parent,
	161	const wxString& message,
	162	const wxString& caption,
	163	int n,
	164	const wxString *choices,
	165	long style = wxCHOICEDLG_STYLE,
6463b9f5 JS	166	const wxPoint& pos = wxDefaultPosition)
	167	{
	168	(void)Create(parent, message, caption, n, choices, style, pos);
	169	}
584ad2a3 MB	170	wxMultiChoiceDialog(wxWindow *parent,
	171	const wxString& message,
	172	const wxString& caption,
	173	const wxArrayString& choices,
	174	long style = wxCHOICEDLG_STYLE,
	175	const wxPoint& pos = wxDefaultPosition)
	176	{
	177	(void)Create(parent, message, caption, choices, style, pos);
	178	}
257bf510 VZ	179
	180	bool Create(wxWindow *parent,
	181	const wxString& message,
	182	const wxString& caption,
d6c9c1b7 VZ	183	int n,
d6c9c1b7 VZ	184	const wxString *choices,
257bf510 VZ	185	long style = wxCHOICEDLG_STYLE,
257bf510 VZ	186	const wxPoint& pos = wxDefaultPosition);
584ad2a3 MB	187	bool Create(wxWindow *parent,
	188	const wxString& message,
	189	const wxString& caption,
	190	const wxArrayString& choices,
	191	long style = wxCHOICEDLG_STYLE,
	192	const wxPoint& pos = wxDefaultPosition);
c801d85f	193
d6c9c1b7 VZ	194	void SetSelections(const wxArrayInt& selections);
d6c9c1b7 VZ	195	wxArrayInt GetSelections() const { return m_selections; }
c801d85f	196
257bf510	197	// implementation from now on
3d49ce44	198	virtual bool TransferDataFromWindow();
c801d85f	199
c801d85f	200	protected:
d6c9c1b7	201	wxArrayInt m_selections;
257bf510 VZ	202
257bf510 VZ	203	private:
fc7a2a60	204	DECLARE_DYNAMIC_CLASS_NO_COPY(wxMultiChoiceDialog)
c801d85f KB	205	};
c801d85f KB	206
d6c9c1b7 VZ	207	// ----------------------------------------------------------------------------
	208	// wrapper functions which can be used to get selection(s) from the user
	209	// ----------------------------------------------------------------------------
	210
	211	// get the user selection as a string
	212	WXDLLEXPORT wxString wxGetSingleChoice(const wxString& message,
	213	const wxString& caption,
	214	const wxArrayString& choices,
	215	wxWindow parent = (wxWindow ) NULL,
	216	int x = -1,
	217	int y = -1,
	218	bool centre = TRUE,
	219	int width = wxCHOICE_WIDTH,
	220	int height = wxCHOICE_HEIGHT);
c801d85f	221
d6c9c1b7 VZ	222	WXDLLEXPORT wxString wxGetSingleChoice(const wxString& message,
	223	const wxString& caption,
	224	int n, const wxString *choices,
	225	wxWindow parent = (wxWindow ) NULL,
	226	int x = -1,
	227	int y = -1,
	228	bool centre = TRUE,
	229	int width = wxCHOICE_WIDTH,
	230	int height = wxCHOICE_HEIGHT);
c801d85f KB	231
	232	// Same as above but gets position in list of strings, instead of string,
	233	// or -1 if no selection
d6c9c1b7 VZ	234	WXDLLEXPORT int wxGetSingleChoiceIndex(const wxString& message,
	235	const wxString& caption,
	236	const wxArrayString& choices,
	237	wxWindow parent = (wxWindow ) NULL,
	238	int x = -1,
	239	int y = -1,
	240	bool centre = TRUE,
	241	int width = wxCHOICE_WIDTH,
	242	int height = wxCHOICE_HEIGHT);
	243
	244	WXDLLEXPORT int wxGetSingleChoiceIndex(const wxString& message,
	245	const wxString& caption,
	246	int n, const wxString *choices,
	247	wxWindow parent = (wxWindow ) NULL,
	248	int x = -1,
	249	int y = -1,
	250	bool centre = TRUE,
	251	int width = wxCHOICE_WIDTH,
	252	int height = wxCHOICE_HEIGHT);
	253
	254	// Return client data instead or NULL if cancelled
	255	WXDLLEXPORT void* wxGetSingleChoiceData(const wxString& message,
	256	const wxString& caption,
	257	const wxArrayString& choices,
	258	void **client_data,
	259	wxWindow parent = (wxWindow ) NULL,
	260	int x = -1, int y = -1,
	261	bool centre = TRUE,
	262	int width = wxCHOICE_WIDTH,
	263	int height = wxCHOICE_HEIGHT);
	264
	265	WXDLLEXPORT void* wxGetSingleChoiceData(const wxString& message,
	266	const wxString& caption,
	267	int n, const wxString *choices,
	268	void **client_data,
	269	wxWindow parent = (wxWindow ) NULL,
	270	int x = -1, int y = -1,
	271	bool centre = TRUE,
	272	int width = wxCHOICE_WIDTH,
	273	int height = wxCHOICE_HEIGHT);
	274
	275	// fill the array with the indices of the chosen items, it will be empty
	276	// if no items were selected or Cancel was pressed - return the number of
	277	// selections
	278	WXDLLEXPORT size_t wxGetMultipleChoices(wxArrayInt& selections,
	279	const wxString& message,
	280	const wxString& caption,
	281	int n, const wxString *choices,
	282	wxWindow parent = (wxWindow ) NULL,
	283	int x = -1,
	284	int y = -1,
	285	bool centre = TRUE,
	286	int width = wxCHOICE_WIDTH,
	287	int height = wxCHOICE_HEIGHT);
	288
	289	WXDLLEXPORT size_t wxGetMultipleChoices(wxArrayInt& selections,
	290	const wxString& message,
	291	const wxString& caption,
	292	const wxArrayString& choices,
	293	wxWindow parent = (wxWindow ) NULL,
	294	int x = -1,
	295	int y = -1,
	296	bool centre = TRUE,
	297	int width = wxCHOICE_WIDTH,
298	int height = wxCHOICE_HEIGHT);
299
d6c9c1b7	300	#endif // __CHOICEDLGH_G__
c801d85f	301