fixup

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

diff --git a/include/wx/listbox.h b/include/wx/listbox.h
index 92c7bf7c08b920013ecf3cd56891d1e9854bc69c..0f083697c76f6b1d9fb549c2908e47f2962e9f66 100644 (file)
--- a/include/wx/listbox.h
+++ b/include/wx/listbox.h
@@ -5,7 +5,7 @@
 // Modified by:
 // Created:     22.10.99
 // RCS-ID:      $Id$
-// Copyright:   (c) wxWindows team
+// Copyright:   (c) wxWidgets team
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
@@ -16,7 +16,7 @@
 // headers
 // ----------------------------------------------------------------------------
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
     #pragma interface "listboxbase.h"
 #endif
 
@@ -27,8 +27,8 @@
 #include "wx/ctrlsub.h"         // base class
 
 // forward declarations are enough here
-class WXDLLEXPORT wxArrayInt;
-class WXDLLEXPORT wxArrayString;
+class WXDLLIMPEXP_BASE wxArrayInt;
+class WXDLLIMPEXP_BASE wxArrayString;
 
 // ----------------------------------------------------------------------------
 // global data
@@ -43,9 +43,11 @@ WXDLLEXPORT_DATA(extern const wxChar*) wxListBoxNameStr;
 class WXDLLEXPORT wxListBoxBase : public wxControlWithItems
 {
 public:
+    wxListBoxBase() { }
+    virtual ~wxListBoxBase();
+
     // all generic methods are in wxControlWithItems, except for the following
     // ones which are not yet implemented by wxChoice/wxCombobox
-
     void Insert(const wxString& item, int pos)
         { DoInsert(item, pos); }
     void Insert(const wxString& item, int pos, void *clientData)
@@ -63,21 +65,40 @@ public:
 
     // multiple selection logic
     virtual bool IsSelected(int n) const = 0;
-    virtual void SetSelection(int n, bool select = TRUE) = 0;
-    virtual void Select(int n) { SetSelection(n, TRUE); }
-    void Deselect(int n) { SetSelection(n, FALSE); }
+    virtual void SetSelection(int n, bool select = true) = 0;
+    virtual void Select(int n) { SetSelection(n, true); }
+    void Deselect(int n) { SetSelection(n, false); }
+    void DeselectAll(int itemToLeaveSelected = -1);
 
-    virtual bool SetStringSelection(const wxString& s, bool select = TRUE);
+    virtual bool SetStringSelection(const wxString& s, bool select = true);
 
     // works for single as well as multiple selection listboxes (unlike
     // GetSelection which only works for listboxes with single selection)
     virtual int GetSelections(wxArrayInt& aSelections) const = 0;
 
-    // Set the specified item at the first visible item or scroll to max
+    // set the specified item at the first visible item or scroll to max
     // range.
     void SetFirstItem(int n) { DoSetFirstItem(n); }
     void SetFirstItem(const wxString& s);
 
+    // ensures that the given item is visible scrolling the listbox if
+    // necessary
+    virtual void EnsureVisible(int n);
+
+    // a combination of Append() and EnsureVisible(): appends the item to the
+    // listbox and ensures that it is visible i.e. not scrolled out of view
+    void AppendAndEnsureVisible(const wxString& s);
+
+    // return true if the listbox allows multiple selection
+    bool HasMultipleSelection() const
+    {
+        return (m_windowStyle & wxLB_MULTIPLE) ||
+               (m_windowStyle & wxLB_EXTENDED);
+    }
+
+    // return true if this listbox is sorted
+    bool IsSorted() const { return (m_windowStyle & wxLB_SORT) != 0; }
+
     // emulate selecting or deselecting the item event.GetInt() (depending on
     // event.GetExtraLong())
     void Command(wxCommandEvent& event);
@@ -89,34 +110,36 @@ public:
 protected:
     // NB: due to wxGTK implementation details, DoInsert() is implemented
     //     using DoInsertItems() and not the other way round
-    void DoInsert(const wxString& item, int pos)
-        { InsertItems(1, &item, pos); }
+    virtual int DoInsert(const wxString& item, int pos)
+        { InsertItems(1, &item, pos); return pos; }
 
     // to be implemented in derived classes
     virtual void DoInsertItems(const wxArrayString& items, int pos) = 0;
     virtual void DoSetItems(const wxArrayString& items, void **clientData) = 0;
 
     virtual void DoSetFirstItem(int n) = 0;
+
+    DECLARE_NO_COPY_CLASS(wxListBoxBase)
 };
 
 // ----------------------------------------------------------------------------
 // include the platform-specific class declaration
 // ----------------------------------------------------------------------------
 
-#if defined(__WXMSW__)
+#if defined(__WXUNIVERSAL__)
+    #include "wx/univ/listbox.h"
+#elif defined(__WXMSW__)
     #include "wx/msw/listbox.h"
 #elif defined(__WXMOTIF__)
     #include "wx/motif/listbox.h"
 #elif defined(__WXGTK__)
     #include "wx/gtk/listbox.h"
-#elif defined(__WXQT__)
-    #include "wx/qt/listbox.h"
 #elif defined(__WXMAC__)
     #include "wx/mac/listbox.h"
 #elif defined(__WXPM__)
     #include "wx/os2/listbox.h"
-#elif defined(__WXSTUBS__)
-    #include "wx/stubs/listbox.h"
+#elif defined(__WXCOCOA__)
+    #include "wx/cocoa/listbox.h"
 #endif
 
 #endif // wxUSE_LISTBOX