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