]> git.saurik.com Git - wxWidgets.git/blob - include/wx/listctrl.h
extracted Unix code in a separate new file (src/unix/dlunix.cpp), it remains only...
[wxWidgets.git] / include / wx / listctrl.h
1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: wx/listctrl.h
3 // Purpose: wxListCtrl class
4 // Author: Vadim Zeitlin
5 // Modified by:
6 // Created: 04.12.99
7 // RCS-ID: $Id$
8 // Copyright: (c) wxWidgets team
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_LISTCTRL_H_BASE_
13 #define _WX_LISTCTRL_H_BASE_
14
15 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
16 #pragma interface "listctrlbase.h"
17 #endif
18
19 #include "wx/defs.h" // headers should include this before first wxUSE_XXX check
20
21 #if wxUSE_LISTCTRL
22
23 #include "wx/listbase.h"
24
25 // ----------------------------------------------------------------------------
26 // constants
27 // ----------------------------------------------------------------------------
28
29 WXDLLEXPORT_DATA(extern const wxChar*) wxListCtrlNameStr;
30
31 // ----------------------------------------------------------------------------
32 // include the wxListCtrl class declaration
33 // ----------------------------------------------------------------------------
34
35 #if defined(__WIN32__) && !defined(__WXUNIVERSAL__)
36 #include "wx/msw/listctrl.h"
37 #else
38 #include "wx/generic/listctrl.h"
39 #endif
40
41 // ----------------------------------------------------------------------------
42 // wxListView: a class which provides a better API for list control
43 // ----------------------------------------------------------------------------
44
45 class WXDLLEXPORT wxListView : public wxListCtrl
46 {
47 public:
48 wxListView() { }
49 wxListView( wxWindow *parent,
50 wxWindowID winid = wxID_ANY,
51 const wxPoint& pos = wxDefaultPosition,
52 const wxSize& size = wxDefaultSize,
53 long style = wxLC_REPORT,
54 const wxValidator& validator = wxDefaultValidator,
55 const wxString &name = wxListCtrlNameStr)
56 {
57 Create(parent, winid, pos, size, style, validator, name);
58 }
59
60 // focus/selection stuff
61 // ---------------------
62
63 // [de]select an item
64 void Select(long n, bool on = true)
65 {
66 SetItemState(n, on ? wxLIST_STATE_SELECTED : 0, wxLIST_STATE_SELECTED);
67 }
68
69 // focus and show the given item
70 void Focus(long index)
71 {
72 SetItemState(index, wxLIST_STATE_FOCUSED, wxLIST_STATE_FOCUSED);
73 EnsureVisible(index);
74 }
75
76 // get the currently focused item or -1 if none
77 long GetFocusedItem() const
78 {
79 return GetNextItem(-1, wxLIST_NEXT_ALL, wxLIST_STATE_FOCUSED);
80 }
81
82 // get first and subsequent selected items, return -1 when no more
83 long GetNextSelected(long item) const
84 { return GetNextItem(item, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED); }
85 long GetFirstSelected() const
86 { return GetNextSelected(-1); }
87
88 // return true if the item is selected
89 bool IsSelected(long index)
90 { return GetItemState(index, wxLIST_STATE_SELECTED) != 0; }
91
92 // columns
93 // -------
94
95 void SetColumnImage(int col, int image)
96 {
97 wxListItem item;
98 item.SetMask(wxLIST_MASK_IMAGE);
99 item.SetImage(image);
100 SetColumn(col, item);
101 }
102
103 void ClearColumnImage(int col) { SetColumnImage(col, -1); }
104
105 private:
106 DECLARE_DYNAMIC_CLASS_NO_COPY(wxListView)
107 };
108
109 #endif // wxUSE_LISTCTRL
110
111 #endif
112 // _WX_LISTCTRL_H_BASE_