made the validation message more clear

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

diff --git a/include/wx/generic/choicdgg.h b/include/wx/generic/choicdgg.h
index cef0162261880278252be40912fb351727f134cf..c1f264b3bb03132510a7f09b3f32552caf981105 100644 (file)
--- a/include/wx/generic/choicdgg.h
+++ b/include/wx/generic/choicdgg.h
@@ -1,101 +1,310 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        choicdgg.h
+// Name:        wx/generic/choicdgg.h

 // Purpose:     Generic choice dialogs
 // Author:      Julian Smart
 // 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$
 // Created:     01/02/97
 // RCS-ID:      $Id$

-// Copyright:   (c)
-// Licence:    wxWindows licence
+// Copyright:   (c) wxWindows team
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef __CHOICEDLGH_G__
 #define __CHOICEDLGH_G__
 
 #ifdef __GNUG__
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef __CHOICEDLGH_G__
 #define __CHOICEDLGH_G__
 
 #ifdef __GNUG__

-#pragma interface "choicdgg.h"
+    #pragma interface "choicdgg.h"

 #endif
 
 #endif
 

-#include "wx/setup.h"
+#include "wx/dynarray.h"

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

+class WXDLLEXPORT wxListBox;
+
+// ----------------------------------------------------------------------------
+// some (ugly...) constants
+// ----------------------------------------------------------------------------
+

 #define wxCHOICE_HEIGHT 150
 #define wxCHOICE_WIDTH 200
 
 #define wxCHOICE_HEIGHT 150
 #define wxCHOICE_WIDTH 200
 

-#define wxID_LISTBOX 3000
+#define wxCHOICEDLG_STYLE (wxDEFAULT_DIALOG_STYLE|wxOK | wxCANCEL | wxCENTRE)
+
+// ----------------------------------------------------------------------------
+// wxAnyChoiceDialog: a base class for dialogs containing a listbox
+// ----------------------------------------------------------------------------

 
 

-class WXDLLEXPORT wxSingleChoiceDialog: public wxDialog
+class WXDLLEXPORT wxAnyChoiceDialog : public wxDialog

 {
 {

-DECLARE_DYNAMIC_CLASS(wxSingleChoiceDialog)

 public:
 public:

-    wxSingleChoiceDialog(wxWindow *parent, const wxString& message, const wxString& caption,
-        const int n, const wxString *choices, char **clientData = NULL, long style = wxOK|wxCANCEL|wxCENTRE, const wxPoint& pos = wxDefaultPosition);
+    wxAnyChoiceDialog() { }

 
 

-    wxSingleChoiceDialog(wxWindow *parent, const wxString& message, const wxString& caption,
-        const wxStringList& choices, char **clientData = NULL, long style = wxOK|wxCANCEL|wxCENTRE, const wxPoint& pos = wxDefaultPosition);
+    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;
+    }

 
 

-    bool Create(wxWindow *parent, const wxString& message, const wxString& caption,
-        const int n, const wxString *choices, char **clientData = NULL, long style = wxOK|wxCANCEL|wxCENTRE, const wxPoint& pos = wxDefaultPosition);
-    bool Create(wxWindow *parent, const wxString& message, const wxString& caption,
-        const wxStringList& choices, char **clientData = NULL, long style = wxOK|wxCANCEL|wxCENTRE, const wxPoint& pos = wxDefaultPosition);
+    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);

 
 

-    void SetSelection(int sel) ;
-    inline int GetSelection(void) const { return m_selection; }
-    inline wxString GetStringSelection(void) const { return m_stringSelection; }
-    inline char *GetSelectionClientData(void) const { return m_clientData; }
+    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 OnOK(wxCommandEvent& event);

+    void OnListBoxDClick(wxCommandEvent& event);
+
+    // old, deprecated methods
+#if WXWIN_COMPATIBILITY_2
+    wxSingleChoiceDialog(wxWindow *parent,
+                         const wxString& message,
+                         const wxString& caption,
+                         const wxStringList& choices,
+                         char **clientData = (char **)NULL,
+                         long style = wxCHOICEDLG_STYLE,
+                         const wxPoint& pos = wxDefaultPosition);

 
 

-DECLARE_EVENT_TABLE()
+    bool Create(wxWindow *parent,
+                const wxString& message,
+                const wxString& caption,
+                const wxStringList& choices,
+                char **clientData = (char **)NULL,
+                long style = wxCHOICEDLG_STYLE,
+                const wxPoint& pos = wxDefaultPosition);
+#endif // WXWIN_COMPATIBILITY_2

 
 protected:
 
 protected:

-    long        m_dialogStyle;

     int         m_selection;
     wxString    m_stringSelection;
     int         m_selection;
     wxString    m_stringSelection;

-    char*       m_clientData;
+
+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,
+                int n,
+                const wxString *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(wxMultiChoiceDialog)

 };
 
 };
 

-wxString WXDLLEXPORT wxGetSingleChoice(const wxString& message, const wxString& caption,
-                        const int n, const wxString *choices, wxWindow *parent = NULL,
-                        const int x = -1, const int y = -1, const bool centre = TRUE,
-                        const int width = wxCHOICE_WIDTH, const int height = wxCHOICE_HEIGHT);
+// ----------------------------------------------------------------------------
+// wrapper functions which can be used to get selection(s) from the user
+// ----------------------------------------------------------------------------

 
 

-wxString WXDLLEXPORT wxGetSingleChoice(const wxString& message, const wxString& caption,
-                        const int n, char *choices[], wxWindow *parent = NULL,
-                        const int x = -1, const int y = -1, const bool centre = TRUE,
-                        const int width = wxCHOICE_WIDTH, const 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
 
 // Same as above but gets position in list of strings, instead of string,
 // or -1 if no selection

-int WXDLLEXPORT wxGetSingleChoiceIndex(const wxString& message, const wxString& caption,
-                           const int n, const wxString *choices, wxWindow *parent = NULL,
-                           const int x = -1, const int y = -1, const bool centre = TRUE,
-                           const int width = wxCHOICE_WIDTH, const int height = wxCHOICE_HEIGHT);
-
-int WXDLLEXPORT wxGetSingleChoiceIndex(const wxString& message, const wxString& caption,
-                           const int n, char *choices[], wxWindow *parent = NULL,
-                           const int x = -1, const int y = -1, const bool centre = TRUE,
-                           const int width = wxCHOICE_WIDTH, const int height = wxCHOICE_HEIGHT);
-
-// Return client data instead
-char* WXDLLEXPORT wxGetSingleChoiceData(const wxString& message, const wxString& caption,
-                            const int n, const wxString *choices, char **client_data,
-                            wxWindow *parent = NULL, const int x = -1, const int y = -1,
-                            const bool centre = TRUE,
-                            const int width = wxCHOICE_WIDTH, const int height = wxCHOICE_HEIGHT);
-
-char* WXDLLEXPORT wxGetSingleChoiceData(const wxString& message, const wxString& caption,
-                            const int n, char *choices[], char **client_data,
-                            wxWindow *parent = NULL, const int x = -1, const int y = -1,
-                            const bool centre = TRUE,
-                            const int width = wxCHOICE_WIDTH, const int height = wxCHOICE_HEIGHT);
-                           
-/*
-int WXDLLEXPORT wxGetMultipleChoice(const wxString& message, const wxString& caption,
-                         const int n, const wxString *choices,
-                         const int nsel, int * selection,
-                         wxWindow *parent = NULL, const int x = -1 , const int y = -1, const bool centre = TRUE,
-                         const int width = wxCHOICE_WIDTH, const 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
+// ----------------------------------------------------------------------------
+
+#if 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