1. use a manifest constant wxNO_LEN instead of -1 for lengths everywhere

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

diff --git a/include/wx/ctrlsub.h b/include/wx/ctrlsub.h
index 0036c21f468a27f33842f467632cdae34ce9d1ed..d27f0102ed5de6336591f2c568466b93f4c7e216 100644 (file)
--- a/include/wx/ctrlsub.h
+++ b/include/wx/ctrlsub.h
@@ -12,9 +12,7 @@
 #ifndef _WX_CTRLSUB_H_BASE_
 #define _WX_CTRLSUB_H_BASE_
 
 #ifndef _WX_CTRLSUB_H_BASE_
 #define _WX_CTRLSUB_H_BASE_
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "controlwithitems.h"
-#endif
+#include "wx/defs.h"

 
 #if wxUSE_CONTROLS
 
 
 #if wxUSE_CONTROLS
 


@@ -24,11 +22,71 @@
 // wxItemContainer defines an interface which is implemented by all controls
 // which have string subitems each of which may be selected.
 //
 // wxItemContainer defines an interface which is implemented by all controls
 // which have string subitems each of which may be selected.
 //

+// It is decomposed in wxItemContainerImmutable which omits all methods
+// adding/removing items and is used by wxRadioBox and wxItemContainer itself.
+//

 // Examples: wxListBox, wxCheckListBox, wxChoice and wxComboBox (which
 // implements an extended interface deriving from this one)
 // ----------------------------------------------------------------------------
 
 // Examples: wxListBox, wxCheckListBox, wxChoice and wxComboBox (which
 // implements an extended interface deriving from this one)
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxItemContainer
+class WXDLLEXPORT wxItemContainerImmutable
+{
+public:
+    wxItemContainerImmutable() { }
+    virtual ~wxItemContainerImmutable();
+
+    // accessing strings
+    // -----------------
+
+    virtual unsigned int GetCount() const = 0;
+    bool IsEmpty() const { return GetCount() == 0; }
+
+    virtual wxString GetString(unsigned int n) const = 0;
+    wxArrayString GetStrings() const;
+    virtual void SetString(unsigned int n, const wxString& s) = 0;
+
+    // finding string natively is either case sensitive or insensitive
+    // but never both so fall back to this base version for not
+    // supported search type
+    virtual int FindString(const wxString& s, bool bCase = false) const
+    {
+        unsigned int count = GetCount();
+
+        for ( unsigned int i = 0; i < count ; ++i )
+        {
+            if (GetString(i).IsSameAs( s , bCase ))
+                return (int)i;
+        }
+
+        return wxNOT_FOUND;
+    }
+
+
+    // selection
+    // ---------
+
+    virtual void SetSelection(int n) = 0;
+    virtual int GetSelection() const = 0;
+
+    // set selection to the specified string, return false if not found
+    bool SetStringSelection(const wxString& s);
+
+    // return the selected string or empty string if none
+    wxString GetStringSelection() const;
+
+    // this is the same as SetSelection( for single-selection controls but
+    // reads better for multi-selection ones
+    void Select(int n) { SetSelection(n); }
+
+
+protected:
+
+    // 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(); }
+};
+
+class WXDLLEXPORT wxItemContainer : public wxItemContainerImmutable

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


@@ -46,70 +104,45 @@ public:
 
     // only for rtti needs (separate name)
     void AppendString( const wxString& item)
 
     // only for rtti needs (separate name)
     void AppendString( const wxString& item)

-    { Append( item ) ; }
+        { Append( item ); }

 
     // append several items at once to the control
     void Append(const wxArrayString& strings);
 
 
     // append several items at once to the control
     void Append(const wxArrayString& strings);
 

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

         { return DoInsert(item, pos); }
         { return DoInsert(item, pos); }

-    int Insert(const wxString& item, int pos, void *clientData);
-    int Insert(const wxString& item, int pos, wxClientData *clientData);
+    int Insert(const wxString& item, unsigned int pos, void *clientData);
+    int Insert(const wxString& item, unsigned int pos, wxClientData *clientData);

 
     // deleting items
     // --------------
 
     virtual void Clear() = 0;
 
     // deleting items
     // --------------
 
     virtual void Clear() = 0;

