make wxMouseState accessors const; document this class

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

diff --git a/include/wx/listctrl.h b/include/wx/listctrl.h
index 1e5c3480c8330b4f575a980d0225cbc1c2cd2d3c..8bb9adcabce0da3bd531f06489bfc521a15c2788 100644 (file)
--- a/include/wx/listctrl.h
+++ b/include/wx/listctrl.h
@@ -1,23 +1,110 @@
+///////////////////////////////////////////////////////////////////////////////
+// Name:        wx/listctrl.h
+// Purpose:     wxListCtrl class
+// Author:      Vadim Zeitlin
+// Modified by:
+// Created:     04.12.99
+// RCS-ID:      $Id$
+// Copyright:   (c) wxWidgets team
+// Licence:     wxWindows licence
+///////////////////////////////////////////////////////////////////////////////
+
 #ifndef _WX_LISTCTRL_H_BASE_
 #define _WX_LISTCTRL_H_BASE_
 
-#if defined(__WXMSW__)
-#ifdef __WIN16__
-#include "wx/generic/listctrl.h"
+#include "wx/defs.h" // headers should include this before first wxUSE_XXX check
+
+#if wxUSE_LISTCTRL
+
+#include "wx/listbase.h"
+
+// ----------------------------------------------------------------------------
+// constants
+// ----------------------------------------------------------------------------
+
+extern WXDLLIMPEXP_DATA_CORE(const char) wxListCtrlNameStr[];
+
+// ----------------------------------------------------------------------------
+// include the wxListCtrl class declaration
+// ----------------------------------------------------------------------------
+
+#if defined(__WIN32__) && !defined(__WXUNIVERSAL__)
+    #include "wx/msw/listctrl.h"
+#elif defined(__WXMAC__) && !defined(__WXUNIVERSAL__)
+    #include "wx/mac/carbon/listctrl.h"
 #else
-#include "wx/msw/listctrl.h"
-#endif
-#elif defined(__WXMOTIF__)
-#include "wx/generic/listctrl.h"
-#elif defined(__WXGTK__)
-#include "wx/generic/listctrl.h"
-#elif defined(__WXQT__)
-#include "wx/generic/listctrl.h"
-#elif defined(__WXMAC__)
-#include "wx/generic/listctrl.h"
-#elif defined(__WXSTUBS__)
-#include "wx/generic/listctrl.h"
+    #include "wx/generic/listctrl.h"
 #endif
 
+// ----------------------------------------------------------------------------
+// wxListView: a class which provides a better API for list control
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_CORE wxListView : public wxListCtrl
+{
+public:
+    wxListView() { }
+    wxListView( wxWindow *parent,
+                wxWindowID winid = wxID_ANY,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = wxLC_REPORT,
+                const wxValidator& validator = wxDefaultValidator,
+                const wxString &name = wxListCtrlNameStr)
+    {
+        Create(parent, winid, pos, size, style, validator, name);
+    }
+
+    // focus/selection stuff
+    // ---------------------
+
+    // [de]select an item
+    void Select(long n, bool on = true)
+    {
+        SetItemState(n, on ? wxLIST_STATE_SELECTED : 0, wxLIST_STATE_SELECTED);
+    }
+
+    // focus and show the given item
+    void Focus(long index)
+    {
+        SetItemState(index, wxLIST_STATE_FOCUSED, wxLIST_STATE_FOCUSED);
+        EnsureVisible(index);
+    }
+
+    // get the currently focused item or -1 if none
+    long GetFocusedItem() const
+    {
+        return GetNextItem(-1, wxLIST_NEXT_ALL, wxLIST_STATE_FOCUSED);
+    }
+
+    // get first and subsequent selected items, return -1 when no more
+    long GetNextSelected(long item) const
+        { return GetNextItem(item, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED); }
+    long GetFirstSelected() const
+        { return GetNextSelected(-1); }
+
+    // return true if the item is selected
+    bool IsSelected(long index) const
+        { return GetItemState(index, wxLIST_STATE_SELECTED) != 0; }
+
+    // columns
+    // -------
+
+    void SetColumnImage(int col, int image)
+    {
+        wxListItem item;
+        item.SetMask(wxLIST_MASK_IMAGE);
+        item.SetImage(image);
+        SetColumn(col, item);
+    }
+
+    void ClearColumnImage(int col) { SetColumnImage(col, -1); }
+
+private:
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxListView)
+};
+
+#endif // wxUSE_LISTCTRL
+
 #endif
     // _WX_LISTCTRL_H_BASE_