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