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