explained how the signature works

[wxWidgets.git] / include / wx / choice.h

diff --git a/include/wx/choice.h b/include/wx/choice.h
index 9940c9f69fdbf938aa2f34e9d74a4b917d5f3ccd..3a95d2eff07f967bf7a174b196894638f4a0d173 100644 (file)
--- a/include/wx/choice.h
+++ b/include/wx/choice.h
@@ -5,7 +5,7 @@
 // Modified by:
 // Created:     26.07.99
 // RCS-ID:      $Id$
-// Copyright:   (c) wxWindows team
+// Copyright:   (c) wxWidgets team
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
@@ -16,11 +16,13 @@
 // headers
 // ----------------------------------------------------------------------------
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
     #pragma interface "choicebase.h"
 #endif
 
-#include "wx/control.h"     // the base class
+#if wxUSE_CHOICE
+
+#include "wx/ctrlsub.h"     // the base class
 
 // ----------------------------------------------------------------------------
 // global data
@@ -32,97 +34,54 @@ WXDLLEXPORT_DATA(extern const wxChar*) wxChoiceNameStr;
 // wxChoice allows to select one of a non-modifiable list of strings
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxChoiceBase : public wxControl
+class WXDLLEXPORT wxChoiceBase : public wxControlWithItems
 {
 public:
-    // ctor
-    wxChoiceBase() { m_clientDataItemsType = ClientData_None; }
-
-    // add a new item to the list
-        // no client data
-    void Append(const wxString& item) { DoAppend(item); }
-        // with client data which belongs to the caller
-    void Append(const wxString &item, void* clientData)
-        { DoAppend(item); SetClientData(GetCount() - 1, clientData); }
-        // with client data which will be deleted by the control
-    void Append(const wxString &item, wxClientData* clientData)
-        { DoAppend(item); SetClientObject(GetCount() - 1, clientData); }
-
-    // delete items from the list
-        // one item
-    virtual void Delete(int n) = 0;
-        // all of them
-    virtual void Clear() = 0;
-
-    // selection (at most one item may be selected in wxChoice)
-        // get the index of currently selected item or -1
-    virtual int GetSelection() const = 0;
-        // get the text of the currently selected item or empty string
-    virtual wxString GetStringSelection() const;
-
-        // set selectionto current item
-    virtual void SetSelection(int n) = 0;
-        // set selection to the current item, returns TRUE if ok
-    virtual bool SetStringSelection(const wxString& sel);
+    wxChoiceBase() { }
+    virtual ~wxChoiceBase();
 
-    // accessors to the list of strings
-        // get the number of items in the list of strings
-    virtual int GetCount() const = 0;
+    // all generic methods are in wxControlWithItems
 
-        // find string in the list, return wxNOT_FOUND if not found
-    virtual int FindString(const wxString& s) const = 0;
-        // get the string with the specified index
-    virtual wxString GetString(int n) const = 0;
+    // single selection logic
+    virtual void SetSelection(int n) = 0;
+    virtual bool SetStringSelection(const wxString& s);
 
-    // set/get the number of columns in the control (as they're not supporte on
+    // don't override this
+    virtual void Select(int n) { SetSelection(n); }
+
+    // set/get the number of columns in the control (as they're not supported on
     // most platforms, they do nothing by default)
     virtual void SetColumns(int WXUNUSED(n) = 1 ) { }
     virtual int GetColumns() const { return 1 ; }
 
-    // client data
-        // untyped (isn't deleted by the control)
-    void SetClientData( int n, void* clientData );
-    void* GetClientData( int n ) const;
-        // typed (is owned and deleted by the control)
-    void SetClientObject( int n, wxClientData* clientData );
-    wxClientData* GetClientObject( int n ) const;
-
-    // emulate selecting the item event.GetInt() from the control
-    virtual void Command(wxCommandEvent &event);
-
-    // deprecated functions, heer for backwards compatibility only
-    int Number() const { return GetCount(); }
+    // emulate selecting the item event.GetInt()
+    void Command(wxCommandEvent& event);
 
 private:
-    // pure virtuals to implement in the derived classes
-    virtual void DoAppend(const wxString& item) = 0;
-
-    virtual void DoSetClientData( int n, void* clientData ) = 0;
-    virtual void* DoGetClientData( int n ) const = 0;
-    virtual void DoSetClientObject( int n, wxClientData* clientData ) = 0;
-    virtual wxClientData* DoGetClientObject( int n ) const = 0;
-
-    // the type of the client data for the items
-    wxClientDataType m_clientDataItemsType;
+    DECLARE_NO_COPY_CLASS(wxChoiceBase)
 };
 
 // ----------------------------------------------------------------------------
 // include the platform-dependent class definition
 // ----------------------------------------------------------------------------
 
-#if defined(__WXMSW__)
+#if defined(__WXUNIVERSAL__)
+    #include "wx/univ/choice.h"
+#elif defined(__WXMSW__)
     #include "wx/msw/choice.h"
 #elif defined(__WXMOTIF__)
     #include "wx/motif/choice.h"
 #elif defined(__WXGTK__)
     #include "wx/gtk/choice.h"
-#elif defined(__WXQT__)
-    #include "wx/qt/choice.h"
 #elif defined(__WXMAC__)
     #include "wx/mac/choice.h"
-#elif defined(__WXSTUBS__)
-    #include "wx/stubs/choice.h"
+#elif defined(__WXCOCOA__)
+    #include "wx/cocoa/choice.h"
+#elif defined(__WXPM__)
+    #include "wx/os2/choice.h"
 #endif
 
+#endif // wxUSE_CHOICE
+
 #endif
     // _WX_CHOICE_H_BASE_