]>
Commit | Line | Data |
---|---|---|
f85afd4e | 1 | ///////////////////////////////////////////////////////////////////////////// |
43947979 | 2 | // Name: wx/generic/grid.h |
f85afd4e MB |
3 | // Purpose: wxGrid and related classes |
4 | // Author: Michael Bedward (based on code by Julian Smart, Robin Dunn) | |
5 | // Modified by: | |
6 | // Created: 1/08/1999 | |
7 | // RCS-ID: $Id$ | |
8 | // Copyright: (c) Michael Bedward | |
9 | // Licence: wxWindows licence | |
10 | ///////////////////////////////////////////////////////////////////////////// | |
11 | ||
f85afd4e MB |
12 | #include "wx/defs.h" |
13 | ||
f85afd4e MB |
14 | #ifndef __WXGRID_H__ |
15 | #define __WXGRID_H__ | |
16 | ||
af49c4b8 | 17 | #if defined(__GNUG__) && !defined(__APPLE__) |
f85afd4e MB |
18 | #pragma interface "grid.h" |
19 | #endif | |
20 | ||
ba8c1601 | 21 | #include "wx/hashmap.h" |
f85afd4e | 22 | #include "wx/panel.h" |
2d66e025 | 23 | #include "wx/scrolwin.h" |
f85afd4e | 24 | #include "wx/string.h" |
2da2f941 | 25 | #include "wx/arrstr.h" |
f85afd4e MB |
26 | #include "wx/scrolbar.h" |
27 | #include "wx/event.h" | |
f85afd4e MB |
28 | #include "wx/combobox.h" |
29 | #include "wx/dynarray.h" | |
025562fe | 30 | #include "wx/timer.h" |
afbd598c | 31 | #include "wx/clntdata.h" |
f85afd4e | 32 | |
816be743 VZ |
33 | // ---------------------------------------------------------------------------- |
34 | // constants | |
35 | // ---------------------------------------------------------------------------- | |
36 | ||
f85afd4e MB |
37 | // Default parameters for wxGrid |
38 | // | |
39 | #define WXGRID_DEFAULT_NUMBER_ROWS 10 | |
40 | #define WXGRID_DEFAULT_NUMBER_COLS 10 | |
41 | #ifdef __WXMSW__ | |
42 | #define WXGRID_DEFAULT_ROW_HEIGHT 25 | |
43 | #else | |
44 | #define WXGRID_DEFAULT_ROW_HEIGHT 30 | |
45 | #endif // __WXMSW__ | |
46 | #define WXGRID_DEFAULT_COL_WIDTH 80 | |
47 | #define WXGRID_DEFAULT_COL_LABEL_HEIGHT 32 | |
48 | #define WXGRID_DEFAULT_ROW_LABEL_WIDTH 82 | |
f1567cdd | 49 | #define WXGRID_LABEL_EDGE_ZONE 2 |
f85afd4e MB |
50 | #define WXGRID_MIN_ROW_HEIGHT 15 |
51 | #define WXGRID_MIN_COL_WIDTH 15 | |
52 | #define WXGRID_DEFAULT_SCROLLBAR_WIDTH 16 | |
f85afd4e | 53 | |
816be743 VZ |
54 | // type names for grid table values |
55 | #define wxGRID_VALUE_STRING _T("string") | |
56 | #define wxGRID_VALUE_BOOL _T("bool") | |
57 | #define wxGRID_VALUE_NUMBER _T("long") | |
58 | #define wxGRID_VALUE_FLOAT _T("double") | |
c4608a8a | 59 | #define wxGRID_VALUE_CHOICE _T("choice") |
816be743 VZ |
60 | |
61 | #define wxGRID_VALUE_TEXT wxGRID_VALUE_STRING | |
62 | #define wxGRID_VALUE_LONG wxGRID_VALUE_NUMBER | |
63 | ||
b99be8fb VZ |
64 | // ---------------------------------------------------------------------------- |
65 | // forward declarations | |
66 | // ---------------------------------------------------------------------------- | |
67 | ||
12f190b0 VS |
68 | class WXDLLIMPEXP_ADV wxGrid; |
69 | class WXDLLIMPEXP_ADV wxGridCellAttr; | |
70 | class WXDLLIMPEXP_ADV wxGridCellAttrProviderData; | |
71 | class WXDLLIMPEXP_ADV wxGridColLabelWindow; | |
72 | class WXDLLIMPEXP_ADV wxGridCornerLabelWindow; | |
73 | class WXDLLIMPEXP_ADV wxGridRowLabelWindow; | |
74 | class WXDLLIMPEXP_ADV wxGridTableBase; | |
75 | class WXDLLIMPEXP_ADV wxGridWindow; | |
76 | class WXDLLIMPEXP_ADV wxGridTypeRegistry; | |
77 | class WXDLLIMPEXP_ADV wxGridSelection; | |
ab79958a | 78 | |
508011ce | 79 | class WXDLLEXPORT wxCheckBox; |
4ee5fc9c | 80 | class WXDLLEXPORT wxComboBox; |
508011ce | 81 | class WXDLLEXPORT wxTextCtrl; |
816be743 | 82 | class WXDLLEXPORT wxSpinCtrl; |
508011ce | 83 | |
12f190b0 VS |
84 | WX_DECLARE_HASH_MAP_WITH_DECL( long, long, wxIntegerHash, wxIntegerEqual, |
85 | wxLongToLongHashMap, class WXDLLIMPEXP_ADV ); | |
ba8c1601 | 86 | |
39bcce60 VZ |
87 | // ---------------------------------------------------------------------------- |
88 | // macros | |
89 | // ---------------------------------------------------------------------------- | |
90 | ||
91 | #define wxSafeIncRef(p) if ( p ) (p)->IncRef() | |
92 | #define wxSafeDecRef(p) if ( p ) (p)->DecRef() | |
93 | ||
ab79958a | 94 | // ---------------------------------------------------------------------------- |
c4608a8a VZ |
95 | // wxGridCellWorker: common base class for wxGridCellRenderer and |
96 | // wxGridCellEditor | |
97 | // | |
98 | // NB: this is more an implementation convenience than a design issue, so this | |
99 | // class is not documented and is not public at all | |
ab79958a VZ |
100 | // ---------------------------------------------------------------------------- |
101 | ||
12f190b0 | 102 | class WXDLLIMPEXP_ADV wxGridCellWorker : public wxClientDataContainer |
ab79958a VZ |
103 | { |
104 | public: | |
c4608a8a | 105 | wxGridCellWorker() { m_nRef = 1; } |
39bcce60 VZ |
106 | |
107 | // this class is ref counted: it is created with ref count of 1, so | |
108 | // calling DecRef() once will delete it. Calling IncRef() allows to lock | |
109 | // it until the matching DecRef() is called | |
110 | void IncRef() { m_nRef++; } | |
111 | void DecRef() { if ( !--m_nRef ) delete this; } | |
112 | ||
c4608a8a VZ |
113 | // interpret renderer parameters: arbitrary string whose interpretatin is |
114 | // left to the derived classes | |
115 | virtual void SetParameters(const wxString& params); | |
116 | ||
117 | protected: | |
118 | // virtual dtor for any base class - private because only DecRef() can | |
119 | // delete us | |
120 | virtual ~wxGridCellWorker(); | |
121 | ||
122 | private: | |
123 | size_t m_nRef; | |
124 | ||
125 | // suppress the stupid gcc warning about the class having private dtor and | |
126 | // no friends | |
127 | friend class wxGridCellWorkerDummyFriend; | |
128 | }; | |
129 | ||
130 | // ---------------------------------------------------------------------------- | |
131 | // wxGridCellRenderer: this class is responsible for actually drawing the cell | |
132 | // in the grid. You may pass it to the wxGridCellAttr (below) to change the | |
133 | // format of one given cell or to wxGrid::SetDefaultRenderer() to change the | |
134 | // view of all cells. This is an ABC, you will normally use one of the | |
135 | // predefined derived classes or derive your own class from it. | |
136 | // ---------------------------------------------------------------------------- | |
137 | ||
12f190b0 | 138 | class WXDLLIMPEXP_ADV wxGridCellRenderer : public wxGridCellWorker |
c4608a8a VZ |
139 | { |
140 | public: | |
ab79958a VZ |
141 | // draw the given cell on the provided DC inside the given rectangle |
142 | // using the style specified by the attribute and the default or selected | |
143 | // state corresponding to the isSelected value. | |
144 | // | |
145 | // this pure virtual function has a default implementation which will | |
146 | // prepare the DC using the given attribute: it will draw the rectangle | |
147 | // with the bg colour from attr and set the text colour and font | |
148 | virtual void Draw(wxGrid& grid, | |
2796cce3 | 149 | wxGridCellAttr& attr, |
ab79958a VZ |
150 | wxDC& dc, |
151 | const wxRect& rect, | |
152 | int row, int col, | |
153 | bool isSelected) = 0; | |
816be743 | 154 | |
65e4e78e VZ |
155 | // get the preferred size of the cell for its contents |
156 | virtual wxSize GetBestSize(wxGrid& grid, | |
157 | wxGridCellAttr& attr, | |
158 | wxDC& dc, | |
159 | int row, int col) = 0; | |
160 | ||
e72b4213 VZ |
161 | // create a new object which is the copy of this one |
162 | virtual wxGridCellRenderer *Clone() const = 0; | |
ab79958a VZ |
163 | }; |
164 | ||
165 | // the default renderer for the cells containing string data | |
12f190b0 | 166 | class WXDLLIMPEXP_ADV wxGridCellStringRenderer : public wxGridCellRenderer |
ab79958a VZ |
167 | { |
168 | public: | |
169 | // draw the string | |
170 | virtual void Draw(wxGrid& grid, | |
2796cce3 | 171 | wxGridCellAttr& attr, |
ab79958a VZ |
172 | wxDC& dc, |
173 | const wxRect& rect, | |
174 | int row, int col, | |
175 | bool isSelected); | |
816be743 | 176 | |
65e4e78e VZ |
177 | // return the string extent |
178 | virtual wxSize GetBestSize(wxGrid& grid, | |
179 | wxGridCellAttr& attr, | |
180 | wxDC& dc, | |
181 | int row, int col); | |
182 | ||
e72b4213 VZ |
183 | virtual wxGridCellRenderer *Clone() const |
184 | { return new wxGridCellStringRenderer; } | |
185 | ||
816be743 VZ |
186 | protected: |
187 | // set the text colours before drawing | |
188 | void SetTextColoursAndFont(wxGrid& grid, | |
189 | wxGridCellAttr& attr, | |
190 | wxDC& dc, | |
191 | bool isSelected); | |
65e4e78e VZ |
192 | |
193 | // calc the string extent for given string/font | |
194 | wxSize DoGetBestSize(wxGridCellAttr& attr, | |
195 | wxDC& dc, | |
196 | const wxString& text); | |
816be743 VZ |
197 | }; |
198 | ||
199 | // the default renderer for the cells containing numeric (long) data | |
12f190b0 | 200 | class WXDLLIMPEXP_ADV wxGridCellNumberRenderer : public wxGridCellStringRenderer |
816be743 VZ |
201 | { |
202 | public: | |
203 | // draw the string right aligned | |
204 | virtual void Draw(wxGrid& grid, | |
205 | wxGridCellAttr& attr, | |
206 | wxDC& dc, | |
207 | const wxRect& rect, | |
208 | int row, int col, | |
209 | bool isSelected); | |
65e4e78e VZ |
210 | |
211 | virtual wxSize GetBestSize(wxGrid& grid, | |
212 | wxGridCellAttr& attr, | |
213 | wxDC& dc, | |
214 | int row, int col); | |
215 | ||
e72b4213 VZ |
216 | virtual wxGridCellRenderer *Clone() const |
217 | { return new wxGridCellNumberRenderer; } | |
218 | ||
65e4e78e VZ |
219 | protected: |
220 | wxString GetString(wxGrid& grid, int row, int col); | |
816be743 VZ |
221 | }; |
222 | ||
12f190b0 | 223 | class WXDLLIMPEXP_ADV wxGridCellFloatRenderer : public wxGridCellStringRenderer |
816be743 VZ |
224 | { |
225 | public: | |
0b190b0f | 226 | wxGridCellFloatRenderer(int width = -1, int precision = -1); |
816be743 VZ |
227 | |
228 | // get/change formatting parameters | |
229 | int GetWidth() const { return m_width; } | |
0b190b0f | 230 | void SetWidth(int width) { m_width = width; m_format.clear(); } |
816be743 | 231 | int GetPrecision() const { return m_precision; } |
0b190b0f | 232 | void SetPrecision(int precision) { m_precision = precision; m_format.clear(); } |
816be743 VZ |
233 | |
234 | // draw the string right aligned with given width/precision | |
235 | virtual void Draw(wxGrid& grid, | |
236 | wxGridCellAttr& attr, | |
237 | wxDC& dc, | |
238 | const wxRect& rect, | |
239 | int row, int col, | |
240 | bool isSelected); | |
241 | ||
65e4e78e VZ |
242 | virtual wxSize GetBestSize(wxGrid& grid, |
243 | wxGridCellAttr& attr, | |
244 | wxDC& dc, | |
245 | int row, int col); | |
0b190b0f VZ |
246 | |
247 | // parameters string format is "width[,precision]" | |
248 | virtual void SetParameters(const wxString& params); | |
249 | ||
e72b4213 VZ |
250 | virtual wxGridCellRenderer *Clone() const; |
251 | ||
65e4e78e VZ |
252 | protected: |
253 | wxString GetString(wxGrid& grid, int row, int col); | |
254 | ||
816be743 VZ |
255 | private: |
256 | // formatting parameters | |
257 | int m_width, | |
0b190b0f | 258 | m_precision; |
816be743 VZ |
259 | |
260 | wxString m_format; | |
ab79958a | 261 | }; |
f85afd4e | 262 | |
508011ce | 263 | // renderer for boolean fields |
12f190b0 | 264 | class WXDLLIMPEXP_ADV wxGridCellBoolRenderer : public wxGridCellRenderer |
508011ce VZ |
265 | { |
266 | public: | |
508011ce VZ |
267 | // draw a check mark or nothing |
268 | virtual void Draw(wxGrid& grid, | |
269 | wxGridCellAttr& attr, | |
270 | wxDC& dc, | |
271 | const wxRect& rect, | |
272 | int row, int col, | |
273 | bool isSelected); | |
65e4e78e VZ |
274 | |
275 | // return the checkmark size | |
276 | virtual wxSize GetBestSize(wxGrid& grid, | |
277 | wxGridCellAttr& attr, | |
278 | wxDC& dc, | |
279 | int row, int col); | |
280 | ||
e72b4213 VZ |
281 | virtual wxGridCellRenderer *Clone() const |
282 | { return new wxGridCellBoolRenderer; } | |
283 | ||
65e4e78e VZ |
284 | private: |
285 | static wxSize ms_sizeCheckMark; | |
508011ce | 286 | }; |
2796cce3 RD |
287 | |
288 | // ---------------------------------------------------------------------------- | |
289 | // wxGridCellEditor: This class is responsible for providing and manipulating | |
290 | // the in-place edit controls for the grid. Instances of wxGridCellEditor | |
291 | // (actually, instances of derived classes since it is an ABC) can be | |
292 | // associated with the cell attributes for individual cells, rows, columns, or | |
293 | // even for the entire grid. | |
294 | // ---------------------------------------------------------------------------- | |
295 | ||
12f190b0 | 296 | class WXDLLIMPEXP_ADV wxGridCellEditor : public wxGridCellWorker |
2796cce3 RD |
297 | { |
298 | public: | |
299 | wxGridCellEditor(); | |
39bcce60 | 300 | |
2796cce3 | 301 | bool IsCreated() { return m_control != NULL; } |
f6bcfd97 BP |
302 | wxControl* GetControl() { return m_control; } |
303 | void SetControl(wxControl* control) { m_control = control; } | |
2796cce3 | 304 | |
1bd71df9 JS |
305 | wxGridCellAttr* GetCellAttr() { return m_attr; } |
306 | void SetCellAttr(wxGridCellAttr* attr) { m_attr = attr; } | |
307 | ||
2796cce3 RD |
308 | // Creates the actual edit control |
309 | virtual void Create(wxWindow* parent, | |
310 | wxWindowID id, | |
2796cce3 RD |
311 | wxEvtHandler* evtHandler) = 0; |
312 | ||
313 | // Size and position the edit control | |
314 | virtual void SetSize(const wxRect& rect); | |
315 | ||
3da93aae VZ |
316 | // Show or hide the edit control, use the specified attributes to set |
317 | // colours/fonts for it | |
318 | virtual void Show(bool show, wxGridCellAttr *attr = (wxGridCellAttr *)NULL); | |
2796cce3 | 319 | |
189d0213 VZ |
320 | // Draws the part of the cell not occupied by the control: the base class |
321 | // version just fills it with background colour from the attribute | |
322 | virtual void PaintBackground(const wxRect& rectCell, wxGridCellAttr *attr); | |
323 | ||
2796cce3 RD |
324 | // Fetch the value from the table and prepare the edit control |
325 | // to begin editing. Set the focus to the edit control. | |
3da93aae | 326 | virtual void BeginEdit(int row, int col, wxGrid* grid) = 0; |
2796cce3 | 327 | |
3324d5f5 VZ |
328 | // Complete the editing of the current cell. Returns true if the value has |
329 | // changed. If necessary, the control may be destroyed. | |
330 | virtual bool EndEdit(int row, int col, wxGrid* grid) = 0; | |
2796cce3 RD |
331 | |
332 | // Reset the value in the control back to its starting value | |
333 | virtual void Reset() = 0; | |
334 | ||
f6bcfd97 BP |
335 | // return TRUE to allow the given key to start editing: the base class |
336 | // version only checks that the event has no modifiers. The derived | |
337 | // classes are supposed to do "if ( base::IsAcceptedKey() && ... )" in | |
338 | // their IsAcceptedKey() implementation, although, of course, it is not a | |
339 | // mandatory requirment. | |
340 | // | |
341 | // NB: if the key is F2 (special), editing will always start and this | |
342 | // method will not be called at all (but StartingKey() will) | |
343 | virtual bool IsAcceptedKey(wxKeyEvent& event); | |
344 | ||
345 | // If the editor is enabled by pressing keys on the grid, this will be | |
346 | // called to let the editor do something about that first key if desired | |
2c9a89e0 RD |
347 | virtual void StartingKey(wxKeyEvent& event); |
348 | ||
e195a54c VZ |
349 | // if the editor is enabled by clicking on the cell, this method will be |
350 | // called | |
351 | virtual void StartingClick(); | |
352 | ||
2796cce3 RD |
353 | // Some types of controls on some platforms may need some help |
354 | // with the Return key. | |
355 | virtual void HandleReturn(wxKeyEvent& event); | |
356 | ||
357 | // Final cleanup | |
358 | virtual void Destroy(); | |
359 | ||
c4608a8a VZ |
360 | // create a new object which is the copy of this one |
361 | virtual wxGridCellEditor *Clone() const = 0; | |
362 | ||
73145b0e JS |
363 | // DJC MAPTEK |
364 | // added GetValue so we can get the value which is in the control | |
365 | virtual wxString GetValue() const = 0; | |
366 | ||
2796cce3 | 367 | protected: |
39bcce60 VZ |
368 | // the dtor is private because only DecRef() can delete us |
369 | virtual ~wxGridCellEditor(); | |
370 | ||
3da93aae | 371 | // the control we show on screen |
2796cce3 | 372 | wxControl* m_control; |
3da93aae | 373 | |
1bd71df9 JS |
374 | // a temporary pointer to the attribute being edited |
375 | wxGridCellAttr* m_attr; | |
376 | ||
3da93aae VZ |
377 | // if we change the colours/font of the control from the default ones, we |
378 | // must restore the default later and we save them here between calls to | |
379 | // Show(TRUE) and Show(FALSE) | |
380 | wxColour m_colFgOld, | |
381 | m_colBgOld; | |
382 | wxFont m_fontOld; | |
39bcce60 VZ |
383 | |
384 | // suppress the stupid gcc warning about the class having private dtor and | |
385 | // no friends | |
386 | friend class wxGridCellEditorDummyFriend; | |
22f3361e VZ |
387 | |
388 | DECLARE_NO_COPY_CLASS(wxGridCellEditor) | |
2796cce3 RD |
389 | }; |
390 | ||
3379ed37 VZ |
391 | #if wxUSE_TEXTCTRL |
392 | ||
508011ce | 393 | // the editor for string/text data |
12f190b0 | 394 | class WXDLLIMPEXP_ADV wxGridCellTextEditor : public wxGridCellEditor |
2796cce3 RD |
395 | { |
396 | public: | |
397 | wxGridCellTextEditor(); | |
398 | ||
399 | virtual void Create(wxWindow* parent, | |
400 | wxWindowID id, | |
2796cce3 | 401 | wxEvtHandler* evtHandler); |
99306db2 | 402 | virtual void SetSize(const wxRect& rect); |
2796cce3 | 403 | |
189d0213 VZ |
404 | virtual void PaintBackground(const wxRect& rectCell, wxGridCellAttr *attr); |
405 | ||
f6bcfd97 | 406 | virtual bool IsAcceptedKey(wxKeyEvent& event); |
3da93aae | 407 | virtual void BeginEdit(int row, int col, wxGrid* grid); |
3324d5f5 | 408 | virtual bool EndEdit(int row, int col, wxGrid* grid); |
2796cce3 RD |
409 | |
410 | virtual void Reset(); | |
2c9a89e0 | 411 | virtual void StartingKey(wxKeyEvent& event); |
2796cce3 RD |
412 | virtual void HandleReturn(wxKeyEvent& event); |
413 | ||
c4608a8a VZ |
414 | // parameters string format is "max_width" |
415 | virtual void SetParameters(const wxString& params); | |
416 | ||
417 | virtual wxGridCellEditor *Clone() const | |
418 | { return new wxGridCellTextEditor; } | |
419 | ||
73145b0e JS |
420 | // DJC MAPTEK |
421 | // added GetValue so we can get the value which is in the control | |
422 | virtual wxString GetValue() const; | |
b54ba671 VZ |
423 | protected: |
424 | wxTextCtrl *Text() const { return (wxTextCtrl *)m_control; } | |
2796cce3 | 425 | |
816be743 VZ |
426 | // parts of our virtual functions reused by the derived classes |
427 | void DoBeginEdit(const wxString& startValue); | |
428 | void DoReset(const wxString& startValue); | |
429 | ||
2796cce3 | 430 | private: |
c4608a8a | 431 | size_t m_maxChars; // max number of chars allowed |
2796cce3 | 432 | wxString m_startValue; |
fc7a2a60 VZ |
433 | |
434 | DECLARE_NO_COPY_CLASS(wxGridCellTextEditor) | |
2796cce3 RD |
435 | }; |
436 | ||
816be743 | 437 | // the editor for numeric (long) data |
12f190b0 | 438 | class WXDLLIMPEXP_ADV wxGridCellNumberEditor : public wxGridCellTextEditor |
816be743 VZ |
439 | { |
440 | public: | |
441 | // allows to specify the range - if min == max == -1, no range checking is | |
442 | // done | |
443 | wxGridCellNumberEditor(int min = -1, int max = -1); | |
444 | ||
445 | virtual void Create(wxWindow* parent, | |
446 | wxWindowID id, | |
447 | wxEvtHandler* evtHandler); | |
448 | ||
f6bcfd97 | 449 | virtual bool IsAcceptedKey(wxKeyEvent& event); |
816be743 | 450 | virtual void BeginEdit(int row, int col, wxGrid* grid); |
3324d5f5 | 451 | virtual bool EndEdit(int row, int col, wxGrid* grid); |
816be743 VZ |
452 | |
453 | virtual void Reset(); | |
454 | virtual void StartingKey(wxKeyEvent& event); | |
455 | ||
c4608a8a VZ |
456 | // parameters string format is "min,max" |
457 | virtual void SetParameters(const wxString& params); | |
458 | ||
459 | virtual wxGridCellEditor *Clone() const | |
460 | { return new wxGridCellNumberEditor(m_min, m_max); } | |
73145b0e JS |
461 | // DJC MAPTEK |
462 | // added GetValue so we can get the value which is in the control | |
463 | virtual wxString GetValue() const; | |
c4608a8a | 464 | |
816be743 VZ |
465 | protected: |
466 | wxSpinCtrl *Spin() const { return (wxSpinCtrl *)m_control; } | |
467 | ||
468 | // if HasRange(), we use wxSpinCtrl - otherwise wxTextCtrl | |
469 | bool HasRange() const { return m_min != m_max; } | |
470 | ||
471 | // string representation of m_valueOld | |
472 | wxString GetString() const | |
473 | { return wxString::Format(_T("%ld"), m_valueOld); } | |
474 | ||
475 | private: | |
476 | int m_min, | |
477 | m_max; | |
478 | ||
479 | long m_valueOld; | |
fc7a2a60 VZ |
480 | |
481 | DECLARE_NO_COPY_CLASS(wxGridCellNumberEditor) | |
816be743 VZ |
482 | }; |
483 | ||
484 | // the editor for floating point numbers (double) data | |
12f190b0 | 485 | class WXDLLIMPEXP_ADV wxGridCellFloatEditor : public wxGridCellTextEditor |
816be743 VZ |
486 | { |
487 | public: | |
f6bcfd97 BP |
488 | wxGridCellFloatEditor(int width = -1, int precision = -1); |
489 | ||
816be743 VZ |
490 | virtual void Create(wxWindow* parent, |
491 | wxWindowID id, | |
492 | wxEvtHandler* evtHandler); | |
493 | ||
f6bcfd97 | 494 | virtual bool IsAcceptedKey(wxKeyEvent& event); |
816be743 | 495 | virtual void BeginEdit(int row, int col, wxGrid* grid); |
3324d5f5 | 496 | virtual bool EndEdit(int row, int col, wxGrid* grid); |
816be743 VZ |
497 | |
498 | virtual void Reset(); | |
499 | virtual void StartingKey(wxKeyEvent& event); | |
500 | ||
c4608a8a | 501 | virtual wxGridCellEditor *Clone() const |
ec53826c | 502 | { return new wxGridCellFloatEditor(m_width, m_precision); } |
c4608a8a | 503 | |
f6bcfd97 BP |
504 | // parameters string format is "width,precision" |
505 | virtual void SetParameters(const wxString& params); | |
506 | ||
816be743 VZ |
507 | protected: |
508 | // string representation of m_valueOld | |
f6bcfd97 | 509 | wxString GetString() const; |
816be743 VZ |
510 | |
511 | private: | |
f6bcfd97 BP |
512 | int m_width, |
513 | m_precision; | |
816be743 | 514 | double m_valueOld; |
fc7a2a60 VZ |
515 | |
516 | DECLARE_NO_COPY_CLASS(wxGridCellFloatEditor) | |
816be743 VZ |
517 | }; |
518 | ||
3379ed37 VZ |
519 | #endif // wxUSE_TEXTCTRL |
520 | ||
521 | #if wxUSE_CHECKBOX | |
522 | ||
508011ce | 523 | // the editor for boolean data |
12f190b0 | 524 | class WXDLLIMPEXP_ADV wxGridCellBoolEditor : public wxGridCellEditor |
508011ce VZ |
525 | { |
526 | public: | |
fc7a2a60 VZ |
527 | wxGridCellBoolEditor() { } |
528 | ||
508011ce VZ |
529 | virtual void Create(wxWindow* parent, |
530 | wxWindowID id, | |
531 | wxEvtHandler* evtHandler); | |
532 | ||
533 | virtual void SetSize(const wxRect& rect); | |
534 | virtual void Show(bool show, wxGridCellAttr *attr = (wxGridCellAttr *)NULL); | |
535 | ||
f6bcfd97 | 536 | virtual bool IsAcceptedKey(wxKeyEvent& event); |
508011ce | 537 | virtual void BeginEdit(int row, int col, wxGrid* grid); |
3324d5f5 | 538 | virtual bool EndEdit(int row, int col, wxGrid* grid); |
508011ce VZ |
539 | |
540 | virtual void Reset(); | |
e195a54c | 541 | virtual void StartingClick(); |
508011ce | 542 | |
c4608a8a VZ |
543 | virtual wxGridCellEditor *Clone() const |
544 | { return new wxGridCellBoolEditor; } | |
73145b0e JS |
545 | // DJC MAPTEK |
546 | // added GetValue so we can get the value which is in the control | |
547 | virtual wxString GetValue() const; | |
c4608a8a | 548 | |
508011ce VZ |
549 | protected: |
550 | wxCheckBox *CBox() const { return (wxCheckBox *)m_control; } | |
551 | ||
552 | private: | |
553 | bool m_startValue; | |
fc7a2a60 VZ |
554 | |
555 | DECLARE_NO_COPY_CLASS(wxGridCellBoolEditor) | |
508011ce VZ |
556 | }; |
557 | ||
3379ed37 VZ |
558 | #endif // wxUSE_CHECKBOX |
559 | ||
560 | #if wxUSE_COMBOBOX | |
561 | ||
4ee5fc9c | 562 | // the editor for string data allowing to choose from the list of strings |
12f190b0 | 563 | class WXDLLIMPEXP_ADV wxGridCellChoiceEditor : public wxGridCellEditor |
4ee5fc9c VZ |
564 | { |
565 | public: | |
566 | // if !allowOthers, user can't type a string not in choices array | |
c4608a8a | 567 | wxGridCellChoiceEditor(size_t count = 0, |
f6bcfd97 | 568 | const wxString choices[] = NULL, |
4ee5fc9c VZ |
569 | bool allowOthers = FALSE); |
570 | ||
571 | virtual void Create(wxWindow* parent, | |
572 | wxWindowID id, | |
573 | wxEvtHandler* evtHandler); | |
574 | ||
575 | virtual void PaintBackground(const wxRect& rectCell, wxGridCellAttr *attr); | |
576 | ||
577 | virtual void BeginEdit(int row, int col, wxGrid* grid); | |
3324d5f5 | 578 | virtual bool EndEdit(int row, int col, wxGrid* grid); |
4ee5fc9c VZ |
579 | |
580 | virtual void Reset(); | |
581 | ||
c4608a8a VZ |
582 | // parameters string format is "item1[,item2[...,itemN]]" |
583 | virtual void SetParameters(const wxString& params); | |
584 | ||
585 | virtual wxGridCellEditor *Clone() const; | |
73145b0e JS |
586 | // DJC MAPTEK |
587 | // added GetValue so we can get the value which is in the control | |
588 | virtual wxString GetValue() const; | |
c4608a8a | 589 | |
4ee5fc9c VZ |
590 | protected: |
591 | wxComboBox *Combo() const { return (wxComboBox *)m_control; } | |
592 | ||
73145b0e JS |
593 | // DJC - (MAPTEK) you at least need access to m_choices if you |
594 | // wish to override this class | |
595 | protected: | |
4ee5fc9c VZ |
596 | wxString m_startValue; |
597 | wxArrayString m_choices; | |
598 | bool m_allowOthers; | |
fc7a2a60 VZ |
599 | |
600 | DECLARE_NO_COPY_CLASS(wxGridCellChoiceEditor) | |
4ee5fc9c | 601 | }; |
a68c1246 | 602 | |
3379ed37 VZ |
603 | #endif // wxUSE_COMBOBOX |
604 | ||
b99be8fb VZ |
605 | // ---------------------------------------------------------------------------- |
606 | // wxGridCellAttr: this class can be used to alter the cells appearance in | |
607 | // the grid by changing their colour/font/... from default. An object of this | |
608 | // class may be returned by wxGridTable::GetAttr(). | |
609 | // ---------------------------------------------------------------------------- | |
610 | ||
12f190b0 | 611 | class WXDLLIMPEXP_ADV wxGridCellAttr : public wxClientDataContainer |
b99be8fb VZ |
612 | { |
613 | public: | |
19d7140e VZ |
614 | enum wxAttrKind |
615 | { | |
616 | Any, | |
617 | Default, | |
618 | Cell, | |
619 | Row, | |
620 | Col, | |
621 | Merged | |
622 | }; | |
623 | ||
b99be8fb | 624 | // ctors |
1df4050d | 625 | wxGridCellAttr(wxGridCellAttr *attrDefault = NULL) |
b99be8fb | 626 | { |
1df4050d VZ |
627 | Init(attrDefault); |
628 | ||
0767cb6f MB |
629 | // MB: args used to be 0,0 here but wxALIGN_LEFT is 0 |
630 | SetAlignment(-1, -1); | |
b99be8fb VZ |
631 | } |
632 | ||
283b7808 VZ |
633 | // VZ: considering the number of members wxGridCellAttr has now, this ctor |
634 | // seems to be pretty useless... may be we should just remove it? | |
b99be8fb VZ |
635 | wxGridCellAttr(const wxColour& colText, |
636 | const wxColour& colBack, | |
637 | const wxFont& font, | |
638 | int hAlign, | |
639 | int vAlign) | |
640 | : m_colText(colText), m_colBack(colBack), m_font(font) | |
641 | { | |
2e9a6788 | 642 | Init(); |
b99be8fb VZ |
643 | SetAlignment(hAlign, vAlign); |
644 | } | |
645 | ||
39bcce60 VZ |
646 | // creates a new copy of this object |
647 | wxGridCellAttr *Clone() const; | |
19d7140e | 648 | void MergeWith(wxGridCellAttr *mergefrom); |
b99be8fb | 649 | |
2e9a6788 VZ |
650 | // this class is ref counted: it is created with ref count of 1, so |
651 | // calling DecRef() once will delete it. Calling IncRef() allows to lock | |
652 | // it until the matching DecRef() is called | |
653 | void IncRef() { m_nRef++; } | |
654 | void DecRef() { if ( !--m_nRef ) delete this; } | |
2e9a6788 | 655 | |
b99be8fb VZ |
656 | // setters |
657 | void SetTextColour(const wxColour& colText) { m_colText = colText; } | |
658 | void SetBackgroundColour(const wxColour& colBack) { m_colBack = colBack; } | |
659 | void SetFont(const wxFont& font) { m_font = font; } | |
660 | void SetAlignment(int hAlign, int vAlign) | |
661 | { | |
662 | m_hAlign = hAlign; | |
663 | m_vAlign = vAlign; | |
664 | } | |
27f35b66 | 665 | void SetSize(int num_rows, int num_cols); |
ef5df12b RD |
666 | void SetOverflow(bool allow = TRUE) |
667 | { m_overflow = allow ? Overflow : SingleCell; } | |
19d7140e VZ |
668 | void SetReadOnly(bool isReadOnly = TRUE) |
669 | { m_isReadOnly = isReadOnly ? ReadOnly : ReadWrite; } | |
b99be8fb | 670 | |
ab79958a VZ |
671 | // takes ownership of the pointer |
672 | void SetRenderer(wxGridCellRenderer *renderer) | |
39bcce60 | 673 | { wxSafeDecRef(m_renderer); m_renderer = renderer; } |
07296f0b | 674 | void SetEditor(wxGridCellEditor* editor) |
39bcce60 | 675 | { wxSafeDecRef(m_editor); m_editor = editor; } |
ab79958a | 676 | |
19d7140e VZ |
677 | void SetKind(wxAttrKind kind) { m_attrkind = kind; } |
678 | ||
b99be8fb VZ |
679 | // accessors |
680 | bool HasTextColour() const { return m_colText.Ok(); } | |
681 | bool HasBackgroundColour() const { return m_colBack.Ok(); } | |
682 | bool HasFont() const { return m_font.Ok(); } | |
0767cb6f | 683 | bool HasAlignment() const { return (m_hAlign != -1 || m_vAlign != -1); } |
2796cce3 | 684 | bool HasRenderer() const { return m_renderer != NULL; } |
07296f0b | 685 | bool HasEditor() const { return m_editor != NULL; } |
19d7140e | 686 | bool HasReadWriteMode() const { return m_isReadOnly != Unset; } |
b63fce94 | 687 | bool HasOverflowMode() const { return m_overflow != UnsetOverflow; } |
b99be8fb | 688 | |
2796cce3 RD |
689 | const wxColour& GetTextColour() const; |
690 | const wxColour& GetBackgroundColour() const; | |
691 | const wxFont& GetFont() const; | |
692 | void GetAlignment(int *hAlign, int *vAlign) const; | |
27f35b66 | 693 | void GetSize(int *num_rows, int *num_cols) const; |
ef5df12b | 694 | bool GetOverflow() const |
b63fce94 | 695 | { return m_overflow != SingleCell; } |
28a77bc4 RD |
696 | wxGridCellRenderer *GetRenderer(wxGrid* grid, int row, int col) const; |
697 | wxGridCellEditor *GetEditor(wxGrid* grid, int row, int col) const; | |
b99be8fb | 698 | |
19d7140e VZ |
699 | bool IsReadOnly() const { return m_isReadOnly == wxGridCellAttr::ReadOnly; } |
700 | ||
701 | wxAttrKind GetKind() { return m_attrkind; } | |
283b7808 | 702 | |
2796cce3 | 703 | void SetDefAttr(wxGridCellAttr* defAttr) { m_defGridAttr = defAttr; } |
ab79958a | 704 | |
b99be8fb | 705 | private: |
19d7140e VZ |
706 | enum wxAttrReadMode |
707 | { | |
708 | Unset = -1, | |
709 | ReadWrite, | |
710 | ReadOnly | |
30bc4a8f | 711 | }; |
19d7140e | 712 | |
b63fce94 RD |
713 | enum wxAttrOverflowMode |
714 | { | |
715 | UnsetOverflow = -1, | |
716 | Overflow, | |
717 | SingleCell | |
718 | }; | |
719 | ||
2e9a6788 | 720 | // the common part of all ctors |
1df4050d | 721 | void Init(wxGridCellAttr *attrDefault = NULL); |
2e9a6788 VZ |
722 | |
723 | // the dtor is private because only DecRef() can delete us | |
39bcce60 VZ |
724 | ~wxGridCellAttr() |
725 | { | |
726 | wxSafeDecRef(m_renderer); | |
727 | wxSafeDecRef(m_editor); | |
728 | } | |
2e9a6788 VZ |
729 | |
730 | // the ref count - when it goes to 0, we die | |
731 | size_t m_nRef; | |
732 | ||
b99be8fb VZ |
733 | wxColour m_colText, |
734 | m_colBack; | |
735 | wxFont m_font; | |
736 | int m_hAlign, | |
737 | m_vAlign; | |
27f35b66 SN |
738 | int m_sizeRows, |
739 | m_sizeCols; | |
ef5df12b RD |
740 | |
741 | wxAttrOverflowMode m_overflow; | |
2e9a6788 | 742 | |
07296f0b RD |
743 | wxGridCellRenderer* m_renderer; |
744 | wxGridCellEditor* m_editor; | |
745 | wxGridCellAttr* m_defGridAttr; | |
ab79958a | 746 | |
19d7140e VZ |
747 | wxAttrReadMode m_isReadOnly; |
748 | ||
749 | wxAttrKind m_attrkind; | |
283b7808 | 750 | |
a68c1246 | 751 | // use Clone() instead |
7ef4c90b | 752 | DECLARE_NO_COPY_CLASS(wxGridCellAttr) |
a68c1246 | 753 | |
2e9a6788 VZ |
754 | // suppress the stupid gcc warning about the class having private dtor and |
755 | // no friends | |
756 | friend class wxGridCellAttrDummyFriend; | |
b99be8fb VZ |
757 | }; |
758 | ||
759 | // ---------------------------------------------------------------------------- | |
760 | // wxGridCellAttrProvider: class used by wxGridTableBase to retrieve/store the | |
761 | // cell attributes. | |
762 | // ---------------------------------------------------------------------------- | |
763 | ||
764 | // implementation note: we separate it from wxGridTableBase because we wish to | |
765 | // avoid deriving a new table class if possible, and sometimes it will be | |
766 | // enough to just derive another wxGridCellAttrProvider instead | |
758cbedf VZ |
767 | // |
768 | // the default implementation is reasonably efficient for the generic case, | |
769 | // but you might still wish to implement your own for some specific situations | |
770 | // if you have performance problems with the stock one | |
12f190b0 | 771 | class WXDLLIMPEXP_ADV wxGridCellAttrProvider : public wxClientDataContainer |
b99be8fb VZ |
772 | { |
773 | public: | |
774 | wxGridCellAttrProvider(); | |
775 | virtual ~wxGridCellAttrProvider(); | |
776 | ||
2e9a6788 | 777 | // DecRef() must be called on the returned pointer |
19d7140e VZ |
778 | virtual wxGridCellAttr *GetAttr(int row, int col, |
779 | wxGridCellAttr::wxAttrKind kind ) const; | |
2e9a6788 | 780 | |
758cbedf VZ |
781 | // all these functions take ownership of the pointer, don't call DecRef() |
782 | // on it | |
2e9a6788 | 783 | virtual void SetAttr(wxGridCellAttr *attr, int row, int col); |
758cbedf VZ |
784 | virtual void SetRowAttr(wxGridCellAttr *attr, int row); |
785 | virtual void SetColAttr(wxGridCellAttr *attr, int col); | |
d1c0b4f9 VZ |
786 | |
787 | // these functions must be called whenever some rows/cols are deleted | |
788 | // because the internal data must be updated then | |
4d60017a SN |
789 | void UpdateAttrRows( size_t pos, int numRows ); |
790 | void UpdateAttrCols( size_t pos, int numCols ); | |
b99be8fb VZ |
791 | |
792 | private: | |
793 | void InitData(); | |
794 | ||
795 | wxGridCellAttrProviderData *m_data; | |
22f3361e VZ |
796 | |
797 | DECLARE_NO_COPY_CLASS(wxGridCellAttrProvider) | |
b99be8fb | 798 | }; |
f85afd4e MB |
799 | |
800 | ////////////////////////////////////////////////////////////////////// | |
801 | // | |
802 | // Grid table classes | |
803 | // | |
804 | ////////////////////////////////////////////////////////////////////// | |
805 | ||
806 | ||
12f190b0 | 807 | class WXDLLIMPEXP_ADV wxGridTableBase : public wxObject, public wxClientDataContainer |
f85afd4e | 808 | { |
60ff3b99 | 809 | public: |
f85afd4e MB |
810 | wxGridTableBase(); |
811 | virtual ~wxGridTableBase(); | |
812 | ||
813 | // You must override these functions in a derived table class | |
814 | // | |
e32352cf SN |
815 | virtual int GetNumberRows() = 0; |
816 | virtual int GetNumberCols() = 0; | |
f85afd4e | 817 | virtual bool IsEmptyCell( int row, int col ) = 0; |
f2d76237 RD |
818 | virtual wxString GetValue( int row, int col ) = 0; |
819 | virtual void SetValue( int row, int col, const wxString& value ) = 0; | |
820 | ||
821 | // Data type determination and value access | |
822 | virtual wxString GetTypeName( int row, int col ); | |
823 | virtual bool CanGetValueAs( int row, int col, const wxString& typeName ); | |
824 | virtual bool CanSetValueAs( int row, int col, const wxString& typeName ); | |
825 | ||
826 | virtual long GetValueAsLong( int row, int col ); | |
827 | virtual double GetValueAsDouble( int row, int col ); | |
828 | virtual bool GetValueAsBool( int row, int col ); | |
829 | ||
830 | virtual void SetValueAsLong( int row, int col, long value ); | |
831 | virtual void SetValueAsDouble( int row, int col, double value ); | |
832 | virtual void SetValueAsBool( int row, int col, bool value ); | |
833 | ||
834 | // For user defined types | |
835 | virtual void* GetValueAsCustom( int row, int col, const wxString& typeName ); | |
836 | virtual void SetValueAsCustom( int row, int col, const wxString& typeName, void* value ); | |
837 | ||
60ff3b99 | 838 | |
f85afd4e MB |
839 | // Overriding these is optional |
840 | // | |
841 | virtual void SetView( wxGrid *grid ) { m_view = grid; } | |
842 | virtual wxGrid * GetView() const { return m_view; } | |
843 | ||
844 | virtual void Clear() {} | |
845 | virtual bool InsertRows( size_t pos = 0, size_t numRows = 1 ); | |
846 | virtual bool AppendRows( size_t numRows = 1 ); | |
847 | virtual bool DeleteRows( size_t pos = 0, size_t numRows = 1 ); | |
848 | virtual bool InsertCols( size_t pos = 0, size_t numCols = 1 ); | |
849 | virtual bool AppendCols( size_t numCols = 1 ); | |
850 | virtual bool DeleteCols( size_t pos = 0, size_t numCols = 1 ); | |
851 | ||
852 | virtual wxString GetRowLabelValue( int row ); | |
853 | virtual wxString GetColLabelValue( int col ); | |
af111fc3 JS |
854 | virtual void SetRowLabelValue( int WXUNUSED(row), const wxString& ) {} |
855 | virtual void SetColLabelValue( int WXUNUSED(col), const wxString& ) {} | |
60ff3b99 | 856 | |
b99be8fb VZ |
857 | // Attribute handling |
858 | // | |
859 | ||
860 | // give us the attr provider to use - we take ownership of the pointer | |
861 | void SetAttrProvider(wxGridCellAttrProvider *attrProvider); | |
862 | ||
863 | // get the currently used attr provider (may be NULL) | |
864 | wxGridCellAttrProvider *GetAttrProvider() const { return m_attrProvider; } | |
865 | ||
f2d76237 RD |
866 | // Does this table allow attributes? Default implementation creates |
867 | // a wxGridCellAttrProvider if necessary. | |
868 | virtual bool CanHaveAttributes(); | |
869 | ||
b99be8fb | 870 | // by default forwarded to wxGridCellAttrProvider if any. May be |
f2d76237 | 871 | // overridden to handle attributes directly in the table. |
19d7140e VZ |
872 | virtual wxGridCellAttr *GetAttr( int row, int col, |
873 | wxGridCellAttr::wxAttrKind kind ); | |
874 | ||
b99be8fb | 875 | |
758cbedf VZ |
876 | // these functions take ownership of the pointer |
877 | virtual void SetAttr(wxGridCellAttr* attr, int row, int col); | |
878 | virtual void SetRowAttr(wxGridCellAttr *attr, int row); | |
879 | virtual void SetColAttr(wxGridCellAttr *attr, int col); | |
b99be8fb | 880 | |
60ff3b99 VZ |
881 | private: |
882 | wxGrid * m_view; | |
b99be8fb | 883 | wxGridCellAttrProvider *m_attrProvider; |
60ff3b99 | 884 | |
f85afd4e | 885 | DECLARE_ABSTRACT_CLASS( wxGridTableBase ); |
22f3361e | 886 | DECLARE_NO_COPY_CLASS(wxGridTableBase) |
f85afd4e MB |
887 | }; |
888 | ||
889 | ||
b99be8fb VZ |
890 | // ---------------------------------------------------------------------------- |
891 | // wxGridTableMessage | |
892 | // ---------------------------------------------------------------------------- | |
f85afd4e MB |
893 | |
894 | // IDs for messages sent from grid table to view | |
895 | // | |
60ff3b99 VZ |
896 | enum wxGridTableRequest |
897 | { | |
f85afd4e MB |
898 | wxGRIDTABLE_REQUEST_VIEW_GET_VALUES = 2000, |
899 | wxGRIDTABLE_REQUEST_VIEW_SEND_VALUES, | |
900 | wxGRIDTABLE_NOTIFY_ROWS_INSERTED, | |
901 | wxGRIDTABLE_NOTIFY_ROWS_APPENDED, | |
902 | wxGRIDTABLE_NOTIFY_ROWS_DELETED, | |
903 | wxGRIDTABLE_NOTIFY_COLS_INSERTED, | |
904 | wxGRIDTABLE_NOTIFY_COLS_APPENDED, | |
905 | wxGRIDTABLE_NOTIFY_COLS_DELETED | |
906 | }; | |
907 | ||
12f190b0 | 908 | class WXDLLIMPEXP_ADV wxGridTableMessage |
f85afd4e | 909 | { |
60ff3b99 | 910 | public: |
f85afd4e MB |
911 | wxGridTableMessage(); |
912 | wxGridTableMessage( wxGridTableBase *table, int id, | |
913 | int comInt1 = -1, | |
914 | int comInt2 = -1 ); | |
915 | ||
916 | void SetTableObject( wxGridTableBase *table ) { m_table = table; } | |
917 | wxGridTableBase * GetTableObject() const { return m_table; } | |
918 | void SetId( int id ) { m_id = id; } | |
919 | int GetId() { return m_id; } | |
920 | void SetCommandInt( int comInt1 ) { m_comInt1 = comInt1; } | |
921 | int GetCommandInt() { return m_comInt1; } | |
922 | void SetCommandInt2( int comInt2 ) { m_comInt2 = comInt2; } | |
60ff3b99 VZ |
923 | int GetCommandInt2() { return m_comInt2; } |
924 | ||
925 | private: | |
926 | wxGridTableBase *m_table; | |
927 | int m_id; | |
928 | int m_comInt1; | |
929 | int m_comInt2; | |
22f3361e VZ |
930 | |
931 | DECLARE_NO_COPY_CLASS(wxGridTableMessage) | |
f85afd4e MB |
932 | }; |
933 | ||
934 | ||
935 | ||
936 | // ------ wxGridStringArray | |
937 | // A 2-dimensional array of strings for data values | |
938 | // | |
939 | ||
2d66e025 MB |
940 | WX_DECLARE_EXPORTED_OBJARRAY(wxArrayString, wxGridStringArray); |
941 | ||
f85afd4e MB |
942 | |
943 | ||
944 | // ------ wxGridStringTable | |
945 | // | |
946 | // Simplest type of data table for a grid for small tables of strings | |
947 | // that are stored in memory | |
948 | // | |
949 | ||
12f190b0 | 950 | class WXDLLIMPEXP_ADV wxGridStringTable : public wxGridTableBase |
f85afd4e | 951 | { |
60ff3b99 | 952 | public: |
f85afd4e MB |
953 | wxGridStringTable(); |
954 | wxGridStringTable( int numRows, int numCols ); | |
e669d97a | 955 | virtual ~wxGridStringTable(); |
f85afd4e MB |
956 | |
957 | // these are pure virtual in wxGridTableBase | |
958 | // | |
e32352cf SN |
959 | int GetNumberRows(); |
960 | int GetNumberCols(); | |
f85afd4e MB |
961 | wxString GetValue( int row, int col ); |
962 | void SetValue( int row, int col, const wxString& s ); | |
963 | bool IsEmptyCell( int row, int col ); | |
60ff3b99 | 964 | |
f85afd4e MB |
965 | // overridden functions from wxGridTableBase |
966 | // | |
967 | void Clear(); | |
968 | bool InsertRows( size_t pos = 0, size_t numRows = 1 ); | |
969 | bool AppendRows( size_t numRows = 1 ); | |
970 | bool DeleteRows( size_t pos = 0, size_t numRows = 1 ); | |
971 | bool InsertCols( size_t pos = 0, size_t numCols = 1 ); | |
972 | bool AppendCols( size_t numCols = 1 ); | |
973 | bool DeleteCols( size_t pos = 0, size_t numCols = 1 ); | |
974 | ||
975 | void SetRowLabelValue( int row, const wxString& ); | |
976 | void SetColLabelValue( int col, const wxString& ); | |
977 | wxString GetRowLabelValue( int row ); | |
978 | wxString GetColLabelValue( int col ); | |
60ff3b99 VZ |
979 | |
980 | private: | |
981 | wxGridStringArray m_data; | |
982 | ||
983 | // These only get used if you set your own labels, otherwise the | |
984 | // GetRow/ColLabelValue functions return wxGridTableBase defaults | |
985 | // | |
986 | wxArrayString m_rowLabels; | |
987 | wxArrayString m_colLabels; | |
988 | ||
fc7a2a60 | 989 | DECLARE_DYNAMIC_CLASS_NO_COPY( wxGridStringTable ) |
f85afd4e MB |
990 | }; |
991 | ||
992 | ||
993 | ||
43947979 | 994 | // ============================================================================ |
f85afd4e | 995 | // Grid view classes |
43947979 VZ |
996 | // ============================================================================ |
997 | ||
998 | // ---------------------------------------------------------------------------- | |
999 | // wxGridCellCoords: location of a cell in the grid | |
1000 | // ---------------------------------------------------------------------------- | |
f85afd4e | 1001 | |
12f190b0 | 1002 | class WXDLLIMPEXP_ADV wxGridCellCoords |
f85afd4e | 1003 | { |
60ff3b99 | 1004 | public: |
f85afd4e MB |
1005 | wxGridCellCoords() { m_row = m_col = -1; } |
1006 | wxGridCellCoords( int r, int c ) { m_row = r; m_col = c; } | |
1007 | ||
1008 | // default copy ctor is ok | |
1009 | ||
e32352cf SN |
1010 | int GetRow() const { return m_row; } |
1011 | void SetRow( int n ) { m_row = n; } | |
1012 | int GetCol() const { return m_col; } | |
1013 | void SetCol( int n ) { m_col = n; } | |
1014 | void Set( int row, int col ) { m_row = row; m_col = col; } | |
60ff3b99 | 1015 | |
f85afd4e MB |
1016 | wxGridCellCoords& operator=( const wxGridCellCoords& other ) |
1017 | { | |
1018 | if ( &other != this ) | |
1019 | { | |
1020 | m_row=other.m_row; | |
1021 | m_col=other.m_col; | |
1022 | } | |
1023 | return *this; | |
1024 | } | |
1025 | ||
508011ce | 1026 | bool operator==( const wxGridCellCoords& other ) const |
f85afd4e MB |
1027 | { |
1028 | return (m_row == other.m_row && m_col == other.m_col); | |
1029 | } | |
1030 | ||
508011ce | 1031 | bool operator!=( const wxGridCellCoords& other ) const |
f85afd4e MB |
1032 | { |
1033 | return (m_row != other.m_row || m_col != other.m_col); | |
1034 | } | |
1035 | ||
508011ce | 1036 | bool operator!() const |
f85afd4e MB |
1037 | { |
1038 | return (m_row == -1 && m_col == -1 ); | |
1039 | } | |
60ff3b99 VZ |
1040 | |
1041 | private: | |
e32352cf SN |
1042 | int m_row; |
1043 | int m_col; | |
f85afd4e MB |
1044 | }; |
1045 | ||
1046 | ||
1047 | // For comparisons... | |
1048 | // | |
12f190b0 VS |
1049 | extern WXDLLIMPEXP_ADV wxGridCellCoords wxGridNoCellCoords; |
1050 | extern WXDLLIMPEXP_ADV wxRect wxGridNoCellRect; | |
f85afd4e | 1051 | |
2d66e025 MB |
1052 | // An array of cell coords... |
1053 | // | |
1054 | WX_DECLARE_EXPORTED_OBJARRAY(wxGridCellCoords, wxGridCellCoordsArray); | |
1055 | ||
b99be8fb VZ |
1056 | // ---------------------------------------------------------------------------- |
1057 | // wxGrid | |
1058 | // ---------------------------------------------------------------------------- | |
f85afd4e | 1059 | |
12f190b0 | 1060 | class WXDLLIMPEXP_ADV wxGrid : public wxScrolledWindow |
60ff3b99 VZ |
1061 | { |
1062 | public: | |
f85afd4e | 1063 | wxGrid() |
b99be8fb | 1064 | { |
2c9a89e0 | 1065 | Create(); |
58dd5b3b | 1066 | } |
60ff3b99 | 1067 | |
f85afd4e MB |
1068 | wxGrid( wxWindow *parent, |
1069 | wxWindowID id, | |
1070 | const wxPoint& pos = wxDefaultPosition, | |
1071 | const wxSize& size = wxDefaultSize, | |
ebd773c6 | 1072 | long style = wxWANTS_CHARS, |
2d66e025 MB |
1073 | const wxString& name = wxPanelNameStr ); |
1074 | ||
e669d97a | 1075 | virtual ~wxGrid(); |
f85afd4e | 1076 | |
b5808881 SN |
1077 | enum wxGridSelectionModes {wxGridSelectCells, |
1078 | wxGridSelectRows, | |
1079 | wxGridSelectColumns}; | |
1080 | ||
1081 | bool CreateGrid( int numRows, int numCols, | |
1082 | wxGrid::wxGridSelectionModes selmode = | |
1083 | wxGrid::wxGridSelectCells ); | |
2d66e025 | 1084 | |
f1567cdd | 1085 | void SetSelectionMode(wxGrid::wxGridSelectionModes selmode); |
aa5b8857 | 1086 | wxGrid::wxGridSelectionModes GetSelectionMode() const; |
60ff3b99 | 1087 | |
2d66e025 MB |
1088 | // ------ grid dimensions |
1089 | // | |
1090 | int GetNumberRows() { return m_numRows; } | |
1091 | int GetNumberCols() { return m_numCols; } | |
1092 | ||
60ff3b99 | 1093 | |
2d66e025 MB |
1094 | // ------ display update functions |
1095 | // | |
d10f4bf9 | 1096 | wxArrayInt CalcRowLabelsExposed( const wxRegion& reg ); |
8fb66724 | 1097 | |
d10f4bf9 VZ |
1098 | wxArrayInt CalcColLabelsExposed( const wxRegion& reg ); |
1099 | wxGridCellCoordsArray CalcCellsExposed( const wxRegion& reg ); | |
60ff3b99 | 1100 | |
2d66e025 | 1101 | |
2d66e025 MB |
1102 | // ------ event handlers |
1103 | // | |
1104 | void ProcessRowLabelMouseEvent( wxMouseEvent& event ); | |
1105 | void ProcessColLabelMouseEvent( wxMouseEvent& event ); | |
1106 | void ProcessCornerLabelMouseEvent( wxMouseEvent& event ); | |
60ff3b99 | 1107 | void ProcessGridCellMouseEvent( wxMouseEvent& event ); |
2d66e025 | 1108 | bool ProcessTableMessage( wxGridTableMessage& ); |
f85afd4e | 1109 | |
6d004f67 MB |
1110 | void DoEndDragResizeRow(); |
1111 | void DoEndDragResizeCol(); | |
60ff3b99 | 1112 | |
f85afd4e | 1113 | wxGridTableBase * GetTable() const { return m_table; } |
043d16b2 | 1114 | bool SetTable( wxGridTableBase *table, bool takeOwnership=FALSE, |
5c8fc7c1 SN |
1115 | wxGrid::wxGridSelectionModes selmode = |
1116 | wxGrid::wxGridSelectCells ); | |
f85afd4e MB |
1117 | |
1118 | void ClearGrid(); | |
1119 | bool InsertRows( int pos = 0, int numRows = 1, bool updateLabels=TRUE ); | |
1120 | bool AppendRows( int numRows = 1, bool updateLabels=TRUE ); | |
1121 | bool DeleteRows( int pos = 0, int numRows = 1, bool updateLabels=TRUE ); | |
1122 | bool InsertCols( int pos = 0, int numCols = 1, bool updateLabels=TRUE ); | |
1123 | bool AppendCols( int numCols = 1, bool updateLabels=TRUE ); | |
60ff3b99 | 1124 | bool DeleteCols( int pos = 0, int numCols = 1, bool updateLabels=TRUE ); |
f85afd4e | 1125 | |
d10f4bf9 | 1126 | void DrawGridCellArea( wxDC& dc , const wxGridCellCoordsArray& cells ); |
7c8a8ad5 | 1127 | void DrawGridSpace( wxDC& dc ); |
2d66e025 | 1128 | void DrawCellBorder( wxDC& dc, const wxGridCellCoords& ); |
4634a5d6 | 1129 | void DrawAllGridLines( wxDC& dc, const wxRegion & reg ); |
2d66e025 | 1130 | void DrawCell( wxDC& dc, const wxGridCellCoords& ); |
d10f4bf9 | 1131 | void DrawHighlight(wxDC& dc, const wxGridCellCoordsArray& cells); |
d16c04bb VZ |
1132 | |
1133 | // this function is called when the current cell highlight must be redrawn | |
1134 | // and may be overridden by the user | |
1135 | virtual void DrawCellHighlight( wxDC& dc, const wxGridCellAttr *attr ); | |
1f1ce288 | 1136 | |
d10f4bf9 | 1137 | void DrawRowLabels( wxDC& dc, const wxArrayInt& rows ); |
2d66e025 | 1138 | void DrawRowLabel( wxDC& dc, int row ); |
8fb66724 | 1139 | |
d10f4bf9 | 1140 | void DrawColLabels( wxDC& dc, const wxArrayInt& cols ); |
2d66e025 | 1141 | void DrawColLabel( wxDC& dc, int col ); |
60ff3b99 | 1142 | |
f85afd4e | 1143 | |
2d66e025 | 1144 | // ------ Cell text drawing functions |
f85afd4e | 1145 | // |
2d66e025 | 1146 | void DrawTextRectangle( wxDC& dc, const wxString&, const wxRect&, |
4c7277db | 1147 | int horizontalAlignment = wxALIGN_LEFT, |
d43851f7 JS |
1148 | int verticalAlignment = wxALIGN_TOP, |
1149 | int textOrientation = wxHORIZONTAL ); | |
30bc4a8f | 1150 | |
d10f4bf9 VZ |
1151 | void DrawTextRectangle( wxDC& dc, const wxArrayString& lines, const wxRect&, |
1152 | int horizontalAlignment = wxALIGN_LEFT, | |
d43851f7 JS |
1153 | int verticalAlignment = wxALIGN_TOP, |
1154 | int textOrientation = wxHORIZONTAL ); | |
d10f4bf9 | 1155 | |
f85afd4e | 1156 | |
2d66e025 MB |
1157 | // Split a string containing newline chararcters into an array of |
1158 | // strings and return the number of lines | |
1159 | // | |
1160 | void StringToLines( const wxString& value, wxArrayString& lines ); | |
60ff3b99 | 1161 | |
2d66e025 | 1162 | void GetTextBoxSize( wxDC& dc, |
d10f4bf9 | 1163 | const wxArrayString& lines, |
2d66e025 | 1164 | long *width, long *height ); |
60ff3b99 | 1165 | |
2d66e025 | 1166 | |
f85afd4e MB |
1167 | // ------ |
1168 | // Code that does a lot of grid modification can be enclosed | |
1169 | // between BeginBatch() and EndBatch() calls to avoid screen | |
1170 | // flicker | |
1171 | // | |
1172 | void BeginBatch() { m_batchCount++; } | |
f6bcfd97 BP |
1173 | void EndBatch(); |
1174 | ||
f85afd4e MB |
1175 | int GetBatchCount() { return m_batchCount; } |
1176 | ||
b7282ad2 DW |
1177 | virtual void Refresh(bool eraseb = TRUE, |
1178 | const wxRect* rect = (const wxRect *) NULL); | |
27f35b66 | 1179 | |
d8232393 MB |
1180 | // Use this, rather than wxWindow::Refresh(), to force an |
1181 | // immediate repainting of the grid. Has no effect if you are | |
1182 | // already inside a BeginBatch / EndBatch block. | |
1183 | // | |
1184 | // This function is necessary because wxGrid has a minimal OnPaint() | |
1185 | // handler to reduce screen flicker. | |
1186 | // | |
1187 | void ForceRefresh(); | |
d2520c85 | 1188 | |
2d66e025 MB |
1189 | |
1190 | // ------ edit control functions | |
1191 | // | |
84035150 | 1192 | bool IsEditable() const { return m_editable; } |
2d66e025 MB |
1193 | void EnableEditing( bool edit ); |
1194 | ||
b54ba671 VZ |
1195 | void EnableCellEditControl( bool enable = TRUE ); |
1196 | void DisableCellEditControl() { EnableCellEditControl(FALSE); } | |
1197 | bool CanEnableCellControl() const; | |
1198 | bool IsCellEditControlEnabled() const; | |
f6bcfd97 | 1199 | bool IsCellEditControlShown() const; |
2d66e025 | 1200 | |
b54ba671 | 1201 | bool IsCurrentCellReadOnly() const; |
2d66e025 | 1202 | |
2d66e025 MB |
1203 | void ShowCellEditControl(); |
1204 | void HideCellEditControl(); | |
2d66e025 MB |
1205 | void SaveEditControlValue(); |
1206 | ||
60ff3b99 | 1207 | |
2d66e025 | 1208 | // ------ grid location functions |
60ff3b99 | 1209 | // Note that all of these functions work with the logical coordinates of |
2d66e025 MB |
1210 | // grid cells and labels so you will need to convert from device |
1211 | // coordinates for mouse events etc. | |
1212 | // | |
1213 | void XYToCell( int x, int y, wxGridCellCoords& ); | |
1214 | int YToRow( int y ); | |
1215 | int XToCol( int x ); | |
1216 | ||
1217 | int YToEdgeOfRow( int y ); | |
1218 | int XToEdgeOfCol( int x ); | |
1219 | ||
1220 | wxRect CellToRect( int row, int col ); | |
1221 | wxRect CellToRect( const wxGridCellCoords& coords ) | |
1222 | { return CellToRect( coords.GetRow(), coords.GetCol() ); } | |
1223 | ||
1224 | int GetGridCursorRow() { return m_currentCellCoords.GetRow(); } | |
1225 | int GetGridCursorCol() { return m_currentCellCoords.GetCol(); } | |
60ff3b99 | 1226 | |
2d66e025 MB |
1227 | // check to see if a cell is either wholly visible (the default arg) or |
1228 | // at least partially visible in the grid window | |
1229 | // | |
1230 | bool IsVisible( int row, int col, bool wholeCellVisible = TRUE ); | |
1231 | bool IsVisible( const wxGridCellCoords& coords, bool wholeCellVisible = TRUE ) | |
1232 | { return IsVisible( coords.GetRow(), coords.GetCol(), wholeCellVisible ); } | |
1233 | void MakeCellVisible( int row, int col ); | |
1234 | void MakeCellVisible( const wxGridCellCoords& coords ) | |
1235 | { MakeCellVisible( coords.GetRow(), coords.GetCol() ); } | |
1236 | ||
60ff3b99 | 1237 | |
2d66e025 MB |
1238 | // ------ grid cursor movement functions |
1239 | // | |
dfaf42d2 | 1240 | void SetGridCursor( int row, int col ) |
b27f2615 | 1241 | { SetCurrentCell( wxGridCellCoords(row, col) ); } |
dfaf42d2 | 1242 | |
5c8fc7c1 SN |
1243 | bool MoveCursorUp( bool expandSelection ); |
1244 | bool MoveCursorDown( bool expandSelection ); | |
1245 | bool MoveCursorLeft( bool expandSelection ); | |
1246 | bool MoveCursorRight( bool expandSelection ); | |
2d66e025 MB |
1247 | bool MovePageDown(); |
1248 | bool MovePageUp(); | |
5c8fc7c1 SN |
1249 | bool MoveCursorUpBlock( bool expandSelection ); |
1250 | bool MoveCursorDownBlock( bool expandSelection ); | |
1251 | bool MoveCursorLeftBlock( bool expandSelection ); | |
1252 | bool MoveCursorRightBlock( bool expandSelection ); | |
2d66e025 | 1253 | |
60ff3b99 | 1254 | |
f85afd4e MB |
1255 | // ------ label and gridline formatting |
1256 | // | |
1257 | int GetDefaultRowLabelSize() { return WXGRID_DEFAULT_ROW_LABEL_WIDTH; } | |
1258 | int GetRowLabelSize() { return m_rowLabelWidth; } | |
60ff3b99 | 1259 | int GetDefaultColLabelSize() { return WXGRID_DEFAULT_COL_LABEL_HEIGHT; } |
f85afd4e MB |
1260 | int GetColLabelSize() { return m_colLabelHeight; } |
1261 | wxColour GetLabelBackgroundColour() { return m_labelBackgroundColour; } | |
1262 | wxColour GetLabelTextColour() { return m_labelTextColour; } | |
1263 | wxFont GetLabelFont() { return m_labelFont; } | |
1264 | void GetRowLabelAlignment( int *horiz, int *vert ); | |
1265 | void GetColLabelAlignment( int *horiz, int *vert ); | |
d43851f7 | 1266 | int GetColLabelTextOrientation(); |
f85afd4e MB |
1267 | wxString GetRowLabelValue( int row ); |
1268 | wxString GetColLabelValue( int col ); | |
1269 | wxColour GetGridLineColour() { return m_gridLineColour; } | |
f6bcfd97 | 1270 | wxColour GetCellHighlightColour() { return m_cellHighlightColour; } |
d2520c85 RD |
1271 | int GetCellHighlightPenWidth() { return m_cellHighlightPenWidth; } |
1272 | int GetCellHighlightROPenWidth() { return m_cellHighlightROPenWidth; } | |
f85afd4e | 1273 | |
ab79958a | 1274 | void SetRowLabelSize( int width ); |
f85afd4e MB |
1275 | void SetColLabelSize( int height ); |
1276 | void SetLabelBackgroundColour( const wxColour& ); | |
1277 | void SetLabelTextColour( const wxColour& ); | |
1278 | void SetLabelFont( const wxFont& ); | |
1279 | void SetRowLabelAlignment( int horiz, int vert ); | |
1280 | void SetColLabelAlignment( int horiz, int vert ); | |
d43851f7 | 1281 | void SetColLabelTextOrientation( int textOrientation ); |
f85afd4e MB |
1282 | void SetRowLabelValue( int row, const wxString& ); |
1283 | void SetColLabelValue( int col, const wxString& ); | |
1284 | void SetGridLineColour( const wxColour& ); | |
f6bcfd97 | 1285 | void SetCellHighlightColour( const wxColour& ); |
d2520c85 RD |
1286 | void SetCellHighlightPenWidth(int width); |
1287 | void SetCellHighlightROPenWidth(int width); | |
28a77bc4 | 1288 | |
6e8524b1 MB |
1289 | void EnableDragRowSize( bool enable = TRUE ); |
1290 | void DisableDragRowSize() { EnableDragRowSize( FALSE ); } | |
1291 | bool CanDragRowSize() { return m_canDragRowSize; } | |
1292 | void EnableDragColSize( bool enable = TRUE ); | |
1293 | void DisableDragColSize() { EnableDragColSize( FALSE ); } | |
1294 | bool CanDragColSize() { return m_canDragColSize; } | |
4cfa5de6 RD |
1295 | void EnableDragGridSize(bool enable = TRUE); |
1296 | void DisableDragGridSize() { EnableDragGridSize(FALSE); } | |
1297 | bool CanDragGridSize() { return m_canDragGridSize; } | |
1298 | ||
27f35b66 SN |
1299 | // this sets the specified attribute for this cell or in this row/col |
1300 | void SetAttr(int row, int col, wxGridCellAttr *attr); | |
758cbedf VZ |
1301 | void SetRowAttr(int row, wxGridCellAttr *attr); |
1302 | void SetColAttr(int col, wxGridCellAttr *attr); | |
1303 | ||
0b190b0f VZ |
1304 | // shortcuts for setting the column parameters |
1305 | ||
1306 | // set the format for the data in the column: default is string | |
1307 | void SetColFormatBool(int col); | |
1308 | void SetColFormatNumber(int col); | |
1309 | void SetColFormatFloat(int col, int width = -1, int precision = -1); | |
1310 | void SetColFormatCustom(int col, const wxString& typeName); | |
1311 | ||
f85afd4e MB |
1312 | void EnableGridLines( bool enable = TRUE ); |
1313 | bool GridLinesEnabled() { return m_gridLinesEnabled; } | |
1314 | ||
f85afd4e MB |
1315 | // ------ row and col formatting |
1316 | // | |
1317 | int GetDefaultRowSize(); | |
1318 | int GetRowSize( int row ); | |
1319 | int GetDefaultColSize(); | |
1320 | int GetColSize( int col ); | |
1321 | wxColour GetDefaultCellBackgroundColour(); | |
1322 | wxColour GetCellBackgroundColour( int row, int col ); | |
1323 | wxColour GetDefaultCellTextColour(); | |
1324 | wxColour GetCellTextColour( int row, int col ); | |
f85afd4e MB |
1325 | wxFont GetDefaultCellFont(); |
1326 | wxFont GetCellFont( int row, int col ); | |
1327 | void GetDefaultCellAlignment( int *horiz, int *vert ); | |
1328 | void GetCellAlignment( int row, int col, int *horiz, int *vert ); | |
27f35b66 SN |
1329 | bool GetDefaultCellOverflow(); |
1330 | bool GetCellOverflow( int row, int col ); | |
1331 | void GetCellSize( int row, int col, int *num_rows, int *num_cols ); | |
60ff3b99 | 1332 | |
f85afd4e MB |
1333 | void SetDefaultRowSize( int height, bool resizeExistingRows = FALSE ); |
1334 | void SetRowSize( int row, int height ); | |
1335 | void SetDefaultColSize( int width, bool resizeExistingCols = FALSE ); | |
8fb66724 | 1336 | |
f85afd4e | 1337 | void SetColSize( int col, int width ); |
43947979 | 1338 | |
af547d51 VZ |
1339 | // automatically size the column or row to fit to its contents, if |
1340 | // setAsMin is TRUE, this optimal width will also be set as minimal width | |
1341 | // for this column | |
1342 | void AutoSizeColumn( int col, bool setAsMin = TRUE ) | |
1343 | { AutoSizeColOrRow(col, setAsMin, TRUE); } | |
1344 | void AutoSizeRow( int row, bool setAsMin = TRUE ) | |
1345 | { AutoSizeColOrRow(row, setAsMin, FALSE); } | |
65e4e78e VZ |
1346 | |
1347 | // auto size all columns (very ineffective for big grids!) | |
266e8367 | 1348 | void AutoSizeColumns( bool setAsMin = TRUE ) |
ad115b2d | 1349 | { (void)SetOrCalcColumnSizes(FALSE, setAsMin); } |
65e4e78e | 1350 | |
266e8367 | 1351 | void AutoSizeRows( bool setAsMin = TRUE ) |
ad115b2d | 1352 | { (void)SetOrCalcRowSizes(FALSE, setAsMin); } |
57c086ef VZ |
1353 | |
1354 | // auto size the grid, that is make the columns/rows of the "right" size | |
1355 | // and also set the grid size to just fit its contents | |
1356 | void AutoSize(); | |
1357 | ||
d43851f7 JS |
1358 | // autosize row height depending on label text |
1359 | void AutoSizeRowLabelSize( int row ); | |
1360 | ||
1361 | // autosize column width depending on label text | |
1362 | void AutoSizeColLabelSize( int col ); | |
1363 | ||
43947979 VZ |
1364 | // column won't be resized to be lesser width - this must be called during |
1365 | // the grid creation because it won't resize the column if it's already | |
1366 | // narrower than the minimal width | |
1367 | void SetColMinimalWidth( int col, int width ); | |
af547d51 | 1368 | void SetRowMinimalHeight( int row, int width ); |
43947979 | 1369 | |
b8d24d4e RG |
1370 | /* These members can be used to query and modify the minimal |
1371 | * acceptable size of grid rows and columns. Call this function in | |
1372 | * your code which creates the grid if you want to display cells | |
1373 | * with a size smaller than the default acceptable minimum size. | |
1374 | * Like the members SetColMinimalWidth and SetRowMinimalWidth, | |
1375 | * the existing rows or columns will not be checked/resized. | |
1376 | */ | |
1377 | void SetColMinimalAcceptableWidth( int width ); | |
1378 | void SetRowMinimalAcceptableHeight( int width ); | |
1379 | int GetColMinimalAcceptableWidth() const; | |
1380 | int GetRowMinimalAcceptableHeight() const; | |
1381 | ||
f85afd4e MB |
1382 | void SetDefaultCellBackgroundColour( const wxColour& ); |
1383 | void SetCellBackgroundColour( int row, int col, const wxColour& ); | |
1384 | void SetDefaultCellTextColour( const wxColour& ); | |
8fb66724 | 1385 | |
f85afd4e | 1386 | void SetCellTextColour( int row, int col, const wxColour& ); |
f85afd4e MB |
1387 | void SetDefaultCellFont( const wxFont& ); |
1388 | void SetCellFont( int row, int col, const wxFont& ); | |
1389 | void SetDefaultCellAlignment( int horiz, int vert ); | |
1390 | void SetCellAlignment( int row, int col, int horiz, int vert ); | |
27f35b66 SN |
1391 | void SetDefaultCellOverflow( bool allow ); |
1392 | void SetCellOverflow( int row, int col, bool allow ); | |
1393 | void SetCellSize( int row, int col, int num_rows, int num_cols ); | |
f85afd4e | 1394 | |
ab79958a | 1395 | // takes ownership of the pointer |
2796cce3 | 1396 | void SetDefaultRenderer(wxGridCellRenderer *renderer); |
ab79958a | 1397 | void SetCellRenderer(int row, int col, wxGridCellRenderer *renderer); |
2796cce3 RD |
1398 | wxGridCellRenderer *GetDefaultRenderer() const; |
1399 | wxGridCellRenderer* GetCellRenderer(int row, int col); | |
1400 | ||
283b7808 | 1401 | // takes ownership of the pointer |
0ba143c9 | 1402 | void SetDefaultEditor(wxGridCellEditor *editor); |
9b4aede2 | 1403 | void SetCellEditor(int row, int col, wxGridCellEditor *editor); |
0ba143c9 | 1404 | wxGridCellEditor *GetDefaultEditor() const; |
9b4aede2 RD |
1405 | wxGridCellEditor* GetCellEditor(int row, int col); |
1406 | ||
60a67569 | 1407 | |
f2d76237 | 1408 | |
f85afd4e MB |
1409 | // ------ cell value accessors |
1410 | // | |
1411 | wxString GetCellValue( int row, int col ) | |
1412 | { | |
1413 | if ( m_table ) | |
1414 | { | |
1415 | return m_table->GetValue( row, col ); | |
1416 | } | |
1417 | else | |
1418 | { | |
1419 | return wxEmptyString; | |
1420 | } | |
1421 | } | |
1422 | ||
1423 | wxString GetCellValue( const wxGridCellCoords& coords ) | |
1424 | { return GetCellValue( coords.GetRow(), coords.GetCol() ); } | |
60ff3b99 | 1425 | |
f85afd4e MB |
1426 | void SetCellValue( int row, int col, const wxString& s ); |
1427 | void SetCellValue( const wxGridCellCoords& coords, const wxString& s ) | |
1428 | { SetCellValue( coords.GetRow(), coords.GetCol(), s ); } | |
f85afd4e | 1429 | |
283b7808 VZ |
1430 | // returns TRUE if the cell can't be edited |
1431 | bool IsReadOnly(int row, int col) const; | |
60ff3b99 | 1432 | |
283b7808 VZ |
1433 | // make the cell editable/readonly |
1434 | void SetReadOnly(int row, int col, bool isReadOnly = TRUE); | |
f85afd4e | 1435 | |
aa5b8857 | 1436 | // ------ select blocks of cells |
f85afd4e MB |
1437 | // |
1438 | void SelectRow( int row, bool addToSelected = FALSE ); | |
1439 | void SelectCol( int col, bool addToSelected = FALSE ); | |
60ff3b99 | 1440 | |
c9097836 MB |
1441 | void SelectBlock( int topRow, int leftCol, int bottomRow, int rightCol, |
1442 | bool addToSelected = FALSE ); | |
f85afd4e MB |
1443 | |
1444 | void SelectBlock( const wxGridCellCoords& topLeft, | |
c9097836 MB |
1445 | const wxGridCellCoords& bottomRight, |
1446 | bool addToSelected = FALSE ) | |
f85afd4e | 1447 | { SelectBlock( topLeft.GetRow(), topLeft.GetCol(), |
c9097836 MB |
1448 | bottomRight.GetRow(), bottomRight.GetCol(), |
1449 | addToSelected ); } | |
f85afd4e MB |
1450 | |
1451 | void SelectAll(); | |
60ff3b99 | 1452 | |
b5808881 | 1453 | bool IsSelection(); |
f85afd4e | 1454 | |
aa5b8857 | 1455 | // ------ deselect blocks or cells |
f7b4b343 VZ |
1456 | // |
1457 | void DeselectRow( int row ); | |
1458 | void DeselectCol( int col ); | |
1459 | void DeselectCell( int row, int col ); | |
1460 | ||
f85afd4e MB |
1461 | void ClearSelection(); |
1462 | ||
84035150 | 1463 | bool IsInSelection( int row, int col ) const; |
f85afd4e | 1464 | |
84035150 | 1465 | bool IsInSelection( const wxGridCellCoords& coords ) const |
f85afd4e MB |
1466 | { return IsInSelection( coords.GetRow(), coords.GetCol() ); } |
1467 | ||
aa5b8857 SN |
1468 | wxGridCellCoordsArray GetSelectedCells() const; |
1469 | wxGridCellCoordsArray GetSelectionBlockTopLeft() const; | |
1470 | wxGridCellCoordsArray GetSelectionBlockBottomRight() const; | |
1471 | wxArrayInt GetSelectedRows() const; | |
1472 | wxArrayInt GetSelectedCols() const; | |
c3baf426 SN |
1473 | |
1474 | // This function returns the rectangle that encloses the block of cells | |
1475 | // limited by TopLeft and BottomRight cell in device coords and clipped | |
1476 | // to the client size of the grid window. | |
1477 | // | |
58dd5b3b | 1478 | wxRect BlockToDeviceRect( const wxGridCellCoords & topLeft, |
b99be8fb | 1479 | const wxGridCellCoords & bottomRight ); |
c3baf426 | 1480 | |
2796cce3 RD |
1481 | // Access or update the selection fore/back colours |
1482 | wxColour GetSelectionBackground() const | |
1483 | { return m_selectionBackground; } | |
1484 | wxColour GetSelectionForeground() const | |
1485 | { return m_selectionForeground; } | |
1486 | ||
1487 | void SetSelectionBackground(const wxColour& c) { m_selectionBackground = c; } | |
1488 | void SetSelectionForeground(const wxColour& c) { m_selectionForeground = c; } | |
1489 | ||
1490 | ||
f2d76237 RD |
1491 | // Methods for a registry for mapping data types to Renderers/Editors |
1492 | void RegisterDataType(const wxString& typeName, | |
1493 | wxGridCellRenderer* renderer, | |
1494 | wxGridCellEditor* editor); | |
73145b0e JS |
1495 | // DJC MAPTEK |
1496 | virtual wxGridCellEditor* GetDefaultEditorForCell(int row, int col) const; | |
99306db2 VZ |
1497 | wxGridCellEditor* GetDefaultEditorForCell(const wxGridCellCoords& c) const |
1498 | { return GetDefaultEditorForCell(c.GetRow(), c.GetCol()); } | |
73145b0e JS |
1499 | virtual wxGridCellRenderer* GetDefaultRendererForCell(int row, int col) const; |
1500 | virtual wxGridCellEditor* GetDefaultEditorForType(const wxString& typeName) const; | |
1501 | virtual wxGridCellRenderer* GetDefaultRendererForType(const wxString& typeName) const; | |
f2d76237 | 1502 | |
266e8367 VZ |
1503 | // grid may occupy more space than needed for its rows/columns, this |
1504 | // function allows to set how big this extra space is | |
1505 | void SetMargins(int extraWidth, int extraHeight) | |
1506 | { | |
1507 | m_extraWidth = extraWidth; | |
1508 | m_extraHeight = extraHeight; | |
b8125adf VZ |
1509 | |
1510 | CalcDimensions(); | |
266e8367 | 1511 | } |
f85afd4e | 1512 | |
d2520c85 RD |
1513 | // Accessors for component windows |
1514 | wxWindow* GetGridWindow() { return (wxWindow*)m_gridWin; } | |
1515 | wxWindow* GetGridRowLabelWindow() { return (wxWindow*)m_rowLabelWin; } | |
1516 | wxWindow* GetGridColLabelWindow() { return (wxWindow*)m_colLabelWin; } | |
1517 | wxWindow* GetGridCornerLabelWindow() { return (wxWindow*)m_cornerLabelWin; } | |
1518 | ||
1519 | ||
1520 | ||
f85afd4e MB |
1521 | // ------ For compatibility with previous wxGrid only... |
1522 | // | |
1523 | // ************************************************ | |
1524 | // ** Don't use these in new code because they ** | |
1525 | // ** are liable to disappear in a future ** | |
1526 | // ** revision ** | |
1527 | // ************************************************ | |
1528 | // | |
1529 | ||
1530 | wxGrid( wxWindow *parent, | |
6daa30a0 | 1531 | int x, int y, int w = -1, int h = -1, |
ebd773c6 | 1532 | long style = wxWANTS_CHARS, |
f85afd4e | 1533 | const wxString& name = wxPanelNameStr ) |
f6bcfd97 | 1534 | : wxScrolledWindow( parent, -1, wxPoint(x,y), wxSize(w,h), |
ebd773c6 | 1535 | (style|wxWANTS_CHARS), name ) |
60ff3b99 | 1536 | { |
f85afd4e | 1537 | Create(); |
60ff3b99 | 1538 | } |
f85afd4e MB |
1539 | |
1540 | void SetCellValue( const wxString& val, int row, int col ) | |
1541 | { SetCellValue( row, col, val ); } | |
60ff3b99 | 1542 | |
f85afd4e MB |
1543 | void UpdateDimensions() |
1544 | { CalcDimensions(); } | |
1545 | ||
1546 | int GetRows() { return GetNumberRows(); } | |
1547 | int GetCols() { return GetNumberCols(); } | |
1548 | int GetCursorRow() { return GetGridCursorRow(); } | |
1549 | int GetCursorColumn() { return GetGridCursorCol(); } | |
60ff3b99 | 1550 | |
2d66e025 MB |
1551 | int GetScrollPosX() { return 0; } |
1552 | int GetScrollPosY() { return 0; } | |
60ff3b99 | 1553 | |
aa5e1f75 SN |
1554 | void SetScrollX( int WXUNUSED(x) ) { } |
1555 | void SetScrollY( int WXUNUSED(y) ) { } | |
f85afd4e MB |
1556 | |
1557 | void SetColumnWidth( int col, int width ) | |
1558 | { SetColSize( col, width ); } | |
60ff3b99 | 1559 | |
f85afd4e MB |
1560 | int GetColumnWidth( int col ) |
1561 | { return GetColSize( col ); } | |
60ff3b99 | 1562 | |
f85afd4e MB |
1563 | void SetRowHeight( int row, int height ) |
1564 | { SetRowSize( row, height ); } | |
60ff3b99 | 1565 | |
7c1cb261 | 1566 | // GetRowHeight() is below |
60ff3b99 | 1567 | |
2d66e025 MB |
1568 | int GetViewHeight() // returned num whole rows visible |
1569 | { return 0; } | |
60ff3b99 | 1570 | |
2d66e025 MB |
1571 | int GetViewWidth() // returned num whole cols visible |
1572 | { return 0; } | |
f85afd4e MB |
1573 | |
1574 | void SetLabelSize( int orientation, int sz ) | |
1575 | { | |
1576 | if ( orientation == wxHORIZONTAL ) | |
1577 | SetColLabelSize( sz ); | |
1578 | else | |
1579 | SetRowLabelSize( sz ); | |
1580 | } | |
1581 | ||
1582 | int GetLabelSize( int orientation ) | |
1583 | { | |
1584 | if ( orientation == wxHORIZONTAL ) | |
1585 | return GetColLabelSize(); | |
1586 | else | |
1587 | return GetRowLabelSize(); | |
1588 | } | |
1589 | ||
1590 | void SetLabelAlignment( int orientation, int align ) | |
1591 | { | |
1592 | if ( orientation == wxHORIZONTAL ) | |
1593 | SetColLabelAlignment( align, -1 ); | |
1594 | else | |
1595 | SetRowLabelAlignment( align, -1 ); | |
1596 | } | |
1597 | ||
af111fc3 | 1598 | int GetLabelAlignment( int orientation, int WXUNUSED(align) ) |
f85afd4e MB |
1599 | { |
1600 | int h, v; | |
1601 | if ( orientation == wxHORIZONTAL ) | |
1602 | { | |
1603 | GetColLabelAlignment( &h, &v ); | |
1604 | return h; | |
1605 | } | |
1606 | else | |
1607 | { | |
1608 | GetRowLabelAlignment( &h, &v ); | |
1609 | return h; | |
1610 | } | |
1611 | } | |
1612 | ||
1613 | void SetLabelValue( int orientation, const wxString& val, int pos ) | |
1614 | { | |
1615 | if ( orientation == wxHORIZONTAL ) | |
1616 | SetColLabelValue( pos, val ); | |
1617 | else | |
1618 | SetRowLabelValue( pos, val ); | |
1619 | } | |
60ff3b99 | 1620 | |
f85afd4e MB |
1621 | wxString GetLabelValue( int orientation, int pos) |
1622 | { | |
1623 | if ( orientation == wxHORIZONTAL ) | |
1624 | return GetColLabelValue( pos ); | |
1625 | else | |
1626 | return GetRowLabelValue( pos ); | |
1627 | } | |
1628 | ||
60ff3b99 | 1629 | wxFont GetCellTextFont() const |
2796cce3 | 1630 | { return m_defaultCellAttr->GetFont(); } |
60ff3b99 | 1631 | |
af111fc3 | 1632 | wxFont GetCellTextFont(int WXUNUSED(row), int WXUNUSED(col)) const |
2796cce3 | 1633 | { return m_defaultCellAttr->GetFont(); } |
60ff3b99 | 1634 | |
f85afd4e MB |
1635 | void SetCellTextFont(const wxFont& fnt) |
1636 | { SetDefaultCellFont( fnt ); } | |
60ff3b99 | 1637 | |
f85afd4e MB |
1638 | void SetCellTextFont(const wxFont& fnt, int row, int col) |
1639 | { SetCellFont( row, col, fnt ); } | |
60ff3b99 | 1640 | |
f85afd4e MB |
1641 | void SetCellTextColour(const wxColour& val, int row, int col) |
1642 | { SetCellTextColour( row, col, val ); } | |
60ff3b99 | 1643 | |
f85afd4e MB |
1644 | void SetCellTextColour(const wxColour& col) |
1645 | { SetDefaultCellTextColour( col ); } | |
60ff3b99 | 1646 | |
f85afd4e MB |
1647 | void SetCellBackgroundColour(const wxColour& col) |
1648 | { SetDefaultCellBackgroundColour( col ); } | |
60ff3b99 | 1649 | |
f85afd4e MB |
1650 | void SetCellBackgroundColour(const wxColour& colour, int row, int col) |
1651 | { SetCellBackgroundColour( row, col, colour ); } | |
60ff3b99 | 1652 | |
f85afd4e MB |
1653 | bool GetEditable() { return IsEditable(); } |
1654 | void SetEditable( bool edit = TRUE ) { EnableEditing( edit ); } | |
1655 | bool GetEditInPlace() { return IsCellEditControlEnabled(); } | |
8fb66724 | 1656 | |
aa5e1f75 | 1657 | void SetEditInPlace(bool WXUNUSED(edit) = TRUE) { } |
f85afd4e | 1658 | |
60a67569 | 1659 | void SetCellAlignment( int align, int row, int col) |
4c7277db | 1660 | { SetCellAlignment(row, col, align, wxALIGN_CENTER); } |
60a67569 JS |
1661 | void SetCellAlignment( int WXUNUSED(align) ) {} |
1662 | void SetCellBitmap(wxBitmap *WXUNUSED(bitmap), int WXUNUSED(row), int WXUNUSED(col)) | |
1663 | { } | |
1664 | void SetDividerPen(const wxPen& WXUNUSED(pen)) { } | |
6fc0f38f | 1665 | wxPen& GetDividerPen() const; |
60a67569 | 1666 | void OnActivate(bool WXUNUSED(active)) {} |
60ff3b99 | 1667 | |
f85afd4e MB |
1668 | // ******** End of compatibility functions ********** |
1669 | ||
2d66e025 MB |
1670 | |
1671 | ||
f85afd4e | 1672 | // ------ control IDs |
2d66e025 | 1673 | enum { wxGRID_CELLCTRL = 2000, |
f85afd4e MB |
1674 | wxGRID_TOPCTRL }; |
1675 | ||
1676 | // ------ control types | |
2d66e025 | 1677 | enum { wxGRID_TEXTCTRL = 2100, |
f85afd4e MB |
1678 | wxGRID_CHECKBOX, |
1679 | wxGRID_CHOICE, | |
1680 | wxGRID_COMBOBOX }; | |
1681 | ||
266e8367 VZ |
1682 | // overridden wxWindow methods |
1683 | virtual void Fit(); | |
1684 | ||
60ff3b99 | 1685 | protected: |
266e8367 VZ |
1686 | virtual wxSize DoGetBestSize() const; |
1687 | ||
60ff3b99 VZ |
1688 | bool m_created; |
1689 | ||
1690 | wxGridWindow *m_gridWin; | |
1691 | wxGridRowLabelWindow *m_rowLabelWin; | |
1692 | wxGridColLabelWindow *m_colLabelWin; | |
1693 | wxGridCornerLabelWindow *m_cornerLabelWin; | |
1694 | ||
60ff3b99 | 1695 | wxGridTableBase *m_table; |
2796cce3 | 1696 | bool m_ownTable; |
60ff3b99 | 1697 | |
60ff3b99 VZ |
1698 | int m_numRows; |
1699 | int m_numCols; | |
1700 | ||
1701 | wxGridCellCoords m_currentCellCoords; | |
1702 | ||
b5808881 SN |
1703 | wxGridCellCoords m_selectingTopLeft; |
1704 | wxGridCellCoords m_selectingBottomRight; | |
d95b0c2b | 1705 | wxGridCellCoords m_selectingKeyboard; |
b5808881 | 1706 | wxGridSelection *m_selection; |
2796cce3 RD |
1707 | wxColour m_selectionBackground; |
1708 | wxColour m_selectionForeground; | |
60ff3b99 | 1709 | |
7c1cb261 VZ |
1710 | // NB: *never* access m_row/col arrays directly because they are created |
1711 | // on demand, *always* use accessor functions instead! | |
1712 | ||
1713 | // init the m_rowHeights/Bottoms arrays with default values | |
1714 | void InitRowHeights(); | |
1715 | ||
60ff3b99 | 1716 | int m_defaultRowHeight; |
b8d24d4e | 1717 | int m_minAcceptableRowHeight; |
60ff3b99 VZ |
1718 | wxArrayInt m_rowHeights; |
1719 | wxArrayInt m_rowBottoms; | |
1720 | ||
7c1cb261 VZ |
1721 | // init the m_colWidths/Rights arrays |
1722 | void InitColWidths(); | |
1723 | ||
60ff3b99 | 1724 | int m_defaultColWidth; |
b8d24d4e | 1725 | int m_minAcceptableColWidth; |
60ff3b99 VZ |
1726 | wxArrayInt m_colWidths; |
1727 | wxArrayInt m_colRights; | |
7c1cb261 VZ |
1728 | |
1729 | // get the col/row coords | |
1730 | int GetColWidth(int col) const; | |
1731 | int GetColLeft(int col) const; | |
1732 | int GetColRight(int col) const; | |
1733 | ||
1734 | // this function must be public for compatibility... | |
1735 | public: | |
1736 | int GetRowHeight(int row) const; | |
1737 | protected: | |
1738 | ||
1739 | int GetRowTop(int row) const; | |
1740 | int GetRowBottom(int row) const; | |
1741 | ||
60ff3b99 VZ |
1742 | int m_rowLabelWidth; |
1743 | int m_colLabelHeight; | |
1744 | ||
266e8367 VZ |
1745 | // the size of the margin left to the right and bottom of the cell area |
1746 | int m_extraWidth, | |
1747 | m_extraHeight; | |
1748 | ||
60ff3b99 VZ |
1749 | wxColour m_labelBackgroundColour; |
1750 | wxColour m_labelTextColour; | |
1751 | wxFont m_labelFont; | |
1752 | ||
1753 | int m_rowLabelHorizAlign; | |
1754 | int m_rowLabelVertAlign; | |
1755 | int m_colLabelHorizAlign; | |
1756 | int m_colLabelVertAlign; | |
d43851f7 | 1757 | int m_colLabelTextOrientation; |
60ff3b99 VZ |
1758 | |
1759 | bool m_defaultRowLabelValues; | |
1760 | bool m_defaultColLabelValues; | |
1761 | ||
1762 | wxColour m_gridLineColour; | |
1763 | bool m_gridLinesEnabled; | |
f6bcfd97 | 1764 | wxColour m_cellHighlightColour; |
d2520c85 RD |
1765 | int m_cellHighlightPenWidth; |
1766 | int m_cellHighlightROPenWidth; | |
1767 | ||
60ff3b99 | 1768 | |
266e8367 VZ |
1769 | // common part of AutoSizeColumn/Row() and GetBestSize() |
1770 | int SetOrCalcColumnSizes(bool calcOnly, bool setAsMin = TRUE); | |
1771 | int SetOrCalcRowSizes(bool calcOnly, bool setAsMin = TRUE); | |
1772 | ||
af547d51 VZ |
1773 | // common part of AutoSizeColumn/Row() |
1774 | void AutoSizeColOrRow(int n, bool setAsMin, bool column /* or row? */); | |
1775 | ||
43947979 VZ |
1776 | // if a column has a minimal width, it will be the value for it in this |
1777 | // hash table | |
ba8c1601 MB |
1778 | wxLongToLongHashMap m_colMinWidths, |
1779 | m_rowMinHeights; | |
43947979 | 1780 | |
af547d51 VZ |
1781 | // get the minimal width of the given column/row |
1782 | int GetColMinimalWidth(int col) const; | |
1783 | int GetRowMinimalHeight(int col) const; | |
b99be8fb VZ |
1784 | |
1785 | // do we have some place to store attributes in? | |
1786 | bool CanHaveAttributes(); | |
60ff3b99 | 1787 | |
2e9a6788 VZ |
1788 | // returns the attribute we may modify in place: a new one if this cell |
1789 | // doesn't have any yet or the existing one if it does | |
1790 | // | |
1791 | // DecRef() must be called on the returned pointer, as usual | |
0a976765 VZ |
1792 | wxGridCellAttr *GetOrCreateCellAttr(int row, int col) const; |
1793 | ||
1794 | // cell attribute cache (currently we only cache 1, may be will do | |
1795 | // more/better later) | |
1796 | struct CachedAttr | |
1797 | { | |
1798 | int row, col; | |
1799 | wxGridCellAttr *attr; | |
1800 | } m_attrCache; | |
1801 | ||
1802 | // invalidates the attribute cache | |
1803 | void ClearAttrCache(); | |
1804 | ||
1805 | // adds an attribute to cache | |
1806 | void CacheAttr(int row, int col, wxGridCellAttr *attr) const; | |
1807 | ||
1808 | // looks for an attr in cache, returns TRUE if found | |
1809 | bool LookupAttr(int row, int col, wxGridCellAttr **attr) const; | |
1810 | ||
1811 | // looks for the attr in cache, if not found asks the table and caches the | |
1812 | // result | |
2e9a6788 | 1813 | wxGridCellAttr *GetCellAttr(int row, int col) const; |
2c9a89e0 RD |
1814 | wxGridCellAttr *GetCellAttr(const wxGridCellCoords& coords ) |
1815 | { return GetCellAttr( coords.GetRow(), coords.GetCol() ); } | |
2e9a6788 | 1816 | |
2796cce3 RD |
1817 | // the default cell attr object for cells that don't have their own |
1818 | wxGridCellAttr* m_defaultCellAttr; | |
1819 | ||
1820 | ||
60ff3b99 VZ |
1821 | bool m_inOnKeyDown; |
1822 | int m_batchCount; | |
1823 | ||
f2d76237 RD |
1824 | |
1825 | wxGridTypeRegistry* m_typeRegistry; | |
1826 | ||
e2b42eeb VZ |
1827 | enum CursorMode |
1828 | { | |
1829 | WXGRID_CURSOR_SELECT_CELL, | |
1830 | WXGRID_CURSOR_RESIZE_ROW, | |
1831 | WXGRID_CURSOR_RESIZE_COL, | |
1832 | WXGRID_CURSOR_SELECT_ROW, | |
1833 | WXGRID_CURSOR_SELECT_COL | |
60ff3b99 VZ |
1834 | }; |
1835 | ||
e2b42eeb VZ |
1836 | // this method not only sets m_cursorMode but also sets the correct cursor |
1837 | // for the given mode and, if captureMouse is not FALSE releases the mouse | |
1838 | // if it was captured and captures it if it must be captured | |
1839 | // | |
1840 | // for this to work, you should always use it and not set m_cursorMode | |
1841 | // directly! | |
1842 | void ChangeCursorMode(CursorMode mode, | |
1843 | wxWindow *win = (wxWindow *)NULL, | |
1844 | bool captureMouse = TRUE); | |
1845 | ||
1846 | wxWindow *m_winCapture; // the window which captured the mouse | |
1847 | CursorMode m_cursorMode; | |
1848 | ||
6e8524b1 MB |
1849 | bool m_canDragRowSize; |
1850 | bool m_canDragColSize; | |
4cfa5de6 | 1851 | bool m_canDragGridSize; |
07296f0b RD |
1852 | int m_dragLastPos; |
1853 | int m_dragRowOrCol; | |
1854 | bool m_isDragging; | |
1855 | wxPoint m_startDragPos; | |
60ff3b99 | 1856 | |
75ecbe45 | 1857 | bool m_waitForSlowClick; |
025562fe | 1858 | |
60ff3b99 VZ |
1859 | wxGridCellCoords m_selectionStart; |
1860 | ||
1861 | wxCursor m_rowResizeCursor; | |
1862 | wxCursor m_colResizeCursor; | |
1863 | ||
b54ba671 VZ |
1864 | bool m_editable; // applies to whole grid |
1865 | bool m_cellEditCtrlEnabled; // is in-place edit currently shown? | |
60ff3b99 VZ |
1866 | |
1867 | ||
1868 | void Create(); | |
1869 | void Init(); | |
1870 | void CalcDimensions(); | |
7807d81c | 1871 | void CalcWindowSizes(); |
60ff3b99 VZ |
1872 | bool Redimension( wxGridTableMessage& ); |
1873 | ||
1874 | ||
fe7b9ed6 VZ |
1875 | int SendEvent( const wxEventType, int row, int col, wxMouseEvent& ); |
1876 | int SendEvent( const wxEventType, int row, int col ); | |
1877 | int SendEvent( const wxEventType type) | |
b54ba671 VZ |
1878 | { |
1879 | return SendEvent(type, | |
1880 | m_currentCellCoords.GetRow(), | |
1881 | m_currentCellCoords.GetCol()); | |
1882 | } | |
60ff3b99 VZ |
1883 | |
1884 | void OnPaint( wxPaintEvent& ); | |
1885 | void OnSize( wxSizeEvent& ); | |
1886 | void OnKeyDown( wxKeyEvent& ); | |
f6bcfd97 | 1887 | void OnKeyUp( wxKeyEvent& ); |
2796cce3 | 1888 | void OnEraseBackground( wxEraseEvent& ); |
60ff3b99 VZ |
1889 | |
1890 | ||
1891 | void SetCurrentCell( const wxGridCellCoords& coords ); | |
1892 | void SetCurrentCell( int row, int col ) | |
1893 | { SetCurrentCell( wxGridCellCoords(row, col) ); } | |
1894 | ||
c9097836 MB |
1895 | void HighlightBlock( int topRow, int leftCol, int bottomRow, int rightCol ); |
1896 | ||
1897 | void HighlightBlock( const wxGridCellCoords& topLeft, | |
d2520c85 | 1898 | const wxGridCellCoords& bottomRight ) |
c9097836 MB |
1899 | { HighlightBlock( topLeft.GetRow(), topLeft.GetCol(), |
1900 | bottomRight.GetRow(), bottomRight.GetCol() ); } | |
60ff3b99 VZ |
1901 | |
1902 | // ------ functions to get/send data (see also public functions) | |
1903 | // | |
1904 | bool GetModelValues(); | |
1905 | bool SetModelValues(); | |
1906 | ||
12f190b0 | 1907 | friend class WXDLLIMPEXP_ADV wxGridSelection; |
60ff3b99 | 1908 | |
2d66e025 | 1909 | DECLARE_DYNAMIC_CLASS( wxGrid ) |
f85afd4e | 1910 | DECLARE_EVENT_TABLE() |
22f3361e | 1911 | DECLARE_NO_COPY_CLASS(wxGrid) |
f85afd4e MB |
1912 | }; |
1913 | ||
b8d24d4e | 1914 | |
43947979 VZ |
1915 | // ---------------------------------------------------------------------------- |
1916 | // Grid event class and event types | |
1917 | // ---------------------------------------------------------------------------- | |
f85afd4e | 1918 | |
12f190b0 | 1919 | class WXDLLIMPEXP_ADV wxGridEvent : public wxNotifyEvent |
f85afd4e | 1920 | { |
60ff3b99 | 1921 | public: |
f85afd4e MB |
1922 | wxGridEvent() |
1923 | : wxNotifyEvent(), m_row(-1), m_col(-1), m_x(-1), m_y(-1), | |
5c8fc7c1 | 1924 | m_selecting(0), m_control(0), m_meta(0), m_shift(0), m_alt(0) |
f85afd4e MB |
1925 | { |
1926 | } | |
1927 | ||
1928 | wxGridEvent(int id, wxEventType type, wxObject* obj, | |
5c8fc7c1 | 1929 | int row=-1, int col=-1, int x=-1, int y=-1, bool sel = TRUE, |
f85afd4e MB |
1930 | bool control=FALSE, bool shift=FALSE, bool alt=FALSE, bool meta=FALSE); |
1931 | ||
1932 | virtual int GetRow() { return m_row; } | |
1933 | virtual int GetCol() { return m_col; } | |
1934 | wxPoint GetPosition() { return wxPoint( m_x, m_y ); } | |
5c8fc7c1 | 1935 | bool Selecting() { return m_selecting; } |
f85afd4e MB |
1936 | bool ControlDown() { return m_control; } |
1937 | bool MetaDown() { return m_meta; } | |
1938 | bool ShiftDown() { return m_shift; } | |
1939 | bool AltDown() { return m_alt; } | |
2d66e025 | 1940 | |
60ff3b99 VZ |
1941 | protected: |
1942 | int m_row; | |
1943 | int m_col; | |
f85afd4e MB |
1944 | int m_x; |
1945 | int m_y; | |
5c8fc7c1 | 1946 | bool m_selecting; |
f85afd4e MB |
1947 | bool m_control; |
1948 | bool m_meta; | |
1949 | bool m_shift; | |
1950 | bool m_alt; | |
60ff3b99 | 1951 | |
fc7a2a60 | 1952 | DECLARE_DYNAMIC_CLASS_NO_COPY(wxGridEvent) |
60ff3b99 VZ |
1953 | }; |
1954 | ||
12f190b0 | 1955 | class WXDLLIMPEXP_ADV wxGridSizeEvent : public wxNotifyEvent |
60ff3b99 VZ |
1956 | { |
1957 | public: | |
f85afd4e MB |
1958 | wxGridSizeEvent() |
1959 | : wxNotifyEvent(), m_rowOrCol(-1), m_x(-1), m_y(-1), | |
1960 | m_control(0), m_meta(0), m_shift(0), m_alt(0) | |
1961 | { | |
1962 | } | |
1963 | ||
1964 | wxGridSizeEvent(int id, wxEventType type, wxObject* obj, | |
1965 | int rowOrCol=-1, int x=-1, int y=-1, | |
1966 | bool control=FALSE, bool shift=FALSE, bool alt=FALSE, bool meta=FALSE); | |
1967 | ||
1968 | int GetRowOrCol() { return m_rowOrCol; } | |
1969 | wxPoint GetPosition() { return wxPoint( m_x, m_y ); } | |
1970 | bool ControlDown() { return m_control; } | |
1971 | bool MetaDown() { return m_meta; } | |
1972 | bool ShiftDown() { return m_shift; } | |
1973 | bool AltDown() { return m_alt; } | |
2d66e025 | 1974 | |
60ff3b99 VZ |
1975 | protected: |
1976 | int m_rowOrCol; | |
1977 | int m_x; | |
1978 | int m_y; | |
1979 | bool m_control; | |
1980 | bool m_meta; | |
1981 | bool m_shift; | |
1982 | bool m_alt; | |
1983 | ||
fc7a2a60 | 1984 | DECLARE_DYNAMIC_CLASS_NO_COPY(wxGridSizeEvent) |
f85afd4e MB |
1985 | }; |
1986 | ||
1987 | ||
12f190b0 | 1988 | class WXDLLIMPEXP_ADV wxGridRangeSelectEvent : public wxNotifyEvent |
f85afd4e | 1989 | { |
60ff3b99 | 1990 | public: |
f85afd4e | 1991 | wxGridRangeSelectEvent() |
60ff3b99 VZ |
1992 | : wxNotifyEvent() |
1993 | { | |
1994 | m_topLeft = wxGridNoCellCoords; | |
1995 | m_bottomRight = wxGridNoCellCoords; | |
5c8fc7c1 | 1996 | m_selecting = FALSE; |
60ff3b99 VZ |
1997 | m_control = FALSE; |
1998 | m_meta = FALSE; | |
1999 | m_shift = FALSE; | |
2000 | m_alt = FALSE; | |
2001 | } | |
f85afd4e MB |
2002 | |
2003 | wxGridRangeSelectEvent(int id, wxEventType type, wxObject* obj, | |
60ff3b99 VZ |
2004 | const wxGridCellCoords& topLeft, |
2005 | const wxGridCellCoords& bottomRight, | |
5c8fc7c1 | 2006 | bool sel = TRUE, |
60ff3b99 VZ |
2007 | bool control=FALSE, bool shift=FALSE, |
2008 | bool alt=FALSE, bool meta=FALSE); | |
f85afd4e MB |
2009 | |
2010 | wxGridCellCoords GetTopLeftCoords() { return m_topLeft; } | |
2011 | wxGridCellCoords GetBottomRightCoords() { return m_bottomRight; } | |
2012 | int GetTopRow() { return m_topLeft.GetRow(); } | |
2013 | int GetBottomRow() { return m_bottomRight.GetRow(); } | |
2014 | int GetLeftCol() { return m_topLeft.GetCol(); } | |
2015 | int GetRightCol() { return m_bottomRight.GetCol(); } | |
5c8fc7c1 | 2016 | bool Selecting() { return m_selecting; } |
f85afd4e MB |
2017 | bool ControlDown() { return m_control; } |
2018 | bool MetaDown() { return m_meta; } | |
2019 | bool ShiftDown() { return m_shift; } | |
2020 | bool AltDown() { return m_alt; } | |
2d66e025 | 2021 | |
60ff3b99 VZ |
2022 | protected: |
2023 | wxGridCellCoords m_topLeft; | |
2024 | wxGridCellCoords m_bottomRight; | |
5c8fc7c1 | 2025 | bool m_selecting; |
60ff3b99 VZ |
2026 | bool m_control; |
2027 | bool m_meta; | |
2028 | bool m_shift; | |
2029 | bool m_alt; | |
2030 | ||
fc7a2a60 | 2031 | DECLARE_DYNAMIC_CLASS_NO_COPY(wxGridRangeSelectEvent) |
f85afd4e MB |
2032 | }; |
2033 | ||
bf7945ce | 2034 | |
12f190b0 | 2035 | class WXDLLIMPEXP_ADV wxGridEditorCreatedEvent : public wxCommandEvent { |
bf7945ce RD |
2036 | public: |
2037 | wxGridEditorCreatedEvent() | |
2038 | : wxCommandEvent() | |
2039 | { | |
2040 | m_row = 0; | |
2041 | m_col = 0; | |
2042 | m_ctrl = NULL; | |
2043 | } | |
2044 | ||
2045 | wxGridEditorCreatedEvent(int id, wxEventType type, wxObject* obj, | |
2046 | int row, int col, wxControl* ctrl); | |
2047 | ||
2048 | int GetRow() { return m_row; } | |
2049 | int GetCol() { return m_col; } | |
2050 | wxControl* GetControl() { return m_ctrl; } | |
2051 | void SetRow(int row) { m_row = row; } | |
2052 | void SetCol(int col) { m_col = col; } | |
2053 | void SetControl(wxControl* ctrl) { m_ctrl = ctrl; } | |
2054 | ||
2055 | private: | |
2056 | int m_row; | |
2057 | int m_col; | |
2058 | wxControl* m_ctrl; | |
2059 | ||
2060 | DECLARE_DYNAMIC_CLASS(wxGridEditorCreatedEvent) | |
22f3361e | 2061 | DECLARE_NO_COPY_CLASS(wxGridEditorCreatedEvent) |
bf7945ce RD |
2062 | }; |
2063 | ||
2064 | ||
2e4df4bf | 2065 | BEGIN_DECLARE_EVENT_TYPES() |
12f190b0 VS |
2066 | DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_GRID_CELL_LEFT_CLICK, 1580) |
2067 | DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_GRID_CELL_RIGHT_CLICK, 1581) | |
2068 | DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_GRID_CELL_LEFT_DCLICK, 1582) | |
2069 | DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_GRID_CELL_RIGHT_DCLICK, 1583) | |
2070 | DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_GRID_LABEL_LEFT_CLICK, 1584) | |
2071 | DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_GRID_LABEL_RIGHT_CLICK, 1585) | |
2072 | DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_GRID_LABEL_LEFT_DCLICK, 1586) | |
2073 | DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_GRID_LABEL_RIGHT_DCLICK, 1587) | |
2074 | DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_GRID_ROW_SIZE, 1588) | |
2075 | DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_GRID_COL_SIZE, 1589) | |
2076 | DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_GRID_RANGE_SELECT, 1590) | |
2077 | DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_GRID_CELL_CHANGE, 1591) | |
2078 | DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_GRID_SELECT_CELL, 1592) | |
2079 | DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_GRID_EDITOR_SHOWN, 1593) | |
2080 | DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_GRID_EDITOR_HIDDEN, 1594) | |
2081 | DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_GRID_EDITOR_CREATED, 1595) | |
2e4df4bf | 2082 | END_DECLARE_EVENT_TYPES() |
749692cc | 2083 | |
f85afd4e MB |
2084 | |
2085 | typedef void (wxEvtHandler::*wxGridEventFunction)(wxGridEvent&); | |
2086 | typedef void (wxEvtHandler::*wxGridSizeEventFunction)(wxGridSizeEvent&); | |
2087 | typedef void (wxEvtHandler::*wxGridRangeSelectEventFunction)(wxGridRangeSelectEvent&); | |
bf7945ce | 2088 | typedef void (wxEvtHandler::*wxGridEditorCreatedEventFunction)(wxGridEditorCreatedEvent&); |
f85afd4e | 2089 | |
2e4df4bf VZ |
2090 | #define EVT_GRID_CELL_LEFT_CLICK(fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_CELL_LEFT_CLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL ), |
2091 | #define EVT_GRID_CELL_RIGHT_CLICK(fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_CELL_RIGHT_CLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL ), | |
2092 | #define EVT_GRID_CELL_LEFT_DCLICK(fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_CELL_LEFT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL ), | |
2093 | #define EVT_GRID_CELL_RIGHT_DCLICK(fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_CELL_RIGHT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL ), | |
2094 | #define EVT_GRID_LABEL_LEFT_CLICK(fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_LABEL_LEFT_CLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL ), | |
2095 | #define EVT_GRID_LABEL_RIGHT_CLICK(fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_LABEL_RIGHT_CLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL ), | |
2096 | #define EVT_GRID_LABEL_LEFT_DCLICK(fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_LABEL_LEFT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL ), | |
2097 | #define EVT_GRID_LABEL_RIGHT_DCLICK(fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_LABEL_RIGHT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL ), | |
2098 | #define EVT_GRID_ROW_SIZE(fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_ROW_SIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridSizeEventFunction) &fn, NULL ), | |
2099 | #define EVT_GRID_COL_SIZE(fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_COL_SIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridSizeEventFunction) &fn, NULL ), | |
2100 | #define EVT_GRID_RANGE_SELECT(fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_RANGE_SELECT, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridRangeSelectEventFunction) &fn, NULL ), | |
2101 | #define EVT_GRID_CELL_CHANGE(fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_CELL_CHANGE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL ), | |
2102 | #define EVT_GRID_SELECT_CELL(fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_SELECT_CELL, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL ), | |
2103 | #define EVT_GRID_EDITOR_SHOWN(fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_EDITOR_SHOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL ), | |
2104 | #define EVT_GRID_EDITOR_HIDDEN(fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_EDITOR_HIDDEN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL ), | |
bf7945ce | 2105 | #define EVT_GRID_EDITOR_CREATED(fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_EDITOR_CREATED, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEditorCreatedEventFunction) &fn, NULL ), |
f85afd4e MB |
2106 | |
2107 | ||
2108 | #if 0 // TODO: implement these ? others ? | |
2109 | ||
77d4384e RR |
2110 | extern const int wxEVT_GRID_CREATE_CELL; |
2111 | extern const int wxEVT_GRID_CHANGE_LABELS; | |
2112 | extern const int wxEVT_GRID_CHANGE_SEL_LABEL; | |
f85afd4e | 2113 | |
2e4df4bf VZ |
2114 | #define EVT_GRID_CREATE_CELL(fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_CREATE_CELL, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL ), |
2115 | #define EVT_GRID_CHANGE_LABELS(fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_CHANGE_LABELS, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL ), | |
2116 | #define EVT_GRID_CHANGE_SEL_LABEL(fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_CHANGE_SEL_LABEL, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL ), | |
f85afd4e MB |
2117 | |
2118 | #endif | |
2119 | ||
f7556ff0 | 2120 | #endif // ifndef wxUSE_GRID |
f85afd4e | 2121 |