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