-    virtual void Delete(int n) = 0;
-
-    // accessing strings
-    // -----------------
-
-    virtual int GetCount() const = 0;
-    bool IsEmpty() const { return GetCount() == 0; }
-
-    virtual wxString GetString(int n) const = 0;
-    wxArrayString GetStrings() const;
-    virtual void SetString(int n, const wxString& s) = 0;
-    virtual int FindString(const wxString& s) const = 0;
-
-    // selection
-    // ---------
-
-    virtual void Select(int n) = 0;
-    virtual int GetSelection() const = 0;
-
-    wxString GetStringSelection() const;
+    virtual void Delete(unsigned int n) = 0;

 
     // misc
     // ----
 
     // client data stuff
 
     // misc
     // ----
 
     // client data stuff

-    void SetClientData(int n, void* clientData);
-    void* GetClientData(int n) const;
+    void SetClientData(unsigned int n, void* clientData);
+    void* GetClientData(unsigned int n) const;

 
 

-    void SetClientObject(int n, wxClientData* clientData);
-    wxClientData* GetClientObject(int n) const;
+    void SetClientObject(unsigned int n, wxClientData* clientData);
+    wxClientData* GetClientObject(unsigned int n) const;

 
     bool HasClientObjectData() const
         { return m_clientDataItemsType == wxClientData_Object; }
     bool HasClientUntypedData() const
         { return m_clientDataItemsType == wxClientData_Void; }
 
 
     bool HasClientObjectData() const
         { return m_clientDataItemsType == wxClientData_Object; }
     bool HasClientUntypedData() const
         { return m_clientDataItemsType == wxClientData_Void; }
 

-#if WXWIN_COMPATIBILITY_2_2
-    // compatibility - these functions are deprecated, use the new ones
-    // instead
-    int Number() const { return GetCount(); }
-#endif // WXWIN_COMPATIBILITY_2_2
-

 protected:
     virtual int DoAppend(const wxString& item) = 0;
 protected:
     virtual int DoAppend(const wxString& item) = 0;

-    virtual int DoInsert(const wxString& item, int pos) = 0;
+    virtual int DoInsert(const wxString& item, unsigned int pos) = 0;

 
 

-    virtual void DoSetItemClientData(int n, void* clientData) = 0;
-    virtual void* DoGetItemClientData(int n) const = 0;
-    virtual void DoSetItemClientObject(int n, wxClientData* clientData) = 0;
-    virtual wxClientData* DoGetItemClientObject(int n) const = 0;
+    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;

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


@@ -128,13 +161,13 @@ protected:
         { wxControl::SetClientObject(data); }                              \
     wxClientData *GetClientObject() const                                  \
         { return wxControl::GetClientObject(); }                           \
         { wxControl::SetClientObject(data); }                              \
     wxClientData *GetClientObject() const                                  \
         { return wxControl::GetClientObject(); }                           \

-    void SetClientData(int n, void* clientData)                            \
+    void SetClientData(unsigned int n, void* clientData)                   \

         { wxItemContainer::SetClientData(n, clientData); }                 \
         { wxItemContainer::SetClientData(n, clientData); }                 \

-    void* GetClientData(int n) const                                       \
+    void* GetClientData(unsigned int n) const                              \

         { return wxItemContainer::GetClientData(n); }                      \
         { return wxItemContainer::GetClientData(n); }                      \

-    void SetClientObject(int n, wxClientData* clientData)                  \
+    void SetClientObject(unsigned int n, wxClientData* clientData)         \

         { wxItemContainer::SetClientObject(n, clientData); }               \
         { wxItemContainer::SetClientObject(n, clientData); }               \

-    wxClientData* GetClientObject(int n) const                             \
+    wxClientData* GetClientObject(unsigned int n) const                    \

         { return wxItemContainer::GetClientObject(n); }
 
 class WXDLLEXPORT wxControlWithItems : public wxControl, public wxItemContainer
         { return wxItemContainer::GetClientObject(n); }
 
 class WXDLLEXPORT wxControlWithItems : public wxControl, public wxItemContainer


@@ -165,10 +198,15 @@ protected:
     virtual void SetInitialBestSize(const wxSize& WXUNUSED(size)) { }
 
 private:
     virtual void SetInitialBestSize(const wxSize& WXUNUSED(size)) { }
 
 private:

+    DECLARE_ABSTRACT_CLASS(wxControlWithItems)

     DECLARE_NO_COPY_CLASS(wxControlWithItems)
 };
 
     DECLARE_NO_COPY_CLASS(wxControlWithItems)
 };
 

+
+// ----------------------------------------------------------------------------
+// inline functions
+// ----------------------------------------------------------------------------
+

 #endif // wxUSE_CONTROLS
 
 #endif // _WX_CTRLSUB_H_BASE_
 #endif // wxUSE_CONTROLS
 
 #endif // _WX_CTRLSUB_H_BASE_

-