1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: SWIG definitions for the new wxGrid and related classes
7 // Created: 17-March-2000
9 // Copyright: (c) 2000 by Total Control Software
10 // Licence: wxWindows license
11 /////////////////////////////////////////////////////////////////////////////
20 #include <wx/generic/gridctrl.h>
23 //----------------------------------------------------------------------
26 %include my_typemaps.i
28 // Import some definitions of other classes, etc.
36 %pragma(python) code = "import wx"
38 //----------------------------------------------------------------------
41 // Put some wx default wxChar* values into wxStrings.
42 DECLARE_DEF_STRING(PanelNameStr);
43 DECLARE_DEF_STRING2(DateTimeFormatStr, wxT("%c"));
44 static const wxString wxPyEmptyString(wxT(""));
47 //---------------------------------------------------------------------------
48 // OOR related typemaps and helper functions
50 %typemap(python, out) wxGridCellRenderer* { $target = wxPyMake_wxGridCellRenderer($source); }
51 %typemap(python, out) wxGridCellEditor* { $target = wxPyMake_wxGridCellEditor($source); }
52 %typemap(python, out) wxGridCellAttr* { $target = wxPyMake_wxGridCellAttr($source); }
53 %typemap(python, out) wxGridCellAttrProvider* { $target = wxPyMake_wxGridCellAttrProvider($source); }
54 %typemap(python, out) wxGridTableBase* { $target = wxPyMake_wxGridTableBase($source); }
59 #define wxPyMake_TEMPLATE(TYPE) \
60 PyObject* wxPyMake_##TYPE(TYPE* source) { \
61 PyObject* target = NULL; \
63 /* Check if there is already a pointer to a Python object in the \
64 OOR data that we can use. */ \
65 wxPyOORClientData* data = (wxPyOORClientData*)source->GetClientObject(); \
67 target = data->m_obj; \
70 /* Otherwise make a new wrapper for it the old fashioned way and \
71 give it the OOR treatment */ \
73 target = wxPyConstructObject(source, #TYPE, FALSE); \
75 source->SetClientObject(new wxPyOORClientData(target)); \
77 } else { /* source was NULL so return None. */ \
78 Py_INCREF(Py_None); target = Py_None; \
84 wxPyMake_TEMPLATE(wxGridCellRenderer)
85 wxPyMake_TEMPLATE(wxGridCellEditor)
86 wxPyMake_TEMPLATE(wxGridCellAttr)
87 wxPyMake_TEMPLATE(wxGridCellAttrProvider)
88 wxPyMake_TEMPLATE(wxGridTableBase)
92 //---------------------------------------------------------------------------
93 // Macros, similar to what's in helpers.h, to aid in the creation of
94 // virtual methods that are able to make callbacks to Python. Many of these
95 // are specific to wxGrid and so are kept here to reduce the mess in helpers.h
100 #define PYCALLBACK_GCA_INTINTKIND(PCLASS, CBNAME) \
101 wxGridCellAttr* CBNAME(int a, int b, wxGridCellAttr::wxAttrKind c) { \
102 wxGridCellAttr* rval = NULL; \
104 wxPyBeginBlockThreads(); \
105 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) { \
107 wxGridCellAttr* ptr; \
108 ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(iii)", a, b, c)); \
110 if (!SWIG_GetPtrObj(ro, (void **)&ptr, "_wxGridCellAttr_p")) \
115 wxPyEndBlockThreads(); \
117 rval = PCLASS::CBNAME(a, b, c); \
120 wxGridCellAttr *base_##CBNAME(int a, int b, wxGridCellAttr::wxAttrKind c) { \
121 return PCLASS::CBNAME(a, b, c); \
126 #define PYCALLBACK__GCAINTINT(PCLASS, CBNAME) \
127 void CBNAME(wxGridCellAttr *attr, int a, int b) { \
128 wxPyBeginBlockThreads(); \
130 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) { \
131 PyObject* obj = wxPyMake_wxGridCellAttr(attr); \
132 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(Oii)", obj, a, b)); \
135 wxPyEndBlockThreads(); \
137 PCLASS::CBNAME(attr, a, b); \
139 void base_##CBNAME(wxGridCellAttr *attr, int a, int b) { \
140 PCLASS::CBNAME(attr, a, b); \
145 #define PYCALLBACK__GCAINT(PCLASS, CBNAME) \
146 void CBNAME(wxGridCellAttr *attr, int val) { \
147 wxPyBeginBlockThreads(); \
149 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) { \
150 PyObject* obj = wxPyMake_wxGridCellAttr(attr); \
151 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(Oi)", obj, val)); \
154 wxPyEndBlockThreads(); \
156 PCLASS::CBNAME(attr, val); \
158 void base_##CBNAME(wxGridCellAttr *attr, int val) { \
159 PCLASS::CBNAME(attr, val); \
164 #define PYCALLBACK_INT__pure(CBNAME) \
166 wxPyBeginBlockThreads(); \
168 if (wxPyCBH_findCallback(m_myInst, #CBNAME)) \
169 rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("()")); \
170 wxPyEndBlockThreads(); \
176 #define PYCALLBACK_BOOL_INTINT_pure(CBNAME) \
177 bool CBNAME(int a, int b) { \
178 wxPyBeginBlockThreads(); \
180 if (wxPyCBH_findCallback(m_myInst, #CBNAME)) \
181 rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(ii)",a,b)); \
182 wxPyEndBlockThreads(); \
187 #define PYCALLBACK_STRING_INTINT_pure(CBNAME) \
188 wxString CBNAME(int a, int b) { \
189 wxPyBeginBlockThreads(); \
191 if (wxPyCBH_findCallback(m_myInst, #CBNAME)) { \
193 ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(ii)",a,b)); \
195 rval = Py2wxString(ro); \
199 wxPyEndBlockThreads(); \
204 #define PYCALLBACK__INTINTSTRING_pure(CBNAME) \
205 void CBNAME(int a, int b, const wxString& c) { \
206 wxPyBeginBlockThreads(); \
207 if (wxPyCBH_findCallback(m_myInst, #CBNAME)) { \
208 PyObject* s = wx2PyString(c); \
209 rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iiO)",a,b,s));\
212 wxPyEndBlockThreads(); \
216 #define PYCALLBACK_STRING_INTINT(PCLASS, CBNAME) \
217 wxString CBNAME(int a, int b) { \
219 wxPyBeginBlockThreads(); \
221 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) { \
223 ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(ii)",a,b)); \
225 rval = Py2wxString(ro); \
229 wxPyEndBlockThreads(); \
231 rval = PCLASS::CBNAME(a, b); \
234 wxString base_##CBNAME(int a, int b) { \
235 return PCLASS::CBNAME(a, b); \
239 #define PYCALLBACK_BOOL_INTINTSTRING(PCLASS, CBNAME) \
240 bool CBNAME(int a, int b, const wxString& c) { \
243 wxPyBeginBlockThreads(); \
244 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) { \
245 PyObject* s = wx2PyString(c); \
246 rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iiO)",a,b,s));\
249 wxPyEndBlockThreads(); \
251 rval = PCLASS::CBNAME(a,b,c); \
254 bool base_##CBNAME(int a, int b, const wxString& c) { \
255 return PCLASS::CBNAME(a,b,c); \
261 #define PYCALLBACK_LONG_INTINT(PCLASS, CBNAME) \
262 long CBNAME(int a, int b) { \
265 wxPyBeginBlockThreads(); \
266 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) \
267 rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(ii)", a,b)); \
268 wxPyEndBlockThreads(); \
270 rval = PCLASS::CBNAME(a,b); \
273 long base_##CBNAME(int a, int b) { \
274 return PCLASS::CBNAME(a,b); \
279 #define PYCALLBACK_BOOL_INTINT(PCLASS, CBNAME) \
280 bool CBNAME(int a, int b) { \
283 wxPyBeginBlockThreads(); \
284 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) \
285 rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(ii)", a,b)); \
286 wxPyEndBlockThreads(); \
288 rval = PCLASS::CBNAME(a,b); \
291 bool base_##CBNAME(int a, int b) { \
292 return PCLASS::CBNAME(a,b); \
297 #define PYCALLBACK_DOUBLE_INTINT(PCLASS, CBNAME) \
298 double CBNAME(int a, int b) { \
300 wxPyBeginBlockThreads(); \
302 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) { \
304 ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(ii)",a,b)); \
306 PyObject* str = PyObject_Str(ro); \
307 rval = PyFloat_AsDouble(str); \
308 Py_DECREF(ro); Py_DECREF(str); \
311 wxPyEndBlockThreads(); \
313 rval = PCLASS::CBNAME(a, b); \
316 double base_##CBNAME(int a, int b) { \
317 return PCLASS::CBNAME(a, b); \
322 #define PYCALLBACK__(PCLASS, CBNAME) \
325 wxPyBeginBlockThreads(); \
326 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) \
327 wxPyCBH_callCallback(m_myInst, Py_BuildValue("()")); \
328 wxPyEndBlockThreads(); \
332 void base_##CBNAME() { \
339 #define PYCALLBACK_BOOL_SIZETSIZET(PCLASS, CBNAME) \
340 bool CBNAME(size_t a, size_t b) { \
343 wxPyBeginBlockThreads(); \
344 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) \
345 rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(ii)", a,b)); \
346 wxPyEndBlockThreads(); \
348 rval = PCLASS::CBNAME(a,b); \
351 bool base_##CBNAME(size_t a, size_t b) { \
352 return PCLASS::CBNAME(a,b); \
357 #define PYCALLBACK_BOOL_SIZET(PCLASS, CBNAME) \
358 bool CBNAME(size_t a) { \
361 wxPyBeginBlockThreads(); \
362 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) \
363 rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(i)", a)); \
364 wxPyEndBlockThreads(); \
366 rval = PCLASS::CBNAME(a); \
369 bool base_##CBNAME(size_t a) { \
370 return PCLASS::CBNAME(a); \
374 #define PYCALLBACK_STRING_INT(PCLASS, CBNAME) \
375 wxString CBNAME(int a) { \
377 wxPyBeginBlockThreads(); \
379 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) { \
381 ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(i)",a)); \
383 rval = Py2wxString(ro); \
387 wxPyEndBlockThreads(); \
389 rval = PCLASS::CBNAME(a); \
392 wxString base_##CBNAME(int a) { \
393 return PCLASS::CBNAME(a); \
397 #define PYCALLBACK__INTSTRING(PCLASS, CBNAME) \
398 void CBNAME(int a, const wxString& c) { \
400 wxPyBeginBlockThreads(); \
401 if (wxPyCBH_findCallback(m_myInst, #CBNAME)) { \
402 PyObject* s = wx2PyString(c); \
403 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iO)",a,s)); \
406 wxPyEndBlockThreads(); \
408 PCLASS::CBNAME(a,c); \
410 void base_##CBNAME(int a, const wxString& c) { \
411 PCLASS::CBNAME(a,c); \
417 #define PYCALLBACK_BOOL_(PCLASS, CBNAME) \
421 wxPyBeginBlockThreads(); \
422 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) \
423 rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("()")); \
424 wxPyEndBlockThreads(); \
426 rval = PCLASS::CBNAME(); \
429 bool base_##CBNAME() { \
430 return PCLASS::CBNAME(); \
435 #define PYCALLBACK__SIZETINT(PCLASS, CBNAME) \
436 void CBNAME(size_t a, int b) { \
438 wxPyBeginBlockThreads(); \
439 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) \
440 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(ii)", a,b)); \
441 wxPyEndBlockThreads(); \
443 PCLASS::CBNAME(a,b); \
445 void base_##CBNAME(size_t a, int b) { \
446 PCLASS::CBNAME(a,b); \
452 #define PYCALLBACK__INTINTLONG(PCLASS, CBNAME) \
453 void CBNAME(int a, int b, long c) { \
455 wxPyBeginBlockThreads(); \
456 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) \
457 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iii)", a,b,c)); \
458 wxPyEndBlockThreads(); \
460 PCLASS::CBNAME(a,b,c); \
462 void base_##CBNAME(int a, int b, long c) { \
463 PCLASS::CBNAME(a,b,c); \
469 #define PYCALLBACK__INTINTDOUBLE(PCLASS, CBNAME) \
470 void CBNAME(int a, int b, double c) { \
472 wxPyBeginBlockThreads(); \
473 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) \
474 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iif)", a,b,c)); \
475 wxPyEndBlockThreads(); \
477 PCLASS::CBNAME(a,b,c); \
479 void base_##CBNAME(int a, int b, double c) { \
480 PCLASS::CBNAME(a,b,c); \
485 #define PYCALLBACK__INTINTBOOL(PCLASS, CBNAME) \
486 void CBNAME(int a, int b, bool c) { \
488 wxPyBeginBlockThreads(); \
489 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) \
490 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iii)", a,b,c)); \
491 wxPyEndBlockThreads(); \
493 PCLASS::CBNAME(a,b,c); \
495 void base_##CBNAME(int a, int b, bool c) { \
496 PCLASS::CBNAME(a,b,c); \
504 //---------------------------------------------------------------------------
506 class wxGridCellCoords;
507 class wxGridCellAttr;
509 #define wxGRID_VALUE_STRING "string"
510 #define wxGRID_VALUE_BOOL "bool"
511 #define wxGRID_VALUE_NUMBER "long"
512 #define wxGRID_VALUE_FLOAT "double"
513 #define wxGRID_VALUE_CHOICE "choice"
514 #define wxGRID_VALUE_TEXT "string"
515 #define wxGRID_VALUE_LONG "long"
516 #define wxGRID_VALUE_CHOICEINT "choiceint"
517 #define wxGRID_VALUE_DATETIME "datetime"
521 wxGridCellCoords wxGridNoCellCoords;
522 wxRect wxGridNoCellRect;
526 //---------------------------------------------------------------------------
527 // wxGridCellRenderer is an ABC, and several derived classes are available.
528 // Classes implemented in Python should be derived from wxPyGridCellRenderer.
531 class wxGridCellRenderer
535 void _setOORInfo(PyObject* _self) {
536 self->SetClientObject(new wxPyOORClientData(_self));
540 void SetParameters(const wxString& params);
544 virtual void Draw(wxGrid& grid,
545 wxGridCellAttr& attr,
549 bool isSelected) = 0;
550 virtual wxSize GetBestSize(wxGrid& grid,
551 wxGridCellAttr& attr,
553 int row, int col) = 0;
554 virtual wxGridCellRenderer *Clone() const = 0;
558 // The C++ version of wxPyGridCellRenderer
560 class wxPyGridCellRenderer : public wxGridCellRenderer
563 wxPyGridCellRenderer() : wxGridCellRenderer() {};
565 // Implement Python callback aware virtual methods
566 void Draw(wxGrid& grid, wxGridCellAttr& attr,
567 wxDC& dc, const wxRect& rect,
568 int row, int col, bool isSelected) {
569 wxPyBeginBlockThreads();
570 if (wxPyCBH_findCallback(m_myInst, "Draw")) {
571 PyObject* go = wxPyMake_wxObject(&grid);
572 PyObject* dco = wxPyMake_wxObject(&dc);
573 PyObject* ao = wxPyMake_wxGridCellAttr(&attr);
574 PyObject* ro = wxPyConstructObject((void*)&rect, "wxRect", 0);
576 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(OOOOiii)", go, ao, dco, ro,
577 row, col, isSelected));
583 wxPyEndBlockThreads();
586 wxSize GetBestSize(wxGrid& grid, wxGridCellAttr& attr, wxDC& dc,
589 wxPyBeginBlockThreads();
590 if (wxPyCBH_findCallback(m_myInst, "GetBestSize")) {
593 PyObject* go = wxPyMake_wxObject(&grid);
594 PyObject* dco = wxPyMake_wxObject(&dc);
595 PyObject* ao = wxPyMake_wxGridCellAttr(&attr);
597 ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(OOOii)",
605 const char* errmsg = "GetBestSize should return a 2-tuple of integers or a wxSize object.";
606 if (!SWIG_GetPtrObj(ro, (void **)&ptr, "_wxSize_p")) {
609 else if (PySequence_Check(ro) && PyObject_Length(ro) == 2) {
610 PyObject* o1 = PySequence_GetItem(ro, 0);
611 PyObject* o2 = PySequence_GetItem(ro, 1);
612 if (PyNumber_Check(o1) && PyNumber_Check(o2))
613 rval = wxSize(PyInt_AsLong(o1), PyInt_AsLong(o2));
615 PyErr_SetString(PyExc_TypeError, errmsg);
620 PyErr_SetString(PyExc_TypeError, errmsg);
625 wxPyEndBlockThreads();
630 wxGridCellRenderer *Clone() const {
631 wxGridCellRenderer* rval = NULL;
632 wxPyBeginBlockThreads();
633 if (wxPyCBH_findCallback(m_myInst, "Clone")) {
635 wxGridCellRenderer* ptr;
636 ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("()"));
638 if (!SWIG_GetPtrObj(ro, (void **)&ptr, "_wxGridCellRenderer_p"))
643 wxPyEndBlockThreads();
647 DEC_PYCALLBACK__STRING(SetParameters);
652 IMP_PYCALLBACK__STRING( wxPyGridCellRenderer, wxGridCellRenderer, SetParameters);
657 // Let SWIG know about it so it can create the Python version
658 class wxPyGridCellRenderer : public wxGridCellRenderer {
660 wxPyGridCellRenderer();
661 void _setCallbackInfo(PyObject* self, PyObject* _class);
662 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxPyGridCellRenderer)"
663 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
665 void base_SetParameters(const wxString& params);
668 //---------------------------------------------------------------------------
669 // Predefined Renderers
671 class wxGridCellStringRenderer : public wxGridCellRenderer
674 wxGridCellStringRenderer();
675 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
679 class wxGridCellNumberRenderer : public wxGridCellStringRenderer
682 wxGridCellNumberRenderer();
683 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
687 class wxGridCellFloatRenderer : public wxGridCellStringRenderer
690 wxGridCellFloatRenderer(int width = -1, int precision = -1);
691 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
693 int GetWidth() const;
694 void SetWidth(int width);
695 int GetPrecision() const;
696 void SetPrecision(int precision);
700 class wxGridCellBoolRenderer : public wxGridCellRenderer
703 wxGridCellBoolRenderer();
704 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
708 class wxGridCellDateTimeRenderer : public wxGridCellStringRenderer
711 wxGridCellDateTimeRenderer(wxString outformat = wxPyDateTimeFormatStr,
712 wxString informat = wxPyDateTimeFormatStr);
713 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
717 class wxGridCellEnumRenderer : public wxGridCellStringRenderer
720 wxGridCellEnumRenderer( const wxString& choices = wxPyEmptyString );
721 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
725 class wxGridCellAutoWrapStringRenderer : public wxGridCellStringRenderer
728 wxGridCellAutoWrapStringRenderer();
729 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
733 //---------------------------------------------------------------------------
734 // wxGridCellEditor is an ABC, and several derived classes are available.
735 // Classes implemented in Python should be derived from wxPyGridCellEditor.
737 class wxGridCellEditor
741 void _setOORInfo(PyObject* _self) {
742 self->SetClientObject(new wxPyOORClientData(_self));
747 wxControl* GetControl();
748 void SetControl(wxControl* control);
750 void SetParameters(const wxString& params);
754 virtual void Create(wxWindow* parent,
756 wxEvtHandler* evtHandler) = 0;
757 virtual void BeginEdit(int row, int col, wxGrid* grid) = 0;
758 virtual bool EndEdit(int row, int col, wxGrid* grid) = 0;
759 virtual void Reset() = 0;
760 virtual wxGridCellEditor *Clone() const = 0;
762 virtual void SetSize(const wxRect& rect);
763 virtual void Show(bool show, wxGridCellAttr *attr = NULL);
764 virtual void PaintBackground(const wxRect& rectCell, wxGridCellAttr *attr);
765 virtual bool IsAcceptedKey(wxKeyEvent& event);
766 virtual void StartingKey(wxKeyEvent& event);
767 virtual void StartingClick();
768 virtual void HandleReturn(wxKeyEvent& event);
769 virtual void Destroy();
774 // The C++ version of wxPyGridCellEditor
776 class wxPyGridCellEditor : public wxGridCellEditor
779 wxPyGridCellEditor() : wxGridCellEditor() {}
781 void Create(wxWindow* parent, wxWindowID id, wxEvtHandler* evtHandler) {
782 wxPyBeginBlockThreads();
783 if (wxPyCBH_findCallback(m_myInst, "Create")) {
784 PyObject* po = wxPyMake_wxObject(parent);
785 PyObject* eo = wxPyMake_wxObject(evtHandler);
787 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(OiO)", po, id, eo));
791 wxPyEndBlockThreads();
795 void BeginEdit(int row, int col, wxGrid* grid) {
796 wxPyBeginBlockThreads();
797 if (wxPyCBH_findCallback(m_myInst, "BeginEdit")) {
798 PyObject* go = wxPyMake_wxObject(grid);
799 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iiO)", row, col, go));
802 wxPyEndBlockThreads();
806 bool EndEdit(int row, int col, wxGrid* grid) {
808 wxPyBeginBlockThreads();
809 if (wxPyCBH_findCallback(m_myInst, "EndEdit")) {
810 PyObject* go = wxPyMake_wxObject(grid);
811 rv = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iiO)", row, col, go));
814 wxPyEndBlockThreads();
819 wxGridCellEditor*Clone() const {
820 wxGridCellEditor* rval = NULL;
821 wxPyBeginBlockThreads();
822 if (wxPyCBH_findCallback(m_myInst, "Clone")) {
824 wxGridCellEditor* ptr;
825 ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("()"));
827 if (!SWIG_GetPtrObj(ro, (void **)&ptr, "_wxGridCellEditor_p"))
832 wxPyEndBlockThreads();
837 void Show(bool show, wxGridCellAttr *attr) {
839 wxPyBeginBlockThreads();
840 if ((found = wxPyCBH_findCallback(m_myInst, "Show"))) {
841 PyObject* ao = wxPyMake_wxGridCellAttr(attr);
842 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iO)", show, ao));
845 wxPyEndBlockThreads();
847 wxGridCellEditor::Show(show, attr);
849 void base_Show(bool show, wxGridCellAttr *attr) {
850 wxGridCellEditor::Show(show, attr);
854 void PaintBackground(const wxRect& rectCell, wxGridCellAttr *attr) {
856 wxPyBeginBlockThreads();
857 if ((found = wxPyCBH_findCallback(m_myInst, "PaintBackground)"))) {
858 PyObject* ao = wxPyMake_wxGridCellAttr(attr);
859 PyObject* ro = wxPyConstructObject((void*)&rectCell, "wxRect", 0);
861 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(OO)", ro, ao));
866 wxPyEndBlockThreads();
868 wxGridCellEditor::PaintBackground(rectCell, attr);
870 void base_PaintBackground(const wxRect& rectCell, wxGridCellAttr *attr) {
871 wxGridCellEditor::PaintBackground(rectCell, attr);
875 DEC_PYCALLBACK___pure(Reset);
876 DEC_PYCALLBACK__constany(SetSize, wxRect);
877 DEC_PYCALLBACK_bool_any(IsAcceptedKey, wxKeyEvent);
878 DEC_PYCALLBACK__any(StartingKey, wxKeyEvent);
879 DEC_PYCALLBACK__any(HandleReturn, wxKeyEvent);
880 DEC_PYCALLBACK__(StartingClick);
881 DEC_PYCALLBACK__(Destroy);
882 DEC_PYCALLBACK__STRING(SetParameters);
888 IMP_PYCALLBACK__STRING( wxPyGridCellEditor, wxGridCellEditor, SetParameters);
889 IMP_PYCALLBACK___pure(wxPyGridCellEditor, wxGridCellEditor, Reset);
890 IMP_PYCALLBACK__constany(wxPyGridCellEditor, wxGridCellEditor, SetSize, wxRect);
891 IMP_PYCALLBACK_bool_any(wxPyGridCellEditor, wxGridCellEditor, IsAcceptedKey, wxKeyEvent);
892 IMP_PYCALLBACK__any(wxPyGridCellEditor, wxGridCellEditor, StartingKey, wxKeyEvent);
893 IMP_PYCALLBACK__any(wxPyGridCellEditor, wxGridCellEditor, HandleReturn, wxKeyEvent);
894 IMP_PYCALLBACK__(wxPyGridCellEditor, wxGridCellEditor, StartingClick);
895 IMP_PYCALLBACK__(wxPyGridCellEditor, wxGridCellEditor, Destroy);
900 // Let SWIG know about it so it can create the Python version
901 class wxPyGridCellEditor : public wxGridCellEditor {
903 wxPyGridCellEditor();
904 void _setCallbackInfo(PyObject* self, PyObject* _class);
905 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxPyGridCellEditor)"
906 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
908 void base_SetSize(const wxRect& rect);
909 void base_Show(bool show, wxGridCellAttr *attr = NULL);
910 void base_PaintBackground(const wxRect& rectCell, wxGridCellAttr *attr);
911 void base_IsAcceptedKey(wxKeyEvent& event);
912 void base_StartingKey(wxKeyEvent& event);
913 void base_StartingClick();
914 void base_HandleReturn(wxKeyEvent& event);
916 void base_SetParameters(const wxString& params);
919 //---------------------------------------------------------------------------
920 // Predefined Editors
922 class wxGridCellTextEditor : public wxGridCellEditor
925 wxGridCellTextEditor();
926 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
930 class wxGridCellNumberEditor : public wxGridCellTextEditor
933 wxGridCellNumberEditor(int min = -1, int max = -1);
934 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
938 class wxGridCellFloatEditor : public wxGridCellTextEditor
941 wxGridCellFloatEditor();
942 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
946 class wxGridCellBoolEditor : public wxGridCellEditor
949 wxGridCellBoolEditor();
950 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
953 class wxGridCellChoiceEditor : public wxGridCellEditor
956 wxGridCellChoiceEditor(int LCOUNT = 0,
957 const wxString* choices = NULL,
958 bool allowOthers = FALSE);
959 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
963 class wxGridCellEnumEditor : public wxGridCellChoiceEditor
966 wxGridCellEnumEditor( const wxString& choices = wxPyEmptyString );
967 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
971 class wxGridCellAutoWrapStringEditor : public wxGridCellTextEditor
974 wxGridCellAutoWrapStringEditor();
975 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
980 //---------------------------------------------------------------------------
997 void _setOORInfo(PyObject* _self) {
998 self->SetClientObject(new wxPyOORClientData(_self));
1002 wxGridCellAttr(wxGridCellAttr *attrDefault = NULL);
1003 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
1005 wxGridCellAttr *Clone() const;
1006 void MergeWith(wxGridCellAttr *mergefrom);
1009 void SetTextColour(const wxColour& colText);
1010 void SetBackgroundColour(const wxColour& colBack);
1011 void SetFont(const wxFont& font);
1012 void SetAlignment(int hAlign, int vAlign);
1013 void SetReadOnly(bool isReadOnly = TRUE);
1015 void SetRenderer(wxGridCellRenderer *renderer);
1016 void SetEditor(wxGridCellEditor* editor);
1017 void SetKind(wxAttrKind kind);
1019 bool HasTextColour() const;
1020 bool HasBackgroundColour() const;
1021 bool HasFont() const;
1022 bool HasAlignment() const;
1023 bool HasRenderer() const;
1024 bool HasEditor() const;
1025 bool HasReadWriteMode() const;
1027 wxColour GetTextColour() const;
1028 wxColour GetBackgroundColour() const;
1029 wxFont GetFont() const;
1030 void GetAlignment(int *OUTPUT, int *OUTPUT) const;
1031 wxGridCellRenderer *GetRenderer(wxGrid* grid, int row, int col) const;
1032 wxGridCellEditor *GetEditor(wxGrid* grid, int row, int col) const;
1034 bool IsReadOnly() const;
1035 void SetDefAttr(wxGridCellAttr* defAttr);
1038 //---------------------------------------------------------------------------
1040 class wxGridCellAttrProvider
1043 wxGridCellAttrProvider();
1044 // ???? virtual ~wxGridCellAttrProvider();
1045 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
1048 void _setOORInfo(PyObject* _self) {
1049 self->SetClientObject(new wxPyOORClientData(_self));
1053 wxGridCellAttr *GetAttr(int row, int col,
1054 wxGridCellAttr::wxAttrKind kind) const;
1055 void SetAttr(wxGridCellAttr *attr, int row, int col);
1056 void SetRowAttr(wxGridCellAttr *attr, int row);
1057 void SetColAttr(wxGridCellAttr *attr, int col);
1059 void UpdateAttrRows( size_t pos, int numRows );
1060 void UpdateAttrCols( size_t pos, int numCols );
1065 // A Python-aware version
1067 class wxPyGridCellAttrProvider : public wxGridCellAttrProvider
1070 wxPyGridCellAttrProvider() : wxGridCellAttrProvider() {};
1072 PYCALLBACK_GCA_INTINTKIND(wxGridCellAttrProvider, GetAttr);
1073 PYCALLBACK__GCAINTINT(wxGridCellAttrProvider, SetAttr);
1074 PYCALLBACK__GCAINT(wxGridCellAttrProvider, SetRowAttr);
1075 PYCALLBACK__GCAINT(wxGridCellAttrProvider, SetColAttr);
1082 // The python-aware version get's SWIGified
1083 class wxPyGridCellAttrProvider : public wxGridCellAttrProvider
1086 wxPyGridCellAttrProvider();
1087 void _setCallbackInfo(PyObject* self, PyObject* _class);
1088 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxPyGridCellAttrProvider)"
1090 wxGridCellAttr *base_GetAttr(int row, int col,
1091 wxGridCellAttr::wxAttrKind kind);
1092 void base_SetAttr(wxGridCellAttr *attr, int row, int col);
1093 void base_SetRowAttr(wxGridCellAttr *attr, int row);
1094 void base_SetColAttr(wxGridCellAttr *attr, int col);
1098 //---------------------------------------------------------------------------
1099 // Grid Table Base class and Python aware version
1102 class wxGridTableBase : public wxObject
1105 // wxGridTableBase(); This is an ABC
1106 //~wxGridTableBase();
1109 void _setOORInfo(PyObject* _self) {
1110 self->SetClientObject(new wxPyOORClientData(_self));
1114 void SetAttrProvider(wxGridCellAttrProvider *attrProvider);
1115 wxGridCellAttrProvider *GetAttrProvider() const;
1116 void SetView( wxGrid *grid );
1117 wxGrid * GetView() const;
1121 virtual int GetNumberRows() = 0;
1122 virtual int GetNumberCols() = 0;
1123 virtual bool IsEmptyCell( int row, int col ) = 0;
1124 virtual wxString GetValue( int row, int col ) = 0;
1125 virtual void SetValue( int row, int col, const wxString& value ) = 0;
1127 // virtuals overridable in wxPyGridTableBase
1128 virtual wxString GetTypeName( int row, int col );
1129 virtual bool CanGetValueAs( int row, int col, const wxString& typeName );
1130 virtual bool CanSetValueAs( int row, int col, const wxString& typeName );
1131 virtual long GetValueAsLong( int row, int col );
1132 virtual double GetValueAsDouble( int row, int col );
1133 virtual bool GetValueAsBool( int row, int col );
1134 virtual void SetValueAsLong( int row, int col, long value );
1135 virtual void SetValueAsDouble( int row, int col, double value );
1136 virtual void SetValueAsBool( int row, int col, bool value );
1138 //virtual void* GetValueAsCustom( int row, int col, const wxString& typeName );
1139 //virtual void SetValueAsCustom( int row, int col, const wxString& typeName, void* value );
1142 virtual void Clear();
1143 virtual bool InsertRows( size_t pos = 0, size_t numRows = 1 );
1144 virtual bool AppendRows( size_t numRows = 1 );
1145 virtual bool DeleteRows( size_t pos = 0, size_t numRows = 1 );
1146 virtual bool InsertCols( size_t pos = 0, size_t numCols = 1 );
1147 virtual bool AppendCols( size_t numCols = 1 );
1148 virtual bool DeleteCols( size_t pos = 0, size_t numCols = 1 );
1150 virtual wxString GetRowLabelValue( int row );
1151 virtual wxString GetColLabelValue( int col );
1152 virtual void SetRowLabelValue( int row, const wxString& value );
1153 virtual void SetColLabelValue( int col, const wxString& value );
1155 virtual bool CanHaveAttributes();
1157 virtual wxGridCellAttr *GetAttr( int row, int col,
1158 wxGridCellAttr::wxAttrKind kind);
1159 virtual void SetAttr(wxGridCellAttr* attr, int row, int col);
1160 virtual void SetRowAttr(wxGridCellAttr *attr, int row);
1161 virtual void SetColAttr(wxGridCellAttr *attr, int col);
1167 // Python-aware version
1169 class wxPyGridTableBase : public wxGridTableBase
1172 wxPyGridTableBase() : wxGridTableBase() {}
1174 PYCALLBACK_INT__pure(GetNumberRows);
1175 PYCALLBACK_INT__pure(GetNumberCols);
1176 PYCALLBACK_BOOL_INTINT_pure(IsEmptyCell);
1177 PYCALLBACK_STRING_INTINT(wxGridTableBase, GetTypeName);
1178 PYCALLBACK_BOOL_INTINTSTRING(wxGridTableBase, CanGetValueAs);
1179 PYCALLBACK_BOOL_INTINTSTRING(wxGridTableBase, CanSetValueAs);
1180 PYCALLBACK__(wxGridTableBase, Clear);
1181 PYCALLBACK_BOOL_SIZETSIZET(wxGridTableBase, InsertRows);
1182 PYCALLBACK_BOOL_SIZETSIZET(wxGridTableBase, DeleteRows);
1183 PYCALLBACK_BOOL_SIZETSIZET(wxGridTableBase, InsertCols);
1184 PYCALLBACK_BOOL_SIZETSIZET(wxGridTableBase, DeleteCols);
1185 PYCALLBACK_BOOL_SIZET(wxGridTableBase, AppendRows);
1186 PYCALLBACK_BOOL_SIZET(wxGridTableBase, AppendCols);
1187 PYCALLBACK_STRING_INT(wxGridTableBase, GetRowLabelValue);
1188 PYCALLBACK_STRING_INT(wxGridTableBase, GetColLabelValue);
1189 PYCALLBACK__INTSTRING(wxGridTableBase, SetRowLabelValue);
1190 PYCALLBACK__INTSTRING(wxGridTableBase, SetColLabelValue);
1191 PYCALLBACK_BOOL_(wxGridTableBase, CanHaveAttributes);
1192 PYCALLBACK_GCA_INTINTKIND(wxGridTableBase, GetAttr);
1193 PYCALLBACK__GCAINTINT(wxGridTableBase, SetAttr);
1194 PYCALLBACK__GCAINT(wxGridTableBase, SetRowAttr);
1195 PYCALLBACK__GCAINT(wxGridTableBase, SetColAttr);
1198 wxString GetValue(int row, int col) {
1199 wxPyBeginBlockThreads();
1201 if (wxPyCBH_findCallback(m_myInst, "GetValue")) {
1203 ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(ii)",row,col));
1205 rval = Py2wxString(ro);
1209 wxPyEndBlockThreads();
1213 void SetValue(int row, int col, const wxString& val) {
1214 wxPyBeginBlockThreads();
1215 if (wxPyCBH_findCallback(m_myInst, "SetValue")) {
1216 PyObject* s = wx2PyString(val);
1217 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iiO)",row,col,s));
1220 wxPyEndBlockThreads();
1224 // Map the Get/Set methods for the standard non-string types to
1225 // the GetValue and SetValue python methods.
1226 long GetValueAsLong( int row, int col ) {
1228 wxPyBeginBlockThreads();
1229 if (wxPyCBH_findCallback(m_myInst, "GetValue")) {
1232 ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(ii)", row, col));
1233 if (ro && PyNumber_Check(ro)) {
1234 num = PyNumber_Int(ro);
1236 rval = PyInt_AsLong(num);
1242 wxPyEndBlockThreads();
1246 double GetValueAsDouble( int row, int col ) {
1248 wxPyBeginBlockThreads();
1249 if (wxPyCBH_findCallback(m_myInst, "GetValue")) {
1252 ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(ii)", row, col));
1253 if (ro && PyNumber_Check(ro)) {
1254 num = PyNumber_Float(ro);
1256 rval = PyFloat_AsDouble(num);
1262 wxPyEndBlockThreads();
1266 bool GetValueAsBool( int row, int col ) {
1267 return (bool)GetValueAsLong(row, col);
1270 void SetValueAsLong( int row, int col, long value ) {
1271 wxPyBeginBlockThreads();
1272 if (wxPyCBH_findCallback(m_myInst, "SetValue")) {
1273 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iii)", row, col, value));
1275 wxPyEndBlockThreads();
1278 void SetValueAsDouble( int row, int col, double value ) {
1279 wxPyBeginBlockThreads();
1280 if (wxPyCBH_findCallback(m_myInst, "SetValue")) {
1281 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iid)", row, col, value));
1283 wxPyEndBlockThreads();
1286 void SetValueAsBool( int row, int col, bool value ) {
1287 SetValueAsLong( row, col, (long)value );
1296 // The python-aware version get's SWIGified
1297 class wxPyGridTableBase : public wxGridTableBase
1300 wxPyGridTableBase();
1301 void _setCallbackInfo(PyObject* self, PyObject* _class);
1302 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxPyGridTableBase)"
1303 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
1305 %addmethods { void Destroy() { delete self; } }
1307 wxString base_GetTypeName( int row, int col );
1308 bool base_CanGetValueAs( int row, int col, const wxString& typeName );
1309 bool base_CanSetValueAs( int row, int col, const wxString& typeName );
1311 bool base_InsertRows( size_t pos = 0, size_t numRows = 1 );
1312 bool base_AppendRows( size_t numRows = 1 );
1313 bool base_DeleteRows( size_t pos = 0, size_t numRows = 1 );
1314 bool base_InsertCols( size_t pos = 0, size_t numCols = 1 );
1315 bool base_AppendCols( size_t numCols = 1 );
1316 bool base_DeleteCols( size_t pos = 0, size_t numCols = 1 );
1317 wxString base_GetRowLabelValue( int row );
1318 wxString base_GetColLabelValue( int col );
1319 void base_SetRowLabelValue( int row, const wxString& value );
1320 void base_SetColLabelValue( int col, const wxString& value );
1321 bool base_CanHaveAttributes();
1322 wxGridCellAttr *base_GetAttr( int row, int col,
1323 wxGridCellAttr::wxAttrKind kind );
1324 void base_SetAttr(wxGridCellAttr* attr, int row, int col);
1325 void base_SetRowAttr(wxGridCellAttr *attr, int row);
1326 void base_SetColAttr(wxGridCellAttr *attr, int col);
1330 //---------------------------------------------------------------------------
1331 // Predefined Tables
1333 class wxGridStringTable : public wxGridTableBase
1336 wxGridStringTable( int numRows=0, int numCols=0 );
1337 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
1340 //---------------------------------------------------------------------------
1341 // The Table can pass messages to the grid to tell it to update itself if
1342 // something has changed.
1344 enum wxGridTableRequest
1346 wxGRIDTABLE_REQUEST_VIEW_GET_VALUES = 2000,
1347 wxGRIDTABLE_REQUEST_VIEW_SEND_VALUES,
1348 wxGRIDTABLE_NOTIFY_ROWS_INSERTED,
1349 wxGRIDTABLE_NOTIFY_ROWS_APPENDED,
1350 wxGRIDTABLE_NOTIFY_ROWS_DELETED,
1351 wxGRIDTABLE_NOTIFY_COLS_INSERTED,
1352 wxGRIDTABLE_NOTIFY_COLS_APPENDED,
1353 wxGRIDTABLE_NOTIFY_COLS_DELETED
1357 class wxGridTableMessage
1360 wxGridTableMessage( wxGridTableBase *table, int id,
1363 ~wxGridTableMessage();
1365 void SetTableObject( wxGridTableBase *table );
1366 wxGridTableBase * GetTableObject() const;
1367 void SetId( int id );
1369 void SetCommandInt( int comInt1 );
1370 int GetCommandInt();
1371 void SetCommandInt2( int comInt2 );
1372 int GetCommandInt2();
1376 //---------------------------------------------------------------------------
1378 class wxGridCellCoords
1381 wxGridCellCoords( int r=-1, int c=-1 );
1382 ~wxGridCellCoords();
1384 int GetRow() const { return m_row; }
1385 void SetRow( int n ) { m_row = n; }
1386 int GetCol() const { return m_col; }
1387 void SetCol( int n ) { m_col = n; }
1388 void Set( int row, int col ) { m_row = row; m_col = col; }
1391 PyObject* asTuple() {
1392 PyObject* tup = PyTuple_New(2);
1393 PyTuple_SET_ITEM(tup, 0, PyInt_FromLong(self->GetRow()));
1394 PyTuple_SET_ITEM(tup, 1, PyInt_FromLong(self->GetCol()));
1398 int __cmp__( const wxGridCellCoords& other ) {
1399 return *self != other;
1402 %pragma(python) addtoclass = "def __str__(self): return str(self.asTuple())"
1403 %pragma(python) addtoclass = "def __repr__(self): return str(self.asTuple())"
1406 // Typemap to allow conversion of sequence objects to wxGridCellCoords...
1407 %typemap(python,in) wxGridCellCoords& (wxGridCellCoords temp) {
1409 if (! wxGridCellCoords_helper($source, &$target))
1413 // ...and here is the associated helper.
1415 bool wxGridCellCoords_helper(PyObject* source, wxGridCellCoords** obj) {
1417 // If source is an object instance then it may already be the right type
1418 if (PyInstance_Check(source)) {
1419 wxGridCellCoords* ptr;
1420 if (SWIG_GetPtrObj(source, (void **)&ptr, "_wxGridCellCoords_p"))
1425 // otherwise a 2-tuple of integers is expected
1426 else if (PySequence_Check(source) && PyObject_Length(source) == 2) {
1427 PyObject* o1 = PySequence_GetItem(source, 0);
1428 PyObject* o2 = PySequence_GetItem(source, 1);
1429 **obj = wxGridCellCoords(PyInt_AsLong(o1), PyInt_AsLong(o2));
1434 PyErr_SetString(PyExc_TypeError, "Expected a 2-tuple of integers or a wxGridCellCoords object.");
1439 //---------------------------------------------------------------------------
1440 //---------------------------------------------------------------------------
1444 // Fool SWIG into treating this enum as an int
1445 typedef int WXGRIDSELECTIONMODES;
1447 // but let the C++ code know what it really is.
1449 typedef wxGrid::wxGridSelectionModes WXGRIDSELECTIONMODES;
1454 class wxGrid : public wxScrolledWindow
1457 wxGrid( wxWindow *parent,
1459 const wxPoint& pos = wxDefaultPosition,
1460 const wxSize& size = wxDefaultSize,
1461 long style = wxWANTS_CHARS,
1462 const wxString& name = wxPyPanelNameStr);
1464 %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
1466 enum wxGridSelectionModes {wxGridSelectCells,
1468 wxGridSelectColumns};
1470 bool CreateGrid( int numRows, int numCols,
1471 WXGRIDSELECTIONMODES selmode = wxGrid::wxGridSelectCells );
1472 void SetSelectionMode(WXGRIDSELECTIONMODES selmode);
1475 // ------ grid dimensions
1477 int GetNumberRows();
1478 int GetNumberCols();
1481 bool ProcessTableMessage( wxGridTableMessage& );
1484 wxGridTableBase * GetTable() const;
1485 bool SetTable( wxGridTableBase *table, bool takeOwnership=FALSE,
1486 WXGRIDSELECTIONMODES selmode =
1487 wxGrid::wxGridSelectCells );
1490 bool InsertRows( int pos = 0, int numRows = 1, bool updateLabels=TRUE );
1491 bool AppendRows( int numRows = 1, bool updateLabels=TRUE );
1492 bool DeleteRows( int pos = 0, int numRows = 1, bool updateLabels=TRUE );
1493 bool InsertCols( int pos = 0, int numCols = 1, bool updateLabels=TRUE );
1494 bool AppendCols( int numCols = 1, bool updateLabels=TRUE );
1495 bool DeleteCols( int pos = 0, int numCols = 1, bool updateLabels=TRUE );
1498 // this function is called when the current cell highlight must be redrawn
1499 // and may be overridden by the user
1500 virtual void DrawCellHighlight( wxDC& dc, const wxGridCellAttr *attr );
1503 // ------ Cell text drawing functions
1505 void DrawTextRectangle( wxDC& dc, const wxString&, const wxRect&,
1506 int horizontalAlignment = wxLEFT,
1507 int verticalAlignment = wxTOP );
1509 // // Split a string containing newline chararcters into an array of
1510 // // strings and return the number of lines
1512 // void StringToLines( const wxString& value, wxArrayString& lines );
1514 void GetTextBoxSize( wxDC& dc,
1515 wxArrayString& lines,
1516 long *OUTPUT, long *OUTPUT );
1520 // Code that does a lot of grid modification can be enclosed
1521 // between BeginBatch() and EndBatch() calls to avoid screen
1526 int GetBatchCount();
1527 void ForceRefresh();
1530 // ------ edit control functions
1532 bool IsEditable() { return m_editable; }
1533 void EnableEditing( bool edit );
1535 void EnableCellEditControl( bool enable = TRUE );
1536 void DisableCellEditControl();
1537 bool CanEnableCellControl() const;
1538 bool IsCellEditControlEnabled() const;
1539 bool IsCellEditControlShown() const;
1541 bool IsCurrentCellReadOnly() const;
1543 void ShowCellEditControl();
1544 void HideCellEditControl();
1545 void SaveEditControlValue();
1548 // ------ grid location functions
1549 // Note that all of these functions work with the logical coordinates of
1550 // grid cells and labels so you will need to convert from device
1551 // coordinates for mouse events etc.
1554 //void XYToCell( int x, int y, wxGridCellCoords& );
1556 %new wxGridCellCoords* XYToCell(int x, int y) {
1557 wxGridCellCoords rv;
1558 self->XYToCell(x, y, rv);
1559 return new wxGridCellCoords(rv);
1563 int YToRow( int y );
1564 int XToCol( int x );
1566 int YToEdgeOfRow( int y );
1567 int XToEdgeOfCol( int x );
1569 wxRect CellToRect( int row, int col );
1570 // TODO: ??? wxRect CellToRect( const wxGridCellCoords& coords );
1573 int GetGridCursorRow();
1574 int GetGridCursorCol();
1576 // check to see if a cell is either wholly visible (the default arg) or
1577 // at least partially visible in the grid window
1579 bool IsVisible( int row, int col, bool wholeCellVisible = TRUE );
1580 // TODO: ??? bool IsVisible( const wxGridCellCoords& coords, bool wholeCellVisible = TRUE );
1581 void MakeCellVisible( int row, int col );
1582 // TODO: ??? void MakeCellVisible( const wxGridCellCoords& coords );
1585 // ------ grid cursor movement functions
1587 void SetGridCursor( int row, int col );
1588 bool MoveCursorUp( bool expandSelection );
1589 bool MoveCursorDown( bool expandSelection );
1590 bool MoveCursorLeft( bool expandSelection );
1591 bool MoveCursorRight( bool expandSelection );
1592 bool MovePageDown();
1594 bool MoveCursorUpBlock( bool expandSelection );
1595 bool MoveCursorDownBlock( bool expandSelection );
1596 bool MoveCursorLeftBlock( bool expandSelection );
1597 bool MoveCursorRightBlock( bool expandSelection );
1600 // ------ label and gridline formatting
1602 int GetDefaultRowLabelSize();
1603 int GetRowLabelSize();
1604 int GetDefaultColLabelSize();
1605 int GetColLabelSize();
1606 wxColour GetLabelBackgroundColour();
1607 wxColour GetLabelTextColour();
1608 wxFont GetLabelFont();
1609 void GetRowLabelAlignment( int *OUTPUT, int *OUTPUT );
1610 void GetColLabelAlignment( int *OUTPUT, int *OUTPUT );
1611 wxString GetRowLabelValue( int row );
1612 wxString GetColLabelValue( int col );
1613 wxColour GetGridLineColour();
1614 wxColour GetCellHighlightColour();
1615 int GetCellHighlightPenWidth();
1616 int GetCellHighlightROPenWidth();
1618 void SetRowLabelSize( int width );
1619 void SetColLabelSize( int height );
1620 void SetLabelBackgroundColour( const wxColour& );
1621 void SetLabelTextColour( const wxColour& );
1622 void SetLabelFont( const wxFont& );
1623 void SetRowLabelAlignment( int horiz, int vert );
1624 void SetColLabelAlignment( int horiz, int vert );
1625 void SetRowLabelValue( int row, const wxString& );
1626 void SetColLabelValue( int col, const wxString& );
1627 void SetGridLineColour( const wxColour& );
1628 void SetCellHighlightColour( const wxColour& );
1629 void SetCellHighlightPenWidth(int width);
1630 void SetCellHighlightROPenWidth(int width);
1632 void EnableDragRowSize( bool enable = TRUE );
1633 void DisableDragRowSize();
1634 bool CanDragRowSize();
1635 void EnableDragColSize( bool enable = TRUE );
1636 void DisableDragColSize();
1637 bool CanDragColSize();
1638 void EnableDragGridSize(bool enable = TRUE);
1639 void DisableDragGridSize();
1640 bool CanDragGridSize();
1642 // this sets the specified attribute for all cells in this row/col
1643 void SetRowAttr(int row, wxGridCellAttr *attr);
1644 void SetColAttr(int col, wxGridCellAttr *attr);
1646 // shortcuts for setting the column parameters
1648 // set the format for the data in the column: default is string
1649 void SetColFormatBool(int col);
1650 void SetColFormatNumber(int col);
1651 void SetColFormatFloat(int col, int width = -1, int precision = -1);
1652 void SetColFormatCustom(int col, const wxString& typeName);
1654 void EnableGridLines( bool enable = TRUE );
1655 bool GridLinesEnabled();
1657 // ------ row and col formatting
1659 int GetDefaultRowSize();
1660 int GetRowSize( int row );
1661 int GetDefaultColSize();
1662 int GetColSize( int col );
1663 wxColour GetDefaultCellBackgroundColour();
1664 wxColour GetCellBackgroundColour( int row, int col );
1665 wxColour GetDefaultCellTextColour();
1666 wxColour GetCellTextColour( int row, int col );
1667 wxFont GetDefaultCellFont();
1668 wxFont GetCellFont( int row, int col );
1669 void GetDefaultCellAlignment( int *horiz, int *vert );
1670 void GetCellAlignment( int row, int col, int *horiz, int *vert );
1672 void SetDefaultRowSize( int height, bool resizeExistingRows = FALSE );
1673 void SetRowSize( int row, int height );
1674 void SetDefaultColSize( int width, bool resizeExistingCols = FALSE );
1676 void SetColSize( int col, int width );
1678 // automatically size the column or row to fit to its contents, if
1679 // setAsMin is TRUE, this optimal width will also be set as minimal width
1681 void AutoSizeColumn( int col, bool setAsMin = TRUE );
1682 void AutoSizeRow( int row, bool setAsMin = TRUE );
1685 // auto size all columns (very ineffective for big grids!)
1686 void AutoSizeColumns( bool setAsMin = TRUE );
1687 void AutoSizeRows( bool setAsMin = TRUE );
1689 // auto size the grid, that is make the columns/rows of the "right" size
1690 // and also set the grid size to just fit its contents
1693 // column won't be resized to be lesser width - this must be called during
1694 // the grid creation because it won't resize the column if it's already
1695 // narrower than the minimal width
1696 void SetColMinimalWidth( int col, int width );
1697 void SetRowMinimalHeight( int row, int width );
1699 void SetDefaultCellBackgroundColour( const wxColour& );
1700 void SetCellBackgroundColour( int row, int col, const wxColour& );
1701 void SetDefaultCellTextColour( const wxColour& );
1703 void SetCellTextColour( int row, int col, const wxColour& );
1704 void SetDefaultCellFont( const wxFont& );
1705 void SetCellFont( int row, int col, const wxFont& );
1706 void SetDefaultCellAlignment( int horiz, int vert );
1707 void SetCellAlignment( int row, int col, int horiz, int vert );
1709 // takes ownership of the pointer
1710 void SetDefaultRenderer(wxGridCellRenderer *renderer);
1711 void SetCellRenderer(int row, int col, wxGridCellRenderer *renderer);
1712 wxGridCellRenderer *GetDefaultRenderer() const;
1713 wxGridCellRenderer* GetCellRenderer(int row, int col);
1715 // takes ownership of the pointer
1716 void SetDefaultEditor(wxGridCellEditor *editor);
1717 void SetCellEditor(int row, int col, wxGridCellEditor *editor);
1718 wxGridCellEditor *GetDefaultEditor() const;
1719 wxGridCellEditor* GetCellEditor(int row, int col);
1723 // ------ cell value accessors
1725 wxString GetCellValue( int row, int col );
1726 // TODO: ??? wxString GetCellValue( const wxGridCellCoords& coords )
1728 void SetCellValue( int row, int col, const wxString& s );
1729 // TODO: ??? void SetCellValue( const wxGridCellCoords& coords, const wxString& s )
1731 // returns TRUE if the cell can't be edited
1732 bool IsReadOnly(int row, int col) const;
1734 // make the cell editable/readonly
1735 void SetReadOnly(int row, int col, bool isReadOnly = TRUE);
1737 // ------ selections of blocks of cells
1739 void SelectRow( int row, bool addToSelected = FALSE );
1740 void SelectCol( int col, bool addToSelected = FALSE );
1742 void SelectBlock( int topRow, int leftCol, int bottomRow, int rightCol,
1743 bool addToSelected = FALSE );
1744 // TODO: ??? void SelectBlock( const wxGridCellCoords& topLeft,
1745 // TODO: ??? const wxGridCellCoords& bottomRight )
1749 void ClearSelection();
1750 bool IsInSelection( int row, int col );
1751 // TODO: ??? bool IsInSelection( const wxGridCellCoords& coords )
1754 // This function returns the rectangle that encloses the block of cells
1755 // limited by TopLeft and BottomRight cell in device coords and clipped
1756 // to the client size of the grid window.
1758 wxRect BlockToDeviceRect( const wxGridCellCoords & topLeft,
1759 const wxGridCellCoords & bottomRight );
1762 // Access or update the selection fore/back colours
1763 wxColour GetSelectionBackground() const;
1764 wxColour GetSelectionForeground() const;
1766 void SetSelectionBackground(const wxColour& c);
1767 void SetSelectionForeground(const wxColour& c);
1770 // Methods for a registry for mapping data types to Renderers/Editors
1771 void RegisterDataType(const wxString& typeName,
1772 wxGridCellRenderer* renderer,
1773 wxGridCellEditor* editor);
1774 wxGridCellEditor* GetDefaultEditorForCell(int row, int col) const;
1775 // TODO: ??? wxGridCellEditor* GetDefaultEditorForCell(const wxGridCellCoords& c) const
1776 wxGridCellRenderer* GetDefaultRendererForCell(int row, int col) const;
1777 wxGridCellEditor* GetDefaultEditorForType(const wxString& typeName) const;
1778 wxGridCellRenderer* GetDefaultRendererForType(const wxString& typeName) const;
1780 // grid may occupy more space than needed for its rows/columns, this
1781 // function allows to set how big this extra space is
1782 void SetMargins(int extraWidth, int extraHeight);
1785 // Accessors for component windows
1786 wxWindow* GetGridWindow();
1787 wxWindow* GetGridRowLabelWindow();
1788 wxWindow* GetGridColLabelWindow();
1789 wxWindow* GetGridCornerLabelWindow();
1795 //---------------------------------------------------------------------------
1796 //---------------------------------------------------------------------------
1797 // Grid events and stuff
1801 class wxGridEvent : public wxNotifyEvent
1804 wxGridEvent(int id, wxEventType type, wxGrid* obj,
1805 int row=-1, int col=-1, int x=-1, int y=-1, bool sel = TRUE,
1806 bool control=FALSE, bool shift=FALSE, bool alt=FALSE, bool meta=FALSE);
1808 virtual int GetRow();
1809 virtual int GetCol();
1810 wxPoint GetPosition();
1820 class wxGridSizeEvent : public wxNotifyEvent
1823 wxGridSizeEvent(int id, wxEventType type, wxGrid* obj,
1824 int rowOrCol=-1, int x=-1, int y=-1,
1825 bool control=FALSE, bool shift=FALSE, bool alt=FALSE, bool meta=FALSE);
1828 wxPoint GetPosition();
1837 class wxGridRangeSelectEvent : public wxNotifyEvent
1840 wxGridRangeSelectEvent(int id, wxEventType type, wxGrid* obj,
1841 const wxGridCellCoords& topLeft,
1842 const wxGridCellCoords& bottomRight,
1844 bool control=FALSE, bool shift=FALSE,
1845 bool alt=FALSE, bool meta=FALSE);
1847 wxGridCellCoords GetTopLeftCoords();
1848 wxGridCellCoords GetBottomRightCoords();
1861 class wxGridEditorCreatedEvent : public wxCommandEvent {
1863 wxGridEditorCreatedEvent(int id, wxEventType type, wxObject* obj,
1864 int row, int col, wxControl* ctrl);
1868 wxControl* GetControl();
1869 void SetRow(int row);
1870 void SetCol(int col);
1871 void SetControl(wxControl* ctrl);
1877 wxEVT_GRID_CELL_LEFT_CLICK,
1878 wxEVT_GRID_CELL_RIGHT_CLICK,
1879 wxEVT_GRID_CELL_LEFT_DCLICK,
1880 wxEVT_GRID_CELL_RIGHT_DCLICK,
1881 wxEVT_GRID_LABEL_LEFT_CLICK,
1882 wxEVT_GRID_LABEL_RIGHT_CLICK,
1883 wxEVT_GRID_LABEL_LEFT_DCLICK,
1884 wxEVT_GRID_LABEL_RIGHT_DCLICK,
1885 wxEVT_GRID_ROW_SIZE,
1886 wxEVT_GRID_COL_SIZE,
1887 wxEVT_GRID_RANGE_SELECT,
1888 wxEVT_GRID_CELL_CHANGE,
1889 wxEVT_GRID_SELECT_CELL,
1890 wxEVT_GRID_EDITOR_SHOWN,
1891 wxEVT_GRID_EDITOR_HIDDEN,
1892 wxEVT_GRID_EDITOR_CREATED,
1897 %pragma(python) code = "
1898 def EVT_GRID_CELL_LEFT_CLICK(win, fn):
1899 win.Connect(-1, -1, wxEVT_GRID_CELL_LEFT_CLICK, fn)
1901 def EVT_GRID_CELL_RIGHT_CLICK(win, fn):
1902 win.Connect(-1, -1, wxEVT_GRID_CELL_RIGHT_CLICK, fn)
1904 def EVT_GRID_CELL_LEFT_DCLICK(win, fn):
1905 win.Connect(-1, -1, wxEVT_GRID_CELL_LEFT_DCLICK, fn)
1907 def EVT_GRID_CELL_RIGHT_DCLICK(win, fn):
1908 win.Connect(-1, -1, wxEVT_GRID_CELL_RIGHT_DCLICK, fn)
1910 def EVT_GRID_LABEL_LEFT_CLICK(win, fn):
1911 win.Connect(-1, -1, wxEVT_GRID_LABEL_LEFT_CLICK, fn)
1913 def EVT_GRID_LABEL_RIGHT_CLICK(win, fn):
1914 win.Connect(-1, -1, wxEVT_GRID_LABEL_RIGHT_CLICK, fn)
1916 def EVT_GRID_LABEL_LEFT_DCLICK(win, fn):
1917 win.Connect(-1, -1, wxEVT_GRID_LABEL_LEFT_DCLICK, fn)
1919 def EVT_GRID_LABEL_RIGHT_DCLICK(win, fn):
1920 win.Connect(-1, -1, wxEVT_GRID_LABEL_RIGHT_DCLICK, fn)
1922 def EVT_GRID_ROW_SIZE(win, fn):
1923 win.Connect(-1, -1, wxEVT_GRID_ROW_SIZE, fn)
1925 def EVT_GRID_COL_SIZE(win, fn):
1926 win.Connect(-1, -1, wxEVT_GRID_COL_SIZE, fn)
1928 def EVT_GRID_RANGE_SELECT(win, fn):
1929 win.Connect(-1, -1, wxEVT_GRID_RANGE_SELECT, fn)
1931 def EVT_GRID_CELL_CHANGE(win, fn):
1932 win.Connect(-1, -1, wxEVT_GRID_CELL_CHANGE, fn)
1934 def EVT_GRID_SELECT_CELL(win, fn):
1935 win.Connect(-1, -1, wxEVT_GRID_SELECT_CELL, fn)
1937 def EVT_GRID_EDITOR_SHOWN(win, fn):
1938 win.Connect(-1, -1, wxEVT_GRID_EDITOR_SHOWN, fn)
1940 def EVT_GRID_EDITOR_HIDDEN(win, fn):
1941 win.Connect(-1, -1, wxEVT_GRID_EDITOR_HIDDEN, fn)
1943 def EVT_GRID_EDITOR_CREATED(win, fn):
1944 win.Connect(-1, -1, wxEVT_GRID_EDITOR_CREATED, fn)
1948 //---------------------------------------------------------------------------
1951 wxClassInfo::CleanUpClasses();
1952 wxClassInfo::InitializeClasses();
1955 //---------------------------------------------------------------------------
1957 %pragma(python) include="_gridextras.py";
1959 //---------------------------------------------------------------------------