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 /////////////////////////////////////////////////////////////////////////////
14 "Classes for implementing a spreadsheet-like control."
17 %module(package="wx", docstring=DOCSTRING) grid
21 #include "wx/wxPython/wxPython.h"
22 #include "wx/wxPython/pyclasses.h"
23 #include "wx/wxPython/printfw.h"
26 #include <wx/generic/gridctrl.h>
31 //---------------------------------------------------------------------------
34 %pythoncode { wx = _core }
35 %pythoncode { __docfilter__ = wx.__DocFilter(globals()) }
38 %include _grid_rename.i
40 MAKE_CONST_WXSTRING_NOSWIG(EmptyString);
41 MAKE_CONST_WXSTRING_NOSWIG(PanelNameStr);
42 MAKE_CONST_WXSTRING2(DateTimeFormatStr, wxT("%c"));
45 //---------------------------------------------------------------------------
46 // OOR related typemaps and helper functions
48 %typemap(out) wxGridCellRenderer* { $result = wxPyMake_wxGridCellRenderer($1); }
49 %typemap(out) wxGridCellEditor* { $result = wxPyMake_wxGridCellEditor($1); }
50 %typemap(out) wxGridCellAttr* { $result = wxPyMake_wxGridCellAttr($1); }
51 %typemap(out) wxGridCellAttrProvider* { $result = wxPyMake_wxGridCellAttrProvider($1); }
52 %typemap(out) wxGridTableBase* { $result = wxPyMake_wxGridTableBase($1); }
57 #define wxPyMake_TEMPLATE(TYPE) \
58 PyObject* wxPyMake_##TYPE(TYPE* source) { \
59 PyObject* target = NULL; \
61 /* Check if there is already a pointer to a Python object in the \
62 OOR data that we can use. */ \
63 wxPyOORClientData* data = (wxPyOORClientData*)source->GetClientObject(); \
65 target = data->m_obj; \
68 /* Otherwise make a new wrapper for it the old fashioned way and \
69 give it the OOR treatment */ \
71 target = wxPyConstructObject(source, wxT(#TYPE), False); \
73 source->SetClientObject(new wxPyOORClientData(target)); \
75 } else { /* source was NULL so return None. */ \
76 Py_INCREF(Py_None); target = Py_None; \
82 wxPyMake_TEMPLATE(wxGridCellRenderer)
83 wxPyMake_TEMPLATE(wxGridCellEditor)
84 wxPyMake_TEMPLATE(wxGridCellAttr)
85 wxPyMake_TEMPLATE(wxGridCellAttrProvider)
86 wxPyMake_TEMPLATE(wxGridTableBase)
90 //---------------------------------------------------------------------------
91 // Macros, similar to what's in helpers.h, to aid in the creation of
92 // virtual methods that are able to make callbacks to Python. Many of these
93 // are specific to wxGrid and so are kept here to reduce the mess in helpers.h
98 #define PYCALLBACK_GCA_INTINTKIND(PCLASS, CBNAME) \
99 wxGridCellAttr* CBNAME(int a, int b, wxGridCellAttr::wxAttrKind c) { \
100 wxGridCellAttr* rval = NULL; \
102 bool blocked = wxPyBeginBlockThreads(); \
103 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) { \
105 wxGridCellAttr* ptr; \
106 ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(iii)", a, b, c)); \
108 if (wxPyConvertSwigPtr(ro, (void **)&ptr, wxT("wxGridCellAttr"))) \
113 wxPyEndBlockThreads(blocked); \
115 rval = PCLASS::CBNAME(a, b, c); \
118 wxGridCellAttr *base_##CBNAME(int a, int b, wxGridCellAttr::wxAttrKind c) { \
119 return PCLASS::CBNAME(a, b, c); \
124 #define PYCALLBACK__GCAINTINT(PCLASS, CBNAME) \
125 void CBNAME(wxGridCellAttr *attr, int a, int b) { \
126 bool blocked = wxPyBeginBlockThreads(); \
128 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) { \
129 PyObject* obj = wxPyMake_wxGridCellAttr(attr); \
130 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(Oii)", obj, a, b)); \
133 wxPyEndBlockThreads(blocked); \
135 PCLASS::CBNAME(attr, a, b); \
137 void base_##CBNAME(wxGridCellAttr *attr, int a, int b) { \
138 PCLASS::CBNAME(attr, a, b); \
143 #define PYCALLBACK__GCAINT(PCLASS, CBNAME) \
144 void CBNAME(wxGridCellAttr *attr, int val) { \
145 bool blocked = wxPyBeginBlockThreads(); \
147 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) { \
148 PyObject* obj = wxPyMake_wxGridCellAttr(attr); \
149 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(Oi)", obj, val)); \
152 wxPyEndBlockThreads(blocked); \
154 PCLASS::CBNAME(attr, val); \
156 void base_##CBNAME(wxGridCellAttr *attr, int val) { \
157 PCLASS::CBNAME(attr, val); \
162 #define PYCALLBACK_INT__pure(CBNAME) \
164 bool blocked = wxPyBeginBlockThreads(); \
166 if (wxPyCBH_findCallback(m_myInst, #CBNAME)) \
167 rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("()")); \
168 wxPyEndBlockThreads(blocked); \
174 #define PYCALLBACK_BOOL_INTINT_pure(CBNAME) \
175 bool CBNAME(int a, int b) { \
176 bool blocked = wxPyBeginBlockThreads(); \
178 if (wxPyCBH_findCallback(m_myInst, #CBNAME)) \
179 rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(ii)",a,b)); \
180 wxPyEndBlockThreads(blocked); \
185 #define PYCALLBACK_STRING_INTINT_pure(CBNAME) \
186 wxString CBNAME(int a, int b) { \
187 bool blocked = wxPyBeginBlockThreads(); \
189 if (wxPyCBH_findCallback(m_myInst, #CBNAME)) { \
191 ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(ii)",a,b)); \
193 rval = Py2wxString(ro); \
197 wxPyEndBlockThreads(blocked); \
202 #define PYCALLBACK__INTINTSTRING_pure(CBNAME) \
203 void CBNAME(int a, int b, const wxString& c) { \
204 bool blocked = wxPyBeginBlockThreads(); \
205 if (wxPyCBH_findCallback(m_myInst, #CBNAME)) { \
206 PyObject* s = wx2PyString(c); \
207 rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iiO)",a,b,s));\
210 wxPyEndBlockThreads(blocked); \
214 #define PYCALLBACK_STRING_INTINT(PCLASS, CBNAME) \
215 wxString CBNAME(int a, int b) { \
217 bool blocked = wxPyBeginBlockThreads(); \
219 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) { \
221 ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(ii)",a,b)); \
223 rval = Py2wxString(ro); \
227 wxPyEndBlockThreads(blocked); \
229 rval = PCLASS::CBNAME(a, b); \
232 wxString base_##CBNAME(int a, int b) { \
233 return PCLASS::CBNAME(a, b); \
237 #define PYCALLBACK_BOOL_INTINTSTRING(PCLASS, CBNAME) \
238 bool CBNAME(int a, int b, const wxString& c) { \
241 bool blocked = wxPyBeginBlockThreads(); \
242 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) { \
243 PyObject* s = wx2PyString(c); \
244 rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iiO)",a,b,s));\
247 wxPyEndBlockThreads(blocked); \
249 rval = PCLASS::CBNAME(a,b,c); \
252 bool base_##CBNAME(int a, int b, const wxString& c) { \
253 return PCLASS::CBNAME(a,b,c); \
259 #define PYCALLBACK_LONG_INTINT(PCLASS, CBNAME) \
260 long CBNAME(int a, int b) { \
263 bool blocked = wxPyBeginBlockThreads(); \
264 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) \
265 rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(ii)", a,b)); \
266 wxPyEndBlockThreads(blocked); \
268 rval = PCLASS::CBNAME(a,b); \
271 long base_##CBNAME(int a, int b) { \
272 return PCLASS::CBNAME(a,b); \
277 #define PYCALLBACK_BOOL_INTINT(PCLASS, CBNAME) \
278 bool CBNAME(int a, int b) { \
281 bool blocked = wxPyBeginBlockThreads(); \
282 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) \
283 rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(ii)", a,b)); \
284 wxPyEndBlockThreads(blocked); \
286 rval = PCLASS::CBNAME(a,b); \
289 bool base_##CBNAME(int a, int b) { \
290 return PCLASS::CBNAME(a,b); \
295 #define PYCALLBACK_DOUBLE_INTINT(PCLASS, CBNAME) \
296 double CBNAME(int a, int b) { \
298 bool blocked = wxPyBeginBlockThreads(); \
300 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) { \
302 ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(ii)",a,b)); \
304 PyObject* str = PyObject_Str(ro); \
305 rval = PyFloat_AsDouble(str); \
306 Py_DECREF(ro); Py_DECREF(str); \
309 wxPyEndBlockThreads(blocked); \
311 rval = PCLASS::CBNAME(a, b); \
314 double base_##CBNAME(int a, int b) { \
315 return PCLASS::CBNAME(a, b); \
320 #define PYCALLBACK__(PCLASS, CBNAME) \
323 bool blocked = wxPyBeginBlockThreads(); \
324 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) \
325 wxPyCBH_callCallback(m_myInst, Py_BuildValue("()")); \
326 wxPyEndBlockThreads(blocked); \
330 void base_##CBNAME() { \
337 #define PYCALLBACK_BOOL_SIZETSIZET(PCLASS, CBNAME) \
338 bool CBNAME(size_t a, size_t b) { \
341 bool blocked = wxPyBeginBlockThreads(); \
342 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) \
343 rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(ii)", a,b)); \
344 wxPyEndBlockThreads(blocked); \
346 rval = PCLASS::CBNAME(a,b); \
349 bool base_##CBNAME(size_t a, size_t b) { \
350 return PCLASS::CBNAME(a,b); \
355 #define PYCALLBACK_BOOL_SIZET(PCLASS, CBNAME) \
356 bool CBNAME(size_t a) { \
359 bool blocked = wxPyBeginBlockThreads(); \
360 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) \
361 rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(i)", a)); \
362 wxPyEndBlockThreads(blocked); \
364 rval = PCLASS::CBNAME(a); \
367 bool base_##CBNAME(size_t a) { \
368 return PCLASS::CBNAME(a); \
372 #define PYCALLBACK_STRING_INT(PCLASS, CBNAME) \
373 wxString CBNAME(int a) { \
375 bool blocked = wxPyBeginBlockThreads(); \
377 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) { \
379 ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(i)",a)); \
381 rval = Py2wxString(ro); \
385 wxPyEndBlockThreads(blocked); \
387 rval = PCLASS::CBNAME(a); \
390 wxString base_##CBNAME(int a) { \
391 return PCLASS::CBNAME(a); \
395 #define PYCALLBACK__INTSTRING(PCLASS, CBNAME) \
396 void CBNAME(int a, const wxString& c) { \
398 bool blocked = wxPyBeginBlockThreads(); \
399 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) { \
400 PyObject* s = wx2PyString(c); \
401 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iO)",a,s)); \
404 wxPyEndBlockThreads(blocked); \
406 PCLASS::CBNAME(a,c); \
408 void base_##CBNAME(int a, const wxString& c) { \
409 PCLASS::CBNAME(a,c); \
415 #define PYCALLBACK_BOOL_(PCLASS, CBNAME) \
419 bool blocked = wxPyBeginBlockThreads(); \
420 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) \
421 rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("()")); \
422 wxPyEndBlockThreads(blocked); \
424 rval = PCLASS::CBNAME(); \
427 bool base_##CBNAME() { \
428 return PCLASS::CBNAME(); \
433 #define PYCALLBACK__SIZETINT(PCLASS, CBNAME) \
434 void CBNAME(size_t a, int b) { \
436 bool blocked = wxPyBeginBlockThreads(); \
437 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) \
438 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(ii)", a,b)); \
439 wxPyEndBlockThreads(blocked); \
441 PCLASS::CBNAME(a,b); \
443 void base_##CBNAME(size_t a, int b) { \
444 PCLASS::CBNAME(a,b); \
450 #define PYCALLBACK__INTINTLONG(PCLASS, CBNAME) \
451 void CBNAME(int a, int b, long c) { \
453 bool blocked = wxPyBeginBlockThreads(); \
454 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) \
455 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iii)", a,b,c)); \
456 wxPyEndBlockThreads(blocked); \
458 PCLASS::CBNAME(a,b,c); \
460 void base_##CBNAME(int a, int b, long c) { \
461 PCLASS::CBNAME(a,b,c); \
467 #define PYCALLBACK__INTINTDOUBLE(PCLASS, CBNAME) \
468 void CBNAME(int a, int b, double c) { \
470 bool blocked = wxPyBeginBlockThreads(); \
471 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) \
472 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iif)", a,b,c)); \
473 wxPyEndBlockThreads(blocked); \
475 PCLASS::CBNAME(a,b,c); \
477 void base_##CBNAME(int a, int b, double c) { \
478 PCLASS::CBNAME(a,b,c); \
483 #define PYCALLBACK__INTINTBOOL(PCLASS, CBNAME) \
484 void CBNAME(int a, int b, bool c) { \
486 bool blocked = wxPyBeginBlockThreads(); \
487 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) \
488 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iii)", a,b,c)); \
489 wxPyEndBlockThreads(blocked); \
491 PCLASS::CBNAME(a,b,c); \
493 void base_##CBNAME(int a, int b, bool c) { \
494 PCLASS::CBNAME(a,b,c); \
502 //---------------------------------------------------------------------------
504 class wxGridCellCoords;
505 class wxGridCellAttr;
507 #define wxGRID_VALUE_STRING "string"
508 #define wxGRID_VALUE_BOOL "bool"
509 #define wxGRID_VALUE_NUMBER "long"
510 #define wxGRID_VALUE_FLOAT "double"
511 #define wxGRID_VALUE_CHOICE "choice"
512 #define wxGRID_VALUE_TEXT "string"
513 #define wxGRID_VALUE_LONG "long"
514 #define wxGRID_VALUE_CHOICEINT "choiceint"
515 #define wxGRID_VALUE_DATETIME "datetime"
519 const wxGridCellCoords wxGridNoCellCoords;
520 const wxRect wxGridNoCellRect;
524 //---------------------------------------------------------------------------
525 // wxGridCellRenderer is an ABC, and several derived classes are available.
526 // Classes implemented in Python should be derived from wxPyGridCellRenderer.
529 class wxGridCellRenderer
533 void _setOORInfo(PyObject* _self) {
534 self->SetClientObject(new wxPyOORClientData(_self));
538 void SetParameters(const wxString& params);
542 virtual void Draw(wxGrid& grid,
543 wxGridCellAttr& attr,
548 virtual wxSize GetBestSize(wxGrid& grid,
549 wxGridCellAttr& attr,
552 virtual wxGridCellRenderer *Clone() const;
556 // The C++ version of wxPyGridCellRenderer
558 class wxPyGridCellRenderer : public wxGridCellRenderer
561 wxPyGridCellRenderer() : wxGridCellRenderer() {};
563 // Implement Python callback aware virtual methods
564 void Draw(wxGrid& grid, wxGridCellAttr& attr,
565 wxDC& dc, const wxRect& rect,
566 int row, int col, bool isSelected) {
567 bool blocked = wxPyBeginBlockThreads();
568 if (wxPyCBH_findCallback(m_myInst, "Draw")) {
569 PyObject* go = wxPyMake_wxObject(&grid);
570 PyObject* dco = wxPyMake_wxObject(&dc);
571 PyObject* ao = wxPyMake_wxGridCellAttr(&attr);
572 PyObject* ro = wxPyConstructObject((void*)&rect, wxT("wxRect"), 0);
574 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(OOOOiii)", go, ao, dco, ro,
575 row, col, isSelected));
581 wxPyEndBlockThreads(blocked);
584 wxSize GetBestSize(wxGrid& grid, wxGridCellAttr& attr, wxDC& dc,
587 bool blocked = wxPyBeginBlockThreads();
588 if (wxPyCBH_findCallback(m_myInst, "GetBestSize")) {
591 PyObject* go = wxPyMake_wxObject(&grid);
592 PyObject* dco = wxPyMake_wxObject(&dc);
593 PyObject* ao = wxPyMake_wxGridCellAttr(&attr);
595 ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(OOOii)",
603 const char* errmsg = "GetBestSize should return a 2-tuple of integers or a wxSize object.";
604 if (wxPyConvertSwigPtr(ro, (void **)&ptr, wxT("wxSize"))) {
607 else if (PySequence_Check(ro) && PyObject_Length(ro) == 2) {
608 PyObject* o1 = PySequence_GetItem(ro, 0);
609 PyObject* o2 = PySequence_GetItem(ro, 1);
610 if (PyNumber_Check(o1) && PyNumber_Check(o2))
611 rval = wxSize(PyInt_AsLong(o1), PyInt_AsLong(o2));
613 PyErr_SetString(PyExc_TypeError, errmsg);
618 PyErr_SetString(PyExc_TypeError, errmsg);
623 wxPyEndBlockThreads(blocked);
628 wxGridCellRenderer *Clone() const {
629 wxGridCellRenderer* rval = NULL;
630 bool blocked = wxPyBeginBlockThreads();
631 if (wxPyCBH_findCallback(m_myInst, "Clone")) {
633 wxGridCellRenderer* ptr;
634 ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("()"));
636 if (wxPyConvertSwigPtr(ro, (void **)&ptr, wxT("wxGridCellRenderer")))
641 wxPyEndBlockThreads(blocked);
645 DEC_PYCALLBACK__STRING(SetParameters);
650 IMP_PYCALLBACK__STRING( wxPyGridCellRenderer, wxGridCellRenderer, SetParameters);
655 // Let SWIG know about it so it can create the Python version
656 class wxPyGridCellRenderer : public wxGridCellRenderer {
658 %pythonAppend wxPyGridCellRenderer "self._setCallbackInfo(self, PyGridCellRenderer);self._setOORInfo(self)"
660 wxPyGridCellRenderer();
661 void _setCallbackInfo(PyObject* self, PyObject* _class);
663 void base_SetParameters(const wxString& params);
666 //---------------------------------------------------------------------------
667 // Predefined Renderers
669 class wxGridCellStringRenderer : public wxGridCellRenderer
672 %pythonAppend wxGridCellStringRenderer "self._setOORInfo(self)"
673 wxGridCellStringRenderer();
677 class wxGridCellNumberRenderer : public wxGridCellStringRenderer
680 %pythonAppend wxGridCellNumberRenderer "self._setOORInfo(self)"
681 wxGridCellNumberRenderer();
685 class wxGridCellFloatRenderer : public wxGridCellStringRenderer
688 %pythonAppend wxGridCellFloatRenderer "self._setOORInfo(self)"
689 wxGridCellFloatRenderer(int width = -1, int precision = -1);
691 int GetWidth() const;
692 void SetWidth(int width);
693 int GetPrecision() const;
694 void SetPrecision(int precision);
698 class wxGridCellBoolRenderer : public wxGridCellRenderer
701 %pythonAppend wxGridCellBoolRenderer "self._setOORInfo(self)"
702 wxGridCellBoolRenderer();
706 class wxGridCellDateTimeRenderer : public wxGridCellStringRenderer
709 %pythonAppend wxGridCellDateTimeRenderer "self._setOORInfo(self)"
710 wxGridCellDateTimeRenderer(wxString outformat = wxPyDateTimeFormatStr,
711 wxString informat = wxPyDateTimeFormatStr);
715 class wxGridCellEnumRenderer : public wxGridCellStringRenderer
718 %pythonAppend wxGridCellEnumRenderer "self._setOORInfo(self)"
719 wxGridCellEnumRenderer( const wxString& choices = wxPyEmptyString );
723 class wxGridCellAutoWrapStringRenderer : public wxGridCellStringRenderer
726 %pythonAppend wxGridCellAutoWrapStringRenderer "self._setOORInfo(self)"
727 wxGridCellAutoWrapStringRenderer();
731 //---------------------------------------------------------------------------
732 // wxGridCellEditor is an ABC, and several derived classes are available.
733 // Classes implemented in Python should be derived from wxPyGridCellEditor.
735 class wxGridCellEditor
739 void _setOORInfo(PyObject* _self) {
740 self->SetClientObject(new wxPyOORClientData(_self));
745 wxControl* GetControl();
746 void SetControl(wxControl* control);
748 wxGridCellAttr* GetCellAttr();
749 void SetCellAttr(wxGridCellAttr* attr);
751 void SetParameters(const wxString& params);
755 virtual void Create(wxWindow* parent,
757 wxEvtHandler* evtHandler);
758 virtual void BeginEdit(int row, int col, wxGrid* grid);
759 virtual bool EndEdit(int row, int col, wxGrid* grid);
760 virtual void Reset();
761 virtual wxGridCellEditor *Clone() const;
763 virtual void SetSize(const wxRect& rect);
764 virtual void Show(bool show, wxGridCellAttr *attr = NULL);
765 virtual void PaintBackground(const wxRect& rectCell, wxGridCellAttr *attr);
766 virtual bool IsAcceptedKey(wxKeyEvent& event);
767 virtual void StartingKey(wxKeyEvent& event);
768 virtual void StartingClick();
769 virtual void HandleReturn(wxKeyEvent& event);
770 virtual void Destroy();
775 // The C++ version of wxPyGridCellEditor
777 class wxPyGridCellEditor : public wxGridCellEditor
780 wxPyGridCellEditor() : wxGridCellEditor() {}
782 void Create(wxWindow* parent, wxWindowID id, wxEvtHandler* evtHandler) {
783 bool blocked = wxPyBeginBlockThreads();
784 if (wxPyCBH_findCallback(m_myInst, "Create")) {
785 PyObject* po = wxPyMake_wxObject(parent);
786 PyObject* eo = wxPyMake_wxObject(evtHandler);
788 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(OiO)", po, id, eo));
792 wxPyEndBlockThreads(blocked);
796 void BeginEdit(int row, int col, wxGrid* grid) {
797 bool blocked = wxPyBeginBlockThreads();
798 if (wxPyCBH_findCallback(m_myInst, "BeginEdit")) {
799 PyObject* go = wxPyMake_wxObject(grid);
800 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iiO)", row, col, go));
803 wxPyEndBlockThreads(blocked);
807 bool EndEdit(int row, int col, wxGrid* grid) {
809 bool blocked = wxPyBeginBlockThreads();
810 if (wxPyCBH_findCallback(m_myInst, "EndEdit")) {
811 PyObject* go = wxPyMake_wxObject(grid);
812 rv = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iiO)", row, col, go));
815 wxPyEndBlockThreads(blocked);
820 wxGridCellEditor* Clone() const {
821 wxGridCellEditor* rval = NULL;
822 bool blocked = wxPyBeginBlockThreads();
823 if (wxPyCBH_findCallback(m_myInst, "Clone")) {
825 wxGridCellEditor* ptr;
826 ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("()"));
828 if (wxPyConvertSwigPtr(ro, (void **)&ptr, wxT("wxGridCellEditor")))
833 wxPyEndBlockThreads(blocked);
838 void Show(bool show, wxGridCellAttr *attr) {
840 bool blocked = wxPyBeginBlockThreads();
841 if ((found = wxPyCBH_findCallback(m_myInst, "Show"))) {
842 PyObject* ao = wxPyMake_wxGridCellAttr(attr);
843 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iO)", show, ao));
846 wxPyEndBlockThreads(blocked);
848 wxGridCellEditor::Show(show, attr);
850 void base_Show(bool show, wxGridCellAttr *attr) {
851 wxGridCellEditor::Show(show, attr);
855 void PaintBackground(const wxRect& rectCell, wxGridCellAttr *attr) {
857 bool blocked = wxPyBeginBlockThreads();
858 if ((found = wxPyCBH_findCallback(m_myInst, "PaintBackground)"))) {
859 PyObject* ao = wxPyMake_wxGridCellAttr(attr);
860 PyObject* ro = wxPyConstructObject((void*)&rectCell, wxT("wxRect"), 0);
862 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(OO)", ro, ao));
867 wxPyEndBlockThreads(blocked);
869 wxGridCellEditor::PaintBackground(rectCell, attr);
871 void base_PaintBackground(const wxRect& rectCell, wxGridCellAttr *attr) {
872 wxGridCellEditor::PaintBackground(rectCell, attr);
876 DEC_PYCALLBACK___pure(Reset);
877 DEC_PYCALLBACK__constany(SetSize, wxRect);
878 DEC_PYCALLBACK_bool_any(IsAcceptedKey, wxKeyEvent);
879 DEC_PYCALLBACK__any(StartingKey, wxKeyEvent);
880 DEC_PYCALLBACK__any(HandleReturn, wxKeyEvent);
881 DEC_PYCALLBACK__(StartingClick);
882 DEC_PYCALLBACK__(Destroy);
883 DEC_PYCALLBACK__STRING(SetParameters);
884 DEC_PYCALLBACK_STRING__constpure(GetValue);
890 IMP_PYCALLBACK__STRING( wxPyGridCellEditor, wxGridCellEditor, SetParameters);
891 IMP_PYCALLBACK___pure(wxPyGridCellEditor, wxGridCellEditor, Reset);
892 IMP_PYCALLBACK__constany(wxPyGridCellEditor, wxGridCellEditor, SetSize, wxRect);
893 IMP_PYCALLBACK_bool_any(wxPyGridCellEditor, wxGridCellEditor, IsAcceptedKey, wxKeyEvent);
894 IMP_PYCALLBACK__any(wxPyGridCellEditor, wxGridCellEditor, StartingKey, wxKeyEvent);
895 IMP_PYCALLBACK__any(wxPyGridCellEditor, wxGridCellEditor, HandleReturn, wxKeyEvent);
896 IMP_PYCALLBACK__(wxPyGridCellEditor, wxGridCellEditor, StartingClick);
897 IMP_PYCALLBACK__(wxPyGridCellEditor, wxGridCellEditor, Destroy);
898 IMP_PYCALLBACK_STRING__constpure(wxPyGridCellEditor, wxGridCellEditor, GetValue);
903 // Let SWIG know about it so it can create the Python version
904 class wxPyGridCellEditor : public wxGridCellEditor {
906 %pythonAppend wxPyGridCellEditor "self._setCallbackInfo(self, PyGridCellEditor);self._setOORInfo(self)"
908 wxPyGridCellEditor();
909 void _setCallbackInfo(PyObject* self, PyObject* _class);
911 void base_SetSize(const wxRect& rect);
912 void base_Show(bool show, wxGridCellAttr *attr = NULL);
913 void base_PaintBackground(const wxRect& rectCell, wxGridCellAttr *attr);
914 bool base_IsAcceptedKey(wxKeyEvent& event);
915 void base_StartingKey(wxKeyEvent& event);
916 void base_StartingClick();
917 void base_HandleReturn(wxKeyEvent& event);
919 void base_SetParameters(const wxString& params);
922 //---------------------------------------------------------------------------
923 // Predefined Editors
925 class wxGridCellTextEditor : public wxGridCellEditor
928 %pythonAppend wxGridCellTextEditor "self._setOORInfo(self)"
929 wxGridCellTextEditor();
930 virtual wxString GetValue();
934 class wxGridCellNumberEditor : public wxGridCellTextEditor
937 %pythonAppend wxGridCellNumberEditor "self._setOORInfo(self)"
938 wxGridCellNumberEditor(int min = -1, int max = -1);
939 virtual wxString GetValue();
943 class wxGridCellFloatEditor : public wxGridCellTextEditor
946 %pythonAppend wxGridCellFloatEditor "self._setOORInfo(self)"
947 wxGridCellFloatEditor(int width = -1, int precision = -1);
948 virtual wxString GetValue();
952 class wxGridCellBoolEditor : public wxGridCellEditor
955 %pythonAppend wxGridCellBoolEditor "self._setOORInfo(self)"
956 wxGridCellBoolEditor();
957 virtual wxString GetValue();
960 class wxGridCellChoiceEditor : public wxGridCellEditor
963 %pythonAppend wxGridCellChoiceEditor "self._setOORInfo(self)"
964 wxGridCellChoiceEditor(int choices = 0,
965 const wxString* choices_array = NULL,
966 bool allowOthers = False);
967 virtual wxString GetValue();
971 class wxGridCellEnumEditor : public wxGridCellChoiceEditor
974 %pythonAppend wxGridCellEnumEditor "self._setOORInfo(self)"
975 wxGridCellEnumEditor( const wxString& choices = wxPyEmptyString );
976 virtual wxString GetValue();
980 class wxGridCellAutoWrapStringEditor : public wxGridCellTextEditor
983 %pythonAppend wxGridCellAutoWrapStringEditor "self._setOORInfo(self)"
984 wxGridCellAutoWrapStringEditor();
985 virtual wxString GetValue();
990 //---------------------------------------------------------------------------
1007 void _setOORInfo(PyObject* _self) {
1008 self->SetClientObject(new wxPyOORClientData(_self));
1012 %pythonAppend wxGridCellAttr "self._setOORInfo(self)"
1014 wxGridCellAttr(wxGridCellAttr *attrDefault = NULL);
1016 wxGridCellAttr *Clone() const;
1017 void MergeWith(wxGridCellAttr *mergefrom);
1020 void SetTextColour(const wxColour& colText);
1021 void SetBackgroundColour(const wxColour& colBack);
1022 void SetFont(const wxFont& font);
1023 void SetAlignment(int hAlign, int vAlign);
1024 void SetSize(int num_rows, int num_cols);
1025 void SetOverflow( bool allow = True );
1026 void SetReadOnly(bool isReadOnly = True);
1028 void SetRenderer(wxGridCellRenderer *renderer);
1029 void SetEditor(wxGridCellEditor* editor);
1030 void SetKind(wxAttrKind kind);
1032 bool HasTextColour() const;
1033 bool HasBackgroundColour() const;
1034 bool HasFont() const;
1035 bool HasAlignment() const;
1036 bool HasRenderer() const;
1037 bool HasEditor() const;
1038 bool HasReadWriteMode() const;
1039 bool HasOverflowMode() const;
1041 wxColour GetTextColour() const;
1042 wxColour GetBackgroundColour() const;
1043 wxFont GetFont() const;
1046 void, GetAlignment(int *OUTPUT, int *OUTPUT) const,
1047 "GetAlignment() -> (hAlign, vAlign)");
1050 void, GetSize(int *OUTPUT, int *OUTPUT) const,
1051 "GetSize() -> (num_rows, num_cols)");
1053 bool GetOverflow() const;
1054 wxGridCellRenderer *GetRenderer(wxGrid* grid, int row, int col) const;
1055 wxGridCellEditor *GetEditor(wxGrid* grid, int row, int col) const;
1057 bool IsReadOnly() const;
1058 void SetDefAttr(wxGridCellAttr* defAttr);
1061 //---------------------------------------------------------------------------
1063 class wxGridCellAttrProvider
1066 %pythonAppend wxGridCellAttrProvider "self._setOORInfo(self)"
1067 wxGridCellAttrProvider();
1068 // ???? virtual ~wxGridCellAttrProvider();
1071 void _setOORInfo(PyObject* _self) {
1072 self->SetClientObject(new wxPyOORClientData(_self));
1076 wxGridCellAttr *GetAttr(int row, int col,
1077 wxGridCellAttr::wxAttrKind kind) const;
1078 void SetAttr(wxGridCellAttr *attr, int row, int col);
1079 void SetRowAttr(wxGridCellAttr *attr, int row);
1080 void SetColAttr(wxGridCellAttr *attr, int col);
1082 void UpdateAttrRows( size_t pos, int numRows );
1083 void UpdateAttrCols( size_t pos, int numCols );
1088 // A Python-aware version
1090 class wxPyGridCellAttrProvider : public wxGridCellAttrProvider
1093 wxPyGridCellAttrProvider() : wxGridCellAttrProvider() {};
1095 PYCALLBACK_GCA_INTINTKIND(wxGridCellAttrProvider, GetAttr);
1096 PYCALLBACK__GCAINTINT(wxGridCellAttrProvider, SetAttr);
1097 PYCALLBACK__GCAINT(wxGridCellAttrProvider, SetRowAttr);
1098 PYCALLBACK__GCAINT(wxGridCellAttrProvider, SetColAttr);
1105 // The python-aware version get's SWIGified
1106 class wxPyGridCellAttrProvider : public wxGridCellAttrProvider
1109 %pythonAppend wxPyGridCellAttrProvider "self._setCallbackInfo(self, PyGridCellAttrProvider)"
1110 wxPyGridCellAttrProvider();
1111 void _setCallbackInfo(PyObject* self, PyObject* _class);
1113 wxGridCellAttr *base_GetAttr(int row, int col,
1114 wxGridCellAttr::wxAttrKind kind);
1115 void base_SetAttr(wxGridCellAttr *attr, int row, int col);
1116 void base_SetRowAttr(wxGridCellAttr *attr, int row);
1117 void base_SetColAttr(wxGridCellAttr *attr, int col);
1121 //---------------------------------------------------------------------------
1122 // Grid Table Base class and Python aware version
1125 class wxGridTableBase : public wxObject
1128 // wxGridTableBase(); This is an ABC
1129 //~wxGridTableBase();
1132 void _setOORInfo(PyObject* _self) {
1133 self->SetClientObject(new wxPyOORClientData(_self));
1137 void SetAttrProvider(wxGridCellAttrProvider *attrProvider);
1138 wxGridCellAttrProvider *GetAttrProvider() const;
1139 void SetView( wxGrid *grid );
1140 wxGrid * GetView() const;
1144 virtual int GetNumberRows();
1145 virtual int GetNumberCols();
1146 virtual bool IsEmptyCell( int row, int col );
1147 virtual wxString GetValue( int row, int col );
1148 virtual void SetValue( int row, int col, const wxString& value );
1150 // virtuals overridable in wxPyGridTableBase
1151 virtual wxString GetTypeName( int row, int col );
1152 virtual bool CanGetValueAs( int row, int col, const wxString& typeName );
1153 virtual bool CanSetValueAs( int row, int col, const wxString& typeName );
1154 virtual long GetValueAsLong( int row, int col );
1155 virtual double GetValueAsDouble( int row, int col );
1156 virtual bool GetValueAsBool( int row, int col );
1157 virtual void SetValueAsLong( int row, int col, long value );
1158 virtual void SetValueAsDouble( int row, int col, double value );
1159 virtual void SetValueAsBool( int row, int col, bool value );
1161 //virtual void* GetValueAsCustom( int row, int col, const wxString& typeName );
1162 //virtual void SetValueAsCustom( int row, int col, const wxString& typeName, void* value );
1165 virtual void Clear();
1166 virtual bool InsertRows( size_t pos = 0, size_t numRows = 1 );
1167 virtual bool AppendRows( size_t numRows = 1 );
1168 virtual bool DeleteRows( size_t pos = 0, size_t numRows = 1 );
1169 virtual bool InsertCols( size_t pos = 0, size_t numCols = 1 );
1170 virtual bool AppendCols( size_t numCols = 1 );
1171 virtual bool DeleteCols( size_t pos = 0, size_t numCols = 1 );
1173 virtual wxString GetRowLabelValue( int row );
1174 virtual wxString GetColLabelValue( int col );
1175 virtual void SetRowLabelValue( int row, const wxString& value );
1176 virtual void SetColLabelValue( int col, const wxString& value );
1178 virtual bool CanHaveAttributes();
1180 virtual wxGridCellAttr *GetAttr( int row, int col,
1181 wxGridCellAttr::wxAttrKind kind);
1182 virtual void SetAttr(wxGridCellAttr* attr, int row, int col);
1183 virtual void SetRowAttr(wxGridCellAttr *attr, int row);
1184 virtual void SetColAttr(wxGridCellAttr *attr, int col);
1190 // Python-aware version
1192 class wxPyGridTableBase : public wxGridTableBase
1195 wxPyGridTableBase() : wxGridTableBase() {}
1197 PYCALLBACK_INT__pure(GetNumberRows);
1198 PYCALLBACK_INT__pure(GetNumberCols);
1199 PYCALLBACK_BOOL_INTINT_pure(IsEmptyCell);
1200 PYCALLBACK_STRING_INTINT(wxGridTableBase, GetTypeName);
1201 PYCALLBACK_BOOL_INTINTSTRING(wxGridTableBase, CanGetValueAs);
1202 PYCALLBACK_BOOL_INTINTSTRING(wxGridTableBase, CanSetValueAs);
1203 PYCALLBACK__(wxGridTableBase, Clear);
1204 PYCALLBACK_BOOL_SIZETSIZET(wxGridTableBase, InsertRows);
1205 PYCALLBACK_BOOL_SIZETSIZET(wxGridTableBase, DeleteRows);
1206 PYCALLBACK_BOOL_SIZETSIZET(wxGridTableBase, InsertCols);
1207 PYCALLBACK_BOOL_SIZETSIZET(wxGridTableBase, DeleteCols);
1208 PYCALLBACK_BOOL_SIZET(wxGridTableBase, AppendRows);
1209 PYCALLBACK_BOOL_SIZET(wxGridTableBase, AppendCols);
1210 PYCALLBACK_STRING_INT(wxGridTableBase, GetRowLabelValue);
1211 PYCALLBACK_STRING_INT(wxGridTableBase, GetColLabelValue);
1212 PYCALLBACK__INTSTRING(wxGridTableBase, SetRowLabelValue);
1213 PYCALLBACK__INTSTRING(wxGridTableBase, SetColLabelValue);
1214 PYCALLBACK_BOOL_(wxGridTableBase, CanHaveAttributes);
1215 PYCALLBACK_GCA_INTINTKIND(wxGridTableBase, GetAttr);
1216 PYCALLBACK__GCAINTINT(wxGridTableBase, SetAttr);
1217 PYCALLBACK__GCAINT(wxGridTableBase, SetRowAttr);
1218 PYCALLBACK__GCAINT(wxGridTableBase, SetColAttr);
1221 wxString GetValue(int row, int col) {
1222 bool blocked = wxPyBeginBlockThreads();
1224 if (wxPyCBH_findCallback(m_myInst, "GetValue")) {
1226 ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(ii)",row,col));
1228 rval = Py2wxString(ro);
1232 wxPyEndBlockThreads(blocked);
1236 void SetValue(int row, int col, const wxString& val) {
1237 bool blocked = wxPyBeginBlockThreads();
1238 if (wxPyCBH_findCallback(m_myInst, "SetValue")) {
1239 PyObject* s = wx2PyString(val);
1240 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iiO)",row,col,s));
1243 wxPyEndBlockThreads(blocked);
1247 // Map the Get/Set methods for the standard non-string types to
1248 // the GetValue and SetValue python methods.
1249 long GetValueAsLong( int row, int col ) {
1251 bool blocked = wxPyBeginBlockThreads();
1252 if (wxPyCBH_findCallback(m_myInst, "GetValue")) {
1255 ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(ii)", row, col));
1256 if (ro && PyNumber_Check(ro)) {
1257 num = PyNumber_Int(ro);
1259 rval = PyInt_AsLong(num);
1265 wxPyEndBlockThreads(blocked);
1269 double GetValueAsDouble( int row, int col ) {
1271 bool blocked = wxPyBeginBlockThreads();
1272 if (wxPyCBH_findCallback(m_myInst, "GetValue")) {
1275 ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(ii)", row, col));
1276 if (ro && PyNumber_Check(ro)) {
1277 num = PyNumber_Float(ro);
1279 rval = PyFloat_AsDouble(num);
1285 wxPyEndBlockThreads(blocked);
1289 bool GetValueAsBool( int row, int col ) {
1290 return (bool)GetValueAsLong(row, col);
1293 void SetValueAsLong( int row, int col, long value ) {
1294 bool blocked = wxPyBeginBlockThreads();
1295 if (wxPyCBH_findCallback(m_myInst, "SetValue")) {
1296 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iii)", row, col, value));
1298 wxPyEndBlockThreads(blocked);
1301 void SetValueAsDouble( int row, int col, double value ) {
1302 bool blocked = wxPyBeginBlockThreads();
1303 if (wxPyCBH_findCallback(m_myInst, "SetValue")) {
1304 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iid)", row, col, value));
1306 wxPyEndBlockThreads(blocked);
1309 void SetValueAsBool( int row, int col, bool value ) {
1310 SetValueAsLong( row, col, (long)value );
1319 // The python-aware version get's SWIGified
1320 class wxPyGridTableBase : public wxGridTableBase
1323 %pythonAppend wxPyGridTableBase "self._setCallbackInfo(self, PyGridTableBase);self._setOORInfo(self)"
1324 wxPyGridTableBase();
1325 void _setCallbackInfo(PyObject* self, PyObject* _class);
1327 %extend { void Destroy() { delete self; } }
1329 wxString base_GetTypeName( int row, int col );
1330 bool base_CanGetValueAs( int row, int col, const wxString& typeName );
1331 bool base_CanSetValueAs( int row, int col, const wxString& typeName );
1333 bool base_InsertRows( size_t pos = 0, size_t numRows = 1 );
1334 bool base_AppendRows( size_t numRows = 1 );
1335 bool base_DeleteRows( size_t pos = 0, size_t numRows = 1 );
1336 bool base_InsertCols( size_t pos = 0, size_t numCols = 1 );
1337 bool base_AppendCols( size_t numCols = 1 );
1338 bool base_DeleteCols( size_t pos = 0, size_t numCols = 1 );
1339 wxString base_GetRowLabelValue( int row );
1340 wxString base_GetColLabelValue( int col );
1341 void base_SetRowLabelValue( int row, const wxString& value );
1342 void base_SetColLabelValue( int col, const wxString& value );
1343 bool base_CanHaveAttributes();
1344 wxGridCellAttr *base_GetAttr( int row, int col,
1345 wxGridCellAttr::wxAttrKind kind );
1346 void base_SetAttr(wxGridCellAttr* attr, int row, int col);
1347 void base_SetRowAttr(wxGridCellAttr *attr, int row);
1348 void base_SetColAttr(wxGridCellAttr *attr, int col);
1352 //---------------------------------------------------------------------------
1353 // Predefined Tables
1355 class wxGridStringTable : public wxGridTableBase
1358 %pythonAppend wxGridStringTable "self._setOORInfo(self)"
1359 wxGridStringTable( int numRows=0, int numCols=0 );
1362 //---------------------------------------------------------------------------
1363 // The Table can pass messages to the grid to tell it to update itself if
1364 // something has changed.
1366 enum wxGridTableRequest
1368 wxGRIDTABLE_REQUEST_VIEW_GET_VALUES = 2000,
1369 wxGRIDTABLE_REQUEST_VIEW_SEND_VALUES,
1370 wxGRIDTABLE_NOTIFY_ROWS_INSERTED,
1371 wxGRIDTABLE_NOTIFY_ROWS_APPENDED,
1372 wxGRIDTABLE_NOTIFY_ROWS_DELETED,
1373 wxGRIDTABLE_NOTIFY_COLS_INSERTED,
1374 wxGRIDTABLE_NOTIFY_COLS_APPENDED,
1375 wxGRIDTABLE_NOTIFY_COLS_DELETED
1379 class wxGridTableMessage
1382 wxGridTableMessage( wxGridTableBase *table, int id,
1385 ~wxGridTableMessage();
1387 void SetTableObject( wxGridTableBase *table );
1388 wxGridTableBase * GetTableObject() const;
1389 void SetId( int id );
1391 void SetCommandInt( int comInt1 );
1392 int GetCommandInt();
1393 void SetCommandInt2( int comInt2 );
1394 int GetCommandInt2();
1398 //---------------------------------------------------------------------------
1401 // Typemap to allow conversion of sequence objects to wxGridCellCoords...
1402 %typemap(in) wxGridCellCoords& (wxGridCellCoords temp) {
1404 if (! wxGridCellCoords_helper($input, &$1)) SWIG_fail;
1406 %typemap(typecheck, precedence=SWIG_TYPECHECK_POINTER) wxGridCellCoords& {
1407 $1 = wxGridCellCoords_typecheck($input);
1411 // ...and here is the associated helper.
1413 bool wxGridCellCoords_helper(PyObject* source, wxGridCellCoords** obj) {
1415 if (source == Py_None) {
1416 **obj = wxGridCellCoords(-1,-1);
1420 // If source is an object instance then it may already be the right type
1421 if (wxPySwigInstance_Check(source)) {
1422 wxGridCellCoords* ptr;
1423 if (! wxPyConvertSwigPtr(source, (void **)&ptr, wxT("wxGridCellCoords")))
1428 // otherwise a 2-tuple of integers is expected
1429 else if (PySequence_Check(source) && PyObject_Length(source) == 2) {
1430 PyObject* o1 = PySequence_GetItem(source, 0);
1431 PyObject* o2 = PySequence_GetItem(source, 1);
1432 if (!PyNumber_Check(o1) || !PyNumber_Check(o2)) {
1437 **obj = wxGridCellCoords(PyInt_AsLong(o1), PyInt_AsLong(o2));
1444 PyErr_SetString(PyExc_TypeError, "Expected a 2-tuple of integers or a wxGridCellCoords object.");
1449 bool wxGridCellCoords_typecheck(PyObject* source) {
1452 if (wxPySwigInstance_Check(source) &&
1453 wxPyConvertSwigPtr(source, (void **)&ptr, wxT("wxGridCellCoords")))
1457 if (PySequence_Check(source) && PySequence_Length(source) == 2)
1465 // Typemap to convert an array of cells coords to a list of tuples...
1466 %typemap(out) wxGridCellCoordsArray {
1467 $result = wxGridCellCoordsArray_helper($1);
1470 // %typemap(ret) wxGridCellCoordsArray {
1475 // ...and the helper function for the above typemap.
1477 PyObject* wxGridCellCoordsArray_helper(const wxGridCellCoordsArray& source)
1479 PyObject* list = PyList_New(0);
1481 for (idx = 0; idx < source.GetCount(); idx += 1) {
1482 wxGridCellCoords& coord = source.Item(idx);
1483 PyObject* tup = PyTuple_New(2);
1484 PyTuple_SET_ITEM(tup, 0, PyInt_FromLong(coord.GetRow()));
1485 PyTuple_SET_ITEM(tup, 1, PyInt_FromLong(coord.GetCol()));
1486 PyList_Append(list, tup);
1497 class wxGridCellCoords
1500 wxGridCellCoords( int r=-1, int c=-1 );
1501 ~wxGridCellCoords();
1504 void SetRow( int n );
1506 void SetCol( int n );
1507 void Set( int row, int col );
1509 bool operator==( const wxGridCellCoords& other ) const;
1510 bool operator!=( const wxGridCellCoords& other ) const;
1514 PyObject* tup = PyTuple_New(2);
1515 PyTuple_SET_ITEM(tup, 0, PyInt_FromLong(self->GetRow()));
1516 PyTuple_SET_ITEM(tup, 1, PyInt_FromLong(self->GetCol()));
1521 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
1522 def __str__(self): return str(self.Get())
1523 def __repr__(self): return 'wxGridCellCoords'+str(self.Get())
1524 def __len__(self): return len(self.Get())
1525 def __getitem__(self, index): return self.asTuple()[index]
1526 def __setitem__(self, index, val):
1527 if index == 0: self.SetRow(val)
1528 elif index == 1: self.SetCol(val)
1529 else: raise IndexError
1535 //---------------------------------------------------------------------------
1536 //---------------------------------------------------------------------------
1540 // Fool SWIG into treating this enum as an int
1541 typedef int WXGRIDSELECTIONMODES;
1543 // but let the C++ code know what it really is.
1545 typedef wxGrid::wxGridSelectionModes WXGRIDSELECTIONMODES;
1550 MustHaveApp(wxGrid);
1552 class wxGrid : public wxScrolledWindow
1555 %pythonAppend wxGrid "self._setOORInfo(self)"
1557 wxGrid( wxWindow *parent,
1559 const wxPoint& pos = wxDefaultPosition,
1560 const wxSize& size = wxDefaultSize,
1561 long style = wxWANTS_CHARS,
1562 const wxString& name = wxPyPanelNameStr);
1564 %name(PreGrid) wxGrid();
1567 bool Create( wxWindow *parent,
1569 const wxPoint& pos = wxDefaultPosition,
1570 const wxSize& size = wxDefaultSize,
1571 long style = wxWANTS_CHARS,
1572 const wxString& name = wxPyPanelNameStr );
1575 enum wxGridSelectionModes {
1581 SelectCells = wxGridSelectCells
1582 SelectRows = wxGridSelectRows
1583 SelectColumns = wxGridSelectColumns
1586 bool CreateGrid( int numRows, int numCols,
1587 WXGRIDSELECTIONMODES selmode = wxGrid::wxGridSelectCells );
1588 void SetSelectionMode(WXGRIDSELECTIONMODES selmode);
1589 WXGRIDSELECTIONMODES GetSelectionMode();
1592 // ------ grid dimensions
1594 int GetNumberRows();
1595 int GetNumberCols();
1598 bool ProcessTableMessage( wxGridTableMessage& );
1601 wxGridTableBase * GetTable() const;
1602 bool SetTable( wxGridTableBase *table, bool takeOwnership=False,
1603 WXGRIDSELECTIONMODES selmode =
1604 wxGrid::wxGridSelectCells );
1607 bool InsertRows( int pos = 0, int numRows = 1, bool updateLabels=True );
1608 bool AppendRows( int numRows = 1, bool updateLabels=True );
1609 bool DeleteRows( int pos = 0, int numRows = 1, bool updateLabels=True );
1610 bool InsertCols( int pos = 0, int numCols = 1, bool updateLabels=True );
1611 bool AppendCols( int numCols = 1, bool updateLabels=True );
1612 bool DeleteCols( int pos = 0, int numCols = 1, bool updateLabels=True );
1615 // this function is called when the current cell highlight must be redrawn
1616 // and may be overridden by the user
1617 virtual void DrawCellHighlight( wxDC& dc, const wxGridCellAttr *attr );
1620 // ------ Cell text drawing functions
1622 void DrawTextRectangle( wxDC& dc, const wxString&, const wxRect&,
1623 int horizontalAlignment = wxLEFT,
1624 int verticalAlignment = wxTOP,
1625 int textOrientation = wxHORIZONTAL );
1627 // // Split a string containing newline chararcters into an array of
1628 // // strings and return the number of lines
1630 // void StringToLines( const wxString& value, wxArrayString& lines );
1633 void, GetTextBoxSize( wxDC& dc, wxArrayString& lines,
1634 long *OUTPUT, long *OUTPUT ),
1635 "GetTextBoxSize(DC dc, list lines) -> (width, height)");
1639 // Code that does a lot of grid modification can be enclosed
1640 // between BeginBatch() and EndBatch() calls to avoid screen
1645 int GetBatchCount();
1646 void ForceRefresh();
1649 // ------ edit control functions
1652 void EnableEditing( bool edit );
1654 void EnableCellEditControl( bool enable = True );
1655 void DisableCellEditControl();
1656 bool CanEnableCellControl() const;
1657 bool IsCellEditControlEnabled() const;
1658 bool IsCellEditControlShown() const;
1660 bool IsCurrentCellReadOnly() const;
1662 void ShowCellEditControl();
1663 void HideCellEditControl();
1664 void SaveEditControlValue();
1667 // ------ grid location functions
1668 // Note that all of these functions work with the logical coordinates of
1669 // grid cells and labels so you will need to convert from device
1670 // coordinates for mouse events etc.
1673 //void XYToCell( int x, int y, wxGridCellCoords& );
1675 wxGridCellCoords XYToCell(int x, int y) {
1676 wxGridCellCoords rv;
1677 self->XYToCell(x, y, rv);
1682 int YToRow( int y );
1683 int XToCol( int x );
1685 int YToEdgeOfRow( int y );
1686 int XToEdgeOfCol( int x );
1688 wxRect CellToRect( int row, int col );
1689 // TODO: ??? wxRect CellToRect( const wxGridCellCoords& coords );
1692 int GetGridCursorRow();
1693 int GetGridCursorCol();
1695 // check to see if a cell is either wholly visible (the default arg) or
1696 // at least partially visible in the grid window
1698 bool IsVisible( int row, int col, bool wholeCellVisible = True );
1699 // TODO: ??? bool IsVisible( const wxGridCellCoords& coords, bool wholeCellVisible = True );
1700 void MakeCellVisible( int row, int col );
1701 // TODO: ??? void MakeCellVisible( const wxGridCellCoords& coords );
1704 // ------ grid cursor movement functions
1706 void SetGridCursor( int row, int col );
1707 bool MoveCursorUp( bool expandSelection );
1708 bool MoveCursorDown( bool expandSelection );
1709 bool MoveCursorLeft( bool expandSelection );
1710 bool MoveCursorRight( bool expandSelection );
1711 bool MovePageDown();
1713 bool MoveCursorUpBlock( bool expandSelection );
1714 bool MoveCursorDownBlock( bool expandSelection );
1715 bool MoveCursorLeftBlock( bool expandSelection );
1716 bool MoveCursorRightBlock( bool expandSelection );
1719 // ------ label and gridline formatting
1721 int GetDefaultRowLabelSize();
1722 int GetRowLabelSize();
1723 int GetDefaultColLabelSize();
1724 int GetColLabelSize();
1725 wxColour GetLabelBackgroundColour();
1726 wxColour GetLabelTextColour();
1727 wxFont GetLabelFont();
1730 void, GetRowLabelAlignment( int *OUTPUT, int *OUTPUT ),
1731 "GetRowLabelAlignment() -> (horiz, vert)");
1734 void, GetColLabelAlignment( int *OUTPUT, int *OUTPUT ),
1735 "GetColLabelAlignment() -> (horiz, vert)");
1737 int GetColLabelTextOrientation();
1738 wxString GetRowLabelValue( int row );
1739 wxString GetColLabelValue( int col );
1740 wxColour GetGridLineColour();
1741 wxColour GetCellHighlightColour();
1742 int GetCellHighlightPenWidth();
1743 int GetCellHighlightROPenWidth();
1745 void SetRowLabelSize( int width );
1746 void SetColLabelSize( int height );
1747 void SetLabelBackgroundColour( const wxColour& );
1748 void SetLabelTextColour( const wxColour& );
1749 void SetLabelFont( const wxFont& );
1750 void SetRowLabelAlignment( int horiz, int vert );
1751 void SetColLabelAlignment( int horiz, int vert );
1752 void SetColLabelTextOrientation( int textOrientation );
1753 void SetRowLabelValue( int row, const wxString& );
1754 void SetColLabelValue( int col, const wxString& );
1755 void SetGridLineColour( const wxColour& );
1756 void SetCellHighlightColour( const wxColour& );
1757 void SetCellHighlightPenWidth(int width);
1758 void SetCellHighlightROPenWidth(int width);
1760 void EnableDragRowSize( bool enable = True );
1761 void DisableDragRowSize();
1762 bool CanDragRowSize();
1763 void EnableDragColSize( bool enable = True );
1764 void DisableDragColSize();
1765 bool CanDragColSize();
1766 void EnableDragGridSize(bool enable = True);
1767 void DisableDragGridSize();
1768 bool CanDragGridSize();
1770 // this sets the specified attribute for all cells in this row/col
1771 void SetAttr(int row, int col, wxGridCellAttr *attr);
1772 void SetRowAttr(int row, wxGridCellAttr *attr);
1773 void SetColAttr(int col, wxGridCellAttr *attr);
1775 // shortcuts for setting the column parameters
1777 // set the format for the data in the column: default is string
1778 void SetColFormatBool(int col);
1779 void SetColFormatNumber(int col);
1780 void SetColFormatFloat(int col, int width = -1, int precision = -1);
1781 void SetColFormatCustom(int col, const wxString& typeName);
1783 void EnableGridLines( bool enable = True );
1784 bool GridLinesEnabled();
1786 // ------ row and col formatting
1788 int GetDefaultRowSize();
1789 int GetRowSize( int row );
1790 int GetDefaultColSize();
1791 int GetColSize( int col );
1792 wxColour GetDefaultCellBackgroundColour();
1793 wxColour GetCellBackgroundColour( int row, int col );
1794 wxColour GetDefaultCellTextColour();
1795 wxColour GetCellTextColour( int row, int col );
1796 wxFont GetDefaultCellFont();
1797 wxFont GetCellFont( int row, int col );
1800 void, GetDefaultCellAlignment( int *OUTPUT, int *OUTPUT ),
1801 "GetDefaultCellAlignment() -> (horiz, vert)");
1804 void, GetCellAlignment( int row, int col, int *OUTPUT, int *OUTPUT ),
1805 "GetCellAlignment() -> (horiz, vert)");
1807 bool GetDefaultCellOverflow();
1808 bool GetCellOverflow( int row, int col );
1811 void, GetCellSize( int row, int col, int *OUTPUT, int *OUTPUT ),
1812 "GetCellSize(int row, int col) -> (num_rows, num_cols)");
1814 void SetDefaultRowSize( int height, bool resizeExistingRows = False );
1815 void SetRowSize( int row, int height );
1816 void SetDefaultColSize( int width, bool resizeExistingCols = False );
1818 void SetColSize( int col, int width );
1820 // automatically size the column or row to fit to its contents, if
1821 // setAsMin is True, this optimal width will also be set as minimal width
1823 void AutoSizeColumn( int col, bool setAsMin = True );
1824 void AutoSizeRow( int row, bool setAsMin = True );
1827 // auto size all columns (very ineffective for big grids!)
1828 void AutoSizeColumns( bool setAsMin = True );
1829 void AutoSizeRows( bool setAsMin = True );
1831 // auto size the grid, that is make the columns/rows of the "right" size
1832 // and also set the grid size to just fit its contents
1835 // autosize row height depending on label text
1836 void AutoSizeRowLabelSize( int row );
1838 // autosize column width depending on label text
1839 void AutoSizeColLabelSize( int col );
1842 // column won't be resized to be lesser width - this must be called during
1843 // the grid creation because it won't resize the column if it's already
1844 // narrower than the minimal width
1845 void SetColMinimalWidth( int col, int width );
1846 void SetRowMinimalHeight( int row, int width );
1848 void SetColMinimalAcceptableWidth( int width );
1849 void SetRowMinimalAcceptableHeight( int width );
1850 int GetColMinimalAcceptableWidth() const;
1851 int GetRowMinimalAcceptableHeight() const;
1853 void SetDefaultCellBackgroundColour( const wxColour& );
1854 void SetCellBackgroundColour( int row, int col, const wxColour& );
1855 void SetDefaultCellTextColour( const wxColour& );
1857 void SetCellTextColour( int row, int col, const wxColour& );
1858 void SetDefaultCellFont( const wxFont& );
1859 void SetCellFont( int row, int col, const wxFont& );
1860 void SetDefaultCellAlignment( int horiz, int vert );
1861 void SetCellAlignment( int row, int col, int horiz, int vert );
1862 void SetDefaultCellOverflow( bool allow );
1863 void SetCellOverflow( int row, int col, bool allow );
1864 void SetCellSize( int row, int col, int num_rows, int num_cols );
1866 // takes ownership of the pointer
1867 void SetDefaultRenderer(wxGridCellRenderer *renderer);
1868 void SetCellRenderer(int row, int col, wxGridCellRenderer *renderer);
1869 wxGridCellRenderer *GetDefaultRenderer() const;
1870 wxGridCellRenderer* GetCellRenderer(int row, int col);
1872 // takes ownership of the pointer
1873 void SetDefaultEditor(wxGridCellEditor *editor);
1874 void SetCellEditor(int row, int col, wxGridCellEditor *editor);
1875 wxGridCellEditor *GetDefaultEditor() const;
1876 wxGridCellEditor* GetCellEditor(int row, int col);
1880 // ------ cell value accessors
1882 wxString GetCellValue( int row, int col );
1883 // TODO: ??? wxString GetCellValue( const wxGridCellCoords& coords )
1885 void SetCellValue( int row, int col, const wxString& s );
1886 // TODO: ??? void SetCellValue( const wxGridCellCoords& coords, const wxString& s )
1888 // returns True if the cell can't be edited
1889 bool IsReadOnly(int row, int col) const;
1891 // make the cell editable/readonly
1892 void SetReadOnly(int row, int col, bool isReadOnly = True);
1894 // ------ selections of blocks of cells
1896 void SelectRow( int row, bool addToSelected = False );
1897 void SelectCol( int col, bool addToSelected = False );
1899 void SelectBlock( int topRow, int leftCol, int bottomRow, int rightCol,
1900 bool addToSelected = False );
1901 // TODO: ??? void SelectBlock( const wxGridCellCoords& topLeft,
1902 // TODO: ??? const wxGridCellCoords& bottomRight )
1906 void ClearSelection();
1907 bool IsInSelection( int row, int col );
1908 // TODO: ??? bool IsInSelection( const wxGridCellCoords& coords )
1910 const wxGridCellCoordsArray GetSelectedCells() const;
1911 const wxGridCellCoordsArray GetSelectionBlockTopLeft() const;
1912 const wxGridCellCoordsArray GetSelectionBlockBottomRight() const;
1913 const wxArrayInt GetSelectedRows() const;
1914 const wxArrayInt GetSelectedCols() const;
1916 void DeselectRow( int row );
1917 void DeselectCol( int col );
1918 void DeselectCell( int row, int col );
1921 // This function returns the rectangle that encloses the block of cells
1922 // limited by TopLeft and BottomRight cell in device coords and clipped
1923 // to the client size of the grid window.
1925 wxRect BlockToDeviceRect( const wxGridCellCoords & topLeft,
1926 const wxGridCellCoords & bottomRight );
1929 // Access or update the selection fore/back colours
1930 wxColour GetSelectionBackground() const;
1931 wxColour GetSelectionForeground() const;
1933 void SetSelectionBackground(const wxColour& c);
1934 void SetSelectionForeground(const wxColour& c);
1937 // Methods for a registry for mapping data types to Renderers/Editors
1938 void RegisterDataType(const wxString& typeName,
1939 wxGridCellRenderer* renderer,
1940 wxGridCellEditor* editor);
1941 wxGridCellEditor* GetDefaultEditorForCell(int row, int col) const;
1942 // TODO: ??? wxGridCellEditor* GetDefaultEditorForCell(const wxGridCellCoords& c) const
1943 wxGridCellRenderer* GetDefaultRendererForCell(int row, int col) const;
1944 wxGridCellEditor* GetDefaultEditorForType(const wxString& typeName) const;
1945 wxGridCellRenderer* GetDefaultRendererForType(const wxString& typeName) const;
1947 // grid may occupy more space than needed for its rows/columns, this
1948 // function allows to set how big this extra space is
1949 void SetMargins(int extraWidth, int extraHeight);
1952 // Accessors for component windows
1953 wxWindow* GetGridWindow();
1954 wxWindow* GetGridRowLabelWindow();
1955 wxWindow* GetGridColLabelWindow();
1956 wxWindow* GetGridCornerLabelWindow();
1959 static wxVisualAttributes
1960 GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
1964 //---------------------------------------------------------------------------
1965 //---------------------------------------------------------------------------
1966 // Grid events and stuff
1970 class wxGridEvent : public wxNotifyEvent
1973 wxGridEvent(int id, wxEventType type, wxGrid* obj,
1974 int row=-1, int col=-1, int x=-1, int y=-1, bool sel = True,
1975 bool control=False, bool shift=False, bool alt=False, bool meta=False);
1977 virtual int GetRow();
1978 virtual int GetCol();
1979 wxPoint GetPosition();
1989 class wxGridSizeEvent : public wxNotifyEvent
1992 wxGridSizeEvent(int id, wxEventType type, wxGrid* obj,
1993 int rowOrCol=-1, int x=-1, int y=-1,
1994 bool control=False, bool shift=False, bool alt=False, bool meta=False);
1997 wxPoint GetPosition();
2006 class wxGridRangeSelectEvent : public wxNotifyEvent
2009 wxGridRangeSelectEvent(int id, wxEventType type, wxGrid* obj,
2010 const wxGridCellCoords& topLeft,
2011 const wxGridCellCoords& bottomRight,
2013 bool control=False, bool shift=False,
2014 bool alt=False, bool meta=False);
2016 wxGridCellCoords GetTopLeftCoords();
2017 wxGridCellCoords GetBottomRightCoords();
2030 class wxGridEditorCreatedEvent : public wxCommandEvent {
2032 wxGridEditorCreatedEvent(int id, wxEventType type, wxObject* obj,
2033 int row, int col, wxControl* ctrl);
2037 wxControl* GetControl();
2038 void SetRow(int row);
2039 void SetCol(int col);
2040 void SetControl(wxControl* ctrl);
2045 %constant wxEventType wxEVT_GRID_CELL_LEFT_CLICK;
2046 %constant wxEventType wxEVT_GRID_CELL_RIGHT_CLICK;
2047 %constant wxEventType wxEVT_GRID_CELL_LEFT_DCLICK;
2048 %constant wxEventType wxEVT_GRID_CELL_RIGHT_DCLICK;
2049 %constant wxEventType wxEVT_GRID_LABEL_LEFT_CLICK;
2050 %constant wxEventType wxEVT_GRID_LABEL_RIGHT_CLICK;
2051 %constant wxEventType wxEVT_GRID_LABEL_LEFT_DCLICK;
2052 %constant wxEventType wxEVT_GRID_LABEL_RIGHT_DCLICK;
2053 %constant wxEventType wxEVT_GRID_ROW_SIZE;
2054 %constant wxEventType wxEVT_GRID_COL_SIZE;
2055 %constant wxEventType wxEVT_GRID_RANGE_SELECT;
2056 %constant wxEventType wxEVT_GRID_CELL_CHANGE;
2057 %constant wxEventType wxEVT_GRID_SELECT_CELL;
2058 %constant wxEventType wxEVT_GRID_EDITOR_SHOWN;
2059 %constant wxEventType wxEVT_GRID_EDITOR_HIDDEN;
2060 %constant wxEventType wxEVT_GRID_EDITOR_CREATED;
2065 EVT_GRID_CELL_LEFT_CLICK = wx.PyEventBinder( wxEVT_GRID_CELL_LEFT_CLICK )
2066 EVT_GRID_CELL_RIGHT_CLICK = wx.PyEventBinder( wxEVT_GRID_CELL_RIGHT_CLICK )
2067 EVT_GRID_CELL_LEFT_DCLICK = wx.PyEventBinder( wxEVT_GRID_CELL_LEFT_DCLICK )
2068 EVT_GRID_CELL_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_GRID_CELL_RIGHT_DCLICK )
2069 EVT_GRID_LABEL_LEFT_CLICK = wx.PyEventBinder( wxEVT_GRID_LABEL_LEFT_CLICK )
2070 EVT_GRID_LABEL_RIGHT_CLICK = wx.PyEventBinder( wxEVT_GRID_LABEL_RIGHT_CLICK )
2071 EVT_GRID_LABEL_LEFT_DCLICK = wx.PyEventBinder( wxEVT_GRID_LABEL_LEFT_DCLICK )
2072 EVT_GRID_LABEL_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_GRID_LABEL_RIGHT_DCLICK )
2073 EVT_GRID_ROW_SIZE = wx.PyEventBinder( wxEVT_GRID_ROW_SIZE )
2074 EVT_GRID_COL_SIZE = wx.PyEventBinder( wxEVT_GRID_COL_SIZE )
2075 EVT_GRID_RANGE_SELECT = wx.PyEventBinder( wxEVT_GRID_RANGE_SELECT )
2076 EVT_GRID_CELL_CHANGE = wx.PyEventBinder( wxEVT_GRID_CELL_CHANGE )
2077 EVT_GRID_SELECT_CELL = wx.PyEventBinder( wxEVT_GRID_SELECT_CELL )
2078 EVT_GRID_EDITOR_SHOWN = wx.PyEventBinder( wxEVT_GRID_EDITOR_SHOWN )
2079 EVT_GRID_EDITOR_HIDDEN = wx.PyEventBinder( wxEVT_GRID_EDITOR_HIDDEN )
2080 EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED )
2083 //---------------------------------------------------------------------------
2088 //---------------------------------------------------------------------------
2089 //---------------------------------------------------------------------------