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