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