]>
Commit | Line | Data |
---|---|---|
1 | ///////////////////////////////////////////////////////////////////////////// | |
2 | // Name: wx/generic/dataview.h | |
3 | // Purpose: wxDataViewCtrl generic implementation header | |
4 | // Author: Robert Roebling | |
5 | // Modified By: Bo Yang | |
6 | // Id: $Id$ | |
7 | // Copyright: (c) 1998 Robert Roebling | |
8 | // Licence: wxWindows licence | |
9 | ///////////////////////////////////////////////////////////////////////////// | |
10 | ||
11 | #ifndef __GENERICDATAVIEWCTRLH__ | |
12 | #define __GENERICDATAVIEWCTRLH__ | |
13 | ||
14 | #include "wx/defs.h" | |
15 | #include "wx/object.h" | |
16 | #include "wx/list.h" | |
17 | #include "wx/control.h" | |
18 | #include "wx/scrolwin.h" | |
19 | #include "wx/icon.h" | |
20 | #include "wx/vector.h" | |
21 | ||
22 | class WXDLLIMPEXP_FWD_ADV wxDataViewMainWindow; | |
23 | class WXDLLIMPEXP_FWD_ADV wxDataViewHeaderWindow; | |
24 | ||
25 | // --------------------------------------------------------- | |
26 | // wxDataViewColumn | |
27 | // --------------------------------------------------------- | |
28 | ||
29 | class WXDLLIMPEXP_ADV wxDataViewColumn : public wxDataViewColumnBase | |
30 | { | |
31 | public: | |
32 | wxDataViewColumn(const wxString& title, | |
33 | wxDataViewRenderer *renderer, | |
34 | unsigned int model_column, | |
35 | int width = wxDVC_DEFAULT_WIDTH, | |
36 | wxAlignment align = wxALIGN_CENTER, | |
37 | int flags = wxDATAVIEW_COL_RESIZABLE) | |
38 | : wxDataViewColumnBase(renderer, model_column), | |
39 | m_title(title) | |
40 | { | |
41 | Init(width, align, flags); | |
42 | } | |
43 | ||
44 | wxDataViewColumn(const wxBitmap& bitmap, | |
45 | wxDataViewRenderer *renderer, | |
46 | unsigned int model_column, | |
47 | int width = wxDVC_DEFAULT_WIDTH, | |
48 | wxAlignment align = wxALIGN_CENTER, | |
49 | int flags = wxDATAVIEW_COL_RESIZABLE) | |
50 | : wxDataViewColumnBase(bitmap, renderer, model_column) | |
51 | { | |
52 | Init(width, align, flags); | |
53 | } | |
54 | ||
55 | // implement wxHeaderColumnBase methods | |
56 | virtual void SetTitle(const wxString& title) { m_title = title; UpdateDisplay(); } | |
57 | virtual wxString GetTitle() const { return m_title; } | |
58 | ||
59 | virtual void SetWidth(int width) { m_width = width; UpdateDisplay(); } | |
60 | virtual int GetWidth() const; | |
61 | ||
62 | virtual void SetMinWidth(int minWidth) { m_minWidth = minWidth; UpdateDisplay(); } | |
63 | virtual int GetMinWidth() const { return m_minWidth; } | |
64 | ||
65 | virtual void SetAlignment(wxAlignment align) { m_align = align; UpdateDisplay(); } | |
66 | virtual wxAlignment GetAlignment() const { return m_align; } | |
67 | ||
68 | virtual void SetFlags(int flags) { m_flags = flags; UpdateDisplay(); } | |
69 | virtual int GetFlags() const { return m_flags; } | |
70 | ||
71 | virtual bool IsSortKey() const { return m_sort; } | |
72 | ||
73 | virtual void UnsetAsSortKey(); | |
74 | ||
75 | virtual void SetSortOrder(bool ascending); | |
76 | ||
77 | virtual bool IsSortOrderAscending() const { return m_sortAscending; } | |
78 | ||
79 | virtual void SetBitmap( const wxBitmap& bitmap ) { wxDataViewColumnBase::SetBitmap(bitmap); UpdateDisplay(); } | |
80 | ||
81 | ||
82 | private: | |
83 | // common part of all ctors | |
84 | void Init(int width, wxAlignment align, int flags); | |
85 | ||
86 | void UpdateDisplay(); | |
87 | ||
88 | wxString m_title; | |
89 | int m_width, | |
90 | m_minWidth; | |
91 | wxAlignment m_align; | |
92 | int m_flags; | |
93 | bool m_sort, | |
94 | m_sortAscending; | |
95 | ||
96 | friend class wxDataViewHeaderWindowBase; | |
97 | friend class wxDataViewHeaderWindow; | |
98 | friend class wxDataViewHeaderWindowMSW; | |
99 | }; | |
100 | ||
101 | // --------------------------------------------------------- | |
102 | // wxDataViewCtrl | |
103 | // --------------------------------------------------------- | |
104 | ||
105 | WX_DECLARE_LIST_WITH_DECL(wxDataViewColumn, wxDataViewColumnList, | |
106 | class WXDLLIMPEXP_ADV); | |
107 | ||
108 | class WXDLLIMPEXP_ADV wxDataViewCtrl : public wxDataViewCtrlBase, | |
109 | public wxScrollHelper | |
110 | { | |
111 | friend class wxDataViewMainWindow; | |
112 | friend class wxDataViewHeaderWindowBase; | |
113 | friend class wxDataViewHeaderWindow; | |
114 | friend class wxDataViewHeaderWindowMSW; | |
115 | friend class wxDataViewColumn; | |
116 | ||
117 | public: | |
118 | wxDataViewCtrl() : wxScrollHelper(this) | |
119 | { | |
120 | Init(); | |
121 | } | |
122 | ||
123 | wxDataViewCtrl( wxWindow *parent, wxWindowID id, | |
124 | const wxPoint& pos = wxDefaultPosition, | |
125 | const wxSize& size = wxDefaultSize, long style = 0, | |
126 | const wxValidator& validator = wxDefaultValidator, | |
127 | const wxString& name = wxDataViewCtrlNameStr ) | |
128 | : wxScrollHelper(this) | |
129 | { | |
130 | Create(parent, id, pos, size, style, validator, name); | |
131 | } | |
132 | ||
133 | virtual ~wxDataViewCtrl(); | |
134 | ||
135 | void Init(); | |
136 | ||
137 | bool Create(wxWindow *parent, wxWindowID id, | |
138 | const wxPoint& pos = wxDefaultPosition, | |
139 | const wxSize& size = wxDefaultSize, long style = 0, | |
140 | const wxValidator& validator = wxDefaultValidator, | |
141 | const wxString& name = wxDataViewCtrlNameStr); | |
142 | ||
143 | virtual bool AssociateModel( wxDataViewModel *model ); | |
144 | ||
145 | virtual bool AppendColumn( wxDataViewColumn *col ); | |
146 | virtual bool PrependColumn( wxDataViewColumn *col ); | |
147 | virtual bool InsertColumn( unsigned int pos, wxDataViewColumn *col ); | |
148 | ||
149 | virtual void DoSetExpanderColumn(); | |
150 | virtual void DoSetIndent(); | |
151 | ||
152 | virtual unsigned int GetColumnCount() const; | |
153 | virtual wxDataViewColumn* GetColumn( unsigned int pos ) const; | |
154 | virtual bool DeleteColumn( wxDataViewColumn *column ); | |
155 | virtual bool ClearColumns(); | |
156 | virtual int GetColumnPosition( const wxDataViewColumn *column ) const; | |
157 | ||
158 | virtual wxDataViewColumn *GetSortingColumn() const; | |
159 | ||
160 | virtual int GetSelectedItemsCount() const; | |
161 | virtual int GetSelections( wxDataViewItemArray & sel ) const; | |
162 | virtual void SetSelections( const wxDataViewItemArray & sel ); | |
163 | virtual void Select( const wxDataViewItem & item ); | |
164 | virtual void Unselect( const wxDataViewItem & item ); | |
165 | virtual bool IsSelected( const wxDataViewItem & item ) const; | |
166 | ||
167 | virtual void SelectAll(); | |
168 | virtual void UnselectAll(); | |
169 | ||
170 | virtual void EnsureVisible( const wxDataViewItem & item, | |
171 | const wxDataViewColumn *column = NULL ); | |
172 | virtual void HitTest( const wxPoint & point, wxDataViewItem & item, | |
173 | wxDataViewColumn* &column ) const; | |
174 | virtual wxRect GetItemRect( const wxDataViewItem & item, | |
175 | const wxDataViewColumn *column = NULL ) const; | |
176 | ||
177 | virtual bool SetRowHeight( int rowHeight ); | |
178 | ||
179 | virtual void Expand( const wxDataViewItem & item ); | |
180 | virtual void Collapse( const wxDataViewItem & item ); | |
181 | virtual bool IsExpanded( const wxDataViewItem & item ) const; | |
182 | ||
183 | virtual void SetFocus(); | |
184 | ||
185 | virtual bool SetFont(const wxFont & font); | |
186 | ||
187 | #if wxUSE_DRAG_AND_DROP | |
188 | virtual bool EnableDragSource( const wxDataFormat &format ); | |
189 | virtual bool EnableDropTarget( const wxDataFormat &format ); | |
190 | #endif // wxUSE_DRAG_AND_DROP | |
191 | ||
192 | virtual wxBorder GetDefaultBorder() const; | |
193 | ||
194 | virtual void EditItem(const wxDataViewItem& item, const wxDataViewColumn *column); | |
195 | ||
196 | // These methods are specific to generic wxDataViewCtrl implementation and | |
197 | // should not be used in portable code. | |
198 | wxColour GetAlternateRowColour() const { return m_alternateRowColour; } | |
199 | void SetAlternateRowColour(const wxColour& colour); | |
200 | ||
201 | protected: | |
202 | virtual void EnsureVisible( int row, int column ); | |
203 | ||
204 | // Notice that row here may be invalid (i.e. >= GetRowCount()), this is not | |
205 | // an error and this function simply returns an invalid item in this case. | |
206 | virtual wxDataViewItem GetItemByRow( unsigned int row ) const; | |
207 | virtual int GetRowByItem( const wxDataViewItem & item ) const; | |
208 | ||
209 | int GetSortingColumnIndex() const { return m_sortingColumnIdx; } | |
210 | void SetSortingColumnIndex(int idx) { m_sortingColumnIdx = idx; } | |
211 | ||
212 | public: // utility functions not part of the API | |
213 | ||
214 | // returns the "best" width for the idx-th column | |
215 | unsigned int GetBestColumnWidth(int idx) const; | |
216 | ||
217 | // called by header window after reorder | |
218 | void ColumnMoved( wxDataViewColumn* col, unsigned int new_pos ); | |
219 | ||
220 | // update the display after a change to an individual column | |
221 | void OnColumnChange(unsigned int idx); | |
222 | ||
223 | // update after a change to the number of columns | |
224 | void OnColumnsCountChanged(); | |
225 | ||
226 | wxWindow *GetMainWindow() { return (wxWindow*) m_clientArea; } | |
227 | ||
228 | // return the index of the given column in m_cols | |
229 | int GetColumnIndex(const wxDataViewColumn *column) const; | |
230 | ||
231 | // return the column displayed at the given position in the control | |
232 | wxDataViewColumn *GetColumnAt(unsigned int pos) const; | |
233 | ||
234 | virtual wxDataViewColumn *GetCurrentColumn() const; | |
235 | ||
236 | virtual void OnInternalIdle(); | |
237 | ||
238 | private: | |
239 | virtual wxDataViewItem DoGetCurrentItem() const; | |
240 | virtual void DoSetCurrentItem(const wxDataViewItem& item); | |
241 | ||
242 | void InvalidateColBestWidths(); | |
243 | void InvalidateColBestWidth(int idx); | |
244 | void UpdateColWidths(); | |
245 | ||
246 | wxDataViewColumnList m_cols; | |
247 | // cached column best widths information, values are for | |
248 | // respective columns from m_cols and the arrays have same size | |
249 | struct CachedColWidthInfo | |
250 | { | |
251 | CachedColWidthInfo() : width(0), dirty(true) {} | |
252 | int width; // cached width or 0 if not computed | |
253 | bool dirty; // column was invalidated, header needs updating | |
254 | }; | |
255 | wxVector<CachedColWidthInfo> m_colsBestWidths; | |
256 | // This indicates that at least one entry in m_colsBestWidths has 'dirty' | |
257 | // flag set. It's cheaper to check one flag in OnInternalIdle() than to | |
258 | // iterate over m_colsBestWidths to check if anything needs to be done. | |
259 | bool m_colsDirty; | |
260 | ||
261 | wxDataViewModelNotifier *m_notifier; | |
262 | wxDataViewMainWindow *m_clientArea; | |
263 | wxDataViewHeaderWindow *m_headerArea; | |
264 | ||
265 | // user defined color to draw row lines, may be invalid | |
266 | wxColour m_alternateRowColour; | |
267 | ||
268 | // the index of the column currently used for sorting or -1 | |
269 | int m_sortingColumnIdx; | |
270 | ||
271 | private: | |
272 | void OnSize( wxSizeEvent &event ); | |
273 | virtual wxSize GetSizeAvailableForScrollTarget(const wxSize& size); | |
274 | ||
275 | // we need to return a special WM_GETDLGCODE value to process just the | |
276 | // arrows but let the other navigation characters through | |
277 | #ifdef __WXMSW__ | |
278 | virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam); | |
279 | #endif // __WXMSW__ | |
280 | ||
281 | WX_FORWARD_TO_SCROLL_HELPER() | |
282 | ||
283 | private: | |
284 | DECLARE_DYNAMIC_CLASS(wxDataViewCtrl) | |
285 | wxDECLARE_NO_COPY_CLASS(wxDataViewCtrl); | |
286 | DECLARE_EVENT_TABLE() | |
287 | }; | |
288 | ||
289 | ||
290 | #endif // __GENERICDATAVIEWCTRLH__ |