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 /////////////////////////////////////////////////////////////////////////////
 
  22 //----------------------------------------------------------------------
 
  25 %include my_typemaps.i
 
  27 // Import some definitions of other classes, etc.
 
  35 %pragma(python) code = "import wx"
 
  37 //---------------------------------------------------------------------------
 
  38 //---------------------------------------------------------------------------
 
  39 // Macros, similar to what's in helpers.h, to aid in the creation of
 
  40 // virtual methods that are able to make callbacks to Python.  Many of these
 
  41 // are specific to wxGrid and so are kept here to reduce the mess in helpers.h
 
  46 #define PYCALLBACK_GCA_INTINT(PCLASS, CBNAME)                           \
 
  47     wxGridCellAttr* CBNAME(int a, int b) {                              \
 
  48         wxGridCellAttr* rval = NULL;                                    \
 
  49         bool doSave = wxPyRestoreThread();                              \
 
  50         if (m_myInst.findCallback(#CBNAME)) {                           \
 
  52             wxGridCellAttr* ptr;                                        \
 
  53             ro = m_myInst.callCallbackObj(Py_BuildValue("(ii)", a, b)); \
 
  55                 if (!SWIG_GetPtrObj(ro, (void **)&ptr, "_wxGridCellAttr_p"))    \
 
  61             rval = PCLASS::CBNAME(a, b);                                \
 
  62         wxPySaveThread(doSave);                                         \
 
  65     wxGridCellAttr *base_##CBNAME(int a, int b) {                       \
 
  66         return PCLASS::CBNAME(a, b);                                    \
 
  71 #define PYCALLBACK__GCAINTINT(PCLASS, CBNAME)                           \
 
  72     void CBNAME(wxGridCellAttr *attr, int a, int b) {                   \
 
  73         bool doSave = wxPyRestoreThread();                              \
 
  74         if (m_myInst.findCallback(#CBNAME))                             \
 
  75             m_myInst.callCallback(                                      \
 
  76                 Py_BuildValue("(Oii)",                                  \
 
  77                               wxPyConstructObject((void*)attr, "wxGridCellAttr"),    \
 
  80             PCLASS::CBNAME(attr, a, b);                                 \
 
  81         wxPySaveThread(doSave);                                         \
 
  83     void base_##CBNAME(wxGridCellAttr *attr, int a, int b) {            \
 
  84         PCLASS::CBNAME(attr, a, b);                                     \
 
  89 #define PYCALLBACK__GCAINT(PCLASS, CBNAME)                              \
 
  90     void CBNAME(wxGridCellAttr *attr, int val) {                        \
 
  91         bool doSave = wxPyRestoreThread();                              \
 
  92         if (m_myInst.findCallback(#CBNAME))                             \
 
  93             m_myInst.callCallback(                                      \
 
  94                 Py_BuildValue("(Oi)",                                   \
 
  95                               wxPyConstructObject((void*)attr, "wxGridCellAttr"),    \
 
  98             PCLASS::CBNAME(attr, val);                                  \
 
  99         wxPySaveThread(doSave);                                         \
 
 101     void base_##CBNAME(wxGridCellAttr *attr, int val) {                 \
 
 102         PCLASS::CBNAME(attr, val);                                      \
 
 107 #define PYCALLBACK_INT__pure(CBNAME)                                    \
 
 109         bool doSave = wxPyRestoreThread();                              \
 
 111         if (m_myInst.findCallback(#CBNAME))                             \
 
 112             rval = m_myInst.callCallback(Py_BuildValue("()"));          \
 
 113         wxPySaveThread(doSave);                                         \
 
 119 #define PYCALLBACK_BOOL_INTINT_pure(CBNAME)                             \
 
 120     bool CBNAME(int a, int b) {                                         \
 
 121         bool doSave = wxPyRestoreThread();                              \
 
 123         if (m_myInst.findCallback(#CBNAME))                             \
 
 124             rval = m_myInst.callCallback(Py_BuildValue("(ii)",a,b));    \
 
 125         wxPySaveThread(doSave);                                         \
 
 131 #define PYCALLBACK_STRING_INTINT_pure(CBNAME)                           \
 
 132     wxString CBNAME(int a, int b) {                                     \
 
 133         bool doSave = wxPyRestoreThread();                              \
 
 135         if (m_myInst.findCallback(#CBNAME)) {                           \
 
 137             ro = m_myInst.callCallbackObj(Py_BuildValue("(ii)",a,b));   \
 
 139                 rval = PyString_AsString(PyObject_Str(ro));             \
 
 143         wxPySaveThread(doSave);                                         \
 
 149 #define PYCALLBACK__INTINTSTRING_pure(CBNAME)                           \
 
 150     void CBNAME(int a, int b, const wxString& c) {                      \
 
 151         bool doSave = wxPyRestoreThread();                              \
 
 152         if (m_myInst.findCallback(#CBNAME))                             \
 
 153             m_myInst.callCallback(Py_BuildValue("(iis)",a,b,c.c_str()));    \
 
 154         wxPySaveThread(doSave);                                         \
 
 158 #define PYCALLBACK_STRING_INTINT(PCLASS, CBNAME)                        \
 
 159     wxString CBNAME(int a, int b) {                                     \
 
 160         bool doSave = wxPyRestoreThread();                              \
 
 162         if (m_myInst.findCallback(#CBNAME)) {                           \
 
 164             ro = m_myInst.callCallbackObj(Py_BuildValue("(ii)",a,b));   \
 
 166                 rval = PyString_AsString(PyObject_Str(ro));             \
 
 170             rval = PCLASS::CBNAME(a, b);                                \
 
 171         wxPySaveThread(doSave);                                         \
 
 174     wxString base_##CBNAME(int a, int b) {                              \
 
 175         return PCLASS::CBNAME(a, b);                                    \
 
 180 #define PYCALLBACK_BOOL_INTINTSTRING(PCLASS, CBNAME)                    \
 
 181     bool CBNAME(int a, int b, const wxString& c)  {                     \
 
 183         bool doSave = wxPyRestoreThread();                              \
 
 184         if (m_myInst.findCallback(#CBNAME))                             \
 
 185             rval = m_myInst.callCallback(Py_BuildValue("(iis)", a,b,c.c_str()));   \
 
 187             rval = PCLASS::CBNAME(a,b,c);                               \
 
 188         wxPySaveThread(doSave);                                         \
 
 191     bool base_##CBNAME(int a, int b, const wxString& c) {               \
 
 192         return PCLASS::CBNAME(a,b,c);                                   \
 
 198 #define PYCALLBACK_LONG_INTINT(PCLASS, CBNAME)                          \
 
 199     long CBNAME(int a, int b)  {                                        \
 
 201         bool doSave = wxPyRestoreThread();                              \
 
 202         if (m_myInst.findCallback(#CBNAME))                             \
 
 203             rval = m_myInst.callCallback(Py_BuildValue("(ii)", a,b));   \
 
 205             rval = PCLASS::CBNAME(a,b);                                 \
 
 206         wxPySaveThread(doSave);                                         \
 
 209     long base_##CBNAME(int a, int b) {                                  \
 
 210         return PCLASS::CBNAME(a,b);                                     \
 
 215 #define PYCALLBACK_BOOL_INTINT(PCLASS, CBNAME)                          \
 
 216     bool CBNAME(int a, int b)  {                                        \
 
 218         bool doSave = wxPyRestoreThread();                              \
 
 219         if (m_myInst.findCallback(#CBNAME))                             \
 
 220             rval = m_myInst.callCallback(Py_BuildValue("(ii)", a,b));   \
 
 222             rval = PCLASS::CBNAME(a,b);                                 \
 
 223         wxPySaveThread(doSave);                                         \
 
 226     bool base_##CBNAME(int a, int b) {                                  \
 
 227         return PCLASS::CBNAME(a,b);                                     \
 
 232 #define PYCALLBACK_DOUBLE_INTINT(PCLASS, CBNAME)                        \
 
 233     double CBNAME(int a, int b) {                                       \
 
 234         bool doSave = wxPyRestoreThread();                              \
 
 236         if (m_myInst.findCallback(#CBNAME)) {                           \
 
 238             ro = m_myInst.callCallbackObj(Py_BuildValue("(ii)",a,b));   \
 
 240                 rval = PyFloat_AsDouble(PyObject_Str(ro));              \
 
 244             rval = PCLASS::CBNAME(a, b);                                \
 
 245         wxPySaveThread(doSave);                                         \
 
 248     double base_##CBNAME(int a, int b) {                                \
 
 249         return PCLASS::CBNAME(a, b);                                    \
 
 254 #define PYCALLBACK__(PCLASS, CBNAME)                                    \
 
 256         bool doSave = wxPyRestoreThread();                              \
 
 257         if (m_myInst.findCallback(#CBNAME))                             \
 
 258             m_myInst.callCallback(Py_BuildValue("()"));                 \
 
 261         wxPySaveThread(doSave);                                         \
 
 263     void base_##CBNAME() {                                              \
 
 270 #define PYCALLBACK_BOOL_SIZETSIZET(PCLASS, CBNAME)                      \
 
 271     bool CBNAME(size_t a, size_t b)  {                                  \
 
 273         bool doSave = wxPyRestoreThread();                              \
 
 274         if (m_myInst.findCallback(#CBNAME))                             \
 
 275             rval = m_myInst.callCallback(Py_BuildValue("(ii)", a,b));   \
 
 277             rval = PCLASS::CBNAME(a,b);                                 \
 
 278         wxPySaveThread(doSave);                                         \
 
 281     bool base_##CBNAME(size_t a, size_t b) {                            \
 
 282         return PCLASS::CBNAME(a,b);                                     \
 
 287 #define PYCALLBACK_BOOL_SIZET(PCLASS, CBNAME)                           \
 
 288     bool CBNAME(size_t a)  {                                            \
 
 290         bool doSave = wxPyRestoreThread();                              \
 
 291         if (m_myInst.findCallback(#CBNAME))                             \
 
 292             rval = m_myInst.callCallback(Py_BuildValue("(i)", a));      \
 
 294             rval = PCLASS::CBNAME(a);                                   \
 
 295         wxPySaveThread(doSave);                                         \
 
 298     bool base_##CBNAME(size_t a) {                                      \
 
 299         return PCLASS::CBNAME(a);                                       \
 
 304 #define PYCALLBACK_STRING_INT(PCLASS, CBNAME)                           \
 
 305     wxString CBNAME(int a) {                                            \
 
 306         bool doSave = wxPyRestoreThread();                              \
 
 308         if (m_myInst.findCallback(#CBNAME)) {                           \
 
 310             ro = m_myInst.callCallbackObj(Py_BuildValue("(i)",a));      \
 
 312                 rval = PyString_AsString(PyObject_Str(ro));             \
 
 316             rval = PCLASS::CBNAME(a);                                   \
 
 317         wxPySaveThread(doSave);                                         \
 
 320     wxString base_##CBNAME(int a) {                                     \
 
 321         return PCLASS::CBNAME(a);                                       \
 
 326 #define PYCALLBACK__INTSTRING(PCLASS, CBNAME)                           \
 
 327     void CBNAME(int a, const wxString& c)  {                            \
 
 328         bool doSave = wxPyRestoreThread();                              \
 
 329         if (m_myInst.findCallback(#CBNAME))                             \
 
 330             m_myInst.callCallback(Py_BuildValue("(is)", a,c.c_str()));  \
 
 332             PCLASS::CBNAME(a,c);                                        \
 
 333         wxPySaveThread(doSave);                                         \
 
 335     void base_##CBNAME(int a, const wxString& c) {                      \
 
 336         PCLASS::CBNAME(a,c);                                            \
 
 342 #define PYCALLBACK_BOOL_(PCLASS, CBNAME)                                \
 
 345         bool doSave = wxPyRestoreThread();                              \
 
 346         if (m_myInst.findCallback(#CBNAME))                             \
 
 347             rval = m_myInst.callCallback(Py_BuildValue("()"));          \
 
 349             rval = PCLASS::CBNAME();                                    \
 
 350         wxPySaveThread(doSave);                                         \
 
 353     bool base_##CBNAME() {                                              \
 
 354         return PCLASS::CBNAME();                                        \
 
 359 #define PYCALLBACK__SIZETINT(PCLASS, CBNAME)                            \
 
 360     void CBNAME(size_t a, int b)  {                                     \
 
 361         bool doSave = wxPyRestoreThread();                              \
 
 362         if (m_myInst.findCallback(#CBNAME))                             \
 
 363             m_myInst.callCallback(Py_BuildValue("(ii)", a,b));          \
 
 365             PCLASS::CBNAME(a,b);                                        \
 
 366         wxPySaveThread(doSave);                                         \
 
 368     void base_##CBNAME(size_t a, int b) {                               \
 
 369         PCLASS::CBNAME(a,b);                                            \
 
 375 #define PYCALLBACK__INTINTLONG(PCLASS, CBNAME)                          \
 
 376     void CBNAME(int a, int b, long c)  {                                \
 
 377         bool doSave = wxPyRestoreThread();                              \
 
 378         if (m_myInst.findCallback(#CBNAME))                             \
 
 379             m_myInst.callCallback(Py_BuildValue("(iii)", a,b,c));       \
 
 381             PCLASS::CBNAME(a,b,c);                                      \
 
 382         wxPySaveThread(doSave);                                         \
 
 384     void base_##CBNAME(int a, int b, long c) {                          \
 
 385         PCLASS::CBNAME(a,b,c);                                          \
 
 391 #define PYCALLBACK__INTINTDOUBLE(PCLASS, CBNAME)                        \
 
 392     void CBNAME(int a, int b, double c)  {                              \
 
 393         bool doSave = wxPyRestoreThread();                              \
 
 394         if (m_myInst.findCallback(#CBNAME))                             \
 
 395             m_myInst.callCallback(Py_BuildValue("(iif)", a,b,c));       \
 
 397             PCLASS::CBNAME(a,b,c);                                      \
 
 398         wxPySaveThread(doSave);                                         \
 
 400     void base_##CBNAME(int a, int b, double c) {                        \
 
 401         PCLASS::CBNAME(a,b,c);                                          \
 
 406 #define PYCALLBACK__INTINTBOOL(PCLASS, CBNAME)                          \
 
 407     void CBNAME(int a, int b, bool c)  {                                \
 
 408         bool doSave = wxPyRestoreThread();                              \
 
 409         if (m_myInst.findCallback(#CBNAME))                             \
 
 410             m_myInst.callCallback(Py_BuildValue("(iii)", a,b,c));       \
 
 412             PCLASS::CBNAME(a,b,c);                                      \
 
 413         wxPySaveThread(doSave);                                         \
 
 415     void base_##CBNAME(int a, int b, bool c) {                          \
 
 416         PCLASS::CBNAME(a,b,c);                                          \
 
 424 //---------------------------------------------------------------------------
 
 426 class wxGridCellCoords;
 
 427 class wxGridCellAttr;
 
 431 #define wxGRID_VALUE_STRING     "string"
 
 432 #define wxGRID_VALUE_BOOL       "bool"
 
 433 #define wxGRID_VALUE_NUMBER     "long"
 
 434 #define wxGRID_VALUE_FLOAT      "double"
 
 435 #define wxGRID_VALUE_CHOICE     "choice"
 
 436 #define wxGRID_VALUE_TEXT       "string"
 
 437 #define wxGRID_VALUE_LONG       "long"
 
 440 wxGridCellCoords wxGridNoCellCoords;
 
 441 wxRect           wxGridNoCellRect;
 
 445 //---------------------------------------------------------------------------
 
 446 // wxGridCellRenderer is an ABC, and several derived classes are available.
 
 447 // Classes implemented in Python should be derived from wxPyGridCellRenderer.
 
 450 class wxGridCellRenderer
 
 453     void SetParameters(const wxString& params);
 
 457     virtual void Draw(wxGrid& grid,
 
 458                       wxGridCellAttr& attr,
 
 462                       bool isSelected) = 0;
 
 463     virtual wxSize GetBestSize(wxGrid& grid,
 
 464                                wxGridCellAttr& attr,
 
 466                                int row, int col) = 0;
 
 467     virtual wxGridCellRenderer *Clone() const = 0;
 
 471 // The C++ version of wxPyGridCellRenderer
 
 473 class wxPyGridCellRenderer : public wxGridCellRenderer
 
 476     wxPyGridCellRenderer() : wxGridCellRenderer() {};
 
 478     // Implement Python callback aware virtual methods
 
 479     void Draw(wxGrid& grid, wxGridCellAttr& attr,
 
 480               wxDC& dc, const wxRect& rect,
 
 481               int row, int col, bool isSelected) {
 
 482         bool doSave = wxPyRestoreThread();
 
 483         if (m_myInst.findCallback("Draw")) {
 
 484             m_myInst.callCallback(
 
 485                 Py_BuildValue("(OOOOiii)",
 
 486                               wxPyConstructObject((void*)&grid, "wxGrid"),
 
 487                               wxPyConstructObject((void*)&attr, "wxGridCellAttr"),
 
 488                               wxPyConstructObject((void*)&dc,   "wxDC"),
 
 489                               wxPyConstructObject((void*)&rect, "wxRect"),
 
 490                               row, col, isSelected));
 
 492         wxPySaveThread(doSave);
 
 495     wxSize GetBestSize(wxGrid& grid, wxGridCellAttr& attr, wxDC& dc,
 
 498         bool doSave = wxPyRestoreThread();
 
 499         if (m_myInst.findCallback("GetBestSize")) {
 
 502             ro = m_myInst.callCallbackObj(
 
 503                 Py_BuildValue("(OOOii)",
 
 504                               wxPyConstructObject((void*)&grid, "wxGrid"),
 
 505                               wxPyConstructObject((void*)&attr, "wxGridCellAttr"),
 
 506                               wxPyConstructObject((void*)&dc,   "wxDC"),
 
 509                 if (!SWIG_GetPtrObj(ro, (void **)&ptr, "_wxSize_p"))
 
 514         wxPySaveThread(doSave);
 
 519     wxGridCellRenderer *Clone() const {
 
 520         wxGridCellRenderer* rval = NULL;
 
 521         bool doSave = wxPyRestoreThread();
 
 522         if (m_myInst.findCallback("Clone")) {
 
 524             wxGridCellRenderer* ptr;
 
 525             ro = m_myInst.callCallbackObj(Py_BuildValue("()"));
 
 527                 if (!SWIG_GetPtrObj(ro, (void **)&ptr, "_wxGridCellRenderer_p"))
 
 532         wxPySaveThread(doSave);
 
 536     DEC_PYCALLBACK__STRING(SetParameters);
 
 541 IMP_PYCALLBACK__STRING( wxPyGridCellRenderer, wxGridCellRenderer, SetParameters);
 
 546 // Let SWIG know about it so it can create the Python version
 
 547 class wxPyGridCellRenderer : public wxGridCellRenderer {
 
 549     wxPyGridCellRenderer();
 
 550     void _setSelf(PyObject* self, PyObject* _class);
 
 551     %pragma(python) addtomethod = "__init__:self._setSelf(self, wxPyGridCellRenderer)"
 
 553     void base_SetParameters(const wxString& params);
 
 556 //---------------------------------------------------------------------------
 
 557 //  Predefined Renderers
 
 559 class wxGridCellStringRenderer : public wxGridCellRenderer
 
 562     wxGridCellStringRenderer();
 
 566 class  wxGridCellNumberRenderer : public wxGridCellStringRenderer
 
 569     wxGridCellNumberRenderer();
 
 573 class  wxGridCellFloatRenderer : public wxGridCellStringRenderer
 
 576     wxGridCellFloatRenderer(int width = -1, int precision = -1);
 
 578     int GetWidth() const;
 
 579     void SetWidth(int width);
 
 580     int GetPrecision() const;
 
 581     void SetPrecision(int precision);
 
 585 class  wxGridCellBoolRenderer : public wxGridCellRenderer
 
 588     wxGridCellBoolRenderer();
 
 593 //---------------------------------------------------------------------------
 
 594 // wxGridCellEditor is an ABC, and several derived classes are available.
 
 595 // Classes implemented in Python should be derived from wxPyGridCellEditor.
 
 597 class  wxGridCellEditor
 
 601     wxControl* GetControl();
 
 602     void SetControl(wxControl* control);
 
 604     void SetParameters(const wxString& params);
 
 608     virtual void Create(wxWindow* parent,
 
 610                         wxEvtHandler* evtHandler) = 0;
 
 611     virtual void BeginEdit(int row, int col, wxGrid* grid) = 0;
 
 612     virtual bool EndEdit(int row, int col, wxGrid* grid) = 0;
 
 613     virtual void Reset() = 0;
 
 614     virtual wxGridCellEditor *Clone() const = 0;
 
 616     virtual void SetSize(const wxRect& rect);
 
 617     virtual void Show(bool show, wxGridCellAttr *attr = NULL);
 
 618     virtual void PaintBackground(const wxRect& rectCell, wxGridCellAttr *attr);
 
 619     virtual bool IsAcceptedKey(wxKeyEvent& event);
 
 620     virtual void StartingKey(wxKeyEvent& event);
 
 621     virtual void StartingClick();
 
 622     virtual void HandleReturn(wxKeyEvent& event);
 
 623     virtual void Destroy();
 
 628 // The C++ version of wxPyGridCellEditor
 
 630 class wxPyGridCellEditor : public wxGridCellEditor
 
 633     wxPyGridCellEditor() : wxGridCellEditor() {}
 
 635     void Create(wxWindow* parent, wxWindowID id, wxEvtHandler* evtHandler) {
 
 636         bool doSave = wxPyRestoreThread();
 
 637         if (m_myInst.findCallback("Create")) {
 
 638             m_myInst.callCallback(
 
 639                 Py_BuildValue("(OiO)",
 
 640                               wxPyConstructObject((void*)parent, "wxWindow"),
 
 642                               wxPyConstructObject((void*)evtHandler, "wxEvtHandler")));
 
 644         wxPySaveThread(doSave);
 
 648     void BeginEdit(int row, int col, wxGrid* grid) {
 
 649         bool doSave = wxPyRestoreThread();
 
 650         if (m_myInst.findCallback("BeginEdit")) {
 
 651             m_myInst.callCallback(
 
 652                 Py_BuildValue("(iiO)", row, col,
 
 653                               wxPyConstructObject((void*)grid, "wxGrid")));
 
 655         wxPySaveThread(doSave);
 
 659     bool EndEdit(int row, int col, wxGrid* grid) {
 
 661         bool doSave = wxPyRestoreThread();
 
 662         if (m_myInst.findCallback("EndEdit")) {
 
 663             rv = m_myInst.callCallback(
 
 664                 Py_BuildValue("(iiO)", row, col,
 
 665                               wxPyConstructObject((void*)grid, "wxGrid")));
 
 667         wxPySaveThread(doSave);
 
 672     wxGridCellEditor *Clone() const {
 
 673         wxGridCellEditor* rval = NULL;
 
 674         bool doSave = wxPyRestoreThread();
 
 675         if (m_myInst.findCallback("Clone")) {
 
 677             wxGridCellEditor* ptr;
 
 678             ro = m_myInst.callCallbackObj(Py_BuildValue("()"));
 
 680                 if (!SWIG_GetPtrObj(ro, (void **)&ptr, "_wxGridCellEditor_p"))
 
 685         wxPySaveThread(doSave);
 
 690     void Show(bool show, wxGridCellAttr *attr) {
 
 691         bool doSave = wxPyRestoreThread();
 
 692         if (m_myInst.findCallback("Show"))
 
 693             m_myInst.callCallback(
 
 694                 Py_BuildValue("(iO)", show,
 
 695                               wxPyConstructObject((void*)attr, "wxGridCellAttr")));
 
 697             wxGridCellEditor::Show(show, attr);
 
 698         wxPySaveThread(doSave);
 
 700     void base_Show(bool show, wxGridCellAttr *attr) {
 
 701         wxGridCellEditor::Show(show, attr);
 
 705     void PaintBackground(const wxRect& rectCell, wxGridCellAttr *attr) {
 
 706         bool doSave = wxPyRestoreThread();
 
 707         if (m_myInst.findCallback("PaintBackground"))
 
 708             m_myInst.callCallback(
 
 709                 Py_BuildValue("(OO)",
 
 710                               wxPyConstructObject((void*)&rectCell, "wxRect"),
 
 711                               wxPyConstructObject((void*)attr, "wxGridCellAttr")));
 
 713             wxGridCellEditor::PaintBackground(rectCell, attr);
 
 714         wxPySaveThread(doSave);
 
 716     void base_PaintBackground(const wxRect& rectCell, wxGridCellAttr *attr) {
 
 717         wxGridCellEditor::PaintBackground(rectCell, attr);
 
 721     DEC_PYCALLBACK___pure(Reset);
 
 722     DEC_PYCALLBACK__constany(SetSize, wxRect);
 
 723     DEC_PYCALLBACK_bool_any(IsAcceptedKey, wxKeyEvent);
 
 724     DEC_PYCALLBACK__any(StartingKey, wxKeyEvent);
 
 725     DEC_PYCALLBACK__any(HandleReturn, wxKeyEvent);
 
 726     DEC_PYCALLBACK__(StartingClick);
 
 727     DEC_PYCALLBACK__(Destroy);
 
 728     DEC_PYCALLBACK__STRING(SetParameters);
 
 734 IMP_PYCALLBACK__STRING( wxPyGridCellEditor, wxGridCellEditor, SetParameters);
 
 735 IMP_PYCALLBACK___pure(wxPyGridCellEditor, wxGridCellEditor, Reset);
 
 736 IMP_PYCALLBACK__constany(wxPyGridCellEditor, wxGridCellEditor, SetSize, wxRect);
 
 737 IMP_PYCALLBACK_bool_any(wxPyGridCellEditor, wxGridCellEditor, IsAcceptedKey, wxKeyEvent);
 
 738 IMP_PYCALLBACK__any(wxPyGridCellEditor, wxGridCellEditor, StartingKey, wxKeyEvent);
 
 739 IMP_PYCALLBACK__any(wxPyGridCellEditor, wxGridCellEditor, HandleReturn, wxKeyEvent);
 
 740 IMP_PYCALLBACK__(wxPyGridCellEditor, wxGridCellEditor, StartingClick);
 
 741 IMP_PYCALLBACK__(wxPyGridCellEditor, wxGridCellEditor, Destroy);
 
 746 // Let SWIG know about it so it can create the Python version
 
 747 class wxPyGridCellEditor : public wxGridCellEditor {
 
 749     wxPyGridCellEditor();
 
 750     void _setSelf(PyObject* self, PyObject* _class);
 
 751     %pragma(python) addtomethod = "__init__:self._setSelf(self, wxPyGridCellEditor)"
 
 753     void base_SetSize(const wxRect& rect);
 
 754     void base_Show(bool show, wxGridCellAttr *attr = NULL);
 
 755     void base_PaintBackground(const wxRect& rectCell, wxGridCellAttr *attr);
 
 756     void base_StartingKey(wxKeyEvent& event);
 
 757     void base_StartingClick();
 
 758     void base_HandleReturn(wxKeyEvent& event);
 
 760     void base_SetParameters(const wxString& params);
 
 763 //---------------------------------------------------------------------------
 
 764 //  Predefined Editors
 
 766 class wxGridCellTextEditor : public wxGridCellEditor
 
 769     wxGridCellTextEditor();
 
 773 class wxGridCellNumberEditor : public wxGridCellTextEditor
 
 776     wxGridCellNumberEditor(int min = -1, int max = -1);
 
 780 class wxGridCellFloatEditor : public wxGridCellTextEditor
 
 783     wxGridCellFloatEditor();
 
 787 class wxGridCellBoolEditor : public wxGridCellEditor
 
 790     wxGridCellBoolEditor();
 
 793 class wxGridCellChoiceEditor : public wxGridCellEditor
 
 796     wxGridCellChoiceEditor(int LCOUNT = 0,
 
 797                            const wxString* choices = NULL,
 
 798                            bool allowOthers = FALSE);
 
 801         wxGridCellChoiceEditor(PyObject* choices,
 
 802                                 bool allowOthers = FALSE) {
 
 804             const char** temp = string_LIST_helper(choices);
 
 806                 int count = PyList_Size(choices);
 
 807                 wxGridCellChoiceEditor* ret;
 
 808                 ret = new wxGridCellChoiceEditor(count, temp, allowOthers);
 
 818 //---------------------------------------------------------------------------
 
 826     wxGridCellAttr *Clone() const;
 
 829     void SetTextColour(const wxColour& colText);
 
 830     void SetBackgroundColour(const wxColour& colBack);
 
 831     void SetFont(const wxFont& font);
 
 832     void SetAlignment(int hAlign, int vAlign);
 
 833     void SetReadOnly(bool isReadOnly = TRUE);
 
 835     void SetRenderer(wxGridCellRenderer *renderer);
 
 836     void SetEditor(wxGridCellEditor* editor);
 
 838     bool HasTextColour() const;
 
 839     bool HasBackgroundColour() const;
 
 840     bool HasFont() const;
 
 841     bool HasAlignment() const;
 
 842     bool HasRenderer() const;
 
 843     bool HasEditor() const;
 
 845     const wxColour& GetTextColour() const;
 
 846     const wxColour& GetBackgroundColour() const;
 
 847     const wxFont& GetFont() const;
 
 848     void GetAlignment(int *OUTPUT, int *OUTPUT) const;
 
 849     wxGridCellRenderer *GetRenderer(wxGrid* grid, int row, int col) const;
 
 850     wxGridCellEditor *GetEditor(wxGrid* grid, int row, int col) const;
 
 852     bool IsReadOnly() const;
 
 853     void SetDefAttr(wxGridCellAttr* defAttr);
 
 856 //---------------------------------------------------------------------------
 
 858 class wxGridCellAttrProvider
 
 861     wxGridCellAttrProvider();
 
 862     // ???? virtual ~wxGridCellAttrProvider();
 
 864     wxGridCellAttr *GetAttr(int row, int col) const;
 
 865     void SetAttr(wxGridCellAttr *attr, int row, int col);
 
 866     void SetRowAttr(wxGridCellAttr *attr, int row);
 
 867     void SetColAttr(wxGridCellAttr *attr, int col);
 
 869     void UpdateAttrRows( size_t pos, int numRows );
 
 870     void UpdateAttrCols( size_t pos, int numCols );
 
 875 // A Python-aware version
 
 877 class wxPyGridCellAttrProvider : public wxGridCellAttrProvider
 
 880     wxPyGridCellAttrProvider() : wxGridCellAttrProvider() {};
 
 882     PYCALLBACK_GCA_INTINT(wxGridCellAttrProvider, GetAttr);
 
 883     PYCALLBACK__GCAINTINT(wxGridCellAttrProvider, SetAttr);
 
 884     PYCALLBACK__GCAINT(wxGridCellAttrProvider, SetRowAttr);
 
 885     PYCALLBACK__GCAINT(wxGridCellAttrProvider, SetColAttr);
 
 892 // The python-aware version get's SWIGified
 
 893 class wxPyGridCellAttrProvider : public wxGridCellAttrProvider
 
 896     wxPyGridCellAttrProvider();
 
 897     void _setSelf(PyObject* self, PyObject* _class);
 
 898     %pragma(python) addtomethod = "__init__:self._setSelf(self, wxPyGridCellAttrProvider)"
 
 900     wxGridCellAttr *base_GetAttr(int row, int col);
 
 901     void base_SetAttr(wxGridCellAttr *attr, int row, int col);
 
 902     void base_SetRowAttr(wxGridCellAttr *attr, int row);
 
 903     void base_SetColAttr(wxGridCellAttr *attr, int col);
 
 907 //---------------------------------------------------------------------------
 
 908 // Grid Table Base class and Python aware version
 
 912 class wxGridTableBase
 
 915     // wxGridTableBase();   This is an ABC
 
 916     //~wxGridTableBase();
 
 918     void SetAttrProvider(wxGridCellAttrProvider *attrProvider);
 
 919     wxGridCellAttrProvider *GetAttrProvider() const;
 
 920     void SetView( wxGrid *grid );
 
 921     wxGrid * GetView() const;
 
 925     virtual int GetNumberRows() = 0;
 
 926     virtual int GetNumberCols() = 0;
 
 927     virtual bool IsEmptyCell( int row, int col ) = 0;
 
 928     virtual wxString GetValue( int row, int col ) = 0;
 
 929     virtual void SetValue( int row, int col, const wxString& value ) = 0;
 
 931     // virtuals overridable in wxPyGridTableBase
 
 932     virtual wxString GetTypeName( int row, int col );
 
 933     virtual bool CanGetValueAs( int row, int col, const wxString& typeName );
 
 934     virtual bool CanSetValueAs( int row, int col, const wxString& typeName );
 
 935     virtual long GetValueAsLong( int row, int col );
 
 936     virtual double GetValueAsDouble( int row, int col );
 
 937     virtual bool GetValueAsBool( int row, int col );
 
 938     virtual void SetValueAsLong( int row, int col, long value );
 
 939     virtual void SetValueAsDouble( int row, int col, double value );
 
 940     virtual void SetValueAsBool( int row, int col, bool value );
 
 942     //virtual void* GetValueAsCustom( int row, int col, const wxString& typeName );
 
 943     //virtual void  SetValueAsCustom( int row, int col, const wxString& typeName, void* value );
 
 946     virtual void Clear();
 
 947     virtual bool InsertRows( size_t pos = 0, size_t numRows = 1 );
 
 948     virtual bool AppendRows( size_t numRows = 1 );
 
 949     virtual bool DeleteRows( size_t pos = 0, size_t numRows = 1 );
 
 950     virtual bool InsertCols( size_t pos = 0, size_t numCols = 1 );
 
 951     virtual bool AppendCols( size_t numCols = 1 );
 
 952     virtual bool DeleteCols( size_t pos = 0, size_t numCols = 1 );
 
 954     virtual wxString GetRowLabelValue( int row );
 
 955     virtual wxString GetColLabelValue( int col );
 
 956     virtual void SetRowLabelValue( int row, const wxString& value );
 
 957     virtual void SetColLabelValue( int col, const wxString& value );
 
 959     virtual bool CanHaveAttributes();
 
 961     virtual wxGridCellAttr *GetAttr( int row, int col );
 
 962     virtual void SetAttr(wxGridCellAttr* attr, int row, int col);
 
 963     virtual void SetRowAttr(wxGridCellAttr *attr, int row);
 
 964     virtual void SetColAttr(wxGridCellAttr *attr, int col);
 
 970 // Python-aware version
 
 972 class wxPyGridTableBase : public wxGridTableBase
 
 975     wxPyGridTableBase() : wxGridTableBase() {}
 
 977     PYCALLBACK_INT__pure(GetNumberRows);
 
 978     PYCALLBACK_INT__pure(GetNumberCols);
 
 979     PYCALLBACK_BOOL_INTINT_pure(IsEmptyCell);
 
 980     PYCALLBACK_STRING_INTINT(wxGridTableBase, GetTypeName);
 
 981     PYCALLBACK_BOOL_INTINTSTRING(wxGridTableBase, CanGetValueAs);
 
 982     PYCALLBACK_BOOL_INTINTSTRING(wxGridTableBase, CanSetValueAs);
 
 983     PYCALLBACK__(wxGridTableBase, Clear);
 
 984     PYCALLBACK_BOOL_SIZETSIZET(wxGridTableBase, InsertRows);
 
 985     PYCALLBACK_BOOL_SIZETSIZET(wxGridTableBase, DeleteRows);
 
 986     PYCALLBACK_BOOL_SIZETSIZET(wxGridTableBase, InsertCols);
 
 987     PYCALLBACK_BOOL_SIZETSIZET(wxGridTableBase, DeleteCols);
 
 988     PYCALLBACK_BOOL_SIZET(wxGridTableBase, AppendRows);
 
 989     PYCALLBACK_BOOL_SIZET(wxGridTableBase, AppendCols);
 
 990     PYCALLBACK_STRING_INT(wxGridTableBase, GetRowLabelValue);
 
 991     PYCALLBACK_STRING_INT(wxGridTableBase, GetColLabelValue);
 
 992     PYCALLBACK__INTSTRING(wxGridTableBase, SetRowLabelValue);
 
 993     PYCALLBACK__INTSTRING(wxGridTableBase, SetColLabelValue);
 
 994     PYCALLBACK_BOOL_(wxGridTableBase, CanHaveAttributes);
 
 995     PYCALLBACK_GCA_INTINT(wxGridTableBase, GetAttr);
 
 996     PYCALLBACK__GCAINTINT(wxGridTableBase, SetAttr);
 
 997     PYCALLBACK__GCAINT(wxGridTableBase, SetRowAttr);
 
 998     PYCALLBACK__GCAINT(wxGridTableBase, SetColAttr);
 
1002     wxString GetValue(int row, int col) {
 
1003         bool doSave = wxPyRestoreThread();
 
1005         if (m_myInst.findCallback("GetValue")) {
 
1007             ro = m_myInst.callCallbackObj(Py_BuildValue("(ii)",row,col));
 
1009                 rval = PyString_AsString(PyObject_Str(ro));
 
1013         wxPySaveThread(doSave);
 
1017     void SetValue(int row, int col, const wxString& val) {
 
1018         bool doSave = wxPyRestoreThread();
 
1019         if (m_myInst.findCallback("SetValue"))
 
1020             m_myInst.callCallback(Py_BuildValue("(iis)",row,col,val.c_str()));
 
1021         wxPySaveThread(doSave);
 
1025     // Map the Get/Set methods for the standard non-string types to
 
1026     // the GetValue and SetValue python methods.
 
1027     long GetValueAsLong( int row, int col ) {
 
1029         bool doSave = wxPyRestoreThread();
 
1030         if (m_myInst.findCallback("GetValue")) {
 
1033             ro = m_myInst.callCallbackObj(Py_BuildValue("(ii)", row, col));
 
1034             if (ro && PyNumber_Check(ro)) {
 
1035                 num = PyNumber_Int(ro);
 
1037                     rval = PyInt_AsLong(num);
 
1043         wxPySaveThread(doSave);
 
1047     double GetValueAsDouble( int row, int col ) {
 
1049         bool doSave = wxPyRestoreThread();
 
1050         if (m_myInst.findCallback("GetValue")) {
 
1053             ro = m_myInst.callCallbackObj(Py_BuildValue("(ii)", row, col));
 
1054             if (ro && PyNumber_Check(ro)) {
 
1055                 num = PyNumber_Float(ro);
 
1057                     rval = PyFloat_AsDouble(num);
 
1063         wxPySaveThread(doSave);
 
1067     bool GetValueAsBool( int row, int col ) {
 
1068         return (bool)GetValueAsLong(row, col);
 
1071     void SetValueAsLong( int row, int col, long value ) {
 
1072         bool doSave = wxPyRestoreThread();
 
1073         if (m_myInst.findCallback("SetValue")) {
 
1074             m_myInst.callCallback(Py_BuildValue("(iii)", row, col, value));
 
1076         wxPySaveThread(doSave);
 
1079     void SetValueAsDouble( int row, int col, double value ) {
 
1080         bool doSave = wxPyRestoreThread();
 
1081         if (m_myInst.findCallback("SetValue")) {
 
1082             m_myInst.callCallback(Py_BuildValue("(iid)", row, col, value));
 
1084         wxPySaveThread(doSave);
 
1087     void SetValueAsBool( int row, int col, bool value ) {
 
1088         SetValueAsLong( row, col, (long)value );
 
1097 // The python-aware version get's SWIGified
 
1098 class wxPyGridTableBase : public wxGridTableBase
 
1101     wxPyGridTableBase();
 
1102     void _setSelf(PyObject* self, PyObject* _class);
 
1103     %pragma(python) addtomethod = "__init__:self._setSelf(self, wxPyGridTableBase)"
 
1105     %addmethods { void Destroy() { delete self; } }
 
1107     wxString base_GetTypeName( int row, int col );
 
1108     bool base_CanGetValueAs( int row, int col, const wxString& typeName );
 
1109     bool base_CanSetValueAs( int row, int col, const wxString& typeName );
 
1111     bool base_InsertRows( size_t pos = 0, size_t numRows = 1 );
 
1112     bool base_AppendRows( size_t numRows = 1 );
 
1113     bool base_DeleteRows( size_t pos = 0, size_t numRows = 1 );
 
1114     bool base_InsertCols( size_t pos = 0, size_t numCols = 1 );
 
1115     bool base_AppendCols( size_t numCols = 1 );
 
1116     bool base_DeleteCols( size_t pos = 0, size_t numCols = 1 );
 
1117     wxString base_GetRowLabelValue( int row );
 
1118     wxString base_GetColLabelValue( int col );
 
1119     void base_SetRowLabelValue( int row, const wxString& value );
 
1120     void base_SetColLabelValue( int col, const wxString& value );
 
1121     bool base_CanHaveAttributes();
 
1122     wxGridCellAttr *base_GetAttr( int row, int col );
 
1123     void base_SetAttr(wxGridCellAttr* attr, int row, int col);
 
1124     void base_SetRowAttr(wxGridCellAttr *attr, int row);
 
1125     void base_SetColAttr(wxGridCellAttr *attr, int col);
 
1129 //---------------------------------------------------------------------------
 
1130 // Predefined Tables
 
1132 class  wxGridStringTable : public wxGridTableBase
 
1135     wxGridStringTable( int numRows=0, int numCols=0 );
 
1138 //---------------------------------------------------------------------------
 
1139 // The Table can pass messages to the grid to tell it to update itself if
 
1140 // something has changed.
 
1142 enum wxGridTableRequest
 
1144     wxGRIDTABLE_REQUEST_VIEW_GET_VALUES = 2000,
 
1145     wxGRIDTABLE_REQUEST_VIEW_SEND_VALUES,
 
1146     wxGRIDTABLE_NOTIFY_ROWS_INSERTED,
 
1147     wxGRIDTABLE_NOTIFY_ROWS_APPENDED,
 
1148     wxGRIDTABLE_NOTIFY_ROWS_DELETED,
 
1149     wxGRIDTABLE_NOTIFY_COLS_INSERTED,
 
1150     wxGRIDTABLE_NOTIFY_COLS_APPENDED,
 
1151     wxGRIDTABLE_NOTIFY_COLS_DELETED
 
1155 class wxGridTableMessage
 
1158     wxGridTableMessage( wxGridTableBase *table, int id,
 
1161     ~wxGridTableMessage();
 
1163     void SetTableObject( wxGridTableBase *table );
 
1164     wxGridTableBase * GetTableObject() const;
 
1165     void SetId( int id );
 
1167     void SetCommandInt( int comInt1 );
 
1168     int  GetCommandInt();
 
1169     void SetCommandInt2( int comInt2 );
 
1170     int  GetCommandInt2();
 
1174 //---------------------------------------------------------------------------
 
1176 class wxGridCellCoords
 
1179     wxGridCellCoords( int r=-1, int c=-1 );
 
1180     ~wxGridCellCoords();
 
1182     int GetRow() const { return m_row; }
 
1183     void SetRow( int n ) { m_row = n; }
 
1184     int GetCol() const { return m_col; }
 
1185     void SetCol( int n ) { m_col = n; }
 
1186     void Set( int row, int col ) { m_row = row; m_col = col; }
 
1189         PyObject* asTuple() {
 
1190             PyObject* tup = PyTuple_New(2);
 
1191             PyTuple_SET_ITEM(tup, 0, PyInt_FromLong(self->GetRow()));
 
1192             PyTuple_SET_ITEM(tup, 1, PyInt_FromLong(self->GetCol()));
 
1196         int __cmp__( const wxGridCellCoords& other ) {
 
1197             return *self != other;
 
1200     %pragma(python) addtoclass = "def __str__(self): return str(self.asTuple())"
 
1201     %pragma(python) addtoclass = "def __repr__(self): return str(self.asTuple())"
 
1204 // Typemap to allow conversion of sequence objects to wxGridCellCoords...
 
1205 %typemap(python,in) wxGridCellCoords& (wxGridCellCoords temp) {
 
1207     if (! wxGridCellCoords_helper($source, &$target))
 
1211 // ...and here is the associated helper.
 
1213 bool wxGridCellCoords_helper(PyObject* source, wxGridCellCoords** obj) {
 
1215     // If source is an object instance then it may already be the right type
 
1216     if (PyInstance_Check(source)) {
 
1217         wxGridCellCoords* ptr;
 
1218         if (SWIG_GetPtrObj(source, (void **)&ptr, "_wxGridCellCoords_p"))
 
1223     // otherwise a 2-tuple of integers is expected
 
1224     else if (PySequence_Check(source) && PyObject_Length(source) == 2) {
 
1225         PyObject* o1 = PySequence_GetItem(source, 0);
 
1226         PyObject* o2 = PySequence_GetItem(source, 1);
 
1227         **obj = wxGridCellCoords(PyInt_AsLong(o1), PyInt_AsLong(o2));
 
1232     PyErr_SetString(PyExc_TypeError, "Expected a 2-tuple of integers or a wxGridCellCoords object.");
 
1237 //---------------------------------------------------------------------------
 
1238 //---------------------------------------------------------------------------
 
1242 // Fool SWIG into treating this enum as an int
 
1243 typedef int WXGRIDSELECTIONMODES;
 
1245 // but let the C++ code know what it really is.
 
1247 typedef wxGrid::wxGridSelectionModes WXGRIDSELECTIONMODES;
 
1252 class wxGrid : public wxScrolledWindow
 
1255     wxGrid( wxWindow *parent,
 
1257             const wxPoint& pos = wxDefaultPosition,
 
1258             const wxSize& size = wxDefaultSize,
 
1259             long style = wxWANTS_CHARS,
 
1260             const char* name = wxPanelNameStr );
 
1264     enum wxGridSelectionModes {wxGridSelectCells,
 
1266                                wxGridSelectColumns};
 
1268     bool CreateGrid( int numRows, int numCols,
 
1269                      WXGRIDSELECTIONMODES selmode = wxGrid::wxGridSelectCells );
 
1270     void SetSelectionMode(WXGRIDSELECTIONMODES selmode);
 
1273     // ------ grid dimensions
 
1275     int      GetNumberRows();
 
1276     int      GetNumberCols();
 
1280 #ifdef NOTNEEDED // ????
 
1281     // ------ display update functions
 
1283     void CalcRowLabelsExposed( wxRegion& reg );
 
1284     void CalcColLabelsExposed( wxRegion& reg );
 
1285     void CalcCellsExposed( wxRegion& reg );
 
1287     // ------ event handlers
 
1289     void ProcessRowLabelMouseEvent( wxMouseEvent& event );
 
1290     void ProcessColLabelMouseEvent( wxMouseEvent& event );
 
1291     void ProcessCornerLabelMouseEvent( wxMouseEvent& event );
 
1292     void ProcessGridCellMouseEvent( wxMouseEvent& event );
 
1293     void DoEndDragResizeRow();
 
1294     void DoEndDragResizeCol();
 
1297     bool ProcessTableMessage( wxGridTableMessage& );
 
1300     wxGridTableBase * GetTable() const;
 
1301     bool SetTable( wxGridTableBase *table, bool takeOwnership=FALSE,
 
1302                    WXGRIDSELECTIONMODES selmode =
 
1303                    wxGrid::wxGridSelectCells );
 
1306     bool InsertRows( int pos = 0, int numRows = 1, bool updateLabels=TRUE );
 
1307     bool AppendRows( int numRows = 1, bool updateLabels=TRUE );
 
1308     bool DeleteRows( int pos = 0, int numRows = 1, bool updateLabels=TRUE );
 
1309     bool InsertCols( int pos = 0, int numCols = 1, bool updateLabels=TRUE );
 
1310     bool AppendCols( int numCols = 1, bool updateLabels=TRUE );
 
1311     bool DeleteCols( int pos = 0, int numCols = 1, bool updateLabels=TRUE );
 
1313 #ifdef NOTNEEDED // ????
 
1314     void DrawGridCellArea( wxDC& dc );
 
1315     void DrawGridSpace( wxDC& dc );
 
1316     void DrawCellBorder( wxDC& dc, const wxGridCellCoords& );
 
1317     void DrawAllGridLines( wxDC& dc, const wxRegion & reg );
 
1318     void DrawCell( wxDC& dc, const wxGridCellCoords& );
 
1319     void DrawHighlight(wxDC& dc);
 
1322     // this function is called when the current cell highlight must be redrawn
 
1323     // and may be overridden by the user
 
1324     virtual void DrawCellHighlight( wxDC& dc, const wxGridCellAttr *attr );
 
1326 #ifdef NOTNEEDED // ????
 
1327     void DrawRowLabels( wxDC& dc );
 
1328     void DrawRowLabel( wxDC& dc, int row );
 
1330     void DrawColLabels( wxDC& dc );
 
1331     void DrawColLabel( wxDC& dc, int col );
 
1334     // ------ Cell text drawing functions
 
1336     void DrawTextRectangle( wxDC& dc, const wxString&, const wxRect&,
 
1337                             int horizontalAlignment = wxLEFT,
 
1338                             int verticalAlignment = wxTOP );
 
1340     // Split a string containing newline chararcters into an array of
 
1341     // strings and return the number of lines
 
1343     void StringToLines( const wxString& value, wxArrayString& lines );
 
1345     void GetTextBoxSize( wxDC& dc,
 
1346                          wxArrayString& lines,
 
1347                          long *OUTPUT, long *OUTPUT );
 
1351     // Code that does a lot of grid modification can be enclosed
 
1352     // between BeginBatch() and EndBatch() calls to avoid screen
 
1357     int      GetBatchCount();
 
1360     // ------ edit control functions
 
1362     bool IsEditable() { return m_editable; }
 
1363     void EnableEditing( bool edit );
 
1365     void EnableCellEditControl( bool enable = TRUE );
 
1366     void DisableCellEditControl();
 
1367     bool CanEnableCellControl() const;
 
1368     bool IsCellEditControlEnabled() const;
 
1369     bool IsCellEditControlShown() const;
 
1371     bool IsCurrentCellReadOnly() const;
 
1373     void ShowCellEditControl();
 
1374     void HideCellEditControl();
 
1375     void SaveEditControlValue();
 
1378     // ------ grid location functions
 
1379     //  Note that all of these functions work with the logical coordinates of
 
1380     //  grid cells and labels so you will need to convert from device
 
1381     //  coordinates for mouse events etc.
 
1384     //void XYToCell( int x, int y, wxGridCellCoords& );
 
1386         %new wxGridCellCoords* XYToCell(int x, int y) {
 
1387             wxGridCellCoords rv;
 
1388             self->XYToCell(x, y, rv);
 
1389             return new wxGridCellCoords(rv);
 
1393     int  YToRow( int y );
 
1394     int  XToCol( int x );
 
1396     int  YToEdgeOfRow( int y );
 
1397     int  XToEdgeOfCol( int x );
 
1399     wxRect CellToRect( int row, int col );
 
1400     // TODO: ??? wxRect CellToRect( const wxGridCellCoords& coords );
 
1403     int  GetGridCursorRow();
 
1404     int  GetGridCursorCol();
 
1406     // check to see if a cell is either wholly visible (the default arg) or
 
1407     // at least partially visible in the grid window
 
1409     bool IsVisible( int row, int col, bool wholeCellVisible = TRUE );
 
1410     // TODO: ??? bool IsVisible( const wxGridCellCoords& coords, bool wholeCellVisible = TRUE );
 
1411     void MakeCellVisible( int row, int col );
 
1412     // TODO: ??? void MakeCellVisible( const wxGridCellCoords& coords );
 
1415     // ------ grid cursor movement functions
 
1417     void SetGridCursor( int row, int col );
 
1418     bool MoveCursorUp( bool expandSelection );
 
1419     bool MoveCursorDown( bool expandSelection );
 
1420     bool MoveCursorLeft( bool expandSelection );
 
1421     bool MoveCursorRight( bool expandSelection );
 
1422     bool MovePageDown();
 
1424     bool MoveCursorUpBlock( bool expandSelection );
 
1425     bool MoveCursorDownBlock( bool expandSelection );
 
1426     bool MoveCursorLeftBlock( bool expandSelection );
 
1427     bool MoveCursorRightBlock( bool expandSelection );
 
1430     // ------ label and gridline formatting
 
1432     int      GetDefaultRowLabelSize();
 
1433     int      GetRowLabelSize();
 
1434     int      GetDefaultColLabelSize();
 
1435     int      GetColLabelSize();
 
1436     wxColour GetLabelBackgroundColour();
 
1437     wxColour GetLabelTextColour();
 
1438     wxFont   GetLabelFont();
 
1439     void     GetRowLabelAlignment( int *OUTPUT, int *OUTPUT );
 
1440     void     GetColLabelAlignment( int *OUTPUT, int *OUTPUT );
 
1441     wxString GetRowLabelValue( int row );
 
1442     wxString GetColLabelValue( int col );
 
1443     wxColour GetGridLineColour();
 
1444     wxColour GetCellHighlightColour();
 
1446     void     SetRowLabelSize( int width );
 
1447     void     SetColLabelSize( int height );
 
1448     void     SetLabelBackgroundColour( const wxColour& );
 
1449     void     SetLabelTextColour( const wxColour& );
 
1450     void     SetLabelFont( const wxFont& );
 
1451     void     SetRowLabelAlignment( int horiz, int vert );
 
1452     void     SetColLabelAlignment( int horiz, int vert );
 
1453     void     SetRowLabelValue( int row, const wxString& );
 
1454     void     SetColLabelValue( int col, const wxString& );
 
1455     void     SetGridLineColour( const wxColour& );
 
1456     void     SetCellHighlightColour( const wxColour& );
 
1458     void     EnableDragRowSize( bool enable = TRUE );
 
1459     void     DisableDragRowSize();
 
1460     bool     CanDragRowSize();
 
1461     void     EnableDragColSize( bool enable = TRUE );
 
1462     void     DisableDragColSize();
 
1463     bool     CanDragColSize();
 
1464     void     EnableDragGridSize(bool enable = TRUE);
 
1465     void     DisableDragGridSize();
 
1466     bool     CanDragGridSize();
 
1468     // this sets the specified attribute for all cells in this row/col
 
1469     void     SetRowAttr(int row, wxGridCellAttr *attr);
 
1470     void     SetColAttr(int col, wxGridCellAttr *attr);
 
1472     // shortcuts for setting the column parameters
 
1474     // set the format for the data in the column: default is string
 
1475     void     SetColFormatBool(int col);
 
1476     void     SetColFormatNumber(int col);
 
1477     void     SetColFormatFloat(int col, int width = -1, int precision = -1);
 
1478     void     SetColFormatCustom(int col, const wxString& typeName);
 
1480     void     EnableGridLines( bool enable = TRUE );
 
1481     bool     GridLinesEnabled();
 
1483     // ------ row and col formatting
 
1485     int      GetDefaultRowSize();
 
1486     int      GetRowSize( int row );
 
1487     int      GetDefaultColSize();
 
1488     int      GetColSize( int col );
 
1489     wxColour GetDefaultCellBackgroundColour();
 
1490     wxColour GetCellBackgroundColour( int row, int col );
 
1491     wxColour GetDefaultCellTextColour();
 
1492     wxColour GetCellTextColour( int row, int col );
 
1493     wxFont   GetDefaultCellFont();
 
1494     wxFont   GetCellFont( int row, int col );
 
1495     void     GetDefaultCellAlignment( int *horiz, int *vert );
 
1496     void     GetCellAlignment( int row, int col, int *horiz, int *vert );
 
1498     void     SetDefaultRowSize( int height, bool resizeExistingRows = FALSE );
 
1499     void     SetRowSize( int row, int height );
 
1500     void     SetDefaultColSize( int width, bool resizeExistingCols = FALSE );
 
1502     void     SetColSize( int col, int width );
 
1504     // automatically size the column or row to fit to its contents, if
 
1505     // setAsMin is TRUE, this optimal width will also be set as minimal width
 
1507     void     AutoSizeColumn( int col, bool setAsMin = TRUE );
 
1508     void     AutoSizeRow( int row, bool setAsMin = TRUE );
 
1511     // auto size all columns (very ineffective for big grids!)
 
1512     void     AutoSizeColumns( bool setAsMin = TRUE );
 
1513     void     AutoSizeRows( bool setAsMin = TRUE );
 
1515     // auto size the grid, that is make the columns/rows of the "right" size
 
1516     // and also set the grid size to just fit its contents
 
1519     // column won't be resized to be lesser width - this must be called during
 
1520     // the grid creation because it won't resize the column if it's already
 
1521     // narrower than the minimal width
 
1522     void     SetColMinimalWidth( int col, int width );
 
1523     void     SetRowMinimalHeight( int row, int width );
 
1525     void     SetDefaultCellBackgroundColour( const wxColour& );
 
1526     void     SetCellBackgroundColour( int row, int col, const wxColour& );
 
1527     void     SetDefaultCellTextColour( const wxColour& );
 
1529     void     SetCellTextColour( int row, int col, const wxColour& );
 
1530     void     SetDefaultCellFont( const wxFont& );
 
1531     void     SetCellFont( int row, int col, const wxFont& );
 
1532     void     SetDefaultCellAlignment( int horiz, int vert );
 
1533     void     SetCellAlignment( int row, int col, int horiz, int vert );
 
1535     // takes ownership of the pointer
 
1536     void SetDefaultRenderer(wxGridCellRenderer *renderer);
 
1537     void SetCellRenderer(int row, int col, wxGridCellRenderer *renderer);
 
1538     wxGridCellRenderer *GetDefaultRenderer() const;
 
1539     wxGridCellRenderer* GetCellRenderer(int row, int col);
 
1541     // takes ownership of the pointer
 
1542     void SetDefaultEditor(wxGridCellEditor *editor);
 
1543     void SetCellEditor(int row, int col, wxGridCellEditor *editor);
 
1544     wxGridCellEditor *GetDefaultEditor() const;
 
1545     wxGridCellEditor* GetCellEditor(int row, int col);
 
1549     // ------ cell value accessors
 
1551     wxString GetCellValue( int row, int col );
 
1552     // TODO: ??? wxString GetCellValue( const wxGridCellCoords& coords )
 
1554     void SetCellValue( int row, int col, const wxString& s );
 
1555     // TODO: ??? void SetCellValue( const wxGridCellCoords& coords, const wxString& s )
 
1557     // returns TRUE if the cell can't be edited
 
1558     bool IsReadOnly(int row, int col) const;
 
1560     // make the cell editable/readonly
 
1561     void SetReadOnly(int row, int col, bool isReadOnly = TRUE);
 
1563     // ------ selections of blocks of cells
 
1565     void SelectRow( int row, bool addToSelected = FALSE );
 
1566     void SelectCol( int col, bool addToSelected = FALSE );
 
1568     void SelectBlock( int topRow, int leftCol, int bottomRow, int rightCol,
 
1569                       bool addToSelected = FALSE );
 
1570     // TODO: ??? void SelectBlock( const wxGridCellCoords& topLeft,
 
1571     // TODO: ???                   const wxGridCellCoords& bottomRight )
 
1575     void ClearSelection();
 
1576     bool IsInSelection( int row, int col );
 
1577     // TODO: ??? bool IsInSelection( const wxGridCellCoords& coords )
 
1580     // This function returns the rectangle that encloses the block of cells
 
1581     // limited by TopLeft and BottomRight cell in device coords and clipped
 
1582     //  to the client size of the grid window.
 
1584     wxRect BlockToDeviceRect( const wxGridCellCoords & topLeft,
 
1585                               const wxGridCellCoords & bottomRight );
 
1588     // Access or update the selection fore/back colours
 
1589     wxColour GetSelectionBackground() const;
 
1590     wxColour GetSelectionForeground() const;
 
1592     void SetSelectionBackground(const wxColour& c);
 
1593     void SetSelectionForeground(const wxColour& c);
 
1596     // Methods for a registry for mapping data types to Renderers/Editors
 
1597     void RegisterDataType(const wxString& typeName,
 
1598                           wxGridCellRenderer* renderer,
 
1599                           wxGridCellEditor* editor);
 
1600     wxGridCellEditor* GetDefaultEditorForCell(int row, int col) const;
 
1601     // TODO: ??? wxGridCellEditor* GetDefaultEditorForCell(const wxGridCellCoords& c) const
 
1602     wxGridCellRenderer* GetDefaultRendererForCell(int row, int col) const;
 
1603     wxGridCellEditor* GetDefaultEditorForType(const wxString& typeName) const;
 
1604     wxGridCellRenderer* GetDefaultRendererForType(const wxString& typeName) const;
 
1606     // grid may occupy more space than needed for its rows/columns, this
 
1607     // function allows to set how big this extra space is
 
1608     void SetMargins(int extraWidth, int extraHeight);
 
1612 //---------------------------------------------------------------------------
 
1613 //---------------------------------------------------------------------------
 
1614 // Grid events and stuff
 
1618 class wxGridEvent : public wxNotifyEvent
 
1621     wxGridEvent(int id, wxEventType type, wxGrid* obj,
 
1622                 int row=-1, int col=-1, int x=-1, int y=-1, bool sel = TRUE,
 
1623                 bool control=FALSE, bool shift=FALSE, bool alt=FALSE, bool meta=FALSE);
 
1625     virtual int GetRow();
 
1626     virtual int GetCol();
 
1627     wxPoint     GetPosition();
 
1637 class  wxGridSizeEvent : public wxNotifyEvent
 
1640     wxGridSizeEvent(int id, wxEventType type, wxGrid* obj,
 
1641                 int rowOrCol=-1, int x=-1, int y=-1,
 
1642                 bool control=FALSE, bool shift=FALSE, bool alt=FALSE, bool meta=FALSE);
 
1645     wxPoint     GetPosition();
 
1654 class wxGridRangeSelectEvent : public wxNotifyEvent
 
1657     wxGridRangeSelectEvent(int id, wxEventType type, wxGrid* obj,
 
1658                            const wxGridCellCoords& topLeft,
 
1659                            const wxGridCellCoords& bottomRight,
 
1661                            bool control=FALSE, bool shift=FALSE,
 
1662                            bool alt=FALSE, bool meta=FALSE);
 
1664     wxGridCellCoords GetTopLeftCoords();
 
1665     wxGridCellCoords GetBottomRightCoords();
 
1678     wxEVT_GRID_CELL_LEFT_CLICK,
 
1679     wxEVT_GRID_CELL_RIGHT_CLICK,
 
1680     wxEVT_GRID_CELL_LEFT_DCLICK,
 
1681     wxEVT_GRID_CELL_RIGHT_DCLICK,
 
1682     wxEVT_GRID_LABEL_LEFT_CLICK,
 
1683     wxEVT_GRID_LABEL_RIGHT_CLICK,
 
1684     wxEVT_GRID_LABEL_LEFT_DCLICK,
 
1685     wxEVT_GRID_LABEL_RIGHT_DCLICK,
 
1686     wxEVT_GRID_ROW_SIZE,
 
1687     wxEVT_GRID_COL_SIZE,
 
1688     wxEVT_GRID_RANGE_SELECT,
 
1689     wxEVT_GRID_CELL_CHANGE,
 
1690     wxEVT_GRID_SELECT_CELL,
 
1691     wxEVT_GRID_EDITOR_SHOWN,
 
1692     wxEVT_GRID_EDITOR_HIDDEN,
 
1697 %pragma(python) code = "
 
1698 def EVT_GRID_CELL_LEFT_CLICK(win, fn):
 
1699     win.Connect(-1, -1, wxEVT_GRID_CELL_LEFT_CLICK, fn)
 
1701 def EVT_GRID_CELL_RIGHT_CLICK(win, fn):
 
1702     win.Connect(-1, -1, wxEVT_GRID_CELL_RIGHT_CLICK, fn)
 
1704 def EVT_GRID_CELL_LEFT_DCLICK(win, fn):
 
1705     win.Connect(-1, -1, wxEVT_GRID_CELL_LEFT_DCLICK, fn)
 
1707 def EVT_GRID_CELL_RIGHT_DCLICK(win, fn):
 
1708     win.Connect(-1, -1, wxEVT_GRID_CELL_RIGHT_DCLICK, fn)
 
1710 def EVT_GRID_LABEL_LEFT_CLICK(win, fn):
 
1711     win.Connect(-1, -1, wxEVT_GRID_LABEL_LEFT_CLICK, fn)
 
1713 def EVT_GRID_LABEL_RIGHT_CLICK(win, fn):
 
1714     win.Connect(-1, -1, wxEVT_GRID_LABEL_RIGHT_CLICK, fn)
 
1716 def EVT_GRID_LABEL_LEFT_DCLICK(win, fn):
 
1717     win.Connect(-1, -1, wxEVT_GRID_LABEL_LEFT_DCLICK, fn)
 
1719 def EVT_GRID_LABEL_RIGHT_DCLICK(win, fn):
 
1720     win.Connect(-1, -1, wxEVT_GRID_LABEL_RIGHT_DCLICK, fn)
 
1722 def EVT_GRID_ROW_SIZE(win, fn):
 
1723     win.Connect(-1, -1, wxEVT_GRID_ROW_SIZE, fn)
 
1725 def EVT_GRID_COL_SIZE(win, fn):
 
1726     win.Connect(-1, -1, wxEVT_GRID_COL_SIZE, fn)
 
1728 def EVT_GRID_RANGE_SELECT(win, fn):
 
1729     win.Connect(-1, -1, wxEVT_GRID_RANGE_SELECT, fn)
 
1731 def EVT_GRID_CELL_CHANGE(win, fn):
 
1732     win.Connect(-1, -1, wxEVT_GRID_CELL_CHANGE, fn)
 
1734 def EVT_GRID_SELECT_CELL(win, fn):
 
1735     win.Connect(-1, -1, wxEVT_GRID_SELECT_CELL, fn)
 
1737 def EVT_GRID_EDITOR_SHOWN(win, fn):
 
1738     win.Connect(-1, -1, wxEVT_GRID_EDITOR_SHOWN, fn)
 
1740 def EVT_GRID_EDITOR_HIDDEN(win, fn):
 
1741     win.Connect(-1, -1, wxEVT_GRID_EDITOR_HIDDEN, fn)
 
1745 //---------------------------------------------------------------------------
 
1747 %pragma(python) include="_gridextras.py";
 
1749 //---------------------------------------------------------------------------