]> git.saurik.com Git - wxWidgets.git/blame - include/wx/generic/grid.h
added ping location for IRIX
[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; }
3100c3db 699 bool HasSize() const { return m_sizeRows != 1 || m_sizeCols != 1; }
b99be8fb 700
2796cce3
RD
701 const wxColour& GetTextColour() const;
702 const wxColour& GetBackgroundColour() const;
703 const wxFont& GetFont() const;
704 void GetAlignment(int *hAlign, int *vAlign) const;
27f35b66 705 void GetSize(int *num_rows, int *num_cols) const;
ef5df12b 706 bool GetOverflow() const
b63fce94 707 { return m_overflow != SingleCell; }
28a77bc4
RD
708 wxGridCellRenderer *GetRenderer(wxGrid* grid, int row, int col) const;
709 wxGridCellEditor *GetEditor(wxGrid* grid, int row, int col) const;
b99be8fb 710
19d7140e
VZ
711 bool IsReadOnly() const { return m_isReadOnly == wxGridCellAttr::ReadOnly; }
712
713 wxAttrKind GetKind() { return m_attrkind; }
283b7808 714
2796cce3 715 void SetDefAttr(wxGridCellAttr* defAttr) { m_defGridAttr = defAttr; }
ab79958a 716
338d1deb
VZ
717protected:
718 // the dtor is private because only DecRef() can delete us
719 virtual ~wxGridCellAttr()
720 {
721 wxSafeDecRef(m_renderer);
722 wxSafeDecRef(m_editor);
723 }
724
b99be8fb 725private:
19d7140e
VZ
726 enum wxAttrReadMode
727 {
728 Unset = -1,
729 ReadWrite,
730 ReadOnly
30bc4a8f 731 };
19d7140e 732
b63fce94
RD
733 enum wxAttrOverflowMode
734 {
735 UnsetOverflow = -1,
736 Overflow,
737 SingleCell
738 };
739
2e9a6788 740 // the common part of all ctors
1df4050d 741 void Init(wxGridCellAttr *attrDefault = NULL);
2e9a6788 742
2e9a6788
VZ
743
744 // the ref count - when it goes to 0, we die
745 size_t m_nRef;
746
b99be8fb
VZ
747 wxColour m_colText,
748 m_colBack;
749 wxFont m_font;
750 int m_hAlign,
751 m_vAlign;
27f35b66
SN
752 int m_sizeRows,
753 m_sizeCols;
ef5df12b
RD
754
755 wxAttrOverflowMode m_overflow;
2e9a6788 756
07296f0b
RD
757 wxGridCellRenderer* m_renderer;
758 wxGridCellEditor* m_editor;
759 wxGridCellAttr* m_defGridAttr;
ab79958a 760
19d7140e
VZ
761 wxAttrReadMode m_isReadOnly;
762
763 wxAttrKind m_attrkind;
283b7808 764
a68c1246 765 // use Clone() instead
7ef4c90b 766 DECLARE_NO_COPY_CLASS(wxGridCellAttr)
a68c1246 767
2e9a6788
VZ
768 // suppress the stupid gcc warning about the class having private dtor and
769 // no friends
770 friend class wxGridCellAttrDummyFriend;
b99be8fb
VZ
771};
772
773// ----------------------------------------------------------------------------
774// wxGridCellAttrProvider: class used by wxGridTableBase to retrieve/store the
775// cell attributes.
776// ----------------------------------------------------------------------------
777
778// implementation note: we separate it from wxGridTableBase because we wish to
779// avoid deriving a new table class if possible, and sometimes it will be
780// enough to just derive another wxGridCellAttrProvider instead
758cbedf
VZ
781//
782// the default implementation is reasonably efficient for the generic case,
783// but you might still wish to implement your own for some specific situations
784// if you have performance problems with the stock one
12f190b0 785class WXDLLIMPEXP_ADV wxGridCellAttrProvider : public wxClientDataContainer
b99be8fb
VZ
786{
787public:
788 wxGridCellAttrProvider();
789 virtual ~wxGridCellAttrProvider();
790
2e9a6788 791 // DecRef() must be called on the returned pointer
19d7140e
VZ
792 virtual wxGridCellAttr *GetAttr(int row, int col,
793 wxGridCellAttr::wxAttrKind kind ) const;
2e9a6788 794
758cbedf
VZ
795 // all these functions take ownership of the pointer, don't call DecRef()
796 // on it
2e9a6788 797 virtual void SetAttr(wxGridCellAttr *attr, int row, int col);
758cbedf
VZ
798 virtual void SetRowAttr(wxGridCellAttr *attr, int row);
799 virtual void SetColAttr(wxGridCellAttr *attr, int col);
d1c0b4f9
VZ
800
801 // these functions must be called whenever some rows/cols are deleted
802 // because the internal data must be updated then
4d60017a
SN
803 void UpdateAttrRows( size_t pos, int numRows );
804 void UpdateAttrCols( size_t pos, int numCols );
b99be8fb
VZ
805
806private:
807 void InitData();
808
809 wxGridCellAttrProviderData *m_data;
22f3361e
VZ
810
811 DECLARE_NO_COPY_CLASS(wxGridCellAttrProvider)
b99be8fb 812};
f85afd4e
MB
813
814//////////////////////////////////////////////////////////////////////
815//
816// Grid table classes
817//
818//////////////////////////////////////////////////////////////////////
819
820
12f190b0 821class WXDLLIMPEXP_ADV wxGridTableBase : public wxObject, public wxClientDataContainer
f85afd4e 822{
60ff3b99 823public:
f85afd4e
MB
824 wxGridTableBase();
825 virtual ~wxGridTableBase();
826
827 // You must override these functions in a derived table class
828 //
e32352cf
SN
829 virtual int GetNumberRows() = 0;
830 virtual int GetNumberCols() = 0;
f85afd4e 831 virtual bool IsEmptyCell( int row, int col ) = 0;
f2d76237
RD
832 virtual wxString GetValue( int row, int col ) = 0;
833 virtual void SetValue( int row, int col, const wxString& value ) = 0;
834
835 // Data type determination and value access
836 virtual wxString GetTypeName( int row, int col );
837 virtual bool CanGetValueAs( int row, int col, const wxString& typeName );
838 virtual bool CanSetValueAs( int row, int col, const wxString& typeName );
839
840 virtual long GetValueAsLong( int row, int col );
841 virtual double GetValueAsDouble( int row, int col );
842 virtual bool GetValueAsBool( int row, int col );
843
844 virtual void SetValueAsLong( int row, int col, long value );
845 virtual void SetValueAsDouble( int row, int col, double value );
846 virtual void SetValueAsBool( int row, int col, bool value );
847
848 // For user defined types
849 virtual void* GetValueAsCustom( int row, int col, const wxString& typeName );
850 virtual void SetValueAsCustom( int row, int col, const wxString& typeName, void* value );
851
60ff3b99 852
f85afd4e
MB
853 // Overriding these is optional
854 //
855 virtual void SetView( wxGrid *grid ) { m_view = grid; }
856 virtual wxGrid * GetView() const { return m_view; }
857
858 virtual void Clear() {}
859 virtual bool InsertRows( size_t pos = 0, size_t numRows = 1 );
860 virtual bool AppendRows( size_t numRows = 1 );
861 virtual bool DeleteRows( size_t pos = 0, size_t numRows = 1 );
862 virtual bool InsertCols( size_t pos = 0, size_t numCols = 1 );
863 virtual bool AppendCols( size_t numCols = 1 );
864 virtual bool DeleteCols( size_t pos = 0, size_t numCols = 1 );
865
866 virtual wxString GetRowLabelValue( int row );
867 virtual wxString GetColLabelValue( int col );
af111fc3
JS
868 virtual void SetRowLabelValue( int WXUNUSED(row), const wxString& ) {}
869 virtual void SetColLabelValue( int WXUNUSED(col), const wxString& ) {}
60ff3b99 870
b99be8fb
VZ
871 // Attribute handling
872 //
873
874 // give us the attr provider to use - we take ownership of the pointer
875 void SetAttrProvider(wxGridCellAttrProvider *attrProvider);
876
877 // get the currently used attr provider (may be NULL)
878 wxGridCellAttrProvider *GetAttrProvider() const { return m_attrProvider; }
879
f2d76237
RD
880 // Does this table allow attributes? Default implementation creates
881 // a wxGridCellAttrProvider if necessary.
882 virtual bool CanHaveAttributes();
883
b99be8fb 884 // by default forwarded to wxGridCellAttrProvider if any. May be
f2d76237 885 // overridden to handle attributes directly in the table.
19d7140e
VZ
886 virtual wxGridCellAttr *GetAttr( int row, int col,
887 wxGridCellAttr::wxAttrKind kind );
888
b99be8fb 889
758cbedf
VZ
890 // these functions take ownership of the pointer
891 virtual void SetAttr(wxGridCellAttr* attr, int row, int col);
892 virtual void SetRowAttr(wxGridCellAttr *attr, int row);
893 virtual void SetColAttr(wxGridCellAttr *attr, int col);
b99be8fb 894
60ff3b99
VZ
895private:
896 wxGrid * m_view;
b99be8fb 897 wxGridCellAttrProvider *m_attrProvider;
60ff3b99 898
3839f37e 899 DECLARE_ABSTRACT_CLASS(wxGridTableBase)
22f3361e 900 DECLARE_NO_COPY_CLASS(wxGridTableBase)
f85afd4e
MB
901};
902
903
b99be8fb
VZ
904// ----------------------------------------------------------------------------
905// wxGridTableMessage
906// ----------------------------------------------------------------------------
f85afd4e
MB
907
908// IDs for messages sent from grid table to view
909//
60ff3b99
VZ
910enum wxGridTableRequest
911{
f85afd4e
MB
912 wxGRIDTABLE_REQUEST_VIEW_GET_VALUES = 2000,
913 wxGRIDTABLE_REQUEST_VIEW_SEND_VALUES,
914 wxGRIDTABLE_NOTIFY_ROWS_INSERTED,
915 wxGRIDTABLE_NOTIFY_ROWS_APPENDED,
916 wxGRIDTABLE_NOTIFY_ROWS_DELETED,
917 wxGRIDTABLE_NOTIFY_COLS_INSERTED,
918 wxGRIDTABLE_NOTIFY_COLS_APPENDED,
919 wxGRIDTABLE_NOTIFY_COLS_DELETED
920};
921
12f190b0 922class WXDLLIMPEXP_ADV wxGridTableMessage
f85afd4e 923{
60ff3b99 924public:
f85afd4e
MB
925 wxGridTableMessage();
926 wxGridTableMessage( wxGridTableBase *table, int id,
927 int comInt1 = -1,
928 int comInt2 = -1 );
929
930 void SetTableObject( wxGridTableBase *table ) { m_table = table; }
931 wxGridTableBase * GetTableObject() const { return m_table; }
932 void SetId( int id ) { m_id = id; }
933 int GetId() { return m_id; }
934 void SetCommandInt( int comInt1 ) { m_comInt1 = comInt1; }
935 int GetCommandInt() { return m_comInt1; }
936 void SetCommandInt2( int comInt2 ) { m_comInt2 = comInt2; }
60ff3b99
VZ
937 int GetCommandInt2() { return m_comInt2; }
938
939private:
940 wxGridTableBase *m_table;
941 int m_id;
942 int m_comInt1;
943 int m_comInt2;
22f3361e
VZ
944
945 DECLARE_NO_COPY_CLASS(wxGridTableMessage)
f85afd4e
MB
946};
947
948
949
950// ------ wxGridStringArray
951// A 2-dimensional array of strings for data values
952//
953
160ba750
VS
954WX_DECLARE_OBJARRAY_WITH_DECL(wxArrayString, wxGridStringArray,
955 class WXDLLIMPEXP_ADV);
2d66e025 956
f85afd4e
MB
957
958
959// ------ wxGridStringTable
960//
961// Simplest type of data table for a grid for small tables of strings
962// that are stored in memory
963//
964
12f190b0 965class WXDLLIMPEXP_ADV wxGridStringTable : public wxGridTableBase
f85afd4e 966{
60ff3b99 967public:
f85afd4e
MB
968 wxGridStringTable();
969 wxGridStringTable( int numRows, int numCols );
e669d97a 970 virtual ~wxGridStringTable();
f85afd4e
MB
971
972 // these are pure virtual in wxGridTableBase
973 //
e32352cf
SN
974 int GetNumberRows();
975 int GetNumberCols();
f85afd4e
MB
976 wxString GetValue( int row, int col );
977 void SetValue( int row, int col, const wxString& s );
978 bool IsEmptyCell( int row, int col );
60ff3b99 979
f85afd4e
MB
980 // overridden functions from wxGridTableBase
981 //
982 void Clear();
983 bool InsertRows( size_t pos = 0, size_t numRows = 1 );
984 bool AppendRows( size_t numRows = 1 );
985 bool DeleteRows( size_t pos = 0, size_t numRows = 1 );
986 bool InsertCols( size_t pos = 0, size_t numCols = 1 );
987 bool AppendCols( size_t numCols = 1 );
988 bool DeleteCols( size_t pos = 0, size_t numCols = 1 );
989
990 void SetRowLabelValue( int row, const wxString& );
991 void SetColLabelValue( int col, const wxString& );
992 wxString GetRowLabelValue( int row );
993 wxString GetColLabelValue( int col );
60ff3b99
VZ
994
995private:
996 wxGridStringArray m_data;
997
998 // These only get used if you set your own labels, otherwise the
999 // GetRow/ColLabelValue functions return wxGridTableBase defaults
1000 //
1001 wxArrayString m_rowLabels;
1002 wxArrayString m_colLabels;
1003
fc7a2a60 1004 DECLARE_DYNAMIC_CLASS_NO_COPY( wxGridStringTable )
f85afd4e
MB
1005};
1006
1007
1008
43947979 1009// ============================================================================
f85afd4e 1010// Grid view classes
43947979
VZ
1011// ============================================================================
1012
1013// ----------------------------------------------------------------------------
1014// wxGridCellCoords: location of a cell in the grid
1015// ----------------------------------------------------------------------------
f85afd4e 1016
12f190b0 1017class WXDLLIMPEXP_ADV wxGridCellCoords
f85afd4e 1018{
60ff3b99 1019public:
f85afd4e
MB
1020 wxGridCellCoords() { m_row = m_col = -1; }
1021 wxGridCellCoords( int r, int c ) { m_row = r; m_col = c; }
1022
1023 // default copy ctor is ok
1024
e32352cf
SN
1025 int GetRow() const { return m_row; }
1026 void SetRow( int n ) { m_row = n; }
1027 int GetCol() const { return m_col; }
1028 void SetCol( int n ) { m_col = n; }
1029 void Set( int row, int col ) { m_row = row; m_col = col; }
60ff3b99 1030
f85afd4e
MB
1031 wxGridCellCoords& operator=( const wxGridCellCoords& other )
1032 {
1033 if ( &other != this )
1034 {
1035 m_row=other.m_row;
1036 m_col=other.m_col;
1037 }
1038 return *this;
1039 }
1040
508011ce 1041 bool operator==( const wxGridCellCoords& other ) const
f85afd4e
MB
1042 {
1043 return (m_row == other.m_row && m_col == other.m_col);
1044 }
1045
508011ce 1046 bool operator!=( const wxGridCellCoords& other ) const
f85afd4e
MB
1047 {
1048 return (m_row != other.m_row || m_col != other.m_col);
1049 }
1050
508011ce 1051 bool operator!() const
f85afd4e
MB
1052 {
1053 return (m_row == -1 && m_col == -1 );
1054 }
60ff3b99
VZ
1055
1056private:
e32352cf
SN
1057 int m_row;
1058 int m_col;
f85afd4e
MB
1059};
1060
1061
1062// For comparisons...
1063//
12f190b0
VS
1064extern WXDLLIMPEXP_ADV wxGridCellCoords wxGridNoCellCoords;
1065extern WXDLLIMPEXP_ADV wxRect wxGridNoCellRect;
f85afd4e 1066
2d66e025
MB
1067// An array of cell coords...
1068//
160ba750
VS
1069WX_DECLARE_OBJARRAY_WITH_DECL(wxGridCellCoords, wxGridCellCoordsArray,
1070 class WXDLLIMPEXP_ADV);
2d66e025 1071
b99be8fb
VZ
1072// ----------------------------------------------------------------------------
1073// wxGrid
1074// ----------------------------------------------------------------------------
f85afd4e 1075
12f190b0 1076class WXDLLIMPEXP_ADV wxGrid : public wxScrolledWindow
60ff3b99
VZ
1077{
1078public:
986a98c6
SC
1079 wxGrid() ;
1080
1081 wxGrid( wxWindow *parent,
1082 wxWindowID id,
1083 const wxPoint& pos = wxDefaultPosition,
1084 const wxSize& size = wxDefaultSize,
1085 long style = wxWANTS_CHARS,
1086 const wxString& name = wxPanelNameStr );
60ff3b99 1087
986a98c6 1088 bool Create( wxWindow *parent,
f85afd4e
MB
1089 wxWindowID id,
1090 const wxPoint& pos = wxDefaultPosition,
1091 const wxSize& size = wxDefaultSize,
ebd773c6 1092 long style = wxWANTS_CHARS,
2d66e025
MB
1093 const wxString& name = wxPanelNameStr );
1094
e669d97a 1095 virtual ~wxGrid();
f85afd4e 1096
b5808881
SN
1097 enum wxGridSelectionModes {wxGridSelectCells,
1098 wxGridSelectRows,
1099 wxGridSelectColumns};
1100
1101 bool CreateGrid( int numRows, int numCols,
1102 wxGrid::wxGridSelectionModes selmode =
1103 wxGrid::wxGridSelectCells );
2d66e025 1104
f1567cdd 1105 void SetSelectionMode(wxGrid::wxGridSelectionModes selmode);
aa5b8857 1106 wxGrid::wxGridSelectionModes GetSelectionMode() const;
60ff3b99 1107
2d66e025
MB
1108 // ------ grid dimensions
1109 //
1110 int GetNumberRows() { return m_numRows; }
1111 int GetNumberCols() { return m_numCols; }
1112
60ff3b99 1113
2d66e025
MB
1114 // ------ display update functions
1115 //
d10f4bf9 1116 wxArrayInt CalcRowLabelsExposed( const wxRegion& reg );
8fb66724 1117
d10f4bf9
VZ
1118 wxArrayInt CalcColLabelsExposed( const wxRegion& reg );
1119 wxGridCellCoordsArray CalcCellsExposed( const wxRegion& reg );
60ff3b99 1120
2d66e025 1121
2d66e025
MB
1122 // ------ event handlers
1123 //
1124 void ProcessRowLabelMouseEvent( wxMouseEvent& event );
1125 void ProcessColLabelMouseEvent( wxMouseEvent& event );
1126 void ProcessCornerLabelMouseEvent( wxMouseEvent& event );
60ff3b99 1127 void ProcessGridCellMouseEvent( wxMouseEvent& event );
2d66e025 1128 bool ProcessTableMessage( wxGridTableMessage& );
f85afd4e 1129
6d004f67
MB
1130 void DoEndDragResizeRow();
1131 void DoEndDragResizeCol();
60ff3b99 1132
f85afd4e 1133 wxGridTableBase * GetTable() const { return m_table; }
ca65c044 1134 bool SetTable( wxGridTableBase *table, bool takeOwnership = false,
5c8fc7c1
SN
1135 wxGrid::wxGridSelectionModes selmode =
1136 wxGrid::wxGridSelectCells );
f85afd4e
MB
1137
1138 void ClearGrid();
ca65c044
WS
1139 bool InsertRows( int pos = 0, int numRows = 1, bool updateLabels = true );
1140 bool AppendRows( int numRows = 1, bool updateLabels = true );
1141 bool DeleteRows( int pos = 0, int numRows = 1, bool updateLabels = true );
1142 bool InsertCols( int pos = 0, int numCols = 1, bool updateLabels = true );
1143 bool AppendCols( int numCols = 1, bool updateLabels = true );
1144 bool DeleteCols( int pos = 0, int numCols = 1, bool updateLabels = true );
f85afd4e 1145
d10f4bf9 1146 void DrawGridCellArea( wxDC& dc , const wxGridCellCoordsArray& cells );
7c8a8ad5 1147 void DrawGridSpace( wxDC& dc );
2d66e025 1148 void DrawCellBorder( wxDC& dc, const wxGridCellCoords& );
4634a5d6 1149 void DrawAllGridLines( wxDC& dc, const wxRegion & reg );
2d66e025 1150 void DrawCell( wxDC& dc, const wxGridCellCoords& );
d10f4bf9 1151 void DrawHighlight(wxDC& dc, const wxGridCellCoordsArray& cells);
d16c04bb
VZ
1152
1153 // this function is called when the current cell highlight must be redrawn
1154 // and may be overridden by the user
1155 virtual void DrawCellHighlight( wxDC& dc, const wxGridCellAttr *attr );
1f1ce288 1156
6914b57a
JS
1157 virtual void DrawRowLabels( wxDC& dc, const wxArrayInt& rows );
1158 virtual void DrawRowLabel( wxDC& dc, int row );
8fb66724 1159
6914b57a
JS
1160 virtual void DrawColLabels( wxDC& dc, const wxArrayInt& cols );
1161 virtual void DrawColLabel( wxDC& dc, int col );
60ff3b99 1162
f85afd4e 1163
2d66e025 1164 // ------ Cell text drawing functions
f85afd4e 1165 //
2d66e025 1166 void DrawTextRectangle( wxDC& dc, const wxString&, const wxRect&,
4c7277db 1167 int horizontalAlignment = wxALIGN_LEFT,
d43851f7
JS
1168 int verticalAlignment = wxALIGN_TOP,
1169 int textOrientation = wxHORIZONTAL );
30bc4a8f 1170
d10f4bf9
VZ
1171 void DrawTextRectangle( wxDC& dc, const wxArrayString& lines, const wxRect&,
1172 int horizontalAlignment = wxALIGN_LEFT,
d43851f7
JS
1173 int verticalAlignment = wxALIGN_TOP,
1174 int textOrientation = wxHORIZONTAL );
d10f4bf9 1175
f85afd4e 1176
2d66e025
MB
1177 // Split a string containing newline chararcters into an array of
1178 // strings and return the number of lines
1179 //
1180 void StringToLines( const wxString& value, wxArrayString& lines );
60ff3b99 1181
2d66e025 1182 void GetTextBoxSize( wxDC& dc,
d10f4bf9 1183 const wxArrayString& lines,
2d66e025 1184 long *width, long *height );
60ff3b99 1185
2d66e025 1186
f85afd4e
MB
1187 // ------
1188 // Code that does a lot of grid modification can be enclosed
1189 // between BeginBatch() and EndBatch() calls to avoid screen
1190 // flicker
1191 //
1192 void BeginBatch() { m_batchCount++; }
f6bcfd97
BP
1193 void EndBatch();
1194
f85afd4e
MB
1195 int GetBatchCount() { return m_batchCount; }
1196
ca65c044 1197 virtual void Refresh(bool eraseb = true,
b7282ad2 1198 const wxRect* rect = (const wxRect *) NULL);
27f35b66 1199
d8232393
MB
1200 // Use this, rather than wxWindow::Refresh(), to force an
1201 // immediate repainting of the grid. Has no effect if you are
1202 // already inside a BeginBatch / EndBatch block.
1203 //
1204 // This function is necessary because wxGrid has a minimal OnPaint()
1205 // handler to reduce screen flicker.
1206 //
1207 void ForceRefresh();
d2520c85 1208
2d66e025
MB
1209
1210 // ------ edit control functions
1211 //
84035150 1212 bool IsEditable() const { return m_editable; }
2d66e025
MB
1213 void EnableEditing( bool edit );
1214
ca65c044
WS
1215 void EnableCellEditControl( bool enable = true );
1216 void DisableCellEditControl() { EnableCellEditControl(false); }
b54ba671
VZ
1217 bool CanEnableCellControl() const;
1218 bool IsCellEditControlEnabled() const;
f6bcfd97 1219 bool IsCellEditControlShown() const;
2d66e025 1220
b54ba671 1221 bool IsCurrentCellReadOnly() const;
2d66e025 1222
2d66e025
MB
1223 void ShowCellEditControl();
1224 void HideCellEditControl();
2d66e025
MB
1225 void SaveEditControlValue();
1226
60ff3b99 1227
2d66e025 1228 // ------ grid location functions
60ff3b99 1229 // Note that all of these functions work with the logical coordinates of
2d66e025
MB
1230 // grid cells and labels so you will need to convert from device
1231 // coordinates for mouse events etc.
1232 //
1233 void XYToCell( int x, int y, wxGridCellCoords& );
1234 int YToRow( int y );
1235 int XToCol( int x );
1236
1237 int YToEdgeOfRow( int y );
1238 int XToEdgeOfCol( int x );
1239
1240 wxRect CellToRect( int row, int col );
1241 wxRect CellToRect( const wxGridCellCoords& coords )
1242 { return CellToRect( coords.GetRow(), coords.GetCol() ); }
1243
1244 int GetGridCursorRow() { return m_currentCellCoords.GetRow(); }
1245 int GetGridCursorCol() { return m_currentCellCoords.GetCol(); }
60ff3b99 1246
2d66e025
MB
1247 // check to see if a cell is either wholly visible (the default arg) or
1248 // at least partially visible in the grid window
1249 //
ca65c044
WS
1250 bool IsVisible( int row, int col, bool wholeCellVisible = true );
1251 bool IsVisible( const wxGridCellCoords& coords, bool wholeCellVisible = true )
2d66e025
MB
1252 { return IsVisible( coords.GetRow(), coords.GetCol(), wholeCellVisible ); }
1253 void MakeCellVisible( int row, int col );
1254 void MakeCellVisible( const wxGridCellCoords& coords )
1255 { MakeCellVisible( coords.GetRow(), coords.GetCol() ); }
1256
60ff3b99 1257
2d66e025
MB
1258 // ------ grid cursor movement functions
1259 //
dfaf42d2 1260 void SetGridCursor( int row, int col )
b27f2615 1261 { SetCurrentCell( wxGridCellCoords(row, col) ); }
dfaf42d2 1262
5c8fc7c1
SN
1263 bool MoveCursorUp( bool expandSelection );
1264 bool MoveCursorDown( bool expandSelection );
1265 bool MoveCursorLeft( bool expandSelection );
1266 bool MoveCursorRight( bool expandSelection );
2d66e025
MB
1267 bool MovePageDown();
1268 bool MovePageUp();
5c8fc7c1
SN
1269 bool MoveCursorUpBlock( bool expandSelection );
1270 bool MoveCursorDownBlock( bool expandSelection );
1271 bool MoveCursorLeftBlock( bool expandSelection );
1272 bool MoveCursorRightBlock( bool expandSelection );
2d66e025 1273
60ff3b99 1274
f85afd4e
MB
1275 // ------ label and gridline formatting
1276 //
1277 int GetDefaultRowLabelSize() { return WXGRID_DEFAULT_ROW_LABEL_WIDTH; }
1278 int GetRowLabelSize() { return m_rowLabelWidth; }
60ff3b99 1279 int GetDefaultColLabelSize() { return WXGRID_DEFAULT_COL_LABEL_HEIGHT; }
f85afd4e
MB
1280 int GetColLabelSize() { return m_colLabelHeight; }
1281 wxColour GetLabelBackgroundColour() { return m_labelBackgroundColour; }
1282 wxColour GetLabelTextColour() { return m_labelTextColour; }
1283 wxFont GetLabelFont() { return m_labelFont; }
1284 void GetRowLabelAlignment( int *horiz, int *vert );
1285 void GetColLabelAlignment( int *horiz, int *vert );
d43851f7 1286 int GetColLabelTextOrientation();
f85afd4e
MB
1287 wxString GetRowLabelValue( int row );
1288 wxString GetColLabelValue( int col );
1289 wxColour GetGridLineColour() { return m_gridLineColour; }
f6bcfd97 1290 wxColour GetCellHighlightColour() { return m_cellHighlightColour; }
d2520c85
RD
1291 int GetCellHighlightPenWidth() { return m_cellHighlightPenWidth; }
1292 int GetCellHighlightROPenWidth() { return m_cellHighlightROPenWidth; }
f85afd4e 1293
ab79958a 1294 void SetRowLabelSize( int width );
f85afd4e
MB
1295 void SetColLabelSize( int height );
1296 void SetLabelBackgroundColour( const wxColour& );
1297 void SetLabelTextColour( const wxColour& );
1298 void SetLabelFont( const wxFont& );
1299 void SetRowLabelAlignment( int horiz, int vert );
1300 void SetColLabelAlignment( int horiz, int vert );
d43851f7 1301 void SetColLabelTextOrientation( int textOrientation );
f85afd4e
MB
1302 void SetRowLabelValue( int row, const wxString& );
1303 void SetColLabelValue( int col, const wxString& );
1304 void SetGridLineColour( const wxColour& );
f6bcfd97 1305 void SetCellHighlightColour( const wxColour& );
d2520c85
RD
1306 void SetCellHighlightPenWidth(int width);
1307 void SetCellHighlightROPenWidth(int width);
28a77bc4 1308
ca65c044
WS
1309 void EnableDragRowSize( bool enable = true );
1310 void DisableDragRowSize() { EnableDragRowSize( false ); }
6e8524b1 1311 bool CanDragRowSize() { return m_canDragRowSize; }
ca65c044
WS
1312 void EnableDragColSize( bool enable = true );
1313 void DisableDragColSize() { EnableDragColSize( false ); }
6e8524b1 1314 bool CanDragColSize() { return m_canDragColSize; }
ca65c044
WS
1315 void EnableDragGridSize(bool enable = true);
1316 void DisableDragGridSize() { EnableDragGridSize(false); }
4cfa5de6
RD
1317 bool CanDragGridSize() { return m_canDragGridSize; }
1318
79dbea21
RD
1319 void EnableDragCell( bool enable = true );
1320 void DisableDragCell() { EnableDragCell( false ); }
1321 bool CanDragCell() { return m_canDragCell; }
1322
27f35b66
SN
1323 // this sets the specified attribute for this cell or in this row/col
1324 void SetAttr(int row, int col, wxGridCellAttr *attr);
758cbedf
VZ
1325 void SetRowAttr(int row, wxGridCellAttr *attr);
1326 void SetColAttr(int col, wxGridCellAttr *attr);
1327
71e60f70
RD
1328 // returns the attribute we may modify in place: a new one if this cell
1329 // doesn't have any yet or the existing one if it does
1330 //
1331 // DecRef() must be called on the returned pointer, as usual
1332 wxGridCellAttr *GetOrCreateCellAttr(int row, int col) const;
1333
d94c09cd 1334
0b190b0f
VZ
1335 // shortcuts for setting the column parameters
1336
1337 // set the format for the data in the column: default is string
1338 void SetColFormatBool(int col);
1339 void SetColFormatNumber(int col);
1340 void SetColFormatFloat(int col, int width = -1, int precision = -1);
1341 void SetColFormatCustom(int col, const wxString& typeName);
1342
ca65c044 1343 void EnableGridLines( bool enable = true );
f85afd4e
MB
1344 bool GridLinesEnabled() { return m_gridLinesEnabled; }
1345
f85afd4e
MB
1346 // ------ row and col formatting
1347 //
1348 int GetDefaultRowSize();
1349 int GetRowSize( int row );
1350 int GetDefaultColSize();
1351 int GetColSize( int col );
1352 wxColour GetDefaultCellBackgroundColour();
1353 wxColour GetCellBackgroundColour( int row, int col );
1354 wxColour GetDefaultCellTextColour();
1355 wxColour GetCellTextColour( int row, int col );
f85afd4e
MB
1356 wxFont GetDefaultCellFont();
1357 wxFont GetCellFont( int row, int col );
1358 void GetDefaultCellAlignment( int *horiz, int *vert );
1359 void GetCellAlignment( int row, int col, int *horiz, int *vert );
27f35b66
SN
1360 bool GetDefaultCellOverflow();
1361 bool GetCellOverflow( int row, int col );
1362 void GetCellSize( int row, int col, int *num_rows, int *num_cols );
60ff3b99 1363
ca65c044 1364 void SetDefaultRowSize( int height, bool resizeExistingRows = false );
f85afd4e 1365 void SetRowSize( int row, int height );
ca65c044 1366 void SetDefaultColSize( int width, bool resizeExistingCols = false );
8fb66724 1367
f85afd4e 1368 void SetColSize( int col, int width );
43947979 1369
af547d51 1370 // automatically size the column or row to fit to its contents, if
ca65c044 1371 // setAsMin is true, this optimal width will also be set as minimal width
af547d51 1372 // for this column
ca65c044
WS
1373 void AutoSizeColumn( int col, bool setAsMin = true )
1374 { AutoSizeColOrRow(col, setAsMin, true); }
1375 void AutoSizeRow( int row, bool setAsMin = true )
1376 { AutoSizeColOrRow(row, setAsMin, false); }
65e4e78e
VZ
1377
1378 // auto size all columns (very ineffective for big grids!)
ca65c044
WS
1379 void AutoSizeColumns( bool setAsMin = true )
1380 { (void)SetOrCalcColumnSizes(false, setAsMin); }
65e4e78e 1381
ca65c044
WS
1382 void AutoSizeRows( bool setAsMin = true )
1383 { (void)SetOrCalcRowSizes(false, setAsMin); }
57c086ef
VZ
1384
1385 // auto size the grid, that is make the columns/rows of the "right" size
1386 // and also set the grid size to just fit its contents
1387 void AutoSize();
1388
d43851f7
JS
1389 // autosize row height depending on label text
1390 void AutoSizeRowLabelSize( int row );
1391
1392 // autosize column width depending on label text
1393 void AutoSizeColLabelSize( int col );
1394
43947979
VZ
1395 // column won't be resized to be lesser width - this must be called during
1396 // the grid creation because it won't resize the column if it's already
1397 // narrower than the minimal width
1398 void SetColMinimalWidth( int col, int width );
af547d51 1399 void SetRowMinimalHeight( int row, int width );
43947979 1400
b8d24d4e
RG
1401 /* These members can be used to query and modify the minimal
1402 * acceptable size of grid rows and columns. Call this function in
1403 * your code which creates the grid if you want to display cells
1404 * with a size smaller than the default acceptable minimum size.
1405 * Like the members SetColMinimalWidth and SetRowMinimalWidth,
1406 * the existing rows or columns will not be checked/resized.
1407 */
1408 void SetColMinimalAcceptableWidth( int width );
1409 void SetRowMinimalAcceptableHeight( int width );
1410 int GetColMinimalAcceptableWidth() const;
1411 int GetRowMinimalAcceptableHeight() const;
1412
f85afd4e
MB
1413 void SetDefaultCellBackgroundColour( const wxColour& );
1414 void SetCellBackgroundColour( int row, int col, const wxColour& );
1415 void SetDefaultCellTextColour( const wxColour& );
8fb66724 1416
f85afd4e 1417 void SetCellTextColour( int row, int col, const wxColour& );
f85afd4e
MB
1418 void SetDefaultCellFont( const wxFont& );
1419 void SetCellFont( int row, int col, const wxFont& );
1420 void SetDefaultCellAlignment( int horiz, int vert );
1421 void SetCellAlignment( int row, int col, int horiz, int vert );
27f35b66
SN
1422 void SetDefaultCellOverflow( bool allow );
1423 void SetCellOverflow( int row, int col, bool allow );
1424 void SetCellSize( int row, int col, int num_rows, int num_cols );
f85afd4e 1425
ab79958a 1426 // takes ownership of the pointer
2796cce3 1427 void SetDefaultRenderer(wxGridCellRenderer *renderer);
ab79958a 1428 void SetCellRenderer(int row, int col, wxGridCellRenderer *renderer);
2796cce3
RD
1429 wxGridCellRenderer *GetDefaultRenderer() const;
1430 wxGridCellRenderer* GetCellRenderer(int row, int col);
1431
283b7808 1432 // takes ownership of the pointer
0ba143c9 1433 void SetDefaultEditor(wxGridCellEditor *editor);
9b4aede2 1434 void SetCellEditor(int row, int col, wxGridCellEditor *editor);
0ba143c9 1435 wxGridCellEditor *GetDefaultEditor() const;
9b4aede2
RD
1436 wxGridCellEditor* GetCellEditor(int row, int col);
1437
60a67569 1438
f2d76237 1439
f85afd4e
MB
1440 // ------ cell value accessors
1441 //
1442 wxString GetCellValue( int row, int col )
1443 {
1444 if ( m_table )
1445 {
1446 return m_table->GetValue( row, col );
1447 }
1448 else
1449 {
1450 return wxEmptyString;
1451 }
1452 }
1453
1454 wxString GetCellValue( const wxGridCellCoords& coords )
1455 { return GetCellValue( coords.GetRow(), coords.GetCol() ); }
60ff3b99 1456
f85afd4e
MB
1457 void SetCellValue( int row, int col, const wxString& s );
1458 void SetCellValue( const wxGridCellCoords& coords, const wxString& s )
1459 { SetCellValue( coords.GetRow(), coords.GetCol(), s ); }
f85afd4e 1460
ca65c044 1461 // returns true if the cell can't be edited
283b7808 1462 bool IsReadOnly(int row, int col) const;
60ff3b99 1463
283b7808 1464 // make the cell editable/readonly
ca65c044 1465 void SetReadOnly(int row, int col, bool isReadOnly = true);
f85afd4e 1466
aa5b8857 1467 // ------ select blocks of cells
f85afd4e 1468 //
ca65c044
WS
1469 void SelectRow( int row, bool addToSelected = false );
1470 void SelectCol( int col, bool addToSelected = false );
60ff3b99 1471
c9097836 1472 void SelectBlock( int topRow, int leftCol, int bottomRow, int rightCol,
ca65c044 1473 bool addToSelected = false );
f85afd4e
MB
1474
1475 void SelectBlock( const wxGridCellCoords& topLeft,
c9097836 1476 const wxGridCellCoords& bottomRight,
ca65c044 1477 bool addToSelected = false )
f85afd4e 1478 { SelectBlock( topLeft.GetRow(), topLeft.GetCol(),
c9097836
MB
1479 bottomRight.GetRow(), bottomRight.GetCol(),
1480 addToSelected ); }
f85afd4e
MB
1481
1482 void SelectAll();
60ff3b99 1483
b5808881 1484 bool IsSelection();
f85afd4e 1485
aa5b8857 1486 // ------ deselect blocks or cells
f7b4b343
VZ
1487 //
1488 void DeselectRow( int row );
1489 void DeselectCol( int col );
1490 void DeselectCell( int row, int col );
1491
f85afd4e
MB
1492 void ClearSelection();
1493
84035150 1494 bool IsInSelection( int row, int col ) const;
f85afd4e 1495
84035150 1496 bool IsInSelection( const wxGridCellCoords& coords ) const
f85afd4e
MB
1497 { return IsInSelection( coords.GetRow(), coords.GetCol() ); }
1498
aa5b8857
SN
1499 wxGridCellCoordsArray GetSelectedCells() const;
1500 wxGridCellCoordsArray GetSelectionBlockTopLeft() const;
1501 wxGridCellCoordsArray GetSelectionBlockBottomRight() const;
1502 wxArrayInt GetSelectedRows() const;
1503 wxArrayInt GetSelectedCols() const;
c3baf426
SN
1504
1505 // This function returns the rectangle that encloses the block of cells
1506 // limited by TopLeft and BottomRight cell in device coords and clipped
1507 // to the client size of the grid window.
1508 //
58dd5b3b 1509 wxRect BlockToDeviceRect( const wxGridCellCoords & topLeft,
b99be8fb 1510 const wxGridCellCoords & bottomRight );
c3baf426 1511
2796cce3
RD
1512 // Access or update the selection fore/back colours
1513 wxColour GetSelectionBackground() const
1514 { return m_selectionBackground; }
1515 wxColour GetSelectionForeground() const
1516 { return m_selectionForeground; }
1517
1518 void SetSelectionBackground(const wxColour& c) { m_selectionBackground = c; }
1519 void SetSelectionForeground(const wxColour& c) { m_selectionForeground = c; }
1520
1521
f2d76237
RD
1522 // Methods for a registry for mapping data types to Renderers/Editors
1523 void RegisterDataType(const wxString& typeName,
1524 wxGridCellRenderer* renderer,
1525 wxGridCellEditor* editor);
73145b0e
JS
1526 // DJC MAPTEK
1527 virtual wxGridCellEditor* GetDefaultEditorForCell(int row, int col) const;
99306db2
VZ
1528 wxGridCellEditor* GetDefaultEditorForCell(const wxGridCellCoords& c) const
1529 { return GetDefaultEditorForCell(c.GetRow(), c.GetCol()); }
73145b0e
JS
1530 virtual wxGridCellRenderer* GetDefaultRendererForCell(int row, int col) const;
1531 virtual wxGridCellEditor* GetDefaultEditorForType(const wxString& typeName) const;
1532 virtual wxGridCellRenderer* GetDefaultRendererForType(const wxString& typeName) const;
f2d76237 1533
266e8367
VZ
1534 // grid may occupy more space than needed for its rows/columns, this
1535 // function allows to set how big this extra space is
1536 void SetMargins(int extraWidth, int extraHeight)
1537 {
1538 m_extraWidth = extraWidth;
1539 m_extraHeight = extraHeight;
b8125adf
VZ
1540
1541 CalcDimensions();
266e8367 1542 }
f85afd4e 1543
d2520c85
RD
1544 // Accessors for component windows
1545 wxWindow* GetGridWindow() { return (wxWindow*)m_gridWin; }
1546 wxWindow* GetGridRowLabelWindow() { return (wxWindow*)m_rowLabelWin; }
1547 wxWindow* GetGridColLabelWindow() { return (wxWindow*)m_colLabelWin; }
1548 wxWindow* GetGridCornerLabelWindow() { return (wxWindow*)m_cornerLabelWin; }
1549
608754c4
JS
1550 // Allow adjustment of scroll increment. The default is (15, 15).
1551 void SetScrollLineX(int x) { m_scrollLineX = x; }
1552 void SetScrollLineY(int y) { m_scrollLineY = y; }
1553 int GetScrollLineX() const { return m_scrollLineX; }
1554 int GetScrollLineY() const { return m_scrollLineY; }
1555
1556 // Implementation
1557 int GetScrollX(int x) const
1558 {
1559 return (x + GetScrollLineX() - 1) / GetScrollLineX();
1560 }
1561
1562 int GetScrollY(int y) const
1563 {
1564 return (y + GetScrollLineY() - 1) / GetScrollLineY();
1565 }
d2520c85
RD
1566
1567
bf646121
VZ
1568 // override some base class functions
1569 virtual bool Enable(bool enable = true);
1570
1571
f85afd4e
MB
1572 // ------ For compatibility with previous wxGrid only...
1573 //
1574 // ************************************************
1575 // ** Don't use these in new code because they **
1576 // ** are liable to disappear in a future **
1577 // ** revision **
1578 // ************************************************
1579 //
1580
1581 wxGrid( wxWindow *parent,
422d0ff0 1582 int x, int y, int w = wxDefaultCoord, int h = wxDefaultCoord,
ebd773c6 1583 long style = wxWANTS_CHARS,
f85afd4e 1584 const wxString& name = wxPanelNameStr )
ca65c044 1585 : wxScrolledWindow( parent, wxID_ANY, wxPoint(x,y), wxSize(w,h),
ebd773c6 1586 (style|wxWANTS_CHARS), name )
60ff3b99 1587 {
f85afd4e 1588 Create();
60ff3b99 1589 }
f85afd4e
MB
1590
1591 void SetCellValue( const wxString& val, int row, int col )
1592 { SetCellValue( row, col, val ); }
60ff3b99 1593
f85afd4e
MB
1594 void UpdateDimensions()
1595 { CalcDimensions(); }
1596
1597 int GetRows() { return GetNumberRows(); }
1598 int GetCols() { return GetNumberCols(); }
1599 int GetCursorRow() { return GetGridCursorRow(); }
1600 int GetCursorColumn() { return GetGridCursorCol(); }
60ff3b99 1601
2d66e025
MB
1602 int GetScrollPosX() { return 0; }
1603 int GetScrollPosY() { return 0; }
60ff3b99 1604
aa5e1f75
SN
1605 void SetScrollX( int WXUNUSED(x) ) { }
1606 void SetScrollY( int WXUNUSED(y) ) { }
f85afd4e
MB
1607
1608 void SetColumnWidth( int col, int width )
1609 { SetColSize( col, width ); }
60ff3b99 1610
f85afd4e
MB
1611 int GetColumnWidth( int col )
1612 { return GetColSize( col ); }
60ff3b99 1613
f85afd4e
MB
1614 void SetRowHeight( int row, int height )
1615 { SetRowSize( row, height ); }
60ff3b99 1616
7c1cb261 1617 // GetRowHeight() is below
60ff3b99 1618
2d66e025
MB
1619 int GetViewHeight() // returned num whole rows visible
1620 { return 0; }
60ff3b99 1621
2d66e025
MB
1622 int GetViewWidth() // returned num whole cols visible
1623 { return 0; }
f85afd4e
MB
1624
1625 void SetLabelSize( int orientation, int sz )
1626 {
1627 if ( orientation == wxHORIZONTAL )
1628 SetColLabelSize( sz );
1629 else
1630 SetRowLabelSize( sz );
1631 }
1632
1633 int GetLabelSize( int orientation )
1634 {
1635 if ( orientation == wxHORIZONTAL )
1636 return GetColLabelSize();
1637 else
1638 return GetRowLabelSize();
1639 }
1640
1641 void SetLabelAlignment( int orientation, int align )
1642 {
1643 if ( orientation == wxHORIZONTAL )
1644 SetColLabelAlignment( align, -1 );
1645 else
1646 SetRowLabelAlignment( align, -1 );
1647 }
1648
af111fc3 1649 int GetLabelAlignment( int orientation, int WXUNUSED(align) )
f85afd4e
MB
1650 {
1651 int h, v;
1652 if ( orientation == wxHORIZONTAL )
1653 {
1654 GetColLabelAlignment( &h, &v );
1655 return h;
1656 }
1657 else
1658 {
1659 GetRowLabelAlignment( &h, &v );
1660 return h;
1661 }
1662 }
1663
1664 void SetLabelValue( int orientation, const wxString& val, int pos )
1665 {
1666 if ( orientation == wxHORIZONTAL )
1667 SetColLabelValue( pos, val );
1668 else
1669 SetRowLabelValue( pos, val );
1670 }
60ff3b99 1671
f85afd4e
MB
1672 wxString GetLabelValue( int orientation, int pos)
1673 {
1674 if ( orientation == wxHORIZONTAL )
1675 return GetColLabelValue( pos );
1676 else
1677 return GetRowLabelValue( pos );
1678 }
1679
60ff3b99 1680 wxFont GetCellTextFont() const
2796cce3 1681 { return m_defaultCellAttr->GetFont(); }
60ff3b99 1682
af111fc3 1683 wxFont GetCellTextFont(int WXUNUSED(row), int WXUNUSED(col)) const
2796cce3 1684 { return m_defaultCellAttr->GetFont(); }
60ff3b99 1685
f85afd4e
MB
1686 void SetCellTextFont(const wxFont& fnt)
1687 { SetDefaultCellFont( fnt ); }
60ff3b99 1688
f85afd4e
MB
1689 void SetCellTextFont(const wxFont& fnt, int row, int col)
1690 { SetCellFont( row, col, fnt ); }
60ff3b99 1691
f85afd4e
MB
1692 void SetCellTextColour(const wxColour& val, int row, int col)
1693 { SetCellTextColour( row, col, val ); }
60ff3b99 1694
f85afd4e
MB
1695 void SetCellTextColour(const wxColour& col)
1696 { SetDefaultCellTextColour( col ); }
60ff3b99 1697
f85afd4e
MB
1698 void SetCellBackgroundColour(const wxColour& col)
1699 { SetDefaultCellBackgroundColour( col ); }
60ff3b99 1700
f85afd4e
MB
1701 void SetCellBackgroundColour(const wxColour& colour, int row, int col)
1702 { SetCellBackgroundColour( row, col, colour ); }
60ff3b99 1703
f85afd4e 1704 bool GetEditable() { return IsEditable(); }
ca65c044 1705 void SetEditable( bool edit = true ) { EnableEditing( edit ); }
f85afd4e 1706 bool GetEditInPlace() { return IsCellEditControlEnabled(); }
8fb66724 1707
ca65c044 1708 void SetEditInPlace(bool WXUNUSED(edit) = true) { }
f85afd4e 1709
60a67569 1710 void SetCellAlignment( int align, int row, int col)
4c7277db 1711 { SetCellAlignment(row, col, align, wxALIGN_CENTER); }
60a67569
JS
1712 void SetCellAlignment( int WXUNUSED(align) ) {}
1713 void SetCellBitmap(wxBitmap *WXUNUSED(bitmap), int WXUNUSED(row), int WXUNUSED(col))
1714 { }
1715 void SetDividerPen(const wxPen& WXUNUSED(pen)) { }
6fc0f38f 1716 wxPen& GetDividerPen() const;
60a67569 1717 void OnActivate(bool WXUNUSED(active)) {}
60ff3b99 1718
f85afd4e
MB
1719 // ******** End of compatibility functions **********
1720
2d66e025
MB
1721
1722
f85afd4e 1723 // ------ control IDs
2d66e025 1724 enum { wxGRID_CELLCTRL = 2000,
f85afd4e
MB
1725 wxGRID_TOPCTRL };
1726
1727 // ------ control types
2d66e025 1728 enum { wxGRID_TEXTCTRL = 2100,
f85afd4e
MB
1729 wxGRID_CHECKBOX,
1730 wxGRID_CHOICE,
1731 wxGRID_COMBOBOX };
1732
266e8367
VZ
1733 // overridden wxWindow methods
1734 virtual void Fit();
1735
60ff3b99 1736protected:
266e8367
VZ
1737 virtual wxSize DoGetBestSize() const;
1738
60ff3b99
VZ
1739 bool m_created;
1740
1741 wxGridWindow *m_gridWin;
1742 wxGridRowLabelWindow *m_rowLabelWin;
1743 wxGridColLabelWindow *m_colLabelWin;
1744 wxGridCornerLabelWindow *m_cornerLabelWin;
1745
60ff3b99 1746 wxGridTableBase *m_table;
2796cce3 1747 bool m_ownTable;
60ff3b99 1748
60ff3b99
VZ
1749 int m_numRows;
1750 int m_numCols;
1751
1752 wxGridCellCoords m_currentCellCoords;
1753
b5808881
SN
1754 wxGridCellCoords m_selectingTopLeft;
1755 wxGridCellCoords m_selectingBottomRight;
d95b0c2b 1756 wxGridCellCoords m_selectingKeyboard;
b5808881 1757 wxGridSelection *m_selection;
2796cce3
RD
1758 wxColour m_selectionBackground;
1759 wxColour m_selectionForeground;
60ff3b99 1760
7c1cb261
VZ
1761 // NB: *never* access m_row/col arrays directly because they are created
1762 // on demand, *always* use accessor functions instead!
1763
1764 // init the m_rowHeights/Bottoms arrays with default values
1765 void InitRowHeights();
1766
60ff3b99 1767 int m_defaultRowHeight;
b8d24d4e 1768 int m_minAcceptableRowHeight;
60ff3b99
VZ
1769 wxArrayInt m_rowHeights;
1770 wxArrayInt m_rowBottoms;
1771
7c1cb261
VZ
1772 // init the m_colWidths/Rights arrays
1773 void InitColWidths();
1774
60ff3b99 1775 int m_defaultColWidth;
b8d24d4e 1776 int m_minAcceptableColWidth;
60ff3b99
VZ
1777 wxArrayInt m_colWidths;
1778 wxArrayInt m_colRights;
7c1cb261
VZ
1779
1780 // get the col/row coords
1781 int GetColWidth(int col) const;
1782 int GetColLeft(int col) const;
1783 int GetColRight(int col) const;
1784
1785 // this function must be public for compatibility...
1786public:
1787 int GetRowHeight(int row) const;
1788protected:
1789
1790 int GetRowTop(int row) const;
1791 int GetRowBottom(int row) const;
1792
60ff3b99
VZ
1793 int m_rowLabelWidth;
1794 int m_colLabelHeight;
1795
266e8367
VZ
1796 // the size of the margin left to the right and bottom of the cell area
1797 int m_extraWidth,
1798 m_extraHeight;
1799
60ff3b99
VZ
1800 wxColour m_labelBackgroundColour;
1801 wxColour m_labelTextColour;
1802 wxFont m_labelFont;
1803
1804 int m_rowLabelHorizAlign;
1805 int m_rowLabelVertAlign;
1806 int m_colLabelHorizAlign;
1807 int m_colLabelVertAlign;
d43851f7 1808 int m_colLabelTextOrientation;
60ff3b99
VZ
1809
1810 bool m_defaultRowLabelValues;
1811 bool m_defaultColLabelValues;
1812
1813 wxColour m_gridLineColour;
1814 bool m_gridLinesEnabled;
f6bcfd97 1815 wxColour m_cellHighlightColour;
d2520c85
RD
1816 int m_cellHighlightPenWidth;
1817 int m_cellHighlightROPenWidth;
1818
60ff3b99 1819
266e8367 1820 // common part of AutoSizeColumn/Row() and GetBestSize()
ca65c044
WS
1821 int SetOrCalcColumnSizes(bool calcOnly, bool setAsMin = true);
1822 int SetOrCalcRowSizes(bool calcOnly, bool setAsMin = true);
266e8367 1823
af547d51
VZ
1824 // common part of AutoSizeColumn/Row()
1825 void AutoSizeColOrRow(int n, bool setAsMin, bool column /* or row? */);
1826
43947979
VZ
1827 // if a column has a minimal width, it will be the value for it in this
1828 // hash table
ba8c1601
MB
1829 wxLongToLongHashMap m_colMinWidths,
1830 m_rowMinHeights;
43947979 1831
af547d51
VZ
1832 // get the minimal width of the given column/row
1833 int GetColMinimalWidth(int col) const;
1834 int GetRowMinimalHeight(int col) const;
b99be8fb
VZ
1835
1836 // do we have some place to store attributes in?
1837 bool CanHaveAttributes();
60ff3b99 1838
0a976765
VZ
1839 // cell attribute cache (currently we only cache 1, may be will do
1840 // more/better later)
1841 struct CachedAttr
1842 {
1843 int row, col;
1844 wxGridCellAttr *attr;
1845 } m_attrCache;
1846
1847 // invalidates the attribute cache
1848 void ClearAttrCache();
1849
1850 // adds an attribute to cache
1851 void CacheAttr(int row, int col, wxGridCellAttr *attr) const;
1852
ca65c044 1853 // looks for an attr in cache, returns true if found
0a976765
VZ
1854 bool LookupAttr(int row, int col, wxGridCellAttr **attr) const;
1855
1856 // looks for the attr in cache, if not found asks the table and caches the
1857 // result
2e9a6788 1858 wxGridCellAttr *GetCellAttr(int row, int col) const;
2c9a89e0
RD
1859 wxGridCellAttr *GetCellAttr(const wxGridCellCoords& coords )
1860 { return GetCellAttr( coords.GetRow(), coords.GetCol() ); }
2e9a6788 1861
2796cce3
RD
1862 // the default cell attr object for cells that don't have their own
1863 wxGridCellAttr* m_defaultCellAttr;
1864
1865
60ff3b99
VZ
1866 bool m_inOnKeyDown;
1867 int m_batchCount;
1868
f2d76237
RD
1869
1870 wxGridTypeRegistry* m_typeRegistry;
1871
e2b42eeb
VZ
1872 enum CursorMode
1873 {
1874 WXGRID_CURSOR_SELECT_CELL,
1875 WXGRID_CURSOR_RESIZE_ROW,
1876 WXGRID_CURSOR_RESIZE_COL,
1877 WXGRID_CURSOR_SELECT_ROW,
1878 WXGRID_CURSOR_SELECT_COL
60ff3b99
VZ
1879 };
1880
e2b42eeb 1881 // this method not only sets m_cursorMode but also sets the correct cursor
ca65c044 1882 // for the given mode and, if captureMouse is not false releases the mouse
e2b42eeb
VZ
1883 // if it was captured and captures it if it must be captured
1884 //
1885 // for this to work, you should always use it and not set m_cursorMode
1886 // directly!
1887 void ChangeCursorMode(CursorMode mode,
1888 wxWindow *win = (wxWindow *)NULL,
ca65c044 1889 bool captureMouse = true);
e2b42eeb
VZ
1890
1891 wxWindow *m_winCapture; // the window which captured the mouse
1892 CursorMode m_cursorMode;
1893
6e8524b1
MB
1894 bool m_canDragRowSize;
1895 bool m_canDragColSize;
4cfa5de6 1896 bool m_canDragGridSize;
79dbea21 1897 bool m_canDragCell;
07296f0b
RD
1898 int m_dragLastPos;
1899 int m_dragRowOrCol;
1900 bool m_isDragging;
1901 wxPoint m_startDragPos;
60ff3b99 1902
75ecbe45 1903 bool m_waitForSlowClick;
025562fe 1904
60ff3b99
VZ
1905 wxGridCellCoords m_selectionStart;
1906
1907 wxCursor m_rowResizeCursor;
1908 wxCursor m_colResizeCursor;
1909
b54ba671
VZ
1910 bool m_editable; // applies to whole grid
1911 bool m_cellEditCtrlEnabled; // is in-place edit currently shown?
60ff3b99 1912
608754c4
JS
1913 int m_scrollLineX; // X scroll increment
1914 int m_scrollLineY; // Y scroll increment
60ff3b99
VZ
1915
1916 void Create();
1917 void Init();
1918 void CalcDimensions();
7807d81c 1919 void CalcWindowSizes();
60ff3b99
VZ
1920 bool Redimension( wxGridTableMessage& );
1921
1922
fe7b9ed6
VZ
1923 int SendEvent( const wxEventType, int row, int col, wxMouseEvent& );
1924 int SendEvent( const wxEventType, int row, int col );
1925 int SendEvent( const wxEventType type)
b54ba671
VZ
1926 {
1927 return SendEvent(type,
1928 m_currentCellCoords.GetRow(),
1929 m_currentCellCoords.GetCol());
1930 }
60ff3b99
VZ
1931
1932 void OnPaint( wxPaintEvent& );
1933 void OnSize( wxSizeEvent& );
1934 void OnKeyDown( wxKeyEvent& );
f6bcfd97 1935 void OnKeyUp( wxKeyEvent& );
63e2147c 1936 void OnChar( wxKeyEvent& );
2796cce3 1937 void OnEraseBackground( wxEraseEvent& );
60ff3b99
VZ
1938
1939
1940 void SetCurrentCell( const wxGridCellCoords& coords );
1941 void SetCurrentCell( int row, int col )
1942 { SetCurrentCell( wxGridCellCoords(row, col) ); }
1943
c9097836
MB
1944 void HighlightBlock( int topRow, int leftCol, int bottomRow, int rightCol );
1945
1946 void HighlightBlock( const wxGridCellCoords& topLeft,
d2520c85 1947 const wxGridCellCoords& bottomRight )
c9097836
MB
1948 { HighlightBlock( topLeft.GetRow(), topLeft.GetCol(),
1949 bottomRight.GetRow(), bottomRight.GetCol() ); }
60ff3b99
VZ
1950
1951 // ------ functions to get/send data (see also public functions)
1952 //
1953 bool GetModelValues();
1954 bool SetModelValues();
1955
12f190b0 1956 friend class WXDLLIMPEXP_ADV wxGridSelection;
60ff3b99 1957
2d66e025 1958 DECLARE_DYNAMIC_CLASS( wxGrid )
f85afd4e 1959 DECLARE_EVENT_TABLE()
22f3361e 1960 DECLARE_NO_COPY_CLASS(wxGrid)
f85afd4e
MB
1961};
1962
b8d24d4e 1963
43947979
VZ
1964// ----------------------------------------------------------------------------
1965// Grid event class and event types
1966// ----------------------------------------------------------------------------
f85afd4e 1967
12f190b0 1968class WXDLLIMPEXP_ADV wxGridEvent : public wxNotifyEvent
f85afd4e 1969{
60ff3b99 1970public:
f85afd4e
MB
1971 wxGridEvent()
1972 : wxNotifyEvent(), m_row(-1), m_col(-1), m_x(-1), m_y(-1),
5c8fc7c1 1973 m_selecting(0), m_control(0), m_meta(0), m_shift(0), m_alt(0)
f85afd4e
MB
1974 {
1975 }
1976
1977 wxGridEvent(int id, wxEventType type, wxObject* obj,
ca65c044
WS
1978 int row=-1, int col=-1, int x=-1, int y=-1, bool sel = true,
1979 bool control = false, bool shift = false, bool alt = false, bool meta = false);
f85afd4e
MB
1980
1981 virtual int GetRow() { return m_row; }
1982 virtual int GetCol() { return m_col; }
1983 wxPoint GetPosition() { return wxPoint( m_x, m_y ); }
5c8fc7c1 1984 bool Selecting() { return m_selecting; }
f85afd4e
MB
1985 bool ControlDown() { return m_control; }
1986 bool MetaDown() { return m_meta; }
1987 bool ShiftDown() { return m_shift; }
1988 bool AltDown() { return m_alt; }
2d66e025 1989
60ff3b99
VZ
1990protected:
1991 int m_row;
1992 int m_col;
f85afd4e
MB
1993 int m_x;
1994 int m_y;
5c8fc7c1 1995 bool m_selecting;
f85afd4e
MB
1996 bool m_control;
1997 bool m_meta;
1998 bool m_shift;
1999 bool m_alt;
60ff3b99 2000
fc7a2a60 2001 DECLARE_DYNAMIC_CLASS_NO_COPY(wxGridEvent)
60ff3b99
VZ
2002};
2003
12f190b0 2004class WXDLLIMPEXP_ADV wxGridSizeEvent : public wxNotifyEvent
60ff3b99
VZ
2005{
2006public:
f85afd4e
MB
2007 wxGridSizeEvent()
2008 : wxNotifyEvent(), m_rowOrCol(-1), m_x(-1), m_y(-1),
2009 m_control(0), m_meta(0), m_shift(0), m_alt(0)
2010 {
2011 }
2012
2013 wxGridSizeEvent(int id, wxEventType type, wxObject* obj,
2014 int rowOrCol=-1, int x=-1, int y=-1,
ca65c044 2015 bool control = false, bool shift = false, bool alt = false, bool meta = false);
f85afd4e
MB
2016
2017 int GetRowOrCol() { return m_rowOrCol; }
2018 wxPoint GetPosition() { return wxPoint( m_x, m_y ); }
2019 bool ControlDown() { return m_control; }
2020 bool MetaDown() { return m_meta; }
2021 bool ShiftDown() { return m_shift; }
2022 bool AltDown() { return m_alt; }
2d66e025 2023
60ff3b99
VZ
2024protected:
2025 int m_rowOrCol;
2026 int m_x;
2027 int m_y;
2028 bool m_control;
2029 bool m_meta;
2030 bool m_shift;
2031 bool m_alt;
2032
fc7a2a60 2033 DECLARE_DYNAMIC_CLASS_NO_COPY(wxGridSizeEvent)
f85afd4e
MB
2034};
2035
2036
12f190b0 2037class WXDLLIMPEXP_ADV wxGridRangeSelectEvent : public wxNotifyEvent
f85afd4e 2038{
60ff3b99 2039public:
f85afd4e 2040 wxGridRangeSelectEvent()
60ff3b99
VZ
2041 : wxNotifyEvent()
2042 {
2043 m_topLeft = wxGridNoCellCoords;
2044 m_bottomRight = wxGridNoCellCoords;
ca65c044
WS
2045 m_selecting = false;
2046 m_control = false;
2047 m_meta = false;
2048 m_shift = false;
2049 m_alt = false;
60ff3b99 2050 }
f85afd4e
MB
2051
2052 wxGridRangeSelectEvent(int id, wxEventType type, wxObject* obj,
60ff3b99
VZ
2053 const wxGridCellCoords& topLeft,
2054 const wxGridCellCoords& bottomRight,
ca65c044
WS
2055 bool sel = true,
2056 bool control = false, bool shift = false,
2057 bool alt = false, bool meta = false);
f85afd4e
MB
2058
2059 wxGridCellCoords GetTopLeftCoords() { return m_topLeft; }
2060 wxGridCellCoords GetBottomRightCoords() { return m_bottomRight; }
2061 int GetTopRow() { return m_topLeft.GetRow(); }
2062 int GetBottomRow() { return m_bottomRight.GetRow(); }
2063 int GetLeftCol() { return m_topLeft.GetCol(); }
2064 int GetRightCol() { return m_bottomRight.GetCol(); }
5c8fc7c1 2065 bool Selecting() { return m_selecting; }
f85afd4e
MB
2066 bool ControlDown() { return m_control; }
2067 bool MetaDown() { return m_meta; }
2068 bool ShiftDown() { return m_shift; }
2069 bool AltDown() { return m_alt; }
2d66e025 2070
60ff3b99
VZ
2071protected:
2072 wxGridCellCoords m_topLeft;
2073 wxGridCellCoords m_bottomRight;
5c8fc7c1 2074 bool m_selecting;
60ff3b99
VZ
2075 bool m_control;
2076 bool m_meta;
2077 bool m_shift;
2078 bool m_alt;
2079
fc7a2a60 2080 DECLARE_DYNAMIC_CLASS_NO_COPY(wxGridRangeSelectEvent)
f85afd4e
MB
2081};
2082
bf7945ce 2083
12f190b0 2084class WXDLLIMPEXP_ADV wxGridEditorCreatedEvent : public wxCommandEvent {
bf7945ce
RD
2085public:
2086 wxGridEditorCreatedEvent()
2087 : wxCommandEvent()
2088 {
2089 m_row = 0;
2090 m_col = 0;
2091 m_ctrl = NULL;
2092 }
2093
2094 wxGridEditorCreatedEvent(int id, wxEventType type, wxObject* obj,
2095 int row, int col, wxControl* ctrl);
2096
2097 int GetRow() { return m_row; }
2098 int GetCol() { return m_col; }
2099 wxControl* GetControl() { return m_ctrl; }
2100 void SetRow(int row) { m_row = row; }
2101 void SetCol(int col) { m_col = col; }
2102 void SetControl(wxControl* ctrl) { m_ctrl = ctrl; }
2103
2104private:
2105 int m_row;
2106 int m_col;
2107 wxControl* m_ctrl;
2108
2109 DECLARE_DYNAMIC_CLASS(wxGridEditorCreatedEvent)
22f3361e 2110 DECLARE_NO_COPY_CLASS(wxGridEditorCreatedEvent)
bf7945ce
RD
2111};
2112
2113
2e4df4bf 2114BEGIN_DECLARE_EVENT_TYPES()
12f190b0
VS
2115 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_GRID_CELL_LEFT_CLICK, 1580)
2116 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_GRID_CELL_RIGHT_CLICK, 1581)
2117 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_GRID_CELL_LEFT_DCLICK, 1582)
2118 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_GRID_CELL_RIGHT_DCLICK, 1583)
2119 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_GRID_LABEL_LEFT_CLICK, 1584)
2120 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_GRID_LABEL_RIGHT_CLICK, 1585)
2121 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_GRID_LABEL_LEFT_DCLICK, 1586)
2122 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_GRID_LABEL_RIGHT_DCLICK, 1587)
2123 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_GRID_ROW_SIZE, 1588)
2124 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_GRID_COL_SIZE, 1589)
2125 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_GRID_RANGE_SELECT, 1590)
2126 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_GRID_CELL_CHANGE, 1591)
2127 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_GRID_SELECT_CELL, 1592)
2128 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_GRID_EDITOR_SHOWN, 1593)
2129 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_GRID_EDITOR_HIDDEN, 1594)
2130 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_GRID_EDITOR_CREATED, 1595)
79dbea21 2131 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_GRID_CELL_BEGIN_DRAG, 1596)
2e4df4bf 2132END_DECLARE_EVENT_TYPES()
749692cc 2133
f85afd4e
MB
2134
2135typedef void (wxEvtHandler::*wxGridEventFunction)(wxGridEvent&);
2136typedef void (wxEvtHandler::*wxGridSizeEventFunction)(wxGridSizeEvent&);
2137typedef void (wxEvtHandler::*wxGridRangeSelectEventFunction)(wxGridRangeSelectEvent&);
bf7945ce 2138typedef void (wxEvtHandler::*wxGridEditorCreatedEventFunction)(wxGridEditorCreatedEvent&);
f85afd4e 2139
7fa03f04 2140#define wxGridEventHandler(func) \
d94c09cd 2141 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxGridEventFunction, &func)
7fa03f04
VZ
2142
2143#define wxGridSizeEventHandler(func) \
d94c09cd 2144 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxGridSizeEventFunction, &func)
7fa03f04
VZ
2145
2146#define wxGridRangeSelectEventHandler(func) \
d94c09cd 2147 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxGridRangeSelectEventFunction, &func)
7fa03f04
VZ
2148
2149#define wxGridEditorCreatedEventHandler(func) \
d94c09cd 2150 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxGridEditorCreatedEventFunction, &func)
7fa03f04
VZ
2151
2152#define wx__DECLARE_GRIDEVT(evt, id, fn) \
2153 wx__DECLARE_EVT1(wxEVT_GRID_ ## evt, id, wxGridEventHandler(fn))
2154
2155#define wx__DECLARE_GRIDSIZEEVT(evt, id, fn) \
2156 wx__DECLARE_EVT1(wxEVT_GRID_ ## evt, id, wxGridSizeEventHandler(fn))
2157
2158#define wx__DECLARE_GRIDRANGESELEVT(evt, id, fn) \
2159 wx__DECLARE_EVT1(wxEVT_GRID_ ## evt, id, wxGridRangeSelectEventHandler(fn))
2160
2161#define wx__DECLARE_GRIDEDITOREVT(evt, id, fn) \
2162 wx__DECLARE_EVT1(wxEVT_GRID_ ## evt, id, wxGridEditorCreatedEventHandler(fn))
2163
2164#define EVT_GRID_CMD_CELL_LEFT_CLICK(id, fn) wx__DECLARE_GRIDEVT(CELL_LEFT_CLICK, id, fn)
2165#define EVT_GRID_CMD_CELL_RIGHT_CLICK(id, fn) wx__DECLARE_GRIDEVT(CELL_RIGHT_CLICK, id, fn)
2166#define EVT_GRID_CMD_CELL_LEFT_DCLICK(id, fn) wx__DECLARE_GRIDEVT(CELL_LEFT_DCLICK, id, fn)
2167#define EVT_GRID_CMD_CELL_RIGHT_DCLICK(id, fn) wx__DECLARE_GRIDEVT(CELL_RIGHT_DCLICK, id, fn)
2168#define EVT_GRID_CMD_LABEL_LEFT_CLICK(id, fn) wx__DECLARE_GRIDEVT(LABEL_LEFT_CLICK, id, fn)
2169#define EVT_GRID_CMD_LABEL_RIGHT_CLICK(id, fn) wx__DECLARE_GRIDEVT(LABEL_RIGHT_CLICK, id, fn)
2170#define EVT_GRID_CMD_LABEL_LEFT_DCLICK(id, fn) wx__DECLARE_GRIDEVT(LABEL_LEFT_DCLICK, id, fn)
2171#define EVT_GRID_CMD_LABEL_RIGHT_DCLICK(id, fn) wx__DECLARE_GRIDEVT(LABEL_RIGHT_DCLICK, id, fn)
2172#define EVT_GRID_CMD_ROW_SIZE(id, fn) wx__DECLARE_GRIDSIZEEVT(ROW_SIZE, id, fn)
2173#define EVT_GRID_CMD_COL_SIZE(id, fn) wx__DECLARE_GRIDSIZEEVT(COL_SIZE, id, fn)
2174#define EVT_GRID_CMD_RANGE_SELECT(id, fn) wx__DECLARE_GRIDRANGESELEVT(RANGE_SELECT, id, fn)
2175#define EVT_GRID_CMD_CELL_CHANGE(id, fn) wx__DECLARE_GRIDEVT(CELL_CHANGE, id, fn)
2176#define EVT_GRID_CMD_SELECT_CELL(id, fn) wx__DECLARE_GRIDEVT(SELECT_CELL, id, fn)
2177#define EVT_GRID_CMD_EDITOR_SHOWN(id, fn) wx__DECLARE_GRIDEVT(EDITOR_SHOWN, id, fn)
2178#define EVT_GRID_CMD_EDITOR_HIDDEN(id, fn) wx__DECLARE_GRIDEVT(EDITOR_HIDDEN, id, fn)
2179#define EVT_GRID_CMD_EDITOR_CREATED(id, fn) wx__DECLARE_GRIDEDITOREVT(EDITOR_CREATED, id, fn)
2180#define EVT_GRID_CMD_CELL_BEGIN_DRAG(id, fn) wx__DECLARE_GRIDEVT(CELL_BEGIN_DRAG, id, fn)
2181
2182// same as above but for any id (exists mainly for backwards compatibility but
2183// then it's also true that you rarely have multiple grid in the same window)
2184#define EVT_GRID_CELL_LEFT_CLICK(fn) EVT_GRID_CMD_CELL_LEFT_CLICK(wxID_ANY, fn)
2185#define EVT_GRID_CELL_RIGHT_CLICK(fn) EVT_GRID_CMD_CELL_RIGHT_CLICK(wxID_ANY, fn)
2186#define EVT_GRID_CELL_LEFT_DCLICK(fn) EVT_GRID_CMD_CELL_LEFT_DCLICK(wxID_ANY, fn)
2187#define EVT_GRID_CELL_RIGHT_DCLICK(fn) EVT_GRID_CMD_CELL_RIGHT_DCLICK(wxID_ANY, fn)
2188#define EVT_GRID_LABEL_LEFT_CLICK(fn) EVT_GRID_CMD_LABEL_LEFT_CLICK(wxID_ANY, fn)
2189#define EVT_GRID_LABEL_RIGHT_CLICK(fn) EVT_GRID_CMD_LABEL_RIGHT_CLICK(wxID_ANY, fn)
2190#define EVT_GRID_LABEL_LEFT_DCLICK(fn) EVT_GRID_CMD_LABEL_LEFT_DCLICK(wxID_ANY, fn)
2191#define EVT_GRID_LABEL_RIGHT_DCLICK(fn) EVT_GRID_CMD_LABEL_RIGHT_DCLICK(wxID_ANY, fn)
2192#define EVT_GRID_ROW_SIZE(fn) EVT_GRID_CMD_ROW_SIZE(wxID_ANY, fn)
2193#define EVT_GRID_COL_SIZE(fn) EVT_GRID_CMD_COL_SIZE(wxID_ANY, fn)
2194#define EVT_GRID_RANGE_SELECT(fn) EVT_GRID_CMD_RANGE_SELECT(wxID_ANY, fn)
2195#define EVT_GRID_CELL_CHANGE(fn) EVT_GRID_CMD_CELL_CHANGE(wxID_ANY, fn)
2196#define EVT_GRID_SELECT_CELL(fn) EVT_GRID_CMD_SELECT_CELL(wxID_ANY, fn)
2197#define EVT_GRID_EDITOR_SHOWN(fn) EVT_GRID_CMD_EDITOR_SHOWN(wxID_ANY, fn)
2198#define EVT_GRID_EDITOR_HIDDEN(fn) EVT_GRID_CMD_EDITOR_HIDDEN(wxID_ANY, fn)
2199#define EVT_GRID_EDITOR_CREATED(fn) EVT_GRID_CMD_EDITOR_CREATED(wxID_ANY, fn)
2200#define EVT_GRID_CELL_BEGIN_DRAG(fn) EVT_GRID_CMD_CELL_BEGIN_DRAG(wxID_ANY, fn)
f85afd4e
MB
2201
2202#if 0 // TODO: implement these ? others ?
2203
77d4384e
RR
2204extern const int wxEVT_GRID_CREATE_CELL;
2205extern const int wxEVT_GRID_CHANGE_LABELS;
2206extern const int wxEVT_GRID_CHANGE_SEL_LABEL;
f85afd4e 2207
ca65c044
WS
2208#define EVT_GRID_CREATE_CELL(fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_CREATE_CELL, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxGridEventFunction, &fn ), NULL ),
2209#define EVT_GRID_CHANGE_LABELS(fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_CHANGE_LABELS, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxGridEventFunction, &fn ), NULL ),
2210#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
2211
2212#endif
2213
f7556ff0 2214#endif // ifndef wxUSE_GRID
f85afd4e 2215