]>
Commit | Line | Data |
---|---|---|
1 | ///////////////////////////////////////////////////////////////////////////// | |
2 | // Name: wx/generic/listctrl.h | |
3 | // Purpose: Generic list control | |
4 | // Author: Robert Roebling | |
5 | // Created: 01/02/97 | |
6 | // Id: | |
7 | // Copyright: (c) 1998 Robert Roebling, Julian Smart and Markus Holzem | |
8 | // Licence: wxWindows licence | |
9 | ///////////////////////////////////////////////////////////////////////////// | |
10 | ||
11 | #ifndef __LISTCTRLH_G__ | |
12 | #define __LISTCTRLH_G__ | |
13 | ||
14 | #ifdef __GNUG__ | |
15 | #pragma interface "listctrl.h" | |
16 | #endif | |
17 | ||
18 | #include "wx/defs.h" | |
19 | #include "wx/object.h" | |
20 | #include "wx/imaglist.h" | |
21 | #include "wx/control.h" | |
22 | #include "wx/timer.h" | |
23 | #include "wx/dcclient.h" | |
24 | #include "wx/scrolwin.h" | |
25 | #include "wx/settings.h" | |
26 | ||
27 | #if wxUSE_DRAG_AND_DROP | |
28 | class WXDLLEXPORT wxDropTarget; | |
29 | #endif | |
30 | ||
31 | //----------------------------------------------------------------------------- | |
32 | // classes | |
33 | //----------------------------------------------------------------------------- | |
34 | ||
35 | class WXDLLEXPORT wxListItem; | |
36 | class WXDLLEXPORT wxListEvent; | |
37 | class WXDLLEXPORT wxListCtrl; | |
38 | ||
39 | //----------------------------------------------------------------------------- | |
40 | // internal classes | |
41 | //----------------------------------------------------------------------------- | |
42 | ||
43 | class WXDLLEXPORT wxListHeaderData; | |
44 | class WXDLLEXPORT wxListItemData; | |
45 | class WXDLLEXPORT wxListLineData; | |
46 | ||
47 | class WXDLLEXPORT wxListHeaderWindow; | |
48 | class WXDLLEXPORT wxListMainWindow; | |
49 | ||
50 | class WXDLLEXPORT wxListRenameTimer; | |
51 | class WXDLLEXPORT wxListTextCtrl; | |
52 | ||
53 | //----------------------------------------------------------------------------- | |
54 | // wxListCtrl | |
55 | //----------------------------------------------------------------------------- | |
56 | ||
57 | class WXDLLEXPORT wxListCtrl: public wxControl | |
58 | { | |
59 | public: | |
60 | wxListCtrl(); | |
61 | wxListCtrl( wxWindow *parent, | |
62 | wxWindowID id = -1, | |
63 | const wxPoint &pos = wxDefaultPosition, | |
64 | const wxSize &size = wxDefaultSize, | |
65 | long style = wxLC_ICON, | |
66 | const wxValidator& validator = wxDefaultValidator, | |
67 | const wxString &name = "listctrl" ) | |
68 | { | |
69 | Create(parent, id, pos, size, style, validator, name); | |
70 | } | |
71 | ~wxListCtrl(); | |
72 | ||
73 | bool Create( wxWindow *parent, | |
74 | wxWindowID id = -1, | |
75 | const wxPoint &pos = wxDefaultPosition, | |
76 | const wxSize &size = wxDefaultSize, | |
77 | long style = wxLC_ICON, | |
78 | const wxValidator& validator = wxDefaultValidator, | |
79 | const wxString &name = "listctrl" ); | |
80 | ||
81 | bool GetColumn( int col, wxListItem& item ) const; | |
82 | bool SetColumn( int col, wxListItem& item ); | |
83 | int GetColumnWidth( int col ) const; | |
84 | bool SetColumnWidth( int col, int width); | |
85 | int GetCountPerPage() const; // not the same in wxGLC as in Windows, I think | |
86 | ||
87 | bool GetItem( wxListItem& info ) const; | |
88 | bool SetItem( wxListItem& info ) ; | |
89 | long SetItem( long index, int col, const wxString& label, int imageId = -1 ); | |
90 | int GetItemState( long item, long stateMask ) const; | |
91 | bool SetItemState( long item, long state, long stateMask); | |
92 | bool SetItemImage( long item, int image, int selImage); | |
93 | wxString GetItemText( long item ) const; | |
94 | void SetItemText( long item, const wxString& str ); | |
95 | long GetItemData( long item ) const; | |
96 | bool SetItemData( long item, long data ); | |
97 | bool GetItemRect( long item, wxRect& rect, int code = wxLIST_RECT_BOUNDS ) const; | |
98 | bool GetItemPosition( long item, wxPoint& pos ) const; | |
99 | bool SetItemPosition( long item, const wxPoint& pos ); // not supported in wxGLC | |
100 | int GetItemCount() const; | |
101 | int GetColumnCount() const; | |
102 | void SetItemSpacing( int spacing, bool isSmall = FALSE ); | |
103 | int GetItemSpacing( bool isSmall ) const; | |
104 | int GetSelectedItemCount() const; | |
105 | wxColour GetTextColour() const; | |
106 | void SetTextColour(const wxColour& col); | |
107 | long GetTopItem() const; | |
108 | ||
109 | void SetSingleStyle( long style, bool add = TRUE ) ; | |
110 | void SetWindowStyleFlag( long style ); | |
111 | void RecreateWindow() {} | |
112 | long GetNextItem( long item, int geometry = wxLIST_NEXT_ALL, int state = wxLIST_STATE_DONTCARE ) const; | |
113 | wxImageList *GetImageList( int which ) const; | |
114 | void SetImageList( wxImageList *imageList, int which ); | |
115 | void AssignImageList( wxImageList *imageList, int which ); | |
116 | bool Arrange( int flag = wxLIST_ALIGN_DEFAULT ); // always wxLIST_ALIGN_LEFT in wxGLC | |
117 | ||
118 | void ClearAll(); | |
119 | bool DeleteItem( long item ); | |
120 | bool DeleteAllItems(); | |
121 | bool DeleteAllColumns(); | |
122 | bool DeleteColumn( int col ); | |
123 | ||
124 | void SetItemCount(long count); | |
125 | ||
126 | void EditLabel( long item ) { Edit(item); } | |
127 | void Edit( long item ); | |
128 | ||
129 | bool EnsureVisible( long item ); | |
130 | long FindItem( long start, const wxString& str, bool partial = FALSE ); | |
131 | long FindItem( long start, long data ); | |
132 | long FindItem( long start, const wxPoint& pt, int direction ); // not supported in wxGLC | |
133 | long HitTest( const wxPoint& point, int& flags); | |
134 | long InsertItem(wxListItem& info); | |
135 | long InsertItem( long index, const wxString& label ); | |
136 | long InsertItem( long index, int imageIndex ); | |
137 | long InsertItem( long index, const wxString& label, int imageIndex ); | |
138 | long InsertColumn( long col, wxListItem& info ); | |
139 | long InsertColumn( long col, const wxString& heading, int format = wxLIST_FORMAT_LEFT, | |
140 | int width = -1 ); | |
141 | bool ScrollList( int dx, int dy ); | |
142 | bool SortItems( wxListCtrlCompare fn, long data ); | |
143 | bool Update( long item ); | |
144 | ||
145 | // returns true if it is a virtual list control | |
146 | bool IsVirtual() const { return (GetWindowStyle() & wxLC_VIRTUAL) != 0; } | |
147 | ||
148 | // refresh items selectively (only useful for virtual list controls) | |
149 | void RefreshItem(long item); | |
150 | void RefreshItems(long itemFrom, long itemTo); | |
151 | ||
152 | // implementation only from now on | |
153 | // ------------------------------- | |
154 | ||
155 | void OnIdle( wxIdleEvent &event ); | |
156 | void OnSize( wxSizeEvent &event ); | |
157 | ||
158 | // We have to hand down a few functions | |
159 | ||
160 | virtual void Freeze(); | |
161 | virtual void Thaw(); | |
162 | ||
163 | virtual bool SetBackgroundColour( const wxColour &colour ); | |
164 | virtual bool SetForegroundColour( const wxColour &colour ); | |
165 | virtual wxColour GetBackgroundColour() const; | |
166 | virtual wxColour GetForegroundColour() const; | |
167 | virtual bool SetFont( const wxFont &font ); | |
168 | virtual bool SetCursor( const wxCursor &cursor ); | |
169 | ||
170 | #if wxUSE_DRAG_AND_DROP | |
171 | virtual void SetDropTarget( wxDropTarget *dropTarget ); | |
172 | virtual wxDropTarget *GetDropTarget() const; | |
173 | #endif | |
174 | ||
175 | virtual bool DoPopupMenu( wxMenu *menu, int x, int y ); | |
176 | ||
177 | virtual void SetFocus(); | |
178 | ||
179 | // implementation | |
180 | // -------------- | |
181 | ||
182 | wxImageList *m_imageListNormal; | |
183 | wxImageList *m_imageListSmall; | |
184 | wxImageList *m_imageListState; // what's that ? | |
185 | bool m_ownsImageListNormal, | |
186 | m_ownsImageListSmall, | |
187 | m_ownsImageListState; | |
188 | wxListHeaderWindow *m_headerWin; | |
189 | wxListMainWindow *m_mainWin; | |
190 | ||
191 | protected: | |
192 | // return the text for the given column of the given item | |
193 | virtual wxString OnGetItemText(long item, long column) const; | |
194 | ||
195 | // return the icon for the given item | |
196 | virtual int OnGetItemImage(long item) const; | |
197 | ||
198 | // return the attribute for the item (may return NULL if none) | |
199 | virtual wxListItemAttr *OnGetItemAttr(long item) const; | |
200 | ||
201 | // it calls our OnGetXXX() functions | |
202 | friend class WXDLLEXPORT wxListMainWindow; | |
203 | ||
204 | private: | |
205 | // Virtual function hiding supression | |
206 | virtual void Update() { wxWindow::Update(); } | |
207 | ||
208 | // create the header window | |
209 | void CreateHeaderWindow(); | |
210 | ||
211 | // reposition the header and the main window in the report view depending | |
212 | // on whether it should be shown or not | |
213 | void ResizeReportView(bool showHeader); | |
214 | ||
215 | DECLARE_EVENT_TABLE() | |
216 | DECLARE_DYNAMIC_CLASS(wxListCtrl); | |
217 | }; | |
218 | ||
219 | ||
220 | #endif // __LISTCTRLH_G__ |