[ 1541434 ] wxListView::IsSelected should be const

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

diff --git a/include/wx/vlbox.h b/include/wx/vlbox.h
index ff1dc10de91b41bb77d127b141a1687a8c4e41a0..bc61c0d542268cc19f90aeda857ba4947323222d 100644 (file)
--- a/include/wx/vlbox.h
+++ b/include/wx/vlbox.h
@@ -5,7 +5,7 @@
 // Modified by:
 // Created:     31.05.03
 // RCS-ID:      $Id$
-// Copyright:   (c) 2003 Vadim Zeitlin <vadim@wxwindows.org>
+// Copyright:   (c) 2003 Vadim Zeitlin <vadim@wxwidgets.org>
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
@@ -13,6 +13,7 @@
 #define _WX_VLBOX_H_
 
 #include "wx/vscroll.h"         // base class
+#include "wx/bitmap.h"
 
 class WXDLLEXPORT wxSelectionStore;
 
@@ -92,6 +93,9 @@ public:
 
     // is this item the current one?
     bool IsCurrent(size_t item) const { return item == (size_t)m_current; }
+    #ifdef __WXUNIVERSAL__
+    bool IsCurrent() const { return wxVScrolledWindow::IsCurrent(); }
+    #endif
 
     // is this item selected?
     bool IsSelected(size_t item) const;
@@ -120,6 +124,9 @@ public:
     // get the margins around each item
     wxPoint GetMargins() const { return m_ptMargins; }
 
+    // get the background colour of selected cells
+    const wxColour& GetSelectionBackground() const { return m_colBgSel; }
+
 
     // operations
     // ----------
@@ -127,19 +134,19 @@ public:
     // set the number of items to be shown in the control
     //
     // this is just a synonym for wxVScrolledWindow::SetLineCount()
-    void SetItemCount(size_t count);
+    virtual void SetItemCount(size_t count);
 
     // delete all items from the control
     void Clear() { SetItemCount(0); }
 
-    // set the selection to the specified item, if it is -1 the selection is
-    // unset
+    // set the selection to the specified item, if it is wxNOT_FOUND the
+    // selection is unset
     //
     // this function is only valid for the single selection listboxes
     void SetSelection(int selection);
 
     // selects or deselects the specified item which must be valid (i.e. not
-    // equal to -1)
+    // equal to wxNOT_FOUND)
     //
     // return true if the items selection status has changed or false
     // otherwise
@@ -179,6 +186,17 @@ public:
     void SetMargins(const wxPoint& pt);
     void SetMargins(wxCoord x, wxCoord y) { SetMargins(wxPoint(x, y)); }
 
+    // change the background colour of the selected cells
+    void SetSelectionBackground(const wxColour& col);
+
+
+    virtual wxVisualAttributes GetDefaultAttributes() const
+    {
+        return GetClassDefaultAttributes(GetWindowVariant());
+    }
+
+    static wxVisualAttributes
+    GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 
 protected:
     // the derived class must implement this function to actually draw the item
@@ -196,11 +214,19 @@ protected:
     // the base class version doesn't do anything
     virtual void OnDrawSeparator(wxDC& dc, wxRect& rect, size_t n) const;
 
+    // this method is used to draw the items background and, maybe, a border
+    // around it
+    //
+    // the base class version implements a reasonable default behaviour which
+    // consists in drawing the selected item with the standard background
+    // colour and drawing a border around the item if it is either selected or
+    // current
+    virtual void OnDrawBackground(wxDC& dc, const wxRect& rect, size_t n) const;
 
     // we implement OnGetLineHeight() in terms of OnMeasureItem() because this
     // allows us to add borders to the items easily
     //
-    // this function is not upposed to be overridden by the derived classes
+    // this function is not supposed to be overridden by the derived classes
     virtual wxCoord OnGetLineHeight(size_t line) const;
 
 
@@ -221,29 +247,52 @@ protected:
     bool DoSelectAll(bool select);
 
     // change the current item (in single selection listbox it also implicitly
-    // changes the selection); current may be -1 in which case there will be
-    // no current item any more
+    // changes the selection); current may be wxNOT_FOUND in which case there
+    // will be no current item any more
     //
     // return true if the current item changed, false otherwise
     bool DoSetCurrent(int current);
 
+    // flags for DoHandleItemClick
+    enum
+    {
+        ItemClick_Shift = 1,        // item shift-clicked
+        ItemClick_Ctrl  = 2,        //       ctrl
+        ItemClick_Kbd   = 4         // item selected from keyboard
+    };
+
     // common part of keyboard and mouse handling processing code
-    void DoHandleItemClick(int item, bool shiftDown, bool ctrlDown);
+    void DoHandleItemClick(int item, int flags);
 
 private:
-    // the current item or -1
+    // the current item or wxNOT_FOUND
     //
     // if m_selStore == NULL this is also the selected item, otherwise the
     // selections are managed by m_selStore
     int m_current;
 
+    // the anchor of the selection for the multiselection listboxes:
+    // shift-clicking an item extends the selection from m_anchor to the item
+    // clicked, for example
+    //
+    // always wxNOT_FOUND for single selection listboxes
+    int m_anchor;
+
     // the object managing our selected items if not NULL
     wxSelectionStore *m_selStore;
 
     // margins
     wxPoint m_ptMargins;
 
+    // the selection bg colour
+    wxColour m_colBgSel;
+
+    // double buffer
+    wxBitmap* m_doubleBuffer;
+
     DECLARE_EVENT_TABLE()
+    DECLARE_NO_COPY_CLASS(wxVListBox)
+    DECLARE_ABSTRACT_CLASS(wxVListBox)
 };
 
 #endif // _WX_VLBOX_H_