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