Comment-only update

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

diff --git a/include/wx/listbox.h b/include/wx/listbox.h
index ef66d8ea3ce47e6fddbbf278fe3e4e2318bf0f36..afb02200368fddaec656e34c9469fd70b45c0026 100644 (file)
--- a/include/wx/listbox.h
+++ b/include/wx/listbox.h
@@ -4,8 +4,7 @@
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     22.10.99
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     22.10.99

-// RCS-ID:      $Id$
-// Copyright:   (c) wxWindows team
+// Copyright:   (c) wxWidgets team

 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 


@@ -16,10 +15,6 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#if defined(__GNUG__) && !defined(__APPLE__)
-    #pragma interface "listboxbase.h"
-#endif
-

 #include "wx/defs.h"
 
 #if wxUSE_LISTBOX
 #include "wx/defs.h"
 
 #if wxUSE_LISTBOX


@@ -27,50 +22,42 @@
 #include "wx/ctrlsub.h"         // base class
 
 // forward declarations are enough here
 #include "wx/ctrlsub.h"         // base class
 
 // forward declarations are enough here

-class WXDLLEXPORT wxArrayInt;
-class WXDLLEXPORT wxArrayString;
+class WXDLLIMPEXP_FWD_BASE wxArrayInt;
+class WXDLLIMPEXP_FWD_BASE wxArrayString;

 
 // ----------------------------------------------------------------------------
 // global data
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // global data
 // ----------------------------------------------------------------------------
 

-WXDLLEXPORT_DATA(extern const wxChar*) wxListBoxNameStr;
+extern WXDLLIMPEXP_DATA_CORE(const char) wxListBoxNameStr[];

 
 // ----------------------------------------------------------------------------
 // wxListBox interface is defined by the class wxListBoxBase
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // wxListBox interface is defined by the class wxListBoxBase
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxListBoxBase : public wxControlWithItems
+class WXDLLIMPEXP_CORE wxListBoxBase : public wxControlWithItems

 {
 public:
     wxListBoxBase() { }
     virtual ~wxListBoxBase();
 
 {
 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)
-        { DoInsert(item, pos); SetClientData(pos, clientData); }
-    void Insert(const wxString& item, int pos, wxClientData *clientData)
-        { DoInsert(item, pos); SetClientObject(pos, clientData); }
-
-    void InsertItems(int nItems, const wxString *items, int pos);
-    void InsertItems(const wxArrayString& items, int pos)
-        { DoInsertItems(items, pos); }
-
-    void Set(int n, const wxString* items, void **clientData = NULL);
-    void Set(const wxArrayString& items, void **clientData = NULL)
-        { DoSetItems(items, clientData); }
+    void InsertItems(unsigned int nItems, const wxString *items, unsigned int pos)
+        { Insert(nItems, items, pos); }
+    void InsertItems(const wxArrayString& items, unsigned int pos)
+        { Insert(items, pos); }

 
     // multiple selection logic
     virtual bool IsSelected(int n) const = 0;
 
     // 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);
+    void SetSelection(int n, bool select) { DoSetSelection(n, select); }
+    void Deselect(int n) { DoSetSelection(n, false); }

     void DeselectAll(int itemToLeaveSelected = -1);
 
     void DeselectAll(int itemToLeaveSelected = -1);
 

-    virtual bool SetStringSelection(const wxString& s, bool select = TRUE);
+    virtual bool SetStringSelection(const wxString& s, bool select);
+    virtual bool SetStringSelection(const wxString& s)
+    {
+        return SetStringSelection(s, true);
+    }

 
     // works for single as well as multiple selection listboxes (unlike
     // GetSelection which only works for listboxes with single selection)
 
     // works for single as well as multiple selection listboxes (unlike
     // GetSelection which only works for listboxes with single selection)


@@ -89,37 +76,65 @@ public:
     // listbox and ensures that it is visible i.e. not scrolled out of view
     void AppendAndEnsureVisible(const wxString& s);
 
     // 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
+    // return true if the listbox allows multiple selection

     bool HasMultipleSelection() const
     {
         return (m_windowStyle & wxLB_MULTIPLE) ||
                (m_windowStyle & wxLB_EXTENDED);
     }
 
     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; }
