]> git.saurik.com Git - wxWidgets.git/blob - include/wx/generic/grid.h
added helper Is{Col,Row}Shown()
[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: Santiago Palacios
6 // Created: 1/08/1999
7 // RCS-ID: $Id$
8 // Copyright: (c) Michael Bedward
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_GENERIC_GRID_H_
13 #define _WX_GENERIC_GRID_H_
14
15 #include "wx/defs.h"
16
17 #if wxUSE_GRID
18
19 #include "wx/scrolwin.h"
20
21 // ----------------------------------------------------------------------------
22 // constants
23 // ----------------------------------------------------------------------------
24
25 extern WXDLLIMPEXP_DATA_ADV(const char) wxGridNameStr[];
26
27 // Default parameters for wxGrid
28 //
29 #define WXGRID_DEFAULT_NUMBER_ROWS 10
30 #define WXGRID_DEFAULT_NUMBER_COLS 10
31 #if defined(__WXMSW__) || defined(__WXGTK20__)
32 #define WXGRID_DEFAULT_ROW_HEIGHT 25
33 #else
34 #define WXGRID_DEFAULT_ROW_HEIGHT 30
35 #endif // __WXMSW__
36 #define WXGRID_DEFAULT_COL_WIDTH 80
37 #define WXGRID_DEFAULT_COL_LABEL_HEIGHT 32
38 #define WXGRID_DEFAULT_ROW_LABEL_WIDTH 82
39 #define WXGRID_LABEL_EDGE_ZONE 2
40 #define WXGRID_MIN_ROW_HEIGHT 15
41 #define WXGRID_MIN_COL_WIDTH 15
42 #define WXGRID_DEFAULT_SCROLLBAR_WIDTH 16
43
44 // type names for grid table values
45 #define wxGRID_VALUE_STRING _T("string")
46 #define wxGRID_VALUE_BOOL _T("bool")
47 #define wxGRID_VALUE_NUMBER _T("long")
48 #define wxGRID_VALUE_FLOAT _T("double")
49 #define wxGRID_VALUE_CHOICE _T("choice")
50
51 #define wxGRID_VALUE_TEXT wxGRID_VALUE_STRING
52 #define wxGRID_VALUE_LONG wxGRID_VALUE_NUMBER
53
54 // magic constant which tells (to some functions) to automatically calculate
55 // the appropriate size
56 #define wxGRID_AUTOSIZE (-1)
57
58 // many wxGrid methods work either with columns or rows, this enum is used for
59 // the parameter indicating which one should it be
60 enum wxGridDirection
61 {
62 wxGRID_COLUMN,
63 wxGRID_ROW
64 };
65
66 // ----------------------------------------------------------------------------
67 // forward declarations
68 // ----------------------------------------------------------------------------
69
70 class WXDLLIMPEXP_FWD_ADV wxGrid;
71 class WXDLLIMPEXP_FWD_ADV wxGridCellAttr;
72 class WXDLLIMPEXP_FWD_ADV wxGridCellAttrProviderData;
73 class WXDLLIMPEXP_FWD_ADV wxGridColLabelWindow;
74 class WXDLLIMPEXP_FWD_ADV wxGridCornerLabelWindow;
75 class WXDLLIMPEXP_FWD_ADV wxGridRowLabelWindow;
76 class WXDLLIMPEXP_FWD_ADV wxGridWindow;
77 class WXDLLIMPEXP_FWD_ADV wxGridTypeRegistry;
78 class WXDLLIMPEXP_FWD_ADV wxGridSelection;
79
80 class WXDLLIMPEXP_FWD_CORE wxHeaderCtrl;
81 class WXDLLIMPEXP_FWD_CORE wxCheckBox;
82 class WXDLLIMPEXP_FWD_CORE wxComboBox;
83 class WXDLLIMPEXP_FWD_CORE wxTextCtrl;
84 #if wxUSE_SPINCTRL
85 class WXDLLIMPEXP_FWD_CORE wxSpinCtrl;
86 #endif
87
88 class wxGridOperations;
89 class wxGridRowOperations;
90 class wxGridColumnOperations;
91 class wxGridDirectionOperations;
92
93 // ----------------------------------------------------------------------------
94 // macros
95 // ----------------------------------------------------------------------------
96
97 #define wxSafeIncRef(p) if ( p ) (p)->IncRef()
98 #define wxSafeDecRef(p) if ( p ) (p)->DecRef()
99
100 // ----------------------------------------------------------------------------
101 // wxGridCellWorker: common base class for wxGridCellRenderer and
102 // wxGridCellEditor
103 //
104 // NB: this is more an implementation convenience than a design issue, so this
105 // class is not documented and is not public at all
106 // ----------------------------------------------------------------------------
107
108 class WXDLLIMPEXP_ADV wxGridCellWorker : public wxClientDataContainer
109 {
110 public:
111 wxGridCellWorker() { m_nRef = 1; }
112
113 // this class is ref counted: it is created with ref count of 1, so
114 // calling DecRef() once will delete it. Calling IncRef() allows to lock
115 // it until the matching DecRef() is called
116 void IncRef() { m_nRef++; }
117 void DecRef() { if ( --m_nRef == 0 ) delete this; }
118
119 // interpret renderer parameters: arbitrary string whose interpretatin is
120 // left to the derived classes
121 virtual void SetParameters(const wxString& params);
122
123 protected:
124 // virtual dtor for any base class - private because only DecRef() can
125 // delete us
126 virtual ~wxGridCellWorker();
127
128 private:
129 size_t m_nRef;
130
131 // suppress the stupid gcc warning about the class having private dtor and
132 // no friends
133 friend class wxGridCellWorkerDummyFriend;
134 };
135
136 // ----------------------------------------------------------------------------
137 // wxGridCellRenderer: this class is responsible for actually drawing the cell
138 // in the grid. You may pass it to the wxGridCellAttr (below) to change the
139 // format of one given cell or to wxGrid::SetDefaultRenderer() to change the
140 // view of all cells. This is an ABC, you will normally use one of the
141 // predefined derived classes or derive your own class from it.
142 // ----------------------------------------------------------------------------
143
144 class WXDLLIMPEXP_ADV wxGridCellRenderer : public wxGridCellWorker
145 {
146 public:
147 // draw the given cell on the provided DC inside the given rectangle
148 // using the style specified by the attribute and the default or selected
149 // state corresponding to the isSelected value.
150 //
151 // this pure virtual function has a default implementation which will
152 // prepare the DC using the given attribute: it will draw the rectangle
153 // with the bg colour from attr and set the text colour and font
154 virtual void Draw(wxGrid& grid,
155 wxGridCellAttr& attr,
156 wxDC& dc,
157 const wxRect& rect,
158 int row, int col,
159 bool isSelected) = 0;
160
161 // get the preferred size of the cell for its contents
162 virtual wxSize GetBestSize(wxGrid& grid,
163 wxGridCellAttr& attr,
164 wxDC& dc,
165 int row, int col) = 0;
166
167 // create a new object which is the copy of this one
168 virtual wxGridCellRenderer *Clone() const = 0;
169 };
170
171 // the default renderer for the cells containing string data
172 class WXDLLIMPEXP_ADV wxGridCellStringRenderer : public wxGridCellRenderer
173 {
174 public:
175 // draw the string
176 virtual void Draw(wxGrid& grid,
177 wxGridCellAttr& attr,
178 wxDC& dc,
179 const wxRect& rect,
180 int row, int col,
181 bool isSelected);
182
183 // return the string extent
184 virtual wxSize GetBestSize(wxGrid& grid,
185 wxGridCellAttr& attr,
186 wxDC& dc,
187 int row, int col);
188
189 virtual wxGridCellRenderer *Clone() const
190 { return new wxGridCellStringRenderer; }
191
192 protected:
193 // set the text colours before drawing
194 void SetTextColoursAndFont(const wxGrid& grid,
195 const wxGridCellAttr& attr,
196 wxDC& dc,
197 bool isSelected);
198
199 // calc the string extent for given string/font
200 wxSize DoGetBestSize(const wxGridCellAttr& attr,
201 wxDC& dc,
202 const wxString& text);
203 };
204
205 // the default renderer for the cells containing numeric (long) data
206 class WXDLLIMPEXP_ADV wxGridCellNumberRenderer : public wxGridCellStringRenderer
207 {
208 public:
209 // draw the string right aligned
210 virtual void Draw(wxGrid& grid,
211 wxGridCellAttr& attr,
212 wxDC& dc,
213 const wxRect& rect,
214 int row, int col,
215 bool isSelected);
216
217 virtual wxSize GetBestSize(wxGrid& grid,
218 wxGridCellAttr& attr,
219 wxDC& dc,
220 int row, int col);
221
222 virtual wxGridCellRenderer *Clone() const
223 { return new wxGridCellNumberRenderer; }
224
225 protected:
226 wxString GetString(const wxGrid& grid, int row, int col);
227 };
228
229 class WXDLLIMPEXP_ADV wxGridCellFloatRenderer : public wxGridCellStringRenderer
230 {
231 public:
232 wxGridCellFloatRenderer(int width = -1, int precision = -1);
233
234 // get/change formatting parameters
235 int GetWidth() const { return m_width; }
236 void SetWidth(int width) { m_width = width; m_format.clear(); }
237 int GetPrecision() const { return m_precision; }
238 void SetPrecision(int precision) { m_precision = precision; m_format.clear(); }
239
240 // draw the string right aligned with given width/precision
241 virtual void Draw(wxGrid& grid,
242 wxGridCellAttr& attr,
243 wxDC& dc,
244 const wxRect& rect,
245 int row, int col,
246 bool isSelected);
247
248 virtual wxSize GetBestSize(wxGrid& grid,
249 wxGridCellAttr& attr,
250 wxDC& dc,
251 int row, int col);
252
253 // parameters string format is "width[,precision]"
254 virtual void SetParameters(const wxString& params);
255
256 virtual wxGridCellRenderer *Clone() const;
257
258 protected:
259 wxString GetString(const wxGrid& grid, int row, int col);
260
261 private:
262 // formatting parameters
263 int m_width,
264 m_precision;
265
266 wxString m_format;
267 };
268
269 // renderer for boolean fields
270 class WXDLLIMPEXP_ADV wxGridCellBoolRenderer : public wxGridCellRenderer
271 {
272 public:
273 // draw a check mark or nothing
274 virtual void Draw(wxGrid& grid,
275 wxGridCellAttr& attr,
276 wxDC& dc,
277 const wxRect& rect,
278 int row, int col,
279 bool isSelected);
280
281 // return the checkmark size
282 virtual wxSize GetBestSize(wxGrid& grid,
283 wxGridCellAttr& attr,
284 wxDC& dc,
285 int row, int col);
286
287 virtual wxGridCellRenderer *Clone() const
288 { return new wxGridCellBoolRenderer; }
289
290 private:
291 static wxSize ms_sizeCheckMark;
292 };
293
294 // ----------------------------------------------------------------------------
295 // wxGridCellEditor: This class is responsible for providing and manipulating
296 // the in-place edit controls for the grid. Instances of wxGridCellEditor
297 // (actually, instances of derived classes since it is an ABC) can be
298 // associated with the cell attributes for individual cells, rows, columns, or
299 // even for the entire grid.
300 // ----------------------------------------------------------------------------
301
302 class WXDLLIMPEXP_ADV wxGridCellEditor : public wxGridCellWorker
303 {
304 public:
305 wxGridCellEditor();
306
307 bool IsCreated() { return m_control != NULL; }
308 wxControl* GetControl() { return m_control; }
309 void SetControl(wxControl* control) { m_control = control; }
310
311 wxGridCellAttr* GetCellAttr() { return m_attr; }
312 void SetCellAttr(wxGridCellAttr* attr) { m_attr = attr; }
313
314 // Creates the actual edit control
315 virtual void Create(wxWindow* parent,
316 wxWindowID id,
317 wxEvtHandler* evtHandler) = 0;
318
319 // Size and position the edit control
320 virtual void SetSize(const wxRect& rect);
321
322 // Show or hide the edit control, use the specified attributes to set
323 // colours/fonts for it
324 virtual void Show(bool show, wxGridCellAttr *attr = NULL);
325
326 // Draws the part of the cell not occupied by the control: the base class
327 // version just fills it with background colour from the attribute
328 virtual void PaintBackground(const wxRect& rectCell, wxGridCellAttr *attr);
329
330 // Fetch the value from the table and prepare the edit control
331 // to begin editing. Set the focus to the edit control.
332 virtual void BeginEdit(int row, int col, wxGrid* grid) = 0;
333
334 // Complete the editing of the current cell. Returns true if the value has
335 // changed. If necessary, the control may be destroyed.
336 virtual bool EndEdit(int row, int col, wxGrid* grid) = 0;
337
338 // Reset the value in the control back to its starting value
339 virtual void Reset() = 0;
340
341 // return true to allow the given key to start editing: the base class
342 // version only checks that the event has no modifiers. The derived
343 // classes are supposed to do "if ( base::IsAcceptedKey() && ... )" in
344 // their IsAcceptedKey() implementation, although, of course, it is not a
345 // mandatory requirment.
346 //
347 // NB: if the key is F2 (special), editing will always start and this
348 // method will not be called at all (but StartingKey() will)
349 virtual bool IsAcceptedKey(wxKeyEvent& event);
350
351 // If the editor is enabled by pressing keys on the grid, this will be
352 // called to let the editor do something about that first key if desired
353 virtual void StartingKey(wxKeyEvent& event);
354
355 // if the editor is enabled by clicking on the cell, this method will be
356 // called
357 virtual void StartingClick();
358
359 // Some types of controls on some platforms may need some help
360 // with the Return key.
361 virtual void HandleReturn(wxKeyEvent& event);
362
363 // Final cleanup
364 virtual void Destroy();
365
366 // create a new object which is the copy of this one
367 virtual wxGridCellEditor *Clone() const = 0;
368
369 // added GetValue so we can get the value which is in the control
370 virtual wxString GetValue() const = 0;
371
372 protected:
373 // the dtor is private because only DecRef() can delete us
374 virtual ~wxGridCellEditor();
375
376 // the control we show on screen
377 wxControl* m_control;
378
379 // a temporary pointer to the attribute being edited
380 wxGridCellAttr* m_attr;
381
382 // if we change the colours/font of the control from the default ones, we
383 // must restore the default later and we save them here between calls to
384 // Show(true) and Show(false)
385 wxColour m_colFgOld,
386 m_colBgOld;
387 wxFont m_fontOld;
388
389 // suppress the stupid gcc warning about the class having private dtor and
390 // no friends
391 friend class wxGridCellEditorDummyFriend;
392
393 DECLARE_NO_COPY_CLASS(wxGridCellEditor)
394 };
395
396 #if wxUSE_TEXTCTRL
397
398 // the editor for string/text data
399 class WXDLLIMPEXP_ADV wxGridCellTextEditor : public wxGridCellEditor
400 {
401 public:
402 wxGridCellTextEditor();
403
404 virtual void Create(wxWindow* parent,
405 wxWindowID id,
406 wxEvtHandler* evtHandler);
407 virtual void SetSize(const wxRect& rect);
408
409 virtual void PaintBackground(const wxRect& rectCell, wxGridCellAttr *attr);
410
411 virtual bool IsAcceptedKey(wxKeyEvent& event);
412 virtual void BeginEdit(int row, int col, wxGrid* grid);
413 virtual bool EndEdit(int row, int col, wxGrid* grid);
414
415 virtual void Reset();
416 virtual void StartingKey(wxKeyEvent& event);
417 virtual void HandleReturn(wxKeyEvent& event);
418
419 // parameters string format is "max_width"
420 virtual void SetParameters(const wxString& params);
421
422 virtual wxGridCellEditor *Clone() const
423 { return new wxGridCellTextEditor; }
424
425 // added GetValue so we can get the value which is in the control
426 virtual wxString GetValue() const;
427
428 protected:
429 wxTextCtrl *Text() const { return (wxTextCtrl *)m_control; }
430
431 // parts of our virtual functions reused by the derived classes
432 void DoCreate(wxWindow* parent, wxWindowID id, wxEvtHandler* evtHandler,
433 long style = 0);
434 void DoBeginEdit(const wxString& startValue);
435 void DoReset(const wxString& startValue);
436
437 private:
438 size_t m_maxChars; // max number of chars allowed
439 wxString m_startValue;
440
441 DECLARE_NO_COPY_CLASS(wxGridCellTextEditor)
442 };
443
444 // the editor for numeric (long) data
445 class WXDLLIMPEXP_ADV wxGridCellNumberEditor : public wxGridCellTextEditor
446 {
447 public:
448 // allows to specify the range - if min == max == -1, no range checking is
449 // done
450 wxGridCellNumberEditor(int min = -1, int max = -1);
451
452 virtual void Create(wxWindow* parent,
453 wxWindowID id,
454 wxEvtHandler* evtHandler);
455
456 virtual bool IsAcceptedKey(wxKeyEvent& event);
457 virtual void BeginEdit(int row, int col, wxGrid* grid);
458 virtual bool EndEdit(int row, int col, wxGrid* grid);
459
460 virtual void Reset();
461 virtual void StartingKey(wxKeyEvent& event);
462
463 // parameters string format is "min,max"
464 virtual void SetParameters(const wxString& params);
465
466 virtual wxGridCellEditor *Clone() const
467 { return new wxGridCellNumberEditor(m_min, m_max); }
468
469 // added GetValue so we can get the value which is in the control
470 virtual wxString GetValue() const;
471
472 protected:
473 #if wxUSE_SPINCTRL
474 wxSpinCtrl *Spin() const { return (wxSpinCtrl *)m_control; }
475 #endif
476
477 // if HasRange(), we use wxSpinCtrl - otherwise wxTextCtrl
478 bool HasRange() const
479 {
480 #if wxUSE_SPINCTRL
481 return m_min != m_max;
482 #else
483 return false;
484 #endif
485 }
486
487 // string representation of m_valueOld
488 wxString GetString() const
489 { return wxString::Format(_T("%ld"), m_valueOld); }
490
491 private:
492 int m_min,
493 m_max;
494
495 long m_valueOld;
496
497 DECLARE_NO_COPY_CLASS(wxGridCellNumberEditor)
498 };
499
500 // the editor for floating point numbers (double) data
501 class WXDLLIMPEXP_ADV wxGridCellFloatEditor : public wxGridCellTextEditor
502 {
503 public:
504 wxGridCellFloatEditor(int width = -1, int precision = -1);
505
506 virtual void Create(wxWindow* parent,
507 wxWindowID id,
508 wxEvtHandler* evtHandler);
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 StartingKey(wxKeyEvent& event);
516
517 virtual wxGridCellEditor *Clone() const
518 { return new wxGridCellFloatEditor(m_width, m_precision); }
519
520 // parameters string format is "width,precision"
521 virtual void SetParameters(const wxString& params);
522
523 protected:
524 // string representation of m_valueOld
525 wxString GetString() const;
526
527 private:
528 int m_width,
529 m_precision;
530 double m_valueOld;
531
532 DECLARE_NO_COPY_CLASS(wxGridCellFloatEditor)
533 };
534
535 #endif // wxUSE_TEXTCTRL
536
537 #if wxUSE_CHECKBOX
538
539 // the editor for boolean data
540 class WXDLLIMPEXP_ADV wxGridCellBoolEditor : public wxGridCellEditor
541 {
542 public:
543 wxGridCellBoolEditor() { }
544
545 virtual void Create(wxWindow* parent,
546 wxWindowID id,
547 wxEvtHandler* evtHandler);
548
549 virtual void SetSize(const wxRect& rect);
550 virtual void Show(bool show, wxGridCellAttr *attr = NULL);
551
552 virtual bool IsAcceptedKey(wxKeyEvent& event);
553 virtual void BeginEdit(int row, int col, wxGrid* grid);
554 virtual bool EndEdit(int row, int col, wxGrid* grid);
555
556 virtual void Reset();
557 virtual void StartingClick();
558 virtual void StartingKey(wxKeyEvent& event);
559
560 virtual wxGridCellEditor *Clone() const
561 { return new wxGridCellBoolEditor; }
562
563 // added GetValue so we can get the value which is in the control, see
564 // also UseStringValues()
565 virtual wxString GetValue() const;
566
567 // set the string values returned by GetValue() for the true and false
568 // states, respectively
569 static void UseStringValues(const wxString& valueTrue = _T("1"),
570 const wxString& valueFalse = wxEmptyString);
571
572 // return true if the given string is equal to the string representation of
573 // true value which we currently use
574 static bool IsTrueValue(const wxString& value);
575
576 protected:
577 wxCheckBox *CBox() const { return (wxCheckBox *)m_control; }
578
579 private:
580 bool m_startValue;
581
582 static wxString ms_stringValues[2];
583
584 DECLARE_NO_COPY_CLASS(wxGridCellBoolEditor)
585 };
586
587 #endif // wxUSE_CHECKBOX
588
589 #if wxUSE_COMBOBOX
590
591 // the editor for string data allowing to choose from the list of strings
592 class WXDLLIMPEXP_ADV wxGridCellChoiceEditor : public wxGridCellEditor
593 {
594 public:
595 // if !allowOthers, user can't type a string not in choices array
596 wxGridCellChoiceEditor(size_t count = 0,
597 const wxString choices[] = NULL,
598 bool allowOthers = false);
599 wxGridCellChoiceEditor(const wxArrayString& choices,
600 bool allowOthers = false);
601
602 virtual void Create(wxWindow* parent,
603 wxWindowID id,
604 wxEvtHandler* evtHandler);
605
606 virtual void PaintBackground(const wxRect& rectCell, wxGridCellAttr *attr);
607
608 virtual void BeginEdit(int row, int col, wxGrid* grid);
609 virtual bool EndEdit(int row, int col, wxGrid* grid);
610
611 virtual void Reset();
612
613 // parameters string format is "item1[,item2[...,itemN]]"
614 virtual void SetParameters(const wxString& params);
615
616 virtual wxGridCellEditor *Clone() const;
617
618 // added GetValue so we can get the value which is in the control
619 virtual wxString GetValue() const;
620
621 protected:
622 wxComboBox *Combo() const { return (wxComboBox *)m_control; }
623
624 // DJC - (MAPTEK) you at least need access to m_choices if you
625 // wish to override this class
626 protected:
627 wxString m_startValue;
628 wxArrayString m_choices;
629 bool m_allowOthers;
630
631 DECLARE_NO_COPY_CLASS(wxGridCellChoiceEditor)
632 };
633
634 #endif // wxUSE_COMBOBOX
635
636 // ----------------------------------------------------------------------------
637 // wxGridCellAttr: this class can be used to alter the cells appearance in
638 // the grid by changing their colour/font/... from default. An object of this
639 // class may be returned by wxGridTable::GetAttr().
640 // ----------------------------------------------------------------------------
641
642 class WXDLLIMPEXP_ADV wxGridCellAttr : public wxClientDataContainer
643 {
644 public:
645 enum wxAttrKind
646 {
647 Any,
648 Default,
649 Cell,
650 Row,
651 Col,
652 Merged
653 };
654
655 // ctors
656 wxGridCellAttr(wxGridCellAttr *attrDefault = NULL)
657 {
658 Init(attrDefault);
659
660 // MB: args used to be 0,0 here but wxALIGN_LEFT is 0
661 SetAlignment(-1, -1);
662 }
663
664 // VZ: considering the number of members wxGridCellAttr has now, this ctor
665 // seems to be pretty useless... may be we should just remove it?
666 wxGridCellAttr(const wxColour& colText,
667 const wxColour& colBack,
668 const wxFont& font,
669 int hAlign,
670 int vAlign)
671 : m_colText(colText), m_colBack(colBack), m_font(font)
672 {
673 Init();
674 SetAlignment(hAlign, vAlign);
675 }
676
677 // creates a new copy of this object
678 wxGridCellAttr *Clone() const;
679 void MergeWith(wxGridCellAttr *mergefrom);
680
681 // this class is ref counted: it is created with ref count of 1, so
682 // calling DecRef() once will delete it. Calling IncRef() allows to lock
683 // it until the matching DecRef() is called
684 void IncRef() { m_nRef++; }
685 void DecRef() { if ( --m_nRef == 0 ) delete this; }
686
687 // setters
688 void SetTextColour(const wxColour& colText) { m_colText = colText; }
689 void SetBackgroundColour(const wxColour& colBack) { m_colBack = colBack; }
690 void SetFont(const wxFont& font) { m_font = font; }
691 void SetAlignment(int hAlign, int vAlign)
692 {
693 m_hAlign = hAlign;
694 m_vAlign = vAlign;
695 }
696 void SetSize(int num_rows, int num_cols);
697 void SetOverflow(bool allow = true)
698 { m_overflow = allow ? Overflow : SingleCell; }
699 void SetReadOnly(bool isReadOnly = true)
700 { m_isReadOnly = isReadOnly ? ReadOnly : ReadWrite; }
701
702 // takes ownership of the pointer
703 void SetRenderer(wxGridCellRenderer *renderer)
704 { wxSafeDecRef(m_renderer); m_renderer = renderer; }
705 void SetEditor(wxGridCellEditor* editor)
706 { wxSafeDecRef(m_editor); m_editor = editor; }
707
708 void SetKind(wxAttrKind kind) { m_attrkind = kind; }
709
710 // accessors
711 bool HasTextColour() const { return m_colText.Ok(); }
712 bool HasBackgroundColour() const { return m_colBack.Ok(); }
713 bool HasFont() const { return m_font.Ok(); }
714 bool HasAlignment() const { return (m_hAlign != -1 || m_vAlign != -1); }
715 bool HasRenderer() const { return m_renderer != NULL; }
716 bool HasEditor() const { return m_editor != NULL; }
717 bool HasReadWriteMode() const { return m_isReadOnly != Unset; }
718 bool HasOverflowMode() const { return m_overflow != UnsetOverflow; }
719 bool HasSize() const { return m_sizeRows != 1 || m_sizeCols != 1; }
720
721 const wxColour& GetTextColour() const;
722 const wxColour& GetBackgroundColour() const;
723 const wxFont& GetFont() const;
724 void GetAlignment(int *hAlign, int *vAlign) const;
725 void GetSize(int *num_rows, int *num_cols) const;
726 bool GetOverflow() const
727 { return m_overflow != SingleCell; }
728 wxGridCellRenderer *GetRenderer(const wxGrid* grid, int row, int col) const;
729 wxGridCellEditor *GetEditor(const wxGrid* grid, int row, int col) const;
730
731 bool IsReadOnly() const { return m_isReadOnly == wxGridCellAttr::ReadOnly; }
732
733 wxAttrKind GetKind() { return m_attrkind; }
734
735 void SetDefAttr(wxGridCellAttr* defAttr) { m_defGridAttr = defAttr; }
736
737 protected:
738 // the dtor is private because only DecRef() can delete us
739 virtual ~wxGridCellAttr()
740 {
741 wxSafeDecRef(m_renderer);
742 wxSafeDecRef(m_editor);
743 }
744
745 private:
746 enum wxAttrReadMode
747 {
748 Unset = -1,
749 ReadWrite,
750 ReadOnly
751 };
752
753 enum wxAttrOverflowMode
754 {
755 UnsetOverflow = -1,
756 Overflow,
757 SingleCell
758 };
759
760 // the common part of all ctors
761 void Init(wxGridCellAttr *attrDefault = NULL);
762
763
764 // the ref count - when it goes to 0, we die
765 size_t m_nRef;
766
767 wxColour m_colText,
768 m_colBack;
769 wxFont m_font;
770 int m_hAlign,
771 m_vAlign;
772 int m_sizeRows,
773 m_sizeCols;
774
775 wxAttrOverflowMode m_overflow;
776
777 wxGridCellRenderer* m_renderer;
778 wxGridCellEditor* m_editor;
779 wxGridCellAttr* m_defGridAttr;
780
781 wxAttrReadMode m_isReadOnly;
782
783 wxAttrKind m_attrkind;
784
785 // use Clone() instead
786 DECLARE_NO_COPY_CLASS(wxGridCellAttr)
787
788 // suppress the stupid gcc warning about the class having private dtor and
789 // no friends
790 friend class wxGridCellAttrDummyFriend;
791 };
792
793 // ----------------------------------------------------------------------------
794 // wxGridCellAttrProvider: class used by wxGridTableBase to retrieve/store the
795 // cell attributes.
796 // ----------------------------------------------------------------------------
797
798 // implementation note: we separate it from wxGridTableBase because we wish to
799 // avoid deriving a new table class if possible, and sometimes it will be
800 // enough to just derive another wxGridCellAttrProvider instead
801 //
802 // the default implementation is reasonably efficient for the generic case,
803 // but you might still wish to implement your own for some specific situations
804 // if you have performance problems with the stock one
805 class WXDLLIMPEXP_ADV wxGridCellAttrProvider : public wxClientDataContainer
806 {
807 public:
808 wxGridCellAttrProvider();
809 virtual ~wxGridCellAttrProvider();
810
811 // DecRef() must be called on the returned pointer
812 virtual wxGridCellAttr *GetAttr(int row, int col,
813 wxGridCellAttr::wxAttrKind kind ) const;
814
815 // all these functions take ownership of the pointer, don't call DecRef()
816 // on it
817 virtual void SetAttr(wxGridCellAttr *attr, int row, int col);
818 virtual void SetRowAttr(wxGridCellAttr *attr, int row);
819 virtual void SetColAttr(wxGridCellAttr *attr, int col);
820
821 // these functions must be called whenever some rows/cols are deleted
822 // because the internal data must be updated then
823 void UpdateAttrRows( size_t pos, int numRows );
824 void UpdateAttrCols( size_t pos, int numCols );
825
826 private:
827 void InitData();
828
829 wxGridCellAttrProviderData *m_data;
830
831 DECLARE_NO_COPY_CLASS(wxGridCellAttrProvider)
832 };
833
834 // ----------------------------------------------------------------------------
835 // wxGridCellCoords: location of a cell in the grid
836 // ----------------------------------------------------------------------------
837
838 class WXDLLIMPEXP_ADV wxGridCellCoords
839 {
840 public:
841 wxGridCellCoords() { m_row = m_col = -1; }
842 wxGridCellCoords( int r, int c ) { m_row = r; m_col = c; }
843
844 // default copy ctor is ok
845
846 int GetRow() const { return m_row; }
847 void SetRow( int n ) { m_row = n; }
848 int GetCol() const { return m_col; }
849 void SetCol( int n ) { m_col = n; }
850 void Set( int row, int col ) { m_row = row; m_col = col; }
851
852 wxGridCellCoords& operator=( const wxGridCellCoords& other )
853 {
854 if ( &other != this )
855 {
856 m_row=other.m_row;
857 m_col=other.m_col;
858 }
859 return *this;
860 }
861
862 bool operator==( const wxGridCellCoords& other ) const
863 {
864 return (m_row == other.m_row && m_col == other.m_col);
865 }
866
867 bool operator!=( const wxGridCellCoords& other ) const
868 {
869 return (m_row != other.m_row || m_col != other.m_col);
870 }
871
872 bool operator!() const
873 {
874 return (m_row == -1 && m_col == -1 );
875 }
876
877 private:
878 int m_row;
879 int m_col;
880 };
881
882
883 // For comparisons...
884 //
885 extern WXDLLIMPEXP_ADV wxGridCellCoords wxGridNoCellCoords;
886 extern WXDLLIMPEXP_ADV wxRect wxGridNoCellRect;
887
888 // An array of cell coords...
889 //
890 WX_DECLARE_OBJARRAY_WITH_DECL(wxGridCellCoords, wxGridCellCoordsArray,
891 class WXDLLIMPEXP_ADV);
892
893 // ----------------------------------------------------------------------------
894 // Grid table classes
895 // ----------------------------------------------------------------------------
896
897 // the abstract base class
898 class WXDLLIMPEXP_ADV wxGridTableBase : public wxObject,
899 public wxClientDataContainer
900 {
901 public:
902 wxGridTableBase();
903 virtual ~wxGridTableBase();
904
905 // You must override these functions in a derived table class
906 //
907
908 // return the number of rows and columns in this table
909 virtual int GetNumberRows() = 0;
910 virtual int GetNumberCols() = 0;
911
912 // the methods above are unfortunately non-const even though they should
913 // have been const -- but changing it now is not possible any longer as it
914 // would break the existing code overriding them, so instead we provide
915 // these const synonyms which can be used from const-correct code
916 int GetRowsCount() const
917 { return const_cast<wxGridTableBase *>(this)->GetNumberRows(); }
918 int GetColsCount() const
919 { return const_cast<wxGridTableBase *>(this)->GetNumberCols(); }
920
921
922 virtual bool IsEmptyCell( int row, int col )
923 {
924 return GetValue(row, col).empty();
925 }
926
927 bool IsEmpty(const wxGridCellCoords& coord)
928 {
929 return IsEmptyCell(coord.GetRow(), coord.GetCol());
930 }
931
932 virtual wxString GetValue( int row, int col ) = 0;
933 virtual void SetValue( int row, int col, const wxString& value ) = 0;
934
935 // Data type determination and value access
936 virtual wxString GetTypeName( int row, int col );
937 virtual bool CanGetValueAs( int row, int col, const wxString& typeName );
938 virtual bool CanSetValueAs( int row, int col, const wxString& typeName );
939
940 virtual long GetValueAsLong( int row, int col );
941 virtual double GetValueAsDouble( int row, int col );
942 virtual bool GetValueAsBool( int row, int col );
943
944 virtual void SetValueAsLong( int row, int col, long value );
945 virtual void SetValueAsDouble( int row, int col, double value );
946 virtual void SetValueAsBool( int row, int col, bool value );
947
948 // For user defined types
949 virtual void* GetValueAsCustom( int row, int col, const wxString& typeName );
950 virtual void SetValueAsCustom( int row, int col, const wxString& typeName, void* value );
951
952
953 // Overriding these is optional
954 //
955 virtual void SetView( wxGrid *grid ) { m_view = grid; }
956 virtual wxGrid * GetView() const { return m_view; }
957
958 virtual void Clear() {}
959 virtual bool InsertRows( size_t pos = 0, size_t numRows = 1 );
960 virtual bool AppendRows( size_t numRows = 1 );
961 virtual bool DeleteRows( size_t pos = 0, size_t numRows = 1 );
962 virtual bool InsertCols( size_t pos = 0, size_t numCols = 1 );
963 virtual bool AppendCols( size_t numCols = 1 );
964 virtual bool DeleteCols( size_t pos = 0, size_t numCols = 1 );
965
966 virtual wxString GetRowLabelValue( int row );
967 virtual wxString GetColLabelValue( int col );
968 virtual void SetRowLabelValue( int WXUNUSED(row), const wxString& ) {}
969 virtual void SetColLabelValue( int WXUNUSED(col), const wxString& ) {}
970
971 // Attribute handling
972 //
973
974 // give us the attr provider to use - we take ownership of the pointer
975 void SetAttrProvider(wxGridCellAttrProvider *attrProvider);
976
977 // get the currently used attr provider (may be NULL)
978 wxGridCellAttrProvider *GetAttrProvider() const { return m_attrProvider; }
979
980 // Does this table allow attributes? Default implementation creates
981 // a wxGridCellAttrProvider if necessary.
982 virtual bool CanHaveAttributes();
983
984 // by default forwarded to wxGridCellAttrProvider if any. May be
985 // overridden to handle attributes directly in the table.
986 virtual wxGridCellAttr *GetAttr( int row, int col,
987 wxGridCellAttr::wxAttrKind kind );
988
989
990 // these functions take ownership of the pointer
991 virtual void SetAttr(wxGridCellAttr* attr, int row, int col);
992 virtual void SetRowAttr(wxGridCellAttr *attr, int row);
993 virtual void SetColAttr(wxGridCellAttr *attr, int col);
994
995 private:
996 wxGrid * m_view;
997 wxGridCellAttrProvider *m_attrProvider;
998
999 DECLARE_ABSTRACT_CLASS(wxGridTableBase)
1000 DECLARE_NO_COPY_CLASS(wxGridTableBase)
1001 };
1002
1003
1004 // ----------------------------------------------------------------------------
1005 // wxGridTableMessage
1006 // ----------------------------------------------------------------------------
1007
1008 // IDs for messages sent from grid table to view
1009 //
1010 enum wxGridTableRequest
1011 {
1012 wxGRIDTABLE_REQUEST_VIEW_GET_VALUES = 2000,
1013 wxGRIDTABLE_REQUEST_VIEW_SEND_VALUES,
1014 wxGRIDTABLE_NOTIFY_ROWS_INSERTED,
1015 wxGRIDTABLE_NOTIFY_ROWS_APPENDED,
1016 wxGRIDTABLE_NOTIFY_ROWS_DELETED,
1017 wxGRIDTABLE_NOTIFY_COLS_INSERTED,
1018 wxGRIDTABLE_NOTIFY_COLS_APPENDED,
1019 wxGRIDTABLE_NOTIFY_COLS_DELETED
1020 };
1021
1022 class WXDLLIMPEXP_ADV wxGridTableMessage
1023 {
1024 public:
1025 wxGridTableMessage();
1026 wxGridTableMessage( wxGridTableBase *table, int id,
1027 int comInt1 = -1,
1028 int comInt2 = -1 );
1029
1030 void SetTableObject( wxGridTableBase *table ) { m_table = table; }
1031 wxGridTableBase * GetTableObject() const { return m_table; }
1032 void SetId( int id ) { m_id = id; }
1033 int GetId() { return m_id; }
1034 void SetCommandInt( int comInt1 ) { m_comInt1 = comInt1; }
1035 int GetCommandInt() { return m_comInt1; }
1036 void SetCommandInt2( int comInt2 ) { m_comInt2 = comInt2; }
1037 int GetCommandInt2() { return m_comInt2; }
1038
1039 private:
1040 wxGridTableBase *m_table;
1041 int m_id;
1042 int m_comInt1;
1043 int m_comInt2;
1044
1045 DECLARE_NO_COPY_CLASS(wxGridTableMessage)
1046 };
1047
1048
1049
1050 // ------ wxGridStringArray
1051 // A 2-dimensional array of strings for data values
1052 //
1053
1054 WX_DECLARE_OBJARRAY_WITH_DECL(wxArrayString, wxGridStringArray,
1055 class WXDLLIMPEXP_ADV);
1056
1057
1058
1059 // ------ wxGridStringTable
1060 //
1061 // Simplest type of data table for a grid for small tables of strings
1062 // that are stored in memory
1063 //
1064
1065 class WXDLLIMPEXP_ADV wxGridStringTable : public wxGridTableBase
1066 {
1067 public:
1068 wxGridStringTable();
1069 wxGridStringTable( int numRows, int numCols );
1070 virtual ~wxGridStringTable();
1071
1072 // these are pure virtual in wxGridTableBase
1073 //
1074 int GetNumberRows();
1075 int GetNumberCols();
1076 wxString GetValue( int row, int col );
1077 void SetValue( int row, int col, const wxString& s );
1078
1079 // overridden functions from wxGridTableBase
1080 //
1081 void Clear();
1082 bool InsertRows( size_t pos = 0, size_t numRows = 1 );
1083 bool AppendRows( size_t numRows = 1 );
1084 bool DeleteRows( size_t pos = 0, size_t numRows = 1 );
1085 bool InsertCols( size_t pos = 0, size_t numCols = 1 );
1086 bool AppendCols( size_t numCols = 1 );
1087 bool DeleteCols( size_t pos = 0, size_t numCols = 1 );
1088
1089 void SetRowLabelValue( int row, const wxString& );
1090 void SetColLabelValue( int col, const wxString& );
1091 wxString GetRowLabelValue( int row );
1092 wxString GetColLabelValue( int col );
1093
1094 private:
1095 wxGridStringArray m_data;
1096
1097 // These only get used if you set your own labels, otherwise the
1098 // GetRow/ColLabelValue functions return wxGridTableBase defaults
1099 //
1100 wxArrayString m_rowLabels;
1101 wxArrayString m_colLabels;
1102
1103 DECLARE_DYNAMIC_CLASS_NO_COPY( wxGridStringTable )
1104 };
1105
1106
1107
1108 // ============================================================================
1109 // Grid view classes
1110 // ============================================================================
1111
1112 // ----------------------------------------------------------------------------
1113 // wxGrid
1114 // ----------------------------------------------------------------------------
1115
1116 class WXDLLIMPEXP_ADV wxGrid : public wxScrolledWindow
1117 {
1118 public:
1119 // possible selection modes
1120 enum wxGridSelectionModes
1121 {
1122 wxGridSelectCells = 0, // allow selecting anything
1123 wxGridSelectRows = 1, // allow selecting only entire rows
1124 wxGridSelectColumns = 2, // allow selecting only entire columns
1125 wxGridSelectRowsOrColumns = wxGridSelectRows | wxGridSelectColumns
1126 };
1127
1128 // creation and destruction
1129 // ------------------------
1130
1131 // ctor and Create() create the grid window, as with the other controls
1132 wxGrid() { Init(); }
1133
1134 wxGrid(wxWindow *parent,
1135 wxWindowID id,
1136 const wxPoint& pos = wxDefaultPosition,
1137 const wxSize& size = wxDefaultSize,
1138 long style = wxWANTS_CHARS,
1139 const wxString& name = wxGridNameStr)
1140 {
1141 Init();
1142
1143 Create(parent, id, pos, size, style, name);
1144 }
1145
1146 bool Create(wxWindow *parent,
1147 wxWindowID id,
1148 const wxPoint& pos = wxDefaultPosition,
1149 const wxSize& size = wxDefaultSize,
1150 long style = wxWANTS_CHARS,
1151 const wxString& name = wxGridNameStr);
1152
1153 virtual ~wxGrid();
1154
1155 // however to initialize grid data either CreateGrid() or SetTable() must
1156 // be also called
1157
1158 // this is basically equivalent to
1159 //
1160 // SetTable(new wxGridStringTable(numRows, numCols), true, selmode)
1161 //
1162 bool CreateGrid( int numRows, int numCols,
1163 wxGridSelectionModes selmode = wxGridSelectCells );
1164
1165 bool SetTable( wxGridTableBase *table,
1166 bool takeOwnership = false,
1167 wxGridSelectionModes selmode = wxGridSelectCells );
1168
1169 bool ProcessTableMessage(wxGridTableMessage&);
1170
1171 wxGridTableBase *GetTable() const { return m_table; }
1172
1173
1174 void SetSelectionMode(wxGridSelectionModes selmode);
1175 wxGridSelectionModes GetSelectionMode() const;
1176
1177 // ------ grid dimensions
1178 //
1179 int GetNumberRows() const { return m_numRows; }
1180 int GetNumberCols() const { return m_numCols; }
1181
1182
1183 // ------ display update functions
1184 //
1185 wxArrayInt CalcRowLabelsExposed( const wxRegion& reg ) const;
1186
1187 wxArrayInt CalcColLabelsExposed( const wxRegion& reg ) const;
1188 wxGridCellCoordsArray CalcCellsExposed( const wxRegion& reg ) const;
1189
1190
1191 void ClearGrid();
1192 bool InsertRows(int pos = 0, int numRows = 1, bool updateLabels = true)
1193 {
1194 return DoModifyLines(&wxGridTableBase::InsertRows,
1195 pos, numRows, updateLabels);
1196 }
1197 bool InsertCols(int pos = 0, int numCols = 1, bool updateLabels = true)
1198 {
1199 return DoModifyLines(&wxGridTableBase::InsertCols,
1200 pos, numCols, updateLabels);
1201 }
1202
1203 bool AppendRows(int numRows = 1, bool updateLabels = true)
1204 {
1205 return DoAppendLines(&wxGridTableBase::AppendRows, numRows, updateLabels);
1206 }
1207 bool AppendCols(int numCols = 1, bool updateLabels = true)
1208 {
1209 return DoAppendLines(&wxGridTableBase::AppendCols, numCols, updateLabels);
1210 }
1211
1212 bool DeleteRows(int pos = 0, int numRows = 1, bool updateLabels = true)
1213 {
1214 return DoModifyLines(&wxGridTableBase::DeleteRows,
1215 pos, numRows, updateLabels);
1216 }
1217 bool DeleteCols(int pos = 0, int numCols = 1, bool updateLabels = true)
1218 {
1219 return DoModifyLines(&wxGridTableBase::DeleteCols,
1220 pos, numCols, updateLabels);
1221 }
1222
1223 void DrawGridCellArea( wxDC& dc , const wxGridCellCoordsArray& cells );
1224 void DrawGridSpace( wxDC& dc );
1225 void DrawCellBorder( wxDC& dc, const wxGridCellCoords& );
1226 void DrawAllGridLines( wxDC& dc, const wxRegion & reg );
1227 void DrawCell( wxDC& dc, const wxGridCellCoords& );
1228 void DrawHighlight(wxDC& dc, const wxGridCellCoordsArray& cells);
1229
1230 // this function is called when the current cell highlight must be redrawn
1231 // and may be overridden by the user
1232 virtual void DrawCellHighlight( wxDC& dc, const wxGridCellAttr *attr );
1233
1234 virtual void DrawRowLabels( wxDC& dc, const wxArrayInt& rows );
1235 virtual void DrawRowLabel( wxDC& dc, int row );
1236
1237 virtual void DrawColLabels( wxDC& dc, const wxArrayInt& cols );
1238 virtual void DrawColLabel( wxDC& dc, int col );
1239
1240 virtual void DrawCornerLabel(wxDC& dc);
1241
1242 // ------ Cell text drawing functions
1243 //
1244 void DrawTextRectangle( wxDC& dc, const wxString&, const wxRect&,
1245 int horizontalAlignment = wxALIGN_LEFT,
1246 int verticalAlignment = wxALIGN_TOP,
1247 int textOrientation = wxHORIZONTAL );
1248
1249 void DrawTextRectangle( wxDC& dc, const wxArrayString& lines, const wxRect&,
1250 int horizontalAlignment = wxALIGN_LEFT,
1251 int verticalAlignment = wxALIGN_TOP,
1252 int textOrientation = wxHORIZONTAL );
1253
1254
1255 // Split a string containing newline characters into an array of
1256 // strings and return the number of lines
1257 //
1258 void StringToLines( const wxString& value, wxArrayString& lines ) const;
1259
1260 void GetTextBoxSize( const wxDC& dc,
1261 const wxArrayString& lines,
1262 long *width, long *height ) const;
1263
1264
1265 // ------
1266 // Code that does a lot of grid modification can be enclosed
1267 // between BeginBatch() and EndBatch() calls to avoid screen
1268 // flicker
1269 //
1270 void BeginBatch() { m_batchCount++; }
1271 void EndBatch();
1272
1273 int GetBatchCount() { return m_batchCount; }
1274
1275 virtual void Refresh(bool eraseb = true, const wxRect* rect = NULL);
1276
1277 // Use this, rather than wxWindow::Refresh(), to force an
1278 // immediate repainting of the grid. Has no effect if you are
1279 // already inside a BeginBatch / EndBatch block.
1280 //
1281 // This function is necessary because wxGrid has a minimal OnPaint()
1282 // handler to reduce screen flicker.
1283 //
1284 void ForceRefresh();
1285
1286
1287 // ------ edit control functions
1288 //
1289 bool IsEditable() const { return m_editable; }
1290 void EnableEditing( bool edit );
1291
1292 void EnableCellEditControl( bool enable = true );
1293 void DisableCellEditControl() { EnableCellEditControl(false); }
1294 bool CanEnableCellControl() const;
1295 bool IsCellEditControlEnabled() const;
1296 bool IsCellEditControlShown() const;
1297
1298 bool IsCurrentCellReadOnly() const;
1299
1300 void ShowCellEditControl();
1301 void HideCellEditControl();
1302 void SaveEditControlValue();
1303
1304
1305 // ------ grid location functions
1306 // Note that all of these functions work with the logical coordinates of
1307 // grid cells and labels so you will need to convert from device
1308 // coordinates for mouse events etc.
1309 //
1310 wxGridCellCoords XYToCell(int x, int y) const;
1311 void XYToCell(int x, int y, wxGridCellCoords& coords) const
1312 { coords = XYToCell(x, y); }
1313 wxGridCellCoords XYToCell(const wxPoint& pos) const
1314 { return XYToCell(pos.x, pos.y); }
1315
1316 // these functions return the index of the row/columns corresponding to the
1317 // given logical position in pixels
1318 //
1319 // if clipToMinMax is false (default, wxNOT_FOUND is returned if the
1320 // position is outside any row/column, otherwise the first/last element is
1321 // returned in this case
1322 int YToRow( int y, bool clipToMinMax = false ) const;
1323 int XToCol( int x, bool clipToMinMax = false ) const;
1324
1325 int YToEdgeOfRow( int y ) const;
1326 int XToEdgeOfCol( int x ) const;
1327
1328 wxRect CellToRect( int row, int col ) const;
1329 wxRect CellToRect( const wxGridCellCoords& coords ) const
1330 { return CellToRect( coords.GetRow(), coords.GetCol() ); }
1331
1332 int GetGridCursorRow() const { return m_currentCellCoords.GetRow(); }
1333 int GetGridCursorCol() const { return m_currentCellCoords.GetCol(); }
1334
1335 // check to see if a cell is either wholly visible (the default arg) or
1336 // at least partially visible in the grid window
1337 //
1338 bool IsVisible( int row, int col, bool wholeCellVisible = true ) const;
1339 bool IsVisible( const wxGridCellCoords& coords, bool wholeCellVisible = true ) const
1340 { return IsVisible( coords.GetRow(), coords.GetCol(), wholeCellVisible ); }
1341 void MakeCellVisible( int row, int col );
1342 void MakeCellVisible( const wxGridCellCoords& coords )
1343 { MakeCellVisible( coords.GetRow(), coords.GetCol() ); }
1344
1345
1346 // ------ grid cursor movement functions
1347 //
1348 void SetGridCursor(int row, int col) { SetCurrentCell(row, col); }
1349 void SetGridCursor(const wxGridCellCoords& c) { SetCurrentCell(c); }
1350
1351 void GoToCell(int row, int col)
1352 {
1353 if ( SetCurrentCell(row, col) )
1354 MakeCellVisible(row, col);
1355 }
1356
1357 void GoToCell(const wxGridCellCoords& coords)
1358 {
1359 if ( SetCurrentCell(coords) )
1360 MakeCellVisible(coords);
1361 }
1362
1363 bool MoveCursorUp( bool expandSelection );
1364 bool MoveCursorDown( bool expandSelection );
1365 bool MoveCursorLeft( bool expandSelection );
1366 bool MoveCursorRight( bool expandSelection );
1367 bool MovePageDown();
1368 bool MovePageUp();
1369 bool MoveCursorUpBlock( bool expandSelection );
1370 bool MoveCursorDownBlock( bool expandSelection );
1371 bool MoveCursorLeftBlock( bool expandSelection );
1372 bool MoveCursorRightBlock( bool expandSelection );
1373
1374
1375 // ------ label and gridline formatting
1376 //
1377 int GetDefaultRowLabelSize() const { return WXGRID_DEFAULT_ROW_LABEL_WIDTH; }
1378 int GetRowLabelSize() const { return m_rowLabelWidth; }
1379 int GetDefaultColLabelSize() const { return WXGRID_DEFAULT_COL_LABEL_HEIGHT; }
1380 int GetColLabelSize() const { return m_colLabelHeight; }
1381 wxColour GetLabelBackgroundColour() const { return m_labelBackgroundColour; }
1382 wxColour GetLabelTextColour() const { return m_labelTextColour; }
1383 wxFont GetLabelFont() const { return m_labelFont; }
1384 void GetRowLabelAlignment( int *horiz, int *vert ) const;
1385 void GetColLabelAlignment( int *horiz, int *vert ) const;
1386 int GetColLabelTextOrientation() const;
1387 wxString GetRowLabelValue( int row ) const;
1388 wxString GetColLabelValue( int col ) const;
1389
1390 wxColour GetCellHighlightColour() const { return m_cellHighlightColour; }
1391 int GetCellHighlightPenWidth() const { return m_cellHighlightPenWidth; }
1392 int GetCellHighlightROPenWidth() const { return m_cellHighlightROPenWidth; }
1393
1394 // this one will use wxHeaderCtrl for the column labels
1395 void UseNativeColHeader(bool native = true);
1396
1397 // this one will still draw them manually but using the native renderer
1398 // instead of using the same appearance as for the row labels
1399 void SetUseNativeColLabels( bool native = true );
1400
1401 void SetRowLabelSize( int width );
1402 void SetColLabelSize( int height );
1403 void HideRowLabels() { SetRowLabelSize( 0 ); }
1404 void HideColLabels() { SetColLabelSize( 0 ); }
1405 void SetLabelBackgroundColour( const wxColour& );
1406 void SetLabelTextColour( const wxColour& );
1407 void SetLabelFont( const wxFont& );
1408 void SetRowLabelAlignment( int horiz, int vert );
1409 void SetColLabelAlignment( int horiz, int vert );
1410 void SetColLabelTextOrientation( int textOrientation );
1411 void SetRowLabelValue( int row, const wxString& );
1412 void SetColLabelValue( int col, const wxString& );
1413 void SetCellHighlightColour( const wxColour& );
1414 void SetCellHighlightPenWidth(int width);
1415 void SetCellHighlightROPenWidth(int width);
1416
1417 void EnableDragRowSize( bool enable = true );
1418 void DisableDragRowSize() { EnableDragRowSize( false ); }
1419 bool CanDragRowSize() const { return m_canDragRowSize; }
1420 void EnableDragColSize( bool enable = true );
1421 void DisableDragColSize() { EnableDragColSize( false ); }
1422 bool CanDragColSize() const { return m_canDragColSize; }
1423 void EnableDragColMove( bool enable = true );
1424 void DisableDragColMove() { EnableDragColMove( false ); }
1425 bool CanDragColMove() const { return m_canDragColMove; }
1426 void EnableDragGridSize(bool enable = true);
1427 void DisableDragGridSize() { EnableDragGridSize(false); }
1428 bool CanDragGridSize() const { return m_canDragGridSize; }
1429
1430 void EnableDragCell( bool enable = true );
1431 void DisableDragCell() { EnableDragCell( false ); }
1432 bool CanDragCell() const { return m_canDragCell; }
1433
1434
1435 // grid lines
1436 // ----------
1437
1438 // enable or disable drawing of the lines
1439 void EnableGridLines(bool enable = true);
1440 bool GridLinesEnabled() const { return m_gridLinesEnabled; }
1441
1442 // by default grid lines stop at last column/row, but this may be changed
1443 void ClipHorzGridLines(bool clip)
1444 { DoClipGridLines(m_gridLinesClipHorz, clip); }
1445 void ClipVertGridLines(bool clip)
1446 { DoClipGridLines(m_gridLinesClipVert, clip); }
1447 bool AreHorzGridLinesClipped() const { return m_gridLinesClipHorz; }
1448 bool AreVertGridLinesClipped() const { return m_gridLinesClipVert; }
1449
1450 // this can be used to change the global grid lines colour
1451 void SetGridLineColour(const wxColour& col);
1452 wxColour GetGridLineColour() const { return m_gridLineColour; }
1453
1454 // these methods may be overridden to customize individual grid lines
1455 // appearance
1456 virtual wxPen GetDefaultGridLinePen();
1457 virtual wxPen GetRowGridLinePen(int row);
1458 virtual wxPen GetColGridLinePen(int col);
1459
1460
1461 // attributes
1462 // ----------
1463
1464 // this sets the specified attribute for this cell or in this row/col
1465 void SetAttr(int row, int col, wxGridCellAttr *attr);
1466 void SetRowAttr(int row, wxGridCellAttr *attr);
1467 void SetColAttr(int col, wxGridCellAttr *attr);
1468
1469 // returns the attribute we may modify in place: a new one if this cell
1470 // doesn't have any yet or the existing one if it does
1471 //
1472 // DecRef() must be called on the returned pointer, as usual
1473 wxGridCellAttr *GetOrCreateCellAttr(int row, int col) const;
1474
1475
1476 // shortcuts for setting the column parameters
1477
1478 // set the format for the data in the column: default is string
1479 void SetColFormatBool(int col);
1480 void SetColFormatNumber(int col);
1481 void SetColFormatFloat(int col, int width = -1, int precision = -1);
1482 void SetColFormatCustom(int col, const wxString& typeName);
1483
1484 // ------ row and col formatting
1485 //
1486 int GetDefaultRowSize() const;
1487 int GetRowSize( int row ) const;
1488 bool IsRowShown(int row) const { return GetRowSize(row) != 0; }
1489 int GetDefaultColSize() const;
1490 int GetColSize( int col ) const;
1491 bool IsColShown(int col) const { return GetColSize(col) != 0; }
1492 wxColour GetDefaultCellBackgroundColour() const;
1493 wxColour GetCellBackgroundColour( int row, int col ) const;
1494 wxColour GetDefaultCellTextColour() const;
1495 wxColour GetCellTextColour( int row, int col ) const;
1496 wxFont GetDefaultCellFont() const;
1497 wxFont GetCellFont( int row, int col ) const;
1498 void GetDefaultCellAlignment( int *horiz, int *vert ) const;
1499 void GetCellAlignment( int row, int col, int *horiz, int *vert ) const;
1500 bool GetDefaultCellOverflow() const;
1501 bool GetCellOverflow( int row, int col ) const;
1502 void GetCellSize( int row, int col, int *num_rows, int *num_cols ) const;
1503 wxSize GetCellSize(const wxGridCellCoords& coords)
1504 {
1505 wxSize s;
1506 GetCellSize(coords.GetRow(), coords.GetCol(), &s.x, &s.y);
1507 return s;
1508 }
1509
1510 // ------ row and col sizes
1511 void SetDefaultRowSize( int height, bool resizeExistingRows = false );
1512 void SetRowSize( int row, int height );
1513 void HideRow(int row) { SetRowSize(row, 0); }
1514 void ShowRow(int row) { SetRowSize(row, -1); }
1515
1516 void SetDefaultColSize( int width, bool resizeExistingCols = false );
1517 void SetColSize( int col, int width );
1518 void HideCol(int col) { SetColSize(col, 0); }
1519 void ShowCol(int col) { SetColSize(col, -1); }
1520
1521
1522 // ------- columns (only, for now) reordering
1523
1524 // columns index <-> positions mapping: by default, the position of the
1525 // column is the same as its index, but the columns can also be reordered
1526 // (either by calling SetColPos() explicitly or by the user dragging the
1527 // columns around) in which case their indices don't correspond to their
1528 // positions on display any longer
1529 //
1530 // internally we always work with indices except for the functions which
1531 // have "Pos" in their names (and which work with columns, not pixels) and
1532 // only the display and hit testing code really cares about display
1533 // positions at all
1534
1535 // return the column index corresponding to the given (valid) position
1536 int GetColAt(int pos) const
1537 {
1538 return m_colAt.empty() ? pos : m_colAt[pos];
1539 }
1540
1541 // reorder the columns so that the column with the given index is now shown
1542 // as the position pos
1543 void SetColPos(int idx, int pos);
1544
1545 // return the position at which the column with the given index is
1546 // displayed: notice that this is a slow operation as we don't maintain the
1547 // reverse mapping currently
1548 int GetColPos(int idx) const
1549 {
1550 if ( m_colAt.IsEmpty() )
1551 return idx;
1552
1553 for ( int i = 0; i < m_numCols; i++ )
1554 {
1555 if ( m_colAt[i] == idx )
1556 return i;
1557 }
1558
1559 wxFAIL_MSG( "invalid column index" );
1560
1561 return wxNOT_FOUND;
1562 }
1563
1564 // reset the columns positions to the default order
1565 void ResetColPos();
1566
1567
1568 // automatically size the column or row to fit to its contents, if
1569 // setAsMin is true, this optimal width will also be set as minimal width
1570 // for this column
1571 void AutoSizeColumn( int col, bool setAsMin = true )
1572 { AutoSizeColOrRow(col, setAsMin, wxGRID_COLUMN); }
1573 void AutoSizeRow( int row, bool setAsMin = true )
1574 { AutoSizeColOrRow(row, setAsMin, wxGRID_ROW); }
1575
1576 // auto size all columns (very ineffective for big grids!)
1577 void AutoSizeColumns( bool setAsMin = true )
1578 { (void)SetOrCalcColumnSizes(false, setAsMin); }
1579
1580 void AutoSizeRows( bool setAsMin = true )
1581 { (void)SetOrCalcRowSizes(false, setAsMin); }
1582
1583 // auto size the grid, that is make the columns/rows of the "right" size
1584 // and also set the grid size to just fit its contents
1585 void AutoSize();
1586
1587 // Note for both AutoSizeRowLabelSize and AutoSizeColLabelSize:
1588 // If col equals to wxGRID_AUTOSIZE value then function autosizes labels column
1589 // instead of data column. Note that this operation may be slow for large
1590 // tables.
1591 // autosize row height depending on label text
1592 void AutoSizeRowLabelSize( int row );
1593
1594 // autosize column width depending on label text
1595 void AutoSizeColLabelSize( int col );
1596
1597 // column won't be resized to be lesser width - this must be called during
1598 // the grid creation because it won't resize the column if it's already
1599 // narrower than the minimal width
1600 void SetColMinimalWidth( int col, int width );
1601 void SetRowMinimalHeight( int row, int width );
1602
1603 /* These members can be used to query and modify the minimal
1604 * acceptable size of grid rows and columns. Call this function in
1605 * your code which creates the grid if you want to display cells
1606 * with a size smaller than the default acceptable minimum size.
1607 * Like the members SetColMinimalWidth and SetRowMinimalWidth,
1608 * the existing rows or columns will not be checked/resized.
1609 */
1610 void SetColMinimalAcceptableWidth( int width );
1611 void SetRowMinimalAcceptableHeight( int width );
1612 int GetColMinimalAcceptableWidth() const;
1613 int GetRowMinimalAcceptableHeight() const;
1614
1615 void SetDefaultCellBackgroundColour( const wxColour& );
1616 void SetCellBackgroundColour( int row, int col, const wxColour& );
1617 void SetDefaultCellTextColour( const wxColour& );
1618
1619 void SetCellTextColour( int row, int col, const wxColour& );
1620 void SetDefaultCellFont( const wxFont& );
1621 void SetCellFont( int row, int col, const wxFont& );
1622 void SetDefaultCellAlignment( int horiz, int vert );
1623 void SetCellAlignment( int row, int col, int horiz, int vert );
1624 void SetDefaultCellOverflow( bool allow );
1625 void SetCellOverflow( int row, int col, bool allow );
1626 void SetCellSize( int row, int col, int num_rows, int num_cols );
1627
1628 // takes ownership of the pointer
1629 void SetDefaultRenderer(wxGridCellRenderer *renderer);
1630 void SetCellRenderer(int row, int col, wxGridCellRenderer *renderer);
1631 wxGridCellRenderer *GetDefaultRenderer() const;
1632 wxGridCellRenderer* GetCellRenderer(int row, int col) const;
1633
1634 // takes ownership of the pointer
1635 void SetDefaultEditor(wxGridCellEditor *editor);
1636 void SetCellEditor(int row, int col, wxGridCellEditor *editor);
1637 wxGridCellEditor *GetDefaultEditor() const;
1638 wxGridCellEditor* GetCellEditor(int row, int col) const;
1639
1640
1641
1642 // ------ cell value accessors
1643 //
1644 wxString GetCellValue( int row, int col ) const
1645 {
1646 if ( m_table )
1647 {
1648 return m_table->GetValue( row, col );
1649 }
1650 else
1651 {
1652 return wxEmptyString;
1653 }
1654 }
1655
1656 wxString GetCellValue( const wxGridCellCoords& coords ) const
1657 { return GetCellValue( coords.GetRow(), coords.GetCol() ); }
1658
1659 void SetCellValue( int row, int col, const wxString& s );
1660 void SetCellValue( const wxGridCellCoords& coords, const wxString& s )
1661 { SetCellValue( coords.GetRow(), coords.GetCol(), s ); }
1662
1663 // returns true if the cell can't be edited
1664 bool IsReadOnly(int row, int col) const;
1665
1666 // make the cell editable/readonly
1667 void SetReadOnly(int row, int col, bool isReadOnly = true);
1668
1669 // ------ select blocks of cells
1670 //
1671 void SelectRow( int row, bool addToSelected = false );
1672 void SelectCol( int col, bool addToSelected = false );
1673
1674 void SelectBlock( int topRow, int leftCol, int bottomRow, int rightCol,
1675 bool addToSelected = false );
1676
1677 void SelectBlock( const wxGridCellCoords& topLeft,
1678 const wxGridCellCoords& bottomRight,
1679 bool addToSelected = false )
1680 { SelectBlock( topLeft.GetRow(), topLeft.GetCol(),
1681 bottomRight.GetRow(), bottomRight.GetCol(),
1682 addToSelected ); }
1683
1684 void SelectAll();
1685
1686 bool IsSelection() const;
1687
1688 // ------ deselect blocks or cells
1689 //
1690 void DeselectRow( int row );
1691 void DeselectCol( int col );
1692 void DeselectCell( int row, int col );
1693
1694 void ClearSelection();
1695
1696 bool IsInSelection( int row, int col ) const;
1697
1698 bool IsInSelection( const wxGridCellCoords& coords ) const
1699 { return IsInSelection( coords.GetRow(), coords.GetCol() ); }
1700
1701 wxGridCellCoordsArray GetSelectedCells() const;
1702 wxGridCellCoordsArray GetSelectionBlockTopLeft() const;
1703 wxGridCellCoordsArray GetSelectionBlockBottomRight() const;
1704 wxArrayInt GetSelectedRows() const;
1705 wxArrayInt GetSelectedCols() const;
1706
1707 // This function returns the rectangle that encloses the block of cells
1708 // limited by TopLeft and BottomRight cell in device coords and clipped
1709 // to the client size of the grid window.
1710 //
1711 wxRect BlockToDeviceRect( const wxGridCellCoords & topLeft,
1712 const wxGridCellCoords & bottomRight ) const;
1713
1714 // Access or update the selection fore/back colours
1715 wxColour GetSelectionBackground() const
1716 { return m_selectionBackground; }
1717 wxColour GetSelectionForeground() const
1718 { return m_selectionForeground; }
1719
1720 void SetSelectionBackground(const wxColour& c) { m_selectionBackground = c; }
1721 void SetSelectionForeground(const wxColour& c) { m_selectionForeground = c; }
1722
1723
1724 // Methods for a registry for mapping data types to Renderers/Editors
1725 void RegisterDataType(const wxString& typeName,
1726 wxGridCellRenderer* renderer,
1727 wxGridCellEditor* editor);
1728 // DJC MAPTEK
1729 virtual wxGridCellEditor* GetDefaultEditorForCell(int row, int col) const;
1730 wxGridCellEditor* GetDefaultEditorForCell(const wxGridCellCoords& c) const
1731 { return GetDefaultEditorForCell(c.GetRow(), c.GetCol()); }
1732 virtual wxGridCellRenderer* GetDefaultRendererForCell(int row, int col) const;
1733 virtual wxGridCellEditor* GetDefaultEditorForType(const wxString& typeName) const;
1734 virtual wxGridCellRenderer* GetDefaultRendererForType(const wxString& typeName) const;
1735
1736 // grid may occupy more space than needed for its rows/columns, this
1737 // function allows to set how big this extra space is
1738 void SetMargins(int extraWidth, int extraHeight)
1739 {
1740 m_extraWidth = extraWidth;
1741 m_extraHeight = extraHeight;
1742
1743 CalcDimensions();
1744 }
1745
1746 // Accessors for component windows
1747 wxWindow* GetGridWindow() const { return (wxWindow*)m_gridWin; }
1748 wxWindow* GetGridRowLabelWindow() const { return (wxWindow*)m_rowLabelWin; }
1749 wxWindow* GetGridColLabelWindow() const { return m_colWindow; }
1750 wxWindow* GetGridCornerLabelWindow() const { return (wxWindow*)m_cornerLabelWin; }
1751
1752 // This one can only be called if we are using the native header window
1753 wxHeaderCtrl *GetGridColHeader() const
1754 {
1755 wxASSERT_MSG( m_useNativeHeader, "no column header window" );
1756
1757 // static_cast<> doesn't work without the full class declaration in
1758 // view and we prefer to avoid adding more compile-time dependencies
1759 // even at the cost of using reinterpret_cast<>
1760 return reinterpret_cast<wxHeaderCtrl *>(m_colWindow);
1761 }
1762
1763 // Allow adjustment of scroll increment. The default is (15, 15).
1764 void SetScrollLineX(int x) { m_scrollLineX = x; }
1765 void SetScrollLineY(int y) { m_scrollLineY = y; }
1766 int GetScrollLineX() const { return m_scrollLineX; }
1767 int GetScrollLineY() const { return m_scrollLineY; }
1768
1769 // ------- drag and drop
1770 #if wxUSE_DRAG_AND_DROP
1771 virtual void SetDropTarget(wxDropTarget *dropTarget);
1772 #endif // wxUSE_DRAG_AND_DROP
1773
1774
1775 // ------- sorting support
1776
1777 // wxGrid doesn't support sorting on its own but it can indicate the sort
1778 // order in the column header (currently only if native header control is
1779 // used though)
1780
1781 // return the column currently displaying the sort indicator or wxNOT_FOUND
1782 // if none
1783 int GetSortingColumn() const { return m_sortCol; }
1784
1785 // return true if this column is currently used for sorting
1786 bool IsSortingBy(int col) const { return GetSortingColumn() == col; }
1787
1788 // return the current sorting order (on GetSortingColumn()): true for
1789 // ascending sort and false for descending; it doesn't make sense to call
1790 // it if GetSortingColumn() returns wxNOT_FOUND
1791 bool IsSortOrderAscending() const { return m_sortIsAscending; }
1792
1793 // set the sorting column (or unsets any existing one if wxNOT_FOUND) and
1794 // the order in which to sort
1795 void SetSortingColumn(int col, bool ascending = true);
1796
1797 // unset any existing sorting column
1798 void UnsetSortingColumn() { SetSortingColumn(wxNOT_FOUND); }
1799
1800 #ifdef WXWIN_COMPATIBILITY_2_8
1801 // ------ For compatibility with previous wxGrid only...
1802 //
1803 // ************************************************
1804 // ** Don't use these in new code because they **
1805 // ** are liable to disappear in a future **
1806 // ** revision **
1807 // ************************************************
1808 //
1809
1810 wxGrid( wxWindow *parent,
1811 int x, int y, int w = wxDefaultCoord, int h = wxDefaultCoord,
1812 long style = wxWANTS_CHARS,
1813 const wxString& name = wxPanelNameStr )
1814 {
1815 Init();
1816 Create(parent, wxID_ANY, wxPoint(x, y), wxSize(w, h), style, name);
1817 }
1818
1819 void SetCellValue( const wxString& val, int row, int col )
1820 { SetCellValue( row, col, val ); }
1821
1822 void UpdateDimensions()
1823 { CalcDimensions(); }
1824
1825 int GetRows() const { return GetNumberRows(); }
1826 int GetCols() const { return GetNumberCols(); }
1827 int GetCursorRow() const { return GetGridCursorRow(); }
1828 int GetCursorColumn() const { return GetGridCursorCol(); }
1829
1830 int GetScrollPosX() const { return 0; }
1831 int GetScrollPosY() const { return 0; }
1832
1833 void SetScrollX( int WXUNUSED(x) ) { }
1834 void SetScrollY( int WXUNUSED(y) ) { }
1835
1836 void SetColumnWidth( int col, int width )
1837 { SetColSize( col, width ); }
1838
1839 int GetColumnWidth( int col ) const
1840 { return GetColSize( col ); }
1841
1842 void SetRowHeight( int row, int height )
1843 { SetRowSize( row, height ); }
1844
1845 // GetRowHeight() is below
1846
1847 int GetViewHeight() const // returned num whole rows visible
1848 { return 0; }
1849
1850 int GetViewWidth() const // returned num whole cols visible
1851 { return 0; }
1852
1853 void SetLabelSize( int orientation, int sz )
1854 {
1855 if ( orientation == wxHORIZONTAL )
1856 SetColLabelSize( sz );
1857 else
1858 SetRowLabelSize( sz );
1859 }
1860
1861 int GetLabelSize( int orientation ) const
1862 {
1863 if ( orientation == wxHORIZONTAL )
1864 return GetColLabelSize();
1865 else
1866 return GetRowLabelSize();
1867 }
1868
1869 void SetLabelAlignment( int orientation, int align )
1870 {
1871 if ( orientation == wxHORIZONTAL )
1872 SetColLabelAlignment( align, -1 );
1873 else
1874 SetRowLabelAlignment( align, -1 );
1875 }
1876
1877 int GetLabelAlignment( int orientation, int WXUNUSED(align) ) const
1878 {
1879 int h, v;
1880 if ( orientation == wxHORIZONTAL )
1881 {
1882 GetColLabelAlignment( &h, &v );
1883 return h;
1884 }
1885 else
1886 {
1887 GetRowLabelAlignment( &h, &v );
1888 return h;
1889 }
1890 }
1891
1892 void SetLabelValue( int orientation, const wxString& val, int pos )
1893 {
1894 if ( orientation == wxHORIZONTAL )
1895 SetColLabelValue( pos, val );
1896 else
1897 SetRowLabelValue( pos, val );
1898 }
1899
1900 wxString GetLabelValue( int orientation, int pos) const
1901 {
1902 if ( orientation == wxHORIZONTAL )
1903 return GetColLabelValue( pos );
1904 else
1905 return GetRowLabelValue( pos );
1906 }
1907
1908 wxFont GetCellTextFont() const
1909 { return m_defaultCellAttr->GetFont(); }
1910
1911 wxFont GetCellTextFont(int WXUNUSED(row), int WXUNUSED(col)) const
1912 { return m_defaultCellAttr->GetFont(); }
1913
1914 void SetCellTextFont(const wxFont& fnt)
1915 { SetDefaultCellFont( fnt ); }
1916
1917 void SetCellTextFont(const wxFont& fnt, int row, int col)
1918 { SetCellFont( row, col, fnt ); }
1919
1920 void SetCellTextColour(const wxColour& val, int row, int col)
1921 { SetCellTextColour( row, col, val ); }
1922
1923 void SetCellTextColour(const wxColour& col)
1924 { SetDefaultCellTextColour( col ); }
1925
1926 void SetCellBackgroundColour(const wxColour& col)
1927 { SetDefaultCellBackgroundColour( col ); }
1928
1929 void SetCellBackgroundColour(const wxColour& colour, int row, int col)
1930 { SetCellBackgroundColour( row, col, colour ); }
1931
1932 bool GetEditable() const { return IsEditable(); }
1933 void SetEditable( bool edit = true ) { EnableEditing( edit ); }
1934 bool GetEditInPlace() const { return IsCellEditControlEnabled(); }
1935
1936 void SetEditInPlace(bool WXUNUSED(edit) = true) { }
1937
1938 void SetCellAlignment( int align, int row, int col)
1939 { SetCellAlignment(row, col, align, wxALIGN_CENTER); }
1940 void SetCellAlignment( int WXUNUSED(align) ) {}
1941 void SetCellBitmap(wxBitmap *WXUNUSED(bitmap), int WXUNUSED(row), int WXUNUSED(col))
1942 { }
1943 void SetDividerPen(const wxPen& WXUNUSED(pen)) { }
1944 wxPen& GetDividerPen() const;
1945 void OnActivate(bool WXUNUSED(active)) {}
1946
1947 // ******** End of compatibility functions **********
1948
1949
1950
1951 // ------ control IDs
1952 enum { wxGRID_CELLCTRL = 2000,
1953 wxGRID_TOPCTRL };
1954
1955 // ------ control types
1956 enum { wxGRID_TEXTCTRL = 2100,
1957 wxGRID_CHECKBOX,
1958 wxGRID_CHOICE,
1959 wxGRID_COMBOBOX };
1960 #endif // WXWIN_COMPATIBILITY_2_8
1961
1962
1963 // override some base class functions
1964 virtual bool Enable(bool enable = true);
1965 virtual wxWindow *GetMainWindowOfCompositeControl()
1966 { return (wxWindow*)m_gridWin; }
1967 virtual void Fit();
1968
1969 // implementation only
1970 void CancelMouseCapture();
1971
1972 protected:
1973 virtual wxSize DoGetBestSize() const;
1974
1975 bool m_created;
1976
1977 wxGridWindow *m_gridWin;
1978 wxGridCornerLabelWindow *m_cornerLabelWin;
1979 wxGridRowLabelWindow *m_rowLabelWin;
1980
1981 // the real type of the column window depends on m_useNativeHeader value:
1982 // if it is true, its dynamic type is wxHeaderCtrl, otherwise it is
1983 // wxGridColLabelWindow, use accessors below when the real type matters
1984 wxWindow *m_colWindow;
1985
1986 wxGridColLabelWindow *GetColLabelWindow() const
1987 {
1988 wxASSERT_MSG( !m_useNativeHeader, "no column label window" );
1989
1990 return reinterpret_cast<wxGridColLabelWindow *>(m_colWindow);
1991 }
1992
1993 wxGridTableBase *m_table;
1994 bool m_ownTable;
1995
1996 int m_numRows;
1997 int m_numCols;
1998
1999 wxGridCellCoords m_currentCellCoords;
2000
2001 // the corners of the block being currently selected or wxGridNoCellCoords
2002 wxGridCellCoords m_selectedBlockTopLeft;
2003 wxGridCellCoords m_selectedBlockBottomRight;
2004
2005 // when selecting blocks of cells (either from the keyboard using Shift
2006 // with cursor keys, or by dragging the mouse), the selection is anchored
2007 // at m_currentCellCoords which defines one of the corners of the rectangle
2008 // being selected -- and this variable defines the other corner, i.e. it's
2009 // either m_selectedBlockTopLeft or m_selectedBlockBottomRight depending on
2010 // which of them is not m_currentCellCoords
2011 //
2012 // if no block selection is in process, it is set to wxGridNoCellCoords
2013 wxGridCellCoords m_selectedBlockCorner;
2014
2015 wxGridSelection *m_selection;
2016
2017 wxColour m_selectionBackground;
2018 wxColour m_selectionForeground;
2019
2020 // NB: *never* access m_row/col arrays directly because they are created
2021 // on demand, *always* use accessor functions instead!
2022
2023 // init the m_rowHeights/Bottoms arrays with default values
2024 void InitRowHeights();
2025
2026 int m_defaultRowHeight;
2027 int m_minAcceptableRowHeight;
2028 wxArrayInt m_rowHeights;
2029 wxArrayInt m_rowBottoms;
2030
2031 // init the m_colWidths/Rights arrays
2032 void InitColWidths();
2033
2034 int m_defaultColWidth;
2035 int m_minAcceptableColWidth;
2036 wxArrayInt m_colWidths;
2037 wxArrayInt m_colRights;
2038
2039 int m_sortCol;
2040 bool m_sortIsAscending;
2041
2042 bool m_useNativeHeader,
2043 m_nativeColumnLabels;
2044
2045 // get the col/row coords
2046 int GetColWidth(int col) const;
2047 int GetColLeft(int col) const;
2048 int GetColRight(int col) const;
2049
2050 // this function must be public for compatibility...
2051 public:
2052 int GetRowHeight(int row) const;
2053 protected:
2054
2055 int GetRowTop(int row) const;
2056 int GetRowBottom(int row) const;
2057
2058 int m_rowLabelWidth;
2059 int m_colLabelHeight;
2060
2061 // the size of the margin left to the right and bottom of the cell area
2062 int m_extraWidth,
2063 m_extraHeight;
2064
2065 wxColour m_labelBackgroundColour;
2066 wxColour m_labelTextColour;
2067 wxFont m_labelFont;
2068
2069 int m_rowLabelHorizAlign;
2070 int m_rowLabelVertAlign;
2071 int m_colLabelHorizAlign;
2072 int m_colLabelVertAlign;
2073 int m_colLabelTextOrientation;
2074
2075 bool m_defaultRowLabelValues;
2076 bool m_defaultColLabelValues;
2077
2078 wxColour m_gridLineColour;
2079 bool m_gridLinesEnabled;
2080 bool m_gridLinesClipHorz,
2081 m_gridLinesClipVert;
2082 wxColour m_cellHighlightColour;
2083 int m_cellHighlightPenWidth;
2084 int m_cellHighlightROPenWidth;
2085
2086
2087 // common part of AutoSizeColumn/Row() and GetBestSize()
2088 int SetOrCalcColumnSizes(bool calcOnly, bool setAsMin = true);
2089 int SetOrCalcRowSizes(bool calcOnly, bool setAsMin = true);
2090
2091 // common part of AutoSizeColumn/Row()
2092 void AutoSizeColOrRow(int n, bool setAsMin, wxGridDirection direction);
2093
2094 // Calculate the minimum acceptable size for labels area
2095 wxCoord CalcColOrRowLabelAreaMinSize(wxGridDirection direction);
2096
2097 // if a column has a minimal width, it will be the value for it in this
2098 // hash table
2099 wxLongToLongHashMap m_colMinWidths,
2100 m_rowMinHeights;
2101
2102 // get the minimal width of the given column/row
2103 int GetColMinimalWidth(int col) const;
2104 int GetRowMinimalHeight(int col) const;
2105
2106 // do we have some place to store attributes in?
2107 bool CanHaveAttributes() const;
2108
2109 // cell attribute cache (currently we only cache 1, may be will do
2110 // more/better later)
2111 struct CachedAttr
2112 {
2113 int row, col;
2114 wxGridCellAttr *attr;
2115 } m_attrCache;
2116
2117 // invalidates the attribute cache
2118 void ClearAttrCache();
2119
2120 // adds an attribute to cache
2121 void CacheAttr(int row, int col, wxGridCellAttr *attr) const;
2122
2123 // looks for an attr in cache, returns true if found
2124 bool LookupAttr(int row, int col, wxGridCellAttr **attr) const;
2125
2126 // looks for the attr in cache, if not found asks the table and caches the
2127 // result
2128 wxGridCellAttr *GetCellAttr(int row, int col) const;
2129 wxGridCellAttr *GetCellAttr(const wxGridCellCoords& coords ) const
2130 { return GetCellAttr( coords.GetRow(), coords.GetCol() ); }
2131
2132 // the default cell attr object for cells that don't have their own
2133 wxGridCellAttr* m_defaultCellAttr;
2134
2135
2136 bool m_inOnKeyDown;
2137 int m_batchCount;
2138
2139
2140 wxGridTypeRegistry* m_typeRegistry;
2141
2142 enum CursorMode
2143 {
2144 WXGRID_CURSOR_SELECT_CELL,
2145 WXGRID_CURSOR_RESIZE_ROW,
2146 WXGRID_CURSOR_RESIZE_COL,
2147 WXGRID_CURSOR_SELECT_ROW,
2148 WXGRID_CURSOR_SELECT_COL,
2149 WXGRID_CURSOR_MOVE_COL
2150 };
2151
2152 // this method not only sets m_cursorMode but also sets the correct cursor
2153 // for the given mode and, if captureMouse is not false releases the mouse
2154 // if it was captured and captures it if it must be captured
2155 //
2156 // for this to work, you should always use it and not set m_cursorMode
2157 // directly!
2158 void ChangeCursorMode(CursorMode mode,
2159 wxWindow *win = NULL,
2160 bool captureMouse = true);
2161
2162 wxWindow *m_winCapture; // the window which captured the mouse
2163
2164 // this variable is used not for finding the correct current cursor but
2165 // mainly for finding out what is going to happen if the mouse starts being
2166 // dragged right now
2167 //
2168 // by default it is WXGRID_CURSOR_SELECT_CELL meaning that nothing else is
2169 // going on, and it is set to one of RESIZE/SELECT/MOVE values while the
2170 // corresponding operation will be started if the user starts dragging the
2171 // mouse from the current position
2172 CursorMode m_cursorMode;
2173
2174
2175 //Column positions
2176 wxArrayInt m_colAt;
2177
2178 bool m_canDragRowSize;
2179 bool m_canDragColSize;
2180 bool m_canDragColMove;
2181 bool m_canDragGridSize;
2182 bool m_canDragCell;
2183
2184 // the last position (horizontal or vertical depending on whether the user
2185 // is resizing a column or a row) where a row or column separator line was
2186 // dragged by the user or -1 of there is no drag operation in progress
2187 int m_dragLastPos;
2188 int m_dragRowOrCol;
2189
2190 // true if a drag operation is in progress; when this is true,
2191 // m_startDragPos is valid, i.e. not wxDefaultPosition
2192 bool m_isDragging;
2193
2194 // the position (in physical coordinates) where the user started dragging
2195 // the mouse or wxDefaultPosition if mouse isn't being dragged
2196 //
2197 // notice that this can be != wxDefaultPosition while m_isDragging is still
2198 // false because we wait until the mouse is moved some distance away before
2199 // setting m_isDragging to true
2200 wxPoint m_startDragPos;
2201
2202 bool m_waitForSlowClick;
2203
2204 wxGridCellCoords m_selectionStart;
2205
2206 wxCursor m_rowResizeCursor;
2207 wxCursor m_colResizeCursor;
2208
2209 bool m_editable; // applies to whole grid
2210 bool m_cellEditCtrlEnabled; // is in-place edit currently shown?
2211
2212 int m_scrollLineX; // X scroll increment
2213 int m_scrollLineY; // Y scroll increment
2214
2215 void Init(); // common part of all ctors
2216 void Create();
2217 void CreateColumnWindow();
2218 void CalcDimensions();
2219 void CalcWindowSizes();
2220 bool Redimension( wxGridTableMessage& );
2221
2222
2223 // generate the appropriate grid event and return -1 if it was vetoed, 1 if
2224 // it was processed (but not vetoed) and 0 if it wasn't processed
2225 int SendEvent(const wxEventType evtType,
2226 int row, int col,
2227 wxMouseEvent& e);
2228 int SendEvent(const wxEventType evtType,
2229 const wxGridCellCoords& coords,
2230 wxMouseEvent& e)
2231 { return SendEvent(evtType, coords.GetRow(), coords.GetCol(), e); }
2232 int SendEvent(const wxEventType evtType, int row, int col);
2233 int SendEvent(const wxEventType evtType, const wxGridCellCoords& coords)
2234 { return SendEvent(evtType, coords.GetRow(), coords.GetCol()); }
2235 int SendEvent(const wxEventType evtType)
2236 { return SendEvent(evtType, m_currentCellCoords); }
2237
2238 void OnPaint( wxPaintEvent& );
2239 void OnSize( wxSizeEvent& );
2240 void OnKeyDown( wxKeyEvent& );
2241 void OnKeyUp( wxKeyEvent& );
2242 void OnChar( wxKeyEvent& );
2243 void OnEraseBackground( wxEraseEvent& );
2244
2245
2246 bool SetCurrentCell( const wxGridCellCoords& coords );
2247 bool SetCurrentCell( int row, int col )
2248 { return SetCurrentCell( wxGridCellCoords(row, col) ); }
2249
2250
2251 // this function is called to extend the block being currently selected
2252 // from mouse and keyboard event handlers
2253 void UpdateBlockBeingSelected(int topRow, int leftCol,
2254 int bottomRow, int rightCol);
2255
2256 void UpdateBlockBeingSelected(const wxGridCellCoords& topLeft,
2257 const wxGridCellCoords& bottomRight)
2258 { UpdateBlockBeingSelected(topLeft.GetRow(), topLeft.GetCol(),
2259 bottomRight.GetRow(), bottomRight.GetCol()); }
2260
2261 // ------ functions to get/send data (see also public functions)
2262 //
2263 bool GetModelValues();
2264 bool SetModelValues();
2265
2266 friend class WXDLLIMPEXP_FWD_ADV wxGridSelection;
2267 friend class wxGridRowOperations;
2268 friend class wxGridColumnOperations;
2269
2270 // they call our private Process{{Corner,Col,Row}Label,GridCell}MouseEvent()
2271 friend class wxGridCornerLabelWindow;
2272 friend class wxGridColLabelWindow;
2273 friend class wxGridRowLabelWindow;
2274 friend class wxGridWindow;
2275
2276 friend class wxGridHeaderCtrl;
2277
2278 private:
2279 // implement wxScrolledWindow method to return m_gridWin size
2280 virtual wxSize GetSizeAvailableForScrollTarget(const wxSize& size);
2281
2282 // redraw the grid lines, should be called after changing their attributes
2283 void RedrawGridLines();
2284
2285 // common part of Clip{Horz,Vert}GridLines
2286 void DoClipGridLines(bool& var, bool clip);
2287
2288 // update the sorting indicator shown in the specified column (whose index
2289 // must be valid)
2290 //
2291 // this will use GetSortingColumn() and IsSortOrderAscending() to determine
2292 // the sorting indicator to effectively show
2293 void UpdateColumnSortingIndicator(int col);
2294
2295 // update the grid after changing the columns order (common part of
2296 // SetColPos() and ResetColPos())
2297 void RefreshAfterColPosChange();
2298
2299
2300 // return the position (not index) of the column at the given logical pixel
2301 // position
2302 //
2303 // this always returns a valid position, even if the coordinate is out of
2304 // bounds (in which case first/last column is returned)
2305 int XToPos(int x) const;
2306
2307
2308 // event handlers and their helpers
2309 // --------------------------------
2310
2311 // process mouse drag event in WXGRID_CURSOR_SELECT_CELL mode
2312 void DoGridCellDrag(wxMouseEvent& event,
2313 const wxGridCellCoords& coords,
2314 bool isFirstDrag);
2315
2316 // process row/column resizing drag event
2317 void DoGridLineDrag(wxMouseEvent& event, const wxGridOperations& oper);
2318
2319 // process mouse drag event in the grid window
2320 void DoGridDragEvent(wxMouseEvent& event, const wxGridCellCoords& coords);
2321
2322 // process different clicks on grid cells
2323 void DoGridCellLeftDown(wxMouseEvent& event,
2324 const wxGridCellCoords& coords,
2325 const wxPoint& pos);
2326 void DoGridCellLeftDClick(wxMouseEvent& event,
2327 const wxGridCellCoords& coords,
2328 const wxPoint& pos);
2329 void DoGridCellLeftUp(wxMouseEvent& event, const wxGridCellCoords& coords);
2330
2331 // process movement (but not dragging) event in the grid cell area
2332 void DoGridMouseMoveEvent(wxMouseEvent& event,
2333 const wxGridCellCoords& coords,
2334 const wxPoint& pos);
2335
2336 // process mouse events in the grid window
2337 void ProcessGridCellMouseEvent(wxMouseEvent& event);
2338
2339 // process mouse events in the row/column labels/corner windows
2340 void ProcessRowLabelMouseEvent(wxMouseEvent& event);
2341 void ProcessColLabelMouseEvent(wxMouseEvent& event);
2342 void ProcessCornerLabelMouseEvent(wxMouseEvent& event);
2343
2344 void DoColHeaderClick(int col);
2345
2346 void DoStartResizeCol(int col);
2347 void DoUpdateResizeCol(int x);
2348 void DoUpdateResizeColWidth(int w);
2349 void DoStartMoveCol(int col);
2350
2351 void DoEndDragResizeRow();
2352 void DoEndDragResizeCol(wxMouseEvent *event = NULL);
2353 void DoEndMoveCol(int pos);
2354
2355
2356 // common implementations of methods defined for both rows and columns
2357 void DeselectLine(int line, const wxGridOperations& oper);
2358 void DoEndDragResizeLine(const wxGridOperations& oper);
2359 int PosToLinePos(int pos, bool clipToMinMax,
2360 const wxGridOperations& oper) const;
2361 int PosToLine(int pos, bool clipToMinMax,
2362 const wxGridOperations& oper) const;
2363 int PosToEdgeOfLine(int pos, const wxGridOperations& oper) const;
2364
2365 bool DoMoveCursor(bool expandSelection,
2366 const wxGridDirectionOperations& diroper);
2367 bool DoMoveCursorByPage(const wxGridDirectionOperations& diroper);
2368 bool DoMoveCursorByBlock(bool expandSelection,
2369 const wxGridDirectionOperations& diroper);
2370 void AdvanceToNextNonEmpty(wxGridCellCoords& coords,
2371 const wxGridDirectionOperations& diroper);
2372
2373 // common part of {Insert,Delete}{Rows,Cols}
2374 bool DoModifyLines(bool (wxGridTableBase::*funcModify)(size_t, size_t),
2375 int pos, int num, bool updateLabels);
2376 // Append{Rows,Cols} is a bit different because of one less parameter
2377 bool DoAppendLines(bool (wxGridTableBase::*funcAppend)(size_t),
2378 int num, bool updateLabels);
2379
2380 DECLARE_DYNAMIC_CLASS( wxGrid )
2381 DECLARE_EVENT_TABLE()
2382 DECLARE_NO_COPY_CLASS(wxGrid)
2383 };
2384
2385 // ----------------------------------------------------------------------------
2386 // wxGridUpdateLocker prevents updates to a grid during its lifetime
2387 // ----------------------------------------------------------------------------
2388
2389 class WXDLLIMPEXP_ADV wxGridUpdateLocker
2390 {
2391 public:
2392 // if the pointer is NULL, Create() can be called later
2393 wxGridUpdateLocker(wxGrid *grid = NULL)
2394 {
2395 Init(grid);
2396 }
2397
2398 // can be called if ctor was used with a NULL pointer, must not be called
2399 // more than once
2400 void Create(wxGrid *grid)
2401 {
2402 wxASSERT_MSG( !m_grid, _T("shouldn't be called more than once") );
2403
2404 Init(grid);
2405 }
2406
2407 ~wxGridUpdateLocker()
2408 {
2409 if ( m_grid )
2410 m_grid->EndBatch();
2411 }
2412
2413 private:
2414 void Init(wxGrid *grid)
2415 {
2416 m_grid = grid;
2417 if ( m_grid )
2418 m_grid->BeginBatch();
2419 }
2420
2421 wxGrid *m_grid;
2422
2423 DECLARE_NO_COPY_CLASS(wxGridUpdateLocker)
2424 };
2425
2426 // ----------------------------------------------------------------------------
2427 // Grid event class and event types
2428 // ----------------------------------------------------------------------------
2429
2430 class WXDLLIMPEXP_ADV wxGridEvent : public wxNotifyEvent,
2431 public wxKeyboardState
2432 {
2433 public:
2434 wxGridEvent()
2435 : wxNotifyEvent()
2436 {
2437 Init(-1, -1, -1, -1, false);
2438 }
2439
2440 wxGridEvent(int id,
2441 wxEventType type,
2442 wxObject* obj,
2443 int row = -1, int col = -1,
2444 int x = -1, int y = -1,
2445 bool sel = true,
2446 const wxKeyboardState& kbd = wxKeyboardState())
2447 : wxNotifyEvent(type, id),
2448 wxKeyboardState(kbd)
2449 {
2450 Init(row, col, x, y, sel);
2451 SetEventObject(obj);
2452 }
2453
2454 // explicitly specifying inline allows gcc < 3.4 to
2455 // handle the deprecation attribute even in the constructor.
2456 wxDEPRECATED( inline
2457 wxGridEvent(int id,
2458 wxEventType type,
2459 wxObject* obj,
2460 int row, int col,
2461 int x, int y,
2462 bool sel,
2463 bool control,
2464 bool shift = false, bool alt = false, bool meta = false));
2465
2466 virtual int GetRow() { return m_row; }
2467 virtual int GetCol() { return m_col; }
2468 wxPoint GetPosition() { return wxPoint( m_x, m_y ); }
2469 bool Selecting() { return m_selecting; }
2470
2471 virtual wxEvent *Clone() const { return new wxGridEvent(*this); }
2472
2473 protected:
2474 int m_row;
2475 int m_col;
2476 int m_x;
2477 int m_y;
2478 bool m_selecting;
2479
2480 private:
2481 void Init(int row, int col, int x, int y, bool sel)
2482 {
2483 m_row = row;
2484 m_col = col;
2485 m_x = x;
2486 m_y = y;
2487 m_selecting = sel;
2488 }
2489
2490 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxGridEvent)
2491 };
2492
2493 class WXDLLIMPEXP_ADV wxGridSizeEvent : public wxNotifyEvent,
2494 public wxKeyboardState
2495 {
2496 public:
2497 wxGridSizeEvent()
2498 : wxNotifyEvent()
2499 {
2500 Init(-1, -1, -1);
2501 }
2502
2503 wxGridSizeEvent(int id,
2504 wxEventType type,
2505 wxObject* obj,
2506 int rowOrCol = -1,
2507 int x = -1, int y = -1,
2508 const wxKeyboardState& kbd = wxKeyboardState())
2509 : wxNotifyEvent(type, id),
2510 wxKeyboardState(kbd)
2511 {
2512 Init(rowOrCol, x, y);
2513
2514 SetEventObject(obj);
2515 }
2516
2517 wxDEPRECATED( inline
2518 wxGridSizeEvent(int id,
2519 wxEventType type,
2520 wxObject* obj,
2521 int rowOrCol,
2522 int x, int y,
2523 bool control,
2524 bool shift = false,
2525 bool alt = false,
2526 bool meta = false) );
2527
2528 int GetRowOrCol() { return m_rowOrCol; }
2529 wxPoint GetPosition() { return wxPoint( m_x, m_y ); }
2530
2531 virtual wxEvent *Clone() const { return new wxGridSizeEvent(*this); }
2532
2533 protected:
2534 int m_rowOrCol;
2535 int m_x;
2536 int m_y;
2537
2538 private:
2539 void Init(int rowOrCol, int x, int y)
2540 {
2541 m_rowOrCol = rowOrCol;
2542 m_x = x;
2543 m_y = y;
2544 }
2545
2546 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxGridSizeEvent)
2547 };
2548
2549
2550 class WXDLLIMPEXP_ADV wxGridRangeSelectEvent : public wxNotifyEvent,
2551 public wxKeyboardState
2552 {
2553 public:
2554 wxGridRangeSelectEvent()
2555 : wxNotifyEvent()
2556 {
2557 Init(wxGridNoCellCoords, wxGridNoCellCoords, false);
2558 }
2559
2560 wxGridRangeSelectEvent(int id,
2561 wxEventType type,
2562 wxObject* obj,
2563 const wxGridCellCoords& topLeft,
2564 const wxGridCellCoords& bottomRight,
2565 bool sel = true,
2566 const wxKeyboardState& kbd = wxKeyboardState())
2567 : wxNotifyEvent(type, id),
2568 wxKeyboardState(kbd)
2569 {
2570 Init(topLeft, bottomRight, sel);
2571
2572 SetEventObject(obj);
2573 }
2574
2575 wxDEPRECATED( inline
2576 wxGridRangeSelectEvent(int id,
2577 wxEventType type,
2578 wxObject* obj,
2579 const wxGridCellCoords& topLeft,
2580 const wxGridCellCoords& bottomRight,
2581 bool sel,
2582 bool control,
2583 bool shift = false,
2584 bool alt = false,
2585 bool meta = false) );
2586
2587 wxGridCellCoords GetTopLeftCoords() { return m_topLeft; }
2588 wxGridCellCoords GetBottomRightCoords() { return m_bottomRight; }
2589 int GetTopRow() { return m_topLeft.GetRow(); }
2590 int GetBottomRow() { return m_bottomRight.GetRow(); }
2591 int GetLeftCol() { return m_topLeft.GetCol(); }
2592 int GetRightCol() { return m_bottomRight.GetCol(); }
2593 bool Selecting() { return m_selecting; }
2594
2595 virtual wxEvent *Clone() const { return new wxGridRangeSelectEvent(*this); }
2596
2597 protected:
2598 void Init(const wxGridCellCoords& topLeft,
2599 const wxGridCellCoords& bottomRight,
2600 bool selecting)
2601 {
2602 m_topLeft = topLeft;
2603 m_bottomRight = bottomRight;
2604 m_selecting = selecting;
2605 }
2606
2607 wxGridCellCoords m_topLeft;
2608 wxGridCellCoords m_bottomRight;
2609 bool m_selecting;
2610
2611 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxGridRangeSelectEvent)
2612 };
2613
2614
2615 class WXDLLIMPEXP_ADV wxGridEditorCreatedEvent : public wxCommandEvent
2616 {
2617 public:
2618 wxGridEditorCreatedEvent()
2619 : wxCommandEvent()
2620 {
2621 m_row = 0;
2622 m_col = 0;
2623 m_ctrl = NULL;
2624 }
2625
2626 wxGridEditorCreatedEvent(int id, wxEventType type, wxObject* obj,
2627 int row, int col, wxControl* ctrl);
2628
2629 int GetRow() { return m_row; }
2630 int GetCol() { return m_col; }
2631 wxControl* GetControl() { return m_ctrl; }
2632 void SetRow(int row) { m_row = row; }
2633 void SetCol(int col) { m_col = col; }
2634 void SetControl(wxControl* ctrl) { m_ctrl = ctrl; }
2635
2636 virtual wxEvent *Clone() const { return new wxGridEditorCreatedEvent(*this); }
2637
2638 private:
2639 int m_row;
2640 int m_col;
2641 wxControl* m_ctrl;
2642
2643 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxGridEditorCreatedEvent)
2644 };
2645
2646
2647 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_GRID_CELL_LEFT_CLICK;
2648 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_GRID_CELL_RIGHT_CLICK;
2649 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_GRID_CELL_LEFT_DCLICK;
2650 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_GRID_CELL_RIGHT_DCLICK;
2651 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_GRID_LABEL_LEFT_CLICK;
2652 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_GRID_LABEL_RIGHT_CLICK;
2653 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_GRID_LABEL_LEFT_DCLICK;
2654 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_GRID_LABEL_RIGHT_DCLICK;
2655 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_GRID_ROW_SIZE;
2656 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_GRID_COL_SIZE;
2657 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_GRID_RANGE_SELECT;
2658 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_GRID_CELL_CHANGE;
2659 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_GRID_SELECT_CELL;
2660 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_GRID_EDITOR_SHOWN;
2661 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_GRID_EDITOR_HIDDEN;
2662 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_GRID_EDITOR_CREATED;
2663 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_GRID_CELL_BEGIN_DRAG;
2664 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_GRID_COL_MOVE;
2665 extern WXDLLIMPEXP_ADV const wxEventType wxEVT_GRID_COL_SORT;
2666
2667
2668 typedef void (wxEvtHandler::*wxGridEventFunction)(wxGridEvent&);
2669 typedef void (wxEvtHandler::*wxGridSizeEventFunction)(wxGridSizeEvent&);
2670 typedef void (wxEvtHandler::*wxGridRangeSelectEventFunction)(wxGridRangeSelectEvent&);
2671 typedef void (wxEvtHandler::*wxGridEditorCreatedEventFunction)(wxGridEditorCreatedEvent&);
2672
2673 #define wxGridEventHandler(func) \
2674 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxGridEventFunction, &func)
2675
2676 #define wxGridSizeEventHandler(func) \
2677 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxGridSizeEventFunction, &func)
2678
2679 #define wxGridRangeSelectEventHandler(func) \
2680 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxGridRangeSelectEventFunction, &func)
2681
2682 #define wxGridEditorCreatedEventHandler(func) \
2683 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxGridEditorCreatedEventFunction, &func)
2684
2685 #define wx__DECLARE_GRIDEVT(evt, id, fn) \
2686 wx__DECLARE_EVT1(wxEVT_GRID_ ## evt, id, wxGridEventHandler(fn))
2687
2688 #define wx__DECLARE_GRIDSIZEEVT(evt, id, fn) \
2689 wx__DECLARE_EVT1(wxEVT_GRID_ ## evt, id, wxGridSizeEventHandler(fn))
2690
2691 #define wx__DECLARE_GRIDRANGESELEVT(evt, id, fn) \
2692 wx__DECLARE_EVT1(wxEVT_GRID_ ## evt, id, wxGridRangeSelectEventHandler(fn))
2693
2694 #define wx__DECLARE_GRIDEDITOREVT(evt, id, fn) \
2695 wx__DECLARE_EVT1(wxEVT_GRID_ ## evt, id, wxGridEditorCreatedEventHandler(fn))
2696
2697 #define EVT_GRID_CMD_CELL_LEFT_CLICK(id, fn) wx__DECLARE_GRIDEVT(CELL_LEFT_CLICK, id, fn)
2698 #define EVT_GRID_CMD_CELL_RIGHT_CLICK(id, fn) wx__DECLARE_GRIDEVT(CELL_RIGHT_CLICK, id, fn)
2699 #define EVT_GRID_CMD_CELL_LEFT_DCLICK(id, fn) wx__DECLARE_GRIDEVT(CELL_LEFT_DCLICK, id, fn)
2700 #define EVT_GRID_CMD_CELL_RIGHT_DCLICK(id, fn) wx__DECLARE_GRIDEVT(CELL_RIGHT_DCLICK, id, fn)
2701 #define EVT_GRID_CMD_LABEL_LEFT_CLICK(id, fn) wx__DECLARE_GRIDEVT(LABEL_LEFT_CLICK, id, fn)
2702 #define EVT_GRID_CMD_LABEL_RIGHT_CLICK(id, fn) wx__DECLARE_GRIDEVT(LABEL_RIGHT_CLICK, id, fn)
2703 #define EVT_GRID_CMD_LABEL_LEFT_DCLICK(id, fn) wx__DECLARE_GRIDEVT(LABEL_LEFT_DCLICK, id, fn)
2704 #define EVT_GRID_CMD_LABEL_RIGHT_DCLICK(id, fn) wx__DECLARE_GRIDEVT(LABEL_RIGHT_DCLICK, id, fn)
2705 #define EVT_GRID_CMD_ROW_SIZE(id, fn) wx__DECLARE_GRIDSIZEEVT(ROW_SIZE, id, fn)
2706 #define EVT_GRID_CMD_COL_SIZE(id, fn) wx__DECLARE_GRIDSIZEEVT(COL_SIZE, id, fn)
2707 #define EVT_GRID_CMD_COL_MOVE(id, fn) wx__DECLARE_GRIDEVT(COL_MOVE, id, fn)
2708 #define EVT_GRID_CMD_COL_SORT(id, fn) wx__DECLARE_GRIDEVT(COL_SORT, id, fn)
2709 #define EVT_GRID_CMD_RANGE_SELECT(id, fn) wx__DECLARE_GRIDRANGESELEVT(RANGE_SELECT, id, fn)
2710 #define EVT_GRID_CMD_CELL_CHANGE(id, fn) wx__DECLARE_GRIDEVT(CELL_CHANGE, id, fn)
2711 #define EVT_GRID_CMD_SELECT_CELL(id, fn) wx__DECLARE_GRIDEVT(SELECT_CELL, id, fn)
2712 #define EVT_GRID_CMD_EDITOR_SHOWN(id, fn) wx__DECLARE_GRIDEVT(EDITOR_SHOWN, id, fn)
2713 #define EVT_GRID_CMD_EDITOR_HIDDEN(id, fn) wx__DECLARE_GRIDEVT(EDITOR_HIDDEN, id, fn)
2714 #define EVT_GRID_CMD_EDITOR_CREATED(id, fn) wx__DECLARE_GRIDEDITOREVT(EDITOR_CREATED, id, fn)
2715 #define EVT_GRID_CMD_CELL_BEGIN_DRAG(id, fn) wx__DECLARE_GRIDEVT(CELL_BEGIN_DRAG, id, fn)
2716
2717 // same as above but for any id (exists mainly for backwards compatibility but
2718 // then it's also true that you rarely have multiple grid in the same window)
2719 #define EVT_GRID_CELL_LEFT_CLICK(fn) EVT_GRID_CMD_CELL_LEFT_CLICK(wxID_ANY, fn)
2720 #define EVT_GRID_CELL_RIGHT_CLICK(fn) EVT_GRID_CMD_CELL_RIGHT_CLICK(wxID_ANY, fn)
2721 #define EVT_GRID_CELL_LEFT_DCLICK(fn) EVT_GRID_CMD_CELL_LEFT_DCLICK(wxID_ANY, fn)
2722 #define EVT_GRID_CELL_RIGHT_DCLICK(fn) EVT_GRID_CMD_CELL_RIGHT_DCLICK(wxID_ANY, fn)
2723 #define EVT_GRID_LABEL_LEFT_CLICK(fn) EVT_GRID_CMD_LABEL_LEFT_CLICK(wxID_ANY, fn)
2724 #define EVT_GRID_LABEL_RIGHT_CLICK(fn) EVT_GRID_CMD_LABEL_RIGHT_CLICK(wxID_ANY, fn)
2725 #define EVT_GRID_LABEL_LEFT_DCLICK(fn) EVT_GRID_CMD_LABEL_LEFT_DCLICK(wxID_ANY, fn)
2726 #define EVT_GRID_LABEL_RIGHT_DCLICK(fn) EVT_GRID_CMD_LABEL_RIGHT_DCLICK(wxID_ANY, fn)
2727 #define EVT_GRID_ROW_SIZE(fn) EVT_GRID_CMD_ROW_SIZE(wxID_ANY, fn)
2728 #define EVT_GRID_COL_SIZE(fn) EVT_GRID_CMD_COL_SIZE(wxID_ANY, fn)
2729 #define EVT_GRID_COL_MOVE(fn) EVT_GRID_CMD_COL_MOVE(wxID_ANY, fn)
2730 #define EVT_GRID_COL_SORT(fn) EVT_GRID_CMD_COL_SORT(wxID_ANY, fn)
2731 #define EVT_GRID_RANGE_SELECT(fn) EVT_GRID_CMD_RANGE_SELECT(wxID_ANY, fn)
2732 #define EVT_GRID_CELL_CHANGE(fn) EVT_GRID_CMD_CELL_CHANGE(wxID_ANY, fn)
2733 #define EVT_GRID_SELECT_CELL(fn) EVT_GRID_CMD_SELECT_CELL(wxID_ANY, fn)
2734 #define EVT_GRID_EDITOR_SHOWN(fn) EVT_GRID_CMD_EDITOR_SHOWN(wxID_ANY, fn)
2735 #define EVT_GRID_EDITOR_HIDDEN(fn) EVT_GRID_CMD_EDITOR_HIDDEN(wxID_ANY, fn)
2736 #define EVT_GRID_EDITOR_CREATED(fn) EVT_GRID_CMD_EDITOR_CREATED(wxID_ANY, fn)
2737 #define EVT_GRID_CELL_BEGIN_DRAG(fn) EVT_GRID_CMD_CELL_BEGIN_DRAG(wxID_ANY, fn)
2738
2739 #if 0 // TODO: implement these ? others ?
2740
2741 extern const int wxEVT_GRID_CREATE_CELL;
2742 extern const int wxEVT_GRID_CHANGE_LABELS;
2743 extern const int wxEVT_GRID_CHANGE_SEL_LABEL;
2744
2745 #define EVT_GRID_CREATE_CELL(fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_CREATE_CELL, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxGridEventFunction, &fn ), NULL ),
2746 #define EVT_GRID_CHANGE_LABELS(fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_CHANGE_LABELS, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxGridEventFunction, &fn ), NULL ),
2747 #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 ),
2748
2749 #endif
2750
2751 #endif // wxUSE_GRID
2752 #endif // _WX_GENERIC_GRID_H_