fix PCH-less build after changing timer id type to WPARAM (closes #10901)

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

diff --git a/include/wx/ctrlsub.h b/include/wx/ctrlsub.h
index d27f0102ed5de6336591f2c568466b93f4c7e216..74dcd4b47d7634e3f65730689d1f72677cee5129 100644 (file)
--- a/include/wx/ctrlsub.h
+++ b/include/wx/ctrlsub.h
@@ -16,6 +16,7 @@
 
 #if wxUSE_CONTROLS
 
 
 #if wxUSE_CONTROLS
 

+#include "wx/arrstr.h"

 #include "wx/control.h"      // base class
 
 // ----------------------------------------------------------------------------
 #include "wx/control.h"      // base class
 
 // ----------------------------------------------------------------------------


@@ -29,7 +30,7 @@
 // implements an extended interface deriving from this one)
 // ----------------------------------------------------------------------------
 
 // implements an extended interface deriving from this one)
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxItemContainerImmutable
+class WXDLLIMPEXP_CORE wxItemContainerImmutable

 {
 public:
     wxItemContainerImmutable() { }
 {
 public:
     wxItemContainerImmutable() { }


@@ -72,7 +73,7 @@ public:
     bool SetStringSelection(const wxString& s);
 
     // return the selected string or empty string if none
     bool SetStringSelection(const wxString& s);
 
     // return the selected string or empty string if none

-    wxString GetStringSelection() const;
+    virtual wxString GetStringSelection() const;

 
     // this is the same as SetSelection( for single-selection controls but
     // reads better for multi-selection ones
 
     // this is the same as SetSelection( for single-selection controls but
     // reads better for multi-selection ones


@@ -80,14 +81,109 @@ public:
 
 
 protected:
 
 
 protected:

-

     // check that the index is valid
     // check that the index is valid

-    inline bool IsValid(unsigned int n) const { return n < GetCount(); }
-    inline bool IsValidInsert(unsigned int n) const { return n <= GetCount(); }
+    bool IsValid(unsigned int n) const { return n < GetCount(); }
+    bool IsValidInsert(unsigned int n) const { return n <= GetCount(); }

 };
 
 };
 

-class WXDLLEXPORT wxItemContainer : public wxItemContainerImmutable
+// ----------------------------------------------------------------------------
+// wxItemContainer extends wxItemContainerImmutable interface with methods
+// for adding/removing items.
+//
+// Classes deriving from this one must override DoInsertItems() to implement
+// adding items to the control. This can often be implemented more efficiently
+// than simply looping over the elements and inserting them but if this is not
+// the case, the generic DoInsertItemsInLoop can be used in implementation, but
+// in this case DoInsertItem() needs to be overridden.
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_CORE wxItemContainer : public wxItemContainerImmutable

 {
 {

+private:
+    // AppendItems() and InsertItems() helpers just call DoAppend/InsertItems()
+    // after doing some checks
+    //
+    // NB: they're defined here so that they're inlined when used in public part
+    int AppendItems(const wxArrayStringsAdapter& items,
+                    void **clientData,
+                    wxClientDataType type)
+    {
+        if ( items.IsEmpty() )
+            return wxNOT_FOUND;
+
+        return DoAppendItems(items, clientData, type);
+    }
+
+    int AppendItems(const wxArrayStringsAdapter& items)
+    {
+        return AppendItems(items, NULL, wxClientData_None);
+    }
+
+    int AppendItems(const wxArrayStringsAdapter& items, void **clientData)
+    {
+        wxASSERT_MSG( GetClientDataType() != wxClientData_Object,
+                      _T("can't mix different types of client data") );
+
+        return AppendItems(items, clientData, wxClientData_Void);
+    }
+
+    int AppendItems(const wxArrayStringsAdapter& items,
+                    wxClientData **clientData)
+    {
+        wxASSERT_MSG( GetClientDataType() != wxClientData_Void,
+                      _T("can't mix different types of client data") );
+
+        return AppendItems(items, reinterpret_cast<void **>(clientData),
+                           wxClientData_Object);
+    }
+
+    int InsertItems(const wxArrayStringsAdapter& items,
+                    unsigned int pos,
+                    void **clientData,
+                    wxClientDataType type)
+    {
+        wxASSERT_MSG( !IsSorted(), _T("can't insert items in sorted control") );
+
+        wxCHECK_MSG( pos <= GetCount(), wxNOT_FOUND,
+                     _T("position out of range") );
+
+        // not all derived classes handle empty arrays correctly in
+        // DoInsertItems() and besides it really doesn't make much sense to do
+        // this (for append it could correspond to creating an initially empty
+        // control but why would anybody need to insert 0 items?)
+        wxCHECK_MSG( !items.IsEmpty(), wxNOT_FOUND,
+                     _T("need something to insert") );
+
+        return DoInsertItems(items, pos, clientData, type);
+    }
+
+    int InsertItems(const wxArrayStringsAdapter& items, unsigned int pos)
+    {
+        return InsertItems(items, pos, NULL, wxClientData_None);
+    }
+
+    int InsertItems(const wxArrayStringsAdapter& items,
+                     unsigned int pos,
+                     void **clientData)
+    {
+        wxASSERT_MSG( GetClientDataType() != wxClientData_Object,
+                      _T("can't mix different types of client data") );
+
+        return InsertItems(items, pos, clientData, wxClientData_Void);
+    }
+
+    int InsertItems(const wxArrayStringsAdapter& items,
+                     unsigned int pos,
+                     wxClientData **clientData)
+    {
+        wxASSERT_MSG( GetClientDataType() != wxClientData_Void,
+                      _T("can't mix different types of client data") );
+
+        return InsertItems(items, pos,
+                           reinterpret_cast<void **>(clientData),
+                           wxClientData_Object);
+    }
+

 public:
     wxItemContainer() { m_clientDataItemsType = wxClientData_None; }
     virtual ~wxItemContainer();
 public:
     wxItemContainer() { m_clientDataItemsType = wxClientData_None; }
     virtual ~wxItemContainer();


@@ -95,55 +191,201 @@ public:
     // adding items
     // ------------
 
     // adding items
     // ------------
 

+    // append single item, return its position in the control (which can be
+    // different from the last one if the control is sorted)

     int Append(const wxString& item)
     int Append(const wxString& item)

-        { return DoAppend(item); }
+        { return AppendItems(item); }

     int Append(const wxString& item, void *clientData)
     int Append(const wxString& item, void *clientData)

-        { int n = DoAppend(item); SetClientData(n, clientData); return n; }
+        { return AppendItems(item, &clientData); }

     int Append(const wxString& item, wxClientData *clientData)
     int Append(const wxString& item, wxClientData *clientData)

-        { int n = DoAppend(item); SetClientObject(n, clientData); return n; }
-
-    // only for rtti needs (separate name)
-    void AppendString( const wxString& item)
-        { Append( item ); }
-
-    // append several items at once to the control
-    void Append(const wxArrayString& strings);
-
+        { return AppendItems(item, &clientData); }
+
+    // append several items at once to the control, return the position of the
+    // last item appended
+    int Append(const wxArrayString& items)
+        { return AppendItems(items); }
+    int Append(const wxArrayString& items, void **clientData)
+        { return AppendItems(items, clientData); }
+    int Append(const wxArrayString& items, wxClientData **clientData)
+        { return AppendItems(items, clientData); }
+    int Append(unsigned int n, const wxString *items)
+        { return AppendItems(wxArrayStringsAdapter(n, items)); }
+    int Append(unsigned int n, const wxString *items, void **clientData)
+        { return AppendItems(wxArrayStringsAdapter(n, items), clientData); }
+    int Append(unsigned int n,
+               const wxString *items,
+               wxClientData **clientData)
+        { return AppendItems(wxArrayStringsAdapter(n, items), clientData); }
+
+    // only for RTTI needs (separate name)
+    void AppendString(const wxString& item)
+        { Append(item); }
+
+
+    // inserting items: not for sorted controls!
+    // -----------------------------------------
+
+    // insert single item at the given position, return its effective position

     int Insert(const wxString& item, unsigned int pos)
     int Insert(const wxString& item, unsigned int pos)

-        { return DoInsert(item, pos); }
-    int Insert(const wxString& item, unsigned int pos, void *clientData);
-    int Insert(const wxString& item, unsigned int pos, wxClientData *clientData);
+        { return InsertItems(item, pos); }
+    int Insert(const wxString& item, unsigned int pos, void *clientData)
+        { return InsertItems(item, pos, &clientData); }
+    int Insert(const wxString& item, unsigned int pos, wxClientData *clientData)
+        { return InsertItems(item, pos, &clientData); }
+
+    // insert several items at once into the control, return the index of the
+    // last item inserted
+    int Insert(const wxArrayString& items, unsigned int pos)
+        { return InsertItems(items, pos); }
+    int Insert(const wxArrayString& items, unsigned int pos, void **clientData)
+        { return InsertItems(items, pos, clientData); }
+    int Insert(const wxArrayString& items,
+               unsigned int pos,
+               wxClientData **clientData)
+        { return InsertItems(items, pos, clientData); }
+    int Insert(unsigned int n, const wxString *items, unsigned int pos)
+        { return InsertItems(wxArrayStringsAdapter(n, items), pos); }
+    int Insert(unsigned int n,
+               const wxString *items,
+               unsigned int pos,
+               void **clientData)
+        { return InsertItems(wxArrayStringsAdapter(n, items), pos, clientData); }
+    int Insert(unsigned int n,
+               const wxString *items,
+               unsigned int pos,
+               wxClientData **clientData)
+        { return InsertItems(wxArrayStringsAdapter(n, items), pos, clientData); }
+
+
+    // replacing items
+    // ---------------
+
+    void Set(const wxArrayString& items)
+        { Clear(); Append(items); }
+    void Set(const wxArrayString& items, void **clientData)
+        { Clear(); Append(items, clientData); }
+    void Set(const wxArrayString& items, wxClientData **clientData)
+        { Clear(); Append(items, clientData); }
+    void Set(unsigned int n, const wxString *items)
+        { Clear(); Append(n, items); }
+    void Set(unsigned int n, const wxString *items, void **clientData)
+        { Clear(); Append(n, items, clientData); }
+    void Set(unsigned int n, const wxString *items, wxClientData **clientData)
+        { Clear(); Append(n, items, clientData); }

 
     // deleting items
     // --------------
 
 
     // deleting items
     // --------------
 

-    virtual void Clear() = 0;
-    virtual void Delete(unsigned int n) = 0;
+    void Clear();
+    void Delete(unsigned int pos);
+
+
+    // various accessors
+    // -----------------
+
+    // The control may maintain its items in a sorted order in which case
+    // items are automatically inserted at the right position when they are
+    // inserted or appended. Derived classes have to override this method if
+    // they implement sorting, typically by returning HasFlag(wxXX_SORT)
+    virtual bool IsSorted() const { return false; }

 
 

-    // misc
-    // ----

 
     // client data stuff
 
     // client data stuff

+    // -----------------
+

     void SetClientData(unsigned int n, void* clientData);
     void* GetClientData(unsigned int n) const;
 
     void SetClientObject(unsigned int n, wxClientData* clientData);
     wxClientData* GetClientObject(unsigned int n) const;
 
     void SetClientData(unsigned int n, void* clientData);
     void* GetClientData(unsigned int n) const;
 
     void SetClientObject(unsigned int n, wxClientData* clientData);
     wxClientData* GetClientObject(unsigned int n) const;
 

+    // return the type of client data stored in this control: usually it just
+    // returns m_clientDataItemsType but must be overridden in the controls
+    // which delegate their client data storage to another one (e.g. wxChoice
+    // in wxUniv which stores data in wxListBox which it uses anyhow); don't
+    // forget to override SetClientDataType() if you override this one
+    //
+    // NB: for this to work no code should ever access m_clientDataItemsType
+    //     directly but only via this function!
+    virtual wxClientDataType GetClientDataType() const
+        { return m_clientDataItemsType; }
+
+    bool HasClientData() const
+        { return GetClientDataType() != wxClientData_None; }

     bool HasClientObjectData() const
     bool HasClientObjectData() const

-        { return m_clientDataItemsType == wxClientData_Object; }
+        { return GetClientDataType() == wxClientData_Object; }

     bool HasClientUntypedData() const
     bool HasClientUntypedData() const

-        { return m_clientDataItemsType == wxClientData_Void; }
+        { return GetClientDataType() == wxClientData_Void; }

 
 protected:
 
 protected:

-    virtual int DoAppend(const wxString& item) = 0;
-    virtual int DoInsert(const wxString& item, unsigned int pos) = 0;
+    // there is usually no need to override this method but you can do it if it
+    // is more convenient to only do "real" insertions in DoInsertItems() and
+    // to implement items appending here (in which case DoInsertItems() should
+    // call this method if pos == GetCount() as it can still be called in this
+    // case if public Insert() is called with such position)
+    virtual int DoAppendItems(const wxArrayStringsAdapter& items,
+                              void **clientData,
+                              wxClientDataType type)
+    {
+        return DoInsertItems(items, GetCount(), clientData, type);
+    }

 
 

-    virtual void DoSetItemClientData(unsigned int n, void* clientData) = 0;
-    virtual void* DoGetItemClientData(unsigned int n) const = 0;
-    virtual void DoSetItemClientObject(unsigned int n, wxClientData* clientData) = 0;
-    virtual wxClientData* DoGetItemClientObject(unsigned int n) const = 0;
+    // this method must be implemented to insert the items into the control at
+    // position pos which can be GetCount() meaning that the items should be
+    // appended; for the sorted controls the position can be ignored
+    //
+    // the derived classes typically use AssignNewItemClientData() to
+    // associate the data with the items as they're being inserted
+    //
+    // the method should return the index of the position the last item was
+    // inserted into or wxNOT_FOUND if an error occurred
+    virtual int DoInsertItems(const wxArrayStringsAdapter & items,
+                              unsigned int pos,
+                              void **clientData,
+                              wxClientDataType type) = 0;
+
+    // before the client data is set for the first time for the control which
+    // hadn't had it before, DoInitItemClientData() is called which gives the
+    // derived class the possibility to initialize its client data storage only
+    // when client data is really used
+    virtual void DoInitItemClientData() { }
+    virtual void DoSetItemClientData(unsigned int n, void *clientData) = 0;
+    virtual void *DoGetItemClientData(unsigned int n) const = 0;
+
+    virtual void DoClear() = 0;
+    virtual void DoDeleteOneItem(unsigned int pos) = 0;
+
+
+    // methods useful for the derived classes which don't have any better way
+    // of adding multiple items to the control than doing it one by one: such
+    // classes should call DoInsertItemsInLoop() from their DoInsert() and
+    // override DoInsertOneItem() to perform the real insertion
+    virtual int DoInsertOneItem(const wxString& item, unsigned int pos);
+    int DoInsertItemsInLoop(const wxArrayStringsAdapter& items,
+                            unsigned int pos,
+                            void **clientData,
+                            wxClientDataType type);
+
+
+    // helper for DoInsertItems(): n is the index into clientData, pos is the
+    // position of the item in the control
+    void AssignNewItemClientData(unsigned int pos,
+                                 void **clientData,
+                                 unsigned int n,
+                                 wxClientDataType type);
+
+    // free the client object associated with the item at given position and
+    // set it to NULL (must only be called if HasClientObjectData())
+    void ResetItemClientObject(unsigned int n);
+
+    // set the type of the client data stored in this control: override this if
+    // you override GetClientDataType()
+    virtual void SetClientDataType(wxClientDataType clientDataItemsType)
+    {
+        m_clientDataItemsType = clientDataItemsType;
+    }

 
 

+private:

     // the type of the client data for the items
     wxClientDataType m_clientDataItemsType;
 };
     // the type of the client data for the items
     wxClientDataType m_clientDataItemsType;
 };


@@ -154,13 +396,13 @@ protected:
 // two versions
 #define wxCONTROL_ITEMCONTAINER_CLIENTDATAOBJECT_RECAST                    \
     void SetClientData(void *data)                                         \
 // two versions
 #define wxCONTROL_ITEMCONTAINER_CLIENTDATAOBJECT_RECAST                    \
     void SetClientData(void *data)                                         \

-        { wxControl::SetClientData(data); }                                \
+        { wxEvtHandler::SetClientData(data); }                             \

     void *GetClientData() const                                            \
     void *GetClientData() const                                            \

-        { return wxControl::GetClientData(); }                             \
+        { return wxEvtHandler::GetClientData(); }                          \

     void SetClientObject(wxClientData *data)                               \
     void SetClientObject(wxClientData *data)                               \

-        { wxControl::SetClientObject(data); }                              \
+        { wxEvtHandler::SetClientObject(data); }                           \

     wxClientData *GetClientObject() const                                  \
     wxClientData *GetClientObject() const                                  \

-        { return wxControl::GetClientObject(); }                           \
+        { return wxEvtHandler::GetClientObject(); }                        \

     void SetClientData(unsigned int n, void* clientData)                   \
         { wxItemContainer::SetClientData(n, clientData); }                 \
     void* GetClientData(unsigned int n) const                              \
     void SetClientData(unsigned int n, void* clientData)                   \
         { wxItemContainer::SetClientData(n, clientData); }                 \
     void* GetClientData(unsigned int n) const                              \


@@ -170,11 +412,11 @@ protected:
     wxClientData* GetClientObject(unsigned int n) const                    \
         { return wxItemContainer::GetClientObject(n); }
 
     wxClientData* GetClientObject(unsigned int n) const                    \
         { return wxItemContainer::GetClientObject(n); }
 

-class WXDLLEXPORT wxControlWithItems : public wxControl, public wxItemContainer
+class WXDLLIMPEXP_CORE wxControlWithItemsBase : public wxControl,
+                                           public wxItemContainer

 {
 public:
 {
 public:

-    wxControlWithItems() { }
-    virtual ~wxControlWithItems();
+    wxControlWithItemsBase() { }

 
     // we have to redefine these functions here to avoid ambiguities in classes
     // deriving from us which would arise otherwise because both base classses
 
     // we have to redefine these functions here to avoid ambiguities in classes
     // deriving from us which would arise otherwise because both base classses


@@ -188,24 +430,32 @@ public:
     virtual bool ShouldInheritColours() const { return false; }
 
 protected:
     virtual bool ShouldInheritColours() const { return false; }
 
 protected:

-    // we can't compute our best size before the items are added to the control
-    // which is done after calling SetInitialBestSize() (it is called from the
-    // base class ctor and the items are added in the derived class ctor), so
-    // don't do anything at all here as our size will be changed later anyhow
+    // fill in the client object or data field of the event as appropriate

     //
     //

-    // of course, all derived classes *must* call SetBestSize() from their
-    // ctors for this to work!
-    virtual void SetInitialBestSize(const wxSize& WXUNUSED(size)) { }
+    // calls InitCommandEvent() and, if n != wxNOT_FOUND, also sets the per
+    // item client data
+    void InitCommandEventWithItems(wxCommandEvent& event, int n);

 
 private:
 
 private:

-    DECLARE_ABSTRACT_CLASS(wxControlWithItems)
-    DECLARE_NO_COPY_CLASS(wxControlWithItems)
+    wxDECLARE_NO_COPY_CLASS(wxControlWithItemsBase);

 };
 
 };
 

-
-// ----------------------------------------------------------------------------
-// inline functions
-// ----------------------------------------------------------------------------
+// define the platform-specific wxControlWithItems class
+#if defined(__WXMSW__)
+    #include "wx/msw/ctrlsub.h"
+#elif defined(__WXMOTIF__)
+    #include "wx/motif/ctrlsub.h"
+#else
+    class WXDLLIMPEXP_CORE wxControlWithItems : public wxControlWithItemsBase
+    {
+    public:
+        wxControlWithItems() { }
+
+    private:
+        DECLARE_ABSTRACT_CLASS(wxControlWithItems)
+        wxDECLARE_NO_COPY_CLASS(wxControlWithItems);
+    };
+#endif

 
 #endif // wxUSE_CONTROLS
 
 
 #endif // wxUSE_CONTROLS