+    // override wxItemContainer::IsSorted
+    virtual bool IsSorted() const { return HasFlag( wxLB_SORT ); }

 
     // emulate selecting or deselecting the item event.GetInt() (depending on
     // event.GetExtraLong())
     void Command(wxCommandEvent& event);
 
 
     // emulate selecting or deselecting the item event.GetInt() (depending on
     // event.GetExtraLong())
     void Command(wxCommandEvent& event);
 

-    // compatibility - these functions are deprecated, use the new ones
-    // instead
-    bool Selected(int n) const { return IsSelected(n); }
+    // return the index of the item at this position or wxNOT_FOUND
+    int HitTest(const wxPoint& point) const { return DoListHitTest(point); }
+    int HitTest(int x, int y) const { return DoListHitTest(wxPoint(x, y)); }

 
 

-protected:
-    // NB: due to wxGTK implementation details, DoInsert() is implemented
-    //     using DoInsertItems() and not the other way round
-    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;

 
 

+protected:

     virtual void DoSetFirstItem(int n) = 0;
 
     virtual void DoSetFirstItem(int n) = 0;
 

-    DECLARE_NO_COPY_CLASS(wxListBoxBase)
+    virtual void DoSetSelection(int n, bool select) = 0;
+
+    // there is already wxWindow::DoHitTest() so call this one differently
+    virtual int DoListHitTest(const wxPoint& WXUNUSED(point)) const
+        { return wxNOT_FOUND; }
+
+    // Helper for the code generating events in single selection mode: updates
+    // m_oldSelections and return true if the selection really changed.
+    // Otherwise just returns false.
+    bool DoChangeSingleSelection(int item);
+
+    // Helper for generating events in multiple and extended mode: compare the
+    // current selections with the previously recorded ones (in
+    // m_oldSelections) and send the appropriate event if they differ,
+    // otherwise just return false.
+    bool CalcAndSendEvent();
+
+    // Send a listbox (de)selection or double click event.
+    //
+    // Returns true if the event was processed.
+    bool SendEvent(wxEventType evtType, int item, bool selected);
+
+    // Array storing the indices of all selected items that we already notified
+    // the user code about for multi selection list boxes.
+    //
+    // For single selection list boxes, we reuse this array to store the single
+    // currently selected item, this is used by DoChangeSingleSelection().
+    //
+    // TODO-OPT: wxSelectionStore would be more efficient for big list boxes.
+    wxArrayInt m_oldSelections;
+
+    // Update m_oldSelections with currently selected items (does nothing in
+    // single selection mode on platforms other than MSW).
+    void UpdateOldSelections();
+
+private:
+    wxDECLARE_NO_COPY_CLASS(wxListBoxBase);

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -132,10 +147,12 @@ protected:
     #include "wx/msw/listbox.h"
 #elif defined(__WXMOTIF__)
     #include "wx/motif/listbox.h"
     #include "wx/msw/listbox.h"
 #elif defined(__WXMOTIF__)
     #include "wx/motif/listbox.h"

-#elif defined(__WXGTK__)
+#elif defined(__WXGTK20__)

     #include "wx/gtk/listbox.h"
     #include "wx/gtk/listbox.h"

+#elif defined(__WXGTK__)
+  #include "wx/gtk1/listbox.h"

 #elif defined(__WXMAC__)
 #elif defined(__WXMAC__)

-    #include "wx/mac/listbox.h"
+    #include "wx/osx/listbox.h"

 #elif defined(__WXPM__)
     #include "wx/os2/listbox.h"
 #elif defined(__WXCOCOA__)
 #elif defined(__WXPM__)
     #include "wx/os2/listbox.h"
 #elif defined(__WXCOCOA__)