/////////////////////////////////////////////////////////////////////////////
-// Name: choicdgg.h
+// Name: wx/generic/choicdgg.h
// Purpose: Generic choice dialogs
// Author: Julian Smart
-// Modified by:
+// Modified by: 03.11.00: VZ to add wxArrayString and multiple sel functions
// Created: 01/02/97
// RCS-ID: $Id$
-// Copyright: (c)
+// Copyright: (c) wxWindows team
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#pragma interface "choicdgg.h"
#endif
-#include "wx/setup.h"
+#include "wx/dynarray.h"
#include "wx/dialog.h"
-#include "wx/listbox.h"
+
+class WXDLLEXPORT wxListBox;
+
+// ----------------------------------------------------------------------------
+// some (ugly...) constants
+// ----------------------------------------------------------------------------
#define wxCHOICE_HEIGHT 150
#define wxCHOICE_WIDTH 200
#define wxCHOICEDLG_STYLE (wxDEFAULT_DIALOG_STYLE|wxOK | wxCANCEL | wxCENTRE)
-class WXDLLEXPORT wxSingleChoiceDialog: public wxDialog
+// ----------------------------------------------------------------------------
+// wxAnyChoiceDialog: a base class for dialogs containing a listbox
+// ----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxAnyChoiceDialog : public wxDialog
{
- DECLARE_DYNAMIC_CLASS(wxSingleChoiceDialog)
+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);
+ }
+ 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);
+
+protected:
+ wxListBox *m_listbox;
+};
+
+// ----------------------------------------------------------------------------
+// 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,
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);
+
+ 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);
+
+ // old, deprecated methods
+#ifdef WXWIN_COMPATIBILITY_2
wxSingleChoiceDialog(wxWindow *parent,
const wxString& message,
const wxString& caption,
bool Create(wxWindow *parent,
const wxString& message,
const wxString& caption,
- int n,
- const wxString *choices,
+ const wxStringList& choices,
char **clientData = (char **)NULL,
long style = wxCHOICEDLG_STYLE,
const wxPoint& pos = wxDefaultPosition);
+#endif // WXWIN_COMPATIBILITY_2
+
+protected:
+ int m_selection;
+ wxString m_stringSelection;
+
+private:
+ DECLARE_DYNAMIC_CLASS(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);
+ }
bool Create(wxWindow *parent,
const wxString& message,
const wxString& caption,
- const wxStringList& choices,
- char **clientData = (char **)NULL,
+ int n,
+ const wxString *choices,
long style = wxCHOICEDLG_STYLE,
const wxPoint& pos = wxDefaultPosition);
- void SetSelection(int sel) ;
- int GetSelection() const { return m_selection; }
- wxString GetStringSelection() const { return m_stringSelection; }
-
- // get client data associated with selection
- void *GetClientData() const { return m_clientData; }
-
- // obsolete function (NB: no need to make it return wxChar, it's untyped)
- char *GetSelectionClientData() const { return (char *)m_clientData; }
+ void SetSelections(const wxArrayInt& selections);
+ wxArrayInt GetSelections() const { return m_selections; }
// implementation from now on
- void OnOK(wxCommandEvent& event);
- void OnListBoxDClick(wxCommandEvent& event);
+ virtual bool TransferDataFromWindow();
protected:
- int m_selection;
- int m_dialogStyle;
- wxString m_stringSelection;
- wxListBox *m_listbox;
+ wxArrayInt m_selections;
private:
- DECLARE_EVENT_TABLE()
+ DECLARE_DYNAMIC_CLASS(wxMultiChoiceDialog)
};
-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);
+// ----------------------------------------------------------------------------
+// wrapper functions which can be used to get selection(s) from the user
+// ----------------------------------------------------------------------------
-WXDLLEXPORT wxString wxGetSingleChoice(const wxString& message, const wxString& caption,
- int n, wxChar *choices[], wxWindow *parent = (wxWindow *) NULL,
- int x = -1, int y = -1, bool centre = TRUE,
- int width = wxCHOICE_WIDTH, int height = wxCHOICE_HEIGHT);
+// 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,
- 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 int wxGetSingleChoiceIndex(const wxString& message, const wxString& caption,
- int n, wxChar *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
-// FIXME: this is horrible, using "char *" instead of "void *" belongs to the 70s!
-WXDLLEXPORT wxChar* wxGetSingleChoiceData(const wxString& message, const wxString& caption,
- int n, const wxString *choices, char **client_data,
- wxWindow *parent = (wxWindow *) NULL, int x = -1, int y = -1,
- bool centre = TRUE,
- int width = wxCHOICE_WIDTH, int height = wxCHOICE_HEIGHT);
-
-WXDLLEXPORT wxChar* wxGetSingleChoiceData(const wxString& message, const wxString& caption,
- int n, wxChar *choices[], char **client_data,
- wxWindow *parent = (wxWindow *) NULL, int x = -1, int y = -1,
- bool centre = TRUE,
- int width = wxCHOICE_WIDTH, int height = wxCHOICE_HEIGHT);
-
-/*
-WXDLLEXPORT int wxGetMultipleChoice(const wxString& message, const wxString& caption,
- int n, const wxString *choices,
- int nsel, int * selection,
- wxWindow *parent = 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,
+ 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);
+
+// ----------------------------------------------------------------------------
+// these methods are for backwards compatibility only, not documented and
+// deprecated
+// ----------------------------------------------------------------------------
+
+#ifdef WXWIN_COMPATIBILITY_2
+
+WXDLLEXPORT wxString wxGetSingleChoice(const wxString& message,
+ const wxString& caption,
+ int n, wxChar *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, wxChar *choices[],
+ 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, wxChar **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);
+
+
+#endif // WXWIN_COMPATIBILITY_2
+
+#endif // __CHOICEDLGH_G__
-#endif