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