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