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