wxPython/src/grid.i

   1 ////////////////////////////////////////////////////////////////////////////
   2 // Name:        grid.i
   3 // Purpose:     SWIG definitions for the new wxGrid and related classes
   4 //
   5 // Author:      Robin Dunn
   6 //
   7 // Created:     17-March-2000
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 2000 by Total Control Software
  10 // Licence:     wxWindows license
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 %define DOCSTRING
  14 "Classes for implementing a spreadsheet-like control."
  15 %enddef
  16
  17 %module(package="wx", docstring=DOCSTRING) grid
  18
  19
  20 %{
  21 #include "wx/wxPython/wxPython.h"
  22 #include "wx/wxPython/pyclasses.h"
  23 #include "wx/wxPython/printfw.h"
  24
  25 #include <wx/grid.h>
  26 #include <wx/generic/gridctrl.h>
  27
  28 %}
  29
  30
  31 //---------------------------------------------------------------------------
  32
  33 %import windows.i
  34 %pythoncode { wx = _core }
  35 %pythoncode { __docfilter__ = wx.__DocFilter(globals()) }
  36
  37
  38 %include _grid_rename.i
  39
  40 MAKE_CONST_WXSTRING_NOSWIG(EmptyString);
  41 MAKE_CONST_WXSTRING_NOSWIG(PanelNameStr);
  42 MAKE_CONST_WXSTRING2(DateTimeFormatStr, wxT("%c"));
  43
  44
  45 //---------------------------------------------------------------------------
  46 // OOR related typemaps and helper functions
  47
  48 %typemap(out) wxGridCellRenderer*     { $result = wxPyMake_wxGridCellRenderer($1, $owner); }
  49 %typemap(out) wxGridCellEditor*       { $result = wxPyMake_wxGridCellEditor($1, $owner); }
  50 %typemap(out) wxGridCellAttr*         { $result = wxPyMake_wxGridCellAttr($1, $owner); }
  51 %typemap(out) wxGridCellAttrProvider* { $result = wxPyMake_wxGridCellAttrProvider($1, $owner); }
  52 %typemap(out) wxGridTableBase*        { $result = wxPyMake_wxGridTableBase($1, $owner); }
  53
  54
  55 %{
  56
  57 #define wxPyMake_TEMPLATE(TYPE) \
  58 PyObject* wxPyMake_##TYPE(TYPE* source, bool setThisOwn) { \
  59     PyObject* target = NULL; \
  60     if (source) { \
  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(); \
  64         if (data) { \
  65             target = data->m_obj; \
  66             if (target) \
  67                 Py_INCREF(target); \
  68         } \
  69         /* Otherwise make a new wrapper for it the old fashioned way and \
  70            give it the OOR treatment */ \
  71         if (! target) { \
  72             target = wxPyConstructObject(source, wxT(#TYPE), setThisOwn); \
  73             if (target) \
  74                 source->SetClientObject(new wxPyOORClientData(target)); \
  75         } \
  76     } else {  /* source was NULL so return None. */ \
  77         Py_INCREF(Py_None); target = Py_None; \
  78     } \
  79     return target; \
  80 } \
  81
  82
  83 wxPyMake_TEMPLATE(wxGridCellRenderer)
  84 wxPyMake_TEMPLATE(wxGridCellEditor)
  85 wxPyMake_TEMPLATE(wxGridCellAttr)
  86 wxPyMake_TEMPLATE(wxGridCellAttrProvider)
  87 wxPyMake_TEMPLATE(wxGridTableBase)
  88
  89 %}
  90
  91 //---------------------------------------------------------------------------
  92 // Macros, similar to what's in helpers.h, to aid in the creation of
  93 // virtual methods that are able to make callbacks to Python.  Many of these
  94 // are specific to wxGrid and so are kept here to reduce the mess in helpers.h
  95 // a bit.
  96
  97
  98 %{
  99 #define PYCALLBACK_GCA_INTINTKIND(PCLASS, CBNAME)                               \
 100     wxGridCellAttr* CBNAME(int a, int b, wxGridCellAttr::wxAttrKind c) {        \
 101         wxGridCellAttr* rval = NULL;                                            \
 102         bool found;                                                             \
 103         bool blocked = wxPyBeginBlockThreads();                            \
 104         if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) {                \
 105             PyObject* ro;                                                       \
 106             wxGridCellAttr* ptr;                                                \
 107             ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(iii)", a, b, c)); \
 108             if (ro) {                                                           \
 109                 if (wxPyConvertSwigPtr(ro, (void **)&ptr, wxT("wxGridCellAttr")))    \
 110                     rval = ptr;                                                 \
 111                 Py_DECREF(ro);                                                  \
 112             }                                                                   \
 113         }                                                                       \
 114         wxPyEndBlockThreads(blocked);                                             \
 115         if (! found)                                                            \
 116             rval = PCLASS::CBNAME(a, b, c);                                     \
 117         return rval;                                                            \
 118     }                                                                           \
 119     wxGridCellAttr *base_##CBNAME(int a, int b, wxGridCellAttr::wxAttrKind c) { \
 120         return PCLASS::CBNAME(a, b, c);                                         \
 121     }
 122
 123
 124
 125 #define PYCALLBACK__GCAINTINT(PCLASS, CBNAME)                                   \
 126     void CBNAME(wxGridCellAttr *attr, int a, int b) {                           \
 127         bool blocked = wxPyBeginBlockThreads();                                                \
 128         bool found;                                                             \
 129         if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) {                \
 130             PyObject* obj = wxPyMake_wxGridCellAttr(attr,false);                \
 131             wxPyCBH_callCallback(m_myInst, Py_BuildValue("(Oii)", obj, a, b));  \
 132             Py_DECREF(obj);                                                     \
 133         }                                                                       \
 134         wxPyEndBlockThreads(blocked);                                                  \
 135         if (! found)                                                            \
 136             PCLASS::CBNAME(attr, a, b);                                         \
 137     }                                                                           \
 138     void base_##CBNAME(wxGridCellAttr *attr, int a, int b) {                    \
 139         PCLASS::CBNAME(attr, a, b);                                             \
 140     }
 141
 142
 143
 144 #define PYCALLBACK__GCAINT(PCLASS, CBNAME)                                      \
 145     void CBNAME(wxGridCellAttr *attr, int val) {                                \
 146         bool blocked = wxPyBeginBlockThreads();                                                \
 147         bool found;                                                             \
 148         if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) {                \
 149             PyObject* obj = wxPyMake_wxGridCellAttr(attr,false);                \
 150             wxPyCBH_callCallback(m_myInst, Py_BuildValue("(Oi)", obj, val));    \
 151             Py_DECREF(obj);                                                     \
 152         }                                                                       \
 153         wxPyEndBlockThreads(blocked);                                             \
 154         if (! found)                                                            \
 155             PCLASS::CBNAME(attr, val);                                          \
 156     }                                                                           \
 157     void base_##CBNAME(wxGridCellAttr *attr, int val) {                         \
 158         PCLASS::CBNAME(attr, val);                                              \
 159     }
 160
 161
 162
 163 #define PYCALLBACK_INT__pure(CBNAME)                                            \
 164     int  CBNAME() {                                                             \
 165         bool blocked = wxPyBeginBlockThreads();                            \
 166         int rval = 0;                                                           \
 167         if (wxPyCBH_findCallback(m_myInst, #CBNAME))                            \
 168             rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("()"));         \
 169         wxPyEndBlockThreads(blocked);                                             \
 170         return rval;                                                            \
 171     }
 172
 173
 174
 175 #define PYCALLBACK_BOOL_INTINT_pure(CBNAME)                                     \
 176     bool CBNAME(int a, int b) {                                                 \
 177         bool blocked = wxPyBeginBlockThreads();                            \
 178         bool rval = 0;                                                          \
 179         if (wxPyCBH_findCallback(m_myInst, #CBNAME))                            \
 180             rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(ii)",a,b));   \
 181         wxPyEndBlockThreads(blocked);                                             \
 182         return rval;                                                            \
 183     }
 184
 185
 186 #define PYCALLBACK_STRING_INTINT_pure(CBNAME)                                   \
 187     wxString CBNAME(int a, int b) {                                             \
 188         bool blocked = wxPyBeginBlockThreads();                                                \
 189         wxString rval;                                                          \
 190         if (wxPyCBH_findCallback(m_myInst, #CBNAME)) {                          \
 191             PyObject* ro;                                                       \
 192             ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(ii)",a,b));  \
 193             if (ro) {                                                           \
 194                 rval = Py2wxString(ro);                                         \
 195                 Py_DECREF(ro);                                                  \
 196             }                                                                   \
 197         }                                                                       \
 198         wxPyEndBlockThreads(blocked);                                                  \
 199         return rval;                                                            \
 200     }
 201
 202
 203 #define PYCALLBACK__INTINTSTRING_pure(CBNAME)                                   \
 204     void CBNAME(int a, int b, const wxString& c) {                              \
 205         bool blocked = wxPyBeginBlockThreads();                                                \
 206         if (wxPyCBH_findCallback(m_myInst, #CBNAME)) {                          \
 207             PyObject* s = wx2PyString(c);                                       \
 208             rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iiO)",a,b,s));\
 209             Py_DECREF(s);                                                       \
 210         }                                                                       \
 211         wxPyEndBlockThreads(blocked);                                                  \
 212     }
 213
 214
 215 #define PYCALLBACK_STRING_INTINT(PCLASS, CBNAME)                                \
 216     wxString CBNAME(int a, int b) {                                             \
 217         bool found;                                                             \
 218         bool blocked = wxPyBeginBlockThreads();                                                \
 219         wxString rval;                                                          \
 220         if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) {                \
 221             PyObject* ro;                                                       \
 222             ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(ii)",a,b));  \
 223             if (ro) {                                                           \
 224                 rval = Py2wxString(ro);                                         \
 225                 Py_DECREF(ro);                                                  \
 226             }                                                                   \
 227         }                                                                       \
 228         wxPyEndBlockThreads(blocked);                                                  \
 229         if (! found)                                                            \
 230             rval = PCLASS::CBNAME(a, b);                                        \
 231         return rval;                                                            \
 232     }                                                                           \
 233     wxString base_##CBNAME(int a, int b) {                                      \
 234         return PCLASS::CBNAME(a, b);                                            \
 235     }
 236
 237
 238 #define PYCALLBACK_BOOL_INTINTSTRING(PCLASS, CBNAME)                            \
 239     bool CBNAME(int a, int b, const wxString& c)  {                             \
 240         bool rval = 0;                                                          \
 241         bool found;                                                             \
 242         bool blocked = wxPyBeginBlockThreads();                                                \
 243         if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) {                \
 244             PyObject* s = wx2PyString(c);                                       \
 245             rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iiO)",a,b,s));\
 246             Py_DECREF(s);                                                       \
 247         }                                                                       \
 248         wxPyEndBlockThreads(blocked);                                                  \
 249         if (! found)                                                            \
 250             rval = PCLASS::CBNAME(a,b,c);                                       \
 251         return rval;                                                            \
 252     }                                                                           \
 253     bool base_##CBNAME(int a, int b, const wxString& c) {                       \
 254         return PCLASS::CBNAME(a,b,c);                                           \
 255     }
 256
 257
 258
 259
 260 #define PYCALLBACK_LONG_INTINT(PCLASS, CBNAME)                                  \
 261     long CBNAME(int a, int b)  {                                                \
 262         long rval;                                                              \
 263         bool found;                                                             \
 264         bool blocked = wxPyBeginBlockThreads();                            \
 265         if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME)))                  \
 266             rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(ii)", a,b));  \
 267         wxPyEndBlockThreads(blocked);                                             \
 268         if (! found)                                                            \
 269             rval = PCLASS::CBNAME(a,b);                                         \
 270         return rval;                                                            \
 271     }                                                                           \
 272     long base_##CBNAME(int a, int b) {                                          \
 273         return PCLASS::CBNAME(a,b);                                             \
 274     }
 275
 276
 277
 278 #define PYCALLBACK_BOOL_INTINT(PCLASS, CBNAME)                                  \
 279     bool CBNAME(int a, int b)  {                                                \
 280         bool rval = 0;                                                          \
 281         bool found;                                                             \
 282         bool blocked = wxPyBeginBlockThreads();                            \
 283         if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME)))                  \
 284             rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(ii)", a,b));  \
 285         wxPyEndBlockThreads(blocked);                                             \
 286         if (! found)                                                            \
 287             rval = PCLASS::CBNAME(a,b);                                         \
 288         return rval;                                                            \
 289     }                                                                           \
 290     bool base_##CBNAME(int a, int b) {                                          \
 291         return PCLASS::CBNAME(a,b);                                             \
 292     }
 293
 294
 295
 296 #define PYCALLBACK_DOUBLE_INTINT(PCLASS, CBNAME)                                \
 297     double CBNAME(int a, int b) {                                               \
 298         bool found;                                                             \
 299         bool blocked = wxPyBeginBlockThreads();                            \
 300         double rval;                                                            \
 301         if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) {                \
 302             PyObject* ro;                                                       \
 303             ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(ii)",a,b));  \
 304             if (ro) {                                                           \
 305                 PyObject* str = PyObject_Str(ro);                               \
 306                 rval = PyFloat_AsDouble(str);                                   \
 307                 Py_DECREF(ro);   Py_DECREF(str);                                \
 308             }                                                                   \
 309         }                                                                       \
 310         wxPyEndBlockThreads(blocked);                                                  \
 311         if (! found)                                                            \
 312             rval = PCLASS::CBNAME(a, b);                                        \
 313         return rval;                                                            \
 314     }                                                                           \
 315     double base_##CBNAME(int a, int b) {                                        \
 316         return PCLASS::CBNAME(a, b);                                            \
 317     }
 318
 319
 320
 321 #define PYCALLBACK__(PCLASS, CBNAME)                                            \
 322     void CBNAME()  {                                                            \
 323         bool found;                                                             \
 324         bool blocked = wxPyBeginBlockThreads();                                                \
 325         if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME)))                  \
 326             wxPyCBH_callCallback(m_myInst, Py_BuildValue("()"));                \
 327         wxPyEndBlockThreads(blocked);                                                  \
 328         if (! found)                                                            \
 329             PCLASS::CBNAME();                                                   \
 330     }                                                                           \
 331     void base_##CBNAME() {                                                      \
 332         PCLASS::CBNAME();                                                       \
 333     }
 334
 335
 336
 337
 338 #define PYCALLBACK_BOOL_SIZETSIZET(PCLASS, CBNAME)                              \
 339     bool CBNAME(size_t a, size_t b)  {                                          \
 340         bool rval = 0;                                                          \
 341         bool found;                                                             \
 342         bool blocked = wxPyBeginBlockThreads();                                                \
 343         if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME)))                  \
 344             rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(ii)", a,b));  \
 345         wxPyEndBlockThreads(blocked);                                                  \
 346         if (! found)                                                            \
 347             rval = PCLASS::CBNAME(a,b);                                         \
 348         return rval;                                                            \
 349     }                                                                           \
 350     bool base_##CBNAME(size_t a, size_t b) {                                    \
 351         return PCLASS::CBNAME(a,b);                                             \
 352     }
 353
 354
 355
 356 #define PYCALLBACK_BOOL_SIZET(PCLASS, CBNAME)                                   \
 357     bool CBNAME(size_t a)  {                                                    \
 358         bool rval = 0;                                                          \
 359         bool found;                                                             \
 360         bool blocked = wxPyBeginBlockThreads();                                                \
 361         if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME)))                  \
 362             rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(i)", a));     \
 363         wxPyEndBlockThreads(blocked);                                                  \
 364         if (! found)                                                            \
 365             rval = PCLASS::CBNAME(a);                                           \
 366         return rval;                                                            \
 367     }                                                                           \
 368     bool base_##CBNAME(size_t a) {                                              \
 369         return PCLASS::CBNAME(a);                                               \
 370     }
 371
 372
 373 #define PYCALLBACK_STRING_INT(PCLASS, CBNAME)                                   \
 374     wxString CBNAME(int a) {                                                    \
 375         bool found;                                                             \
 376         bool blocked = wxPyBeginBlockThreads();                                                \
 377         wxString rval;                                                          \
 378         if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) {                \
 379             PyObject* ro;                                                       \
 380             ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(i)",a));     \
 381             if (ro) {                                                           \
 382                 rval = Py2wxString(ro);                                         \
 383                 Py_DECREF(ro);                                                  \
 384             }                                                                   \
 385         }                                                                       \
 386         wxPyEndBlockThreads(blocked);                                                  \
 387         if (! found)                                                            \
 388             rval = PCLASS::CBNAME(a);                                           \
 389         return rval;                                                            \
 390     }                                                                           \
 391     wxString base_##CBNAME(int a) {                                             \
 392         return PCLASS::CBNAME(a);                                               \
 393     }
 394
 395
 396 #define PYCALLBACK__INTSTRING(PCLASS, CBNAME)                                   \
 397     void CBNAME(int a, const wxString& c)  {                                    \
 398         bool found;                                                             \
 399         bool blocked = wxPyBeginBlockThreads();                                                \
 400         if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) {                \
 401             PyObject* s = wx2PyString(c);                                       \
 402             wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iO)",a,s));          \
 403             Py_DECREF(s);                                                       \
 404         }                                                                       \
 405         wxPyEndBlockThreads(blocked);                                                  \
 406         if (! found)                                                            \
 407             PCLASS::CBNAME(a,c);                                                \
 408     }                                                                           \
 409     void base_##CBNAME(int a, const wxString& c) {                              \
 410         PCLASS::CBNAME(a,c);                                                    \
 411     }
 412
 413
 414
 415
 416 #define PYCALLBACK_BOOL_(PCLASS, CBNAME)                                        \
 417     bool CBNAME()  {                                                            \
 418         bool rval = 0;                                                          \
 419         bool found;                                                             \
 420         bool blocked = wxPyBeginBlockThreads();                                                \
 421         if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME)))                  \
 422             rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("()"));         \
 423         wxPyEndBlockThreads(blocked);                                                  \
 424         if (! found)                                                            \
 425             rval = PCLASS::CBNAME();                                            \
 426         return rval;                                                            \
 427     }                                                                           \
 428     bool base_##CBNAME() {                                                      \
 429         return PCLASS::CBNAME();                                                \
 430     }
 431
 432
 433
 434 #define PYCALLBACK__SIZETINT(PCLASS, CBNAME)                                    \
 435     void CBNAME(size_t a, int b)  {                                             \
 436         bool found;                                                             \
 437         bool blocked = wxPyBeginBlockThreads();                                                \
 438         if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME)))                  \
 439             wxPyCBH_callCallback(m_myInst, Py_BuildValue("(ii)", a,b));         \
 440         wxPyEndBlockThreads(blocked);                                                  \
 441         if (! found)                                                            \
 442             PCLASS::CBNAME(a,b);                                                \
 443     }                                                                           \
 444     void base_##CBNAME(size_t a, int b) {                                       \
 445         PCLASS::CBNAME(a,b);                                                    \
 446     }
 447
 448
 449
 450
 451 #define PYCALLBACK__INTINTLONG(PCLASS, CBNAME)                                  \
 452     void CBNAME(int a, int b, long c)  {                                        \
 453         bool found;                                                             \
 454         bool blocked = wxPyBeginBlockThreads();                                                \
 455         if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME)))                  \
 456             wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iii)", a,b,c));      \
 457         wxPyEndBlockThreads(blocked);                                                  \
 458         if (! found)                                                            \
 459             PCLASS::CBNAME(a,b,c);                                              \
 460     }                                                                           \
 461     void base_##CBNAME(int a, int b, long c) {                                  \
 462         PCLASS::CBNAME(a,b,c);                                                  \
 463     }
 464
 465
 466
 467
 468 #define PYCALLBACK__INTINTDOUBLE(PCLASS, CBNAME)                                \
 469     void CBNAME(int a, int b, double c)  {                                      \
 470         bool found;                                                             \
 471         bool blocked = wxPyBeginBlockThreads();                                                \
 472         if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME)))                  \
 473             wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iif)", a,b,c));      \
 474         wxPyEndBlockThreads(blocked);                                                  \
 475         if (! found)                                                            \
 476             PCLASS::CBNAME(a,b,c);                                              \
 477     }                                                                           \
 478     void base_##CBNAME(int a, int b, double c) {                                \
 479         PCLASS::CBNAME(a,b,c);                                                  \
 480     }
 481
 482
 483
 484 #define PYCALLBACK__INTINTBOOL(PCLASS, CBNAME)                                  \
 485     void CBNAME(int a, int b, bool c)  {                                        \
 486         bool found;                                                             \
 487         bool blocked = wxPyBeginBlockThreads();                                                \
 488         if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME)))                  \
 489             wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iii)", a,b,c));      \
 490         wxPyEndBlockThreads(blocked);                                                  \
 491         if (! found)                                                            \
 492             PCLASS::CBNAME(a,b,c);                                              \
 493     }                                                                           \
 494     void base_##CBNAME(int a, int b, bool c) {                                  \
 495         PCLASS::CBNAME(a,b,c);                                                  \
 496     }
 497
 498
 499
 500
 501 %}
 502
 503 //---------------------------------------------------------------------------
 504
 505 class wxGridCellCoords;
 506 class wxGridCellAttr;
 507
 508 #define wxGRID_VALUE_STRING     "string"
 509 #define wxGRID_VALUE_BOOL       "bool"
 510 #define wxGRID_VALUE_NUMBER     "long"
 511 #define wxGRID_VALUE_FLOAT      "double"
 512 #define wxGRID_VALUE_CHOICE     "choice"
 513 #define wxGRID_VALUE_TEXT       "string"
 514 #define wxGRID_VALUE_LONG       "long"
 515 #define wxGRID_VALUE_CHOICEINT  "choiceint"
 516 #define wxGRID_VALUE_DATETIME   "datetime"
 517
 518
 519 %immutable;
 520 const wxGridCellCoords wxGridNoCellCoords;
 521 const wxRect           wxGridNoCellRect;
 522 %mutable;
 523
 524
 525 %{
 526 #define wxGRID_DEFAULT_NUMBER_ROWS        WXGRID_DEFAULT_NUMBER_ROWS
 527 #define wxGRID_DEFAULT_NUMBER_COLS        WXGRID_DEFAULT_NUMBER_COLS
 528 #define wxGRID_DEFAULT_ROW_HEIGHT         WXGRID_DEFAULT_ROW_HEIGHT
 529 #define wxGRID_DEFAULT_COL_WIDTH          WXGRID_DEFAULT_COL_WIDTH
 530 #define wxGRID_DEFAULT_COL_LABEL_HEIGHT   WXGRID_DEFAULT_COL_LABEL_HEIGHT
 531 #define wxGRID_DEFAULT_ROW_LABEL_WIDTH    WXGRID_DEFAULT_ROW_LABEL_WIDTH
 532 #define wxGRID_LABEL_EDGE_ZONE            WXGRID_LABEL_EDGE_ZONE
 533 #define wxGRID_MIN_ROW_HEIGHT             WXGRID_MIN_ROW_HEIGHT
 534 #define wxGRID_MIN_COL_WIDTH              WXGRID_MIN_COL_WIDTH
 535 #define wxGRID_DEFAULT_SCROLLBAR_WIDTH    WXGRID_DEFAULT_SCROLLBAR_WIDTH
 536 %}
 537
 538 enum {
 539     wxGRID_DEFAULT_NUMBER_ROWS,
 540     wxGRID_DEFAULT_NUMBER_COLS,
 541     wxGRID_DEFAULT_ROW_HEIGHT,
 542     wxGRID_DEFAULT_COL_WIDTH,
 543     wxGRID_DEFAULT_COL_LABEL_HEIGHT,
 544     wxGRID_DEFAULT_ROW_LABEL_WIDTH,
 545     wxGRID_LABEL_EDGE_ZONE,
 546     wxGRID_MIN_ROW_HEIGHT,
 547     wxGRID_MIN_COL_WIDTH,
 548     wxGRID_DEFAULT_SCROLLBAR_WIDTH
 549 };
 550
 551
 552 //---------------------------------------------------------------------------
 553 // wxGridCellRenderer is an ABC, and several derived classes are available.
 554 // Classes implemented in Python should be derived from wxPyGridCellRenderer.
 555
 556
 557 class wxGridCellRenderer
 558 {
 559 public:
 560     %extend {
 561         void _setOORInfo(PyObject* _self) {
 562             if (!self->GetClientObject())
 563                 self->SetClientObject(new wxPyOORClientData(_self));
 564         }
 565     }
 566
 567     void SetParameters(const wxString& params);
 568     void IncRef();
 569     void DecRef();
 570
 571     virtual void Draw(wxGrid& grid,
 572                       wxGridCellAttr& attr,
 573                       wxDC& dc,
 574                       const wxRect& rect,
 575                       int row, int col,
 576                       bool isSelected);
 577     virtual wxSize GetBestSize(wxGrid& grid,
 578                                wxGridCellAttr& attr,
 579                                wxDC& dc,
 580                                int row, int col);
 581     virtual wxGridCellRenderer *Clone() const;
 582 };
 583
 584
 585 // The C++ version of wxPyGridCellRenderer
 586 %{
 587 class wxPyGridCellRenderer : public wxGridCellRenderer
 588 {
 589 public:
 590     wxPyGridCellRenderer() : wxGridCellRenderer() {};
 591
 592     // Implement Python callback aware virtual methods
 593     void Draw(wxGrid& grid, wxGridCellAttr& attr,
 594               wxDC& dc, const wxRect& rect,
 595               int row, int col, bool isSelected) {
 596         bool blocked = wxPyBeginBlockThreads();
 597         if (wxPyCBH_findCallback(m_myInst, "Draw")) {
 598             PyObject* go = wxPyMake_wxObject(&grid,false);
 599             PyObject* dco = wxPyMake_wxObject(&dc,false);
 600             PyObject* ao = wxPyMake_wxGridCellAttr(&attr,false);
 601             PyObject* ro = wxPyConstructObject((void*)&rect, wxT("wxRect"), 0);
 602
 603             wxPyCBH_callCallback(m_myInst, Py_BuildValue("(OOOOiii)", go, ao, dco, ro,
 604                                                          row, col, isSelected));
 605             Py_DECREF(go);
 606             Py_DECREF(ao);
 607             Py_DECREF(dco);
 608             Py_DECREF(ro);
 609         }
 610         wxPyEndBlockThreads(blocked);
 611     }
 612
 613     wxSize GetBestSize(wxGrid& grid, wxGridCellAttr& attr, wxDC& dc,
 614                        int row, int col) {
 615         wxSize rval;
 616         bool blocked = wxPyBeginBlockThreads();
 617         if (wxPyCBH_findCallback(m_myInst, "GetBestSize")) {
 618             PyObject* ro;
 619             wxSize*   ptr;
 620             PyObject* go = wxPyMake_wxObject(&grid,false);
 621             PyObject* dco = wxPyMake_wxObject(&dc,false);
 622             PyObject* ao = wxPyMake_wxGridCellAttr(&attr,false);
 623
 624             ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(OOOii)",
 625                                                                  go, ao, dco,
 626                                                                  row, col));
 627             Py_DECREF(go);
 628             Py_DECREF(ao);
 629             Py_DECREF(dco);
 630
 631             if (ro) {
 632                 const char* errmsg = "GetBestSize should return a 2-tuple of integers or a wxSize object.";
 633                 if (wxPyConvertSwigPtr(ro, (void **)&ptr, wxT("wxSize"))) {
 634                     rval = *ptr;
 635                 }
 636                 else if (PySequence_Check(ro) && PyObject_Length(ro) == 2) {
 637                     PyObject* o1 = PySequence_GetItem(ro, 0);
 638                     PyObject* o2 = PySequence_GetItem(ro, 1);
 639                     if (PyNumber_Check(o1) && PyNumber_Check(o2))
 640                         rval = wxSize(PyInt_AsLong(o1), PyInt_AsLong(o2));
 641                     else
 642                         PyErr_SetString(PyExc_TypeError, errmsg);
 643                     Py_DECREF(o1);
 644                     Py_DECREF(o2);
 645                 }
 646                 else {
 647                     PyErr_SetString(PyExc_TypeError, errmsg);
 648                 }
 649                 Py_DECREF(ro);
 650             }
 651         }
 652         wxPyEndBlockThreads(blocked);
 653         return rval;
 654     }
 655
 656
 657     wxGridCellRenderer *Clone() const {
 658         wxGridCellRenderer* rval = NULL;
 659         bool blocked = wxPyBeginBlockThreads();
 660         if (wxPyCBH_findCallback(m_myInst, "Clone")) {
 661             PyObject* ro;
 662             wxGridCellRenderer* ptr;
 663             ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("()"));
 664             if (ro) {
 665                 if (wxPyConvertSwigPtr(ro, (void **)&ptr, wxT("wxGridCellRenderer")))
 666                     rval = ptr;
 667                 Py_DECREF(ro);
 668             }
 669         }
 670         wxPyEndBlockThreads(blocked);
 671         return rval;
 672     }
 673
 674     DEC_PYCALLBACK__STRING(SetParameters);
 675
 676     PYPRIVATE;
 677 };
 678
 679 IMP_PYCALLBACK__STRING( wxPyGridCellRenderer, wxGridCellRenderer, SetParameters);
 680
 681 %}
 682
 683
 684 // Let SWIG know about it so it can create the Python version
 685 class wxPyGridCellRenderer : public wxGridCellRenderer {
 686 public:
 687     %pythonAppend wxPyGridCellRenderer  "self._setCallbackInfo(self, PyGridCellRenderer);self._setOORInfo(self)"
 688
 689     wxPyGridCellRenderer();
 690     void _setCallbackInfo(PyObject* self, PyObject* _class);
 691
 692     void base_SetParameters(const wxString& params);
 693 };
 694
 695 //---------------------------------------------------------------------------
 696 //  Predefined Renderers
 697
 698 class wxGridCellStringRenderer : public wxGridCellRenderer
 699 {
 700 public:
 701     %pythonAppend wxGridCellStringRenderer "self._setOORInfo(self)"
 702     wxGridCellStringRenderer();
 703 };
 704
 705
 706 class  wxGridCellNumberRenderer : public wxGridCellStringRenderer
 707 {
 708 public:
 709     %pythonAppend wxGridCellNumberRenderer "self._setOORInfo(self)"
 710     wxGridCellNumberRenderer();
 711 };
 712
 713
 714 class  wxGridCellFloatRenderer : public wxGridCellStringRenderer
 715 {
 716 public:
 717     %pythonAppend wxGridCellFloatRenderer "self._setOORInfo(self)"
 718     wxGridCellFloatRenderer(int width = -1, int precision = -1);
 719
 720     int GetWidth() const;
 721     void SetWidth(int width);
 722     int GetPrecision() const;
 723     void SetPrecision(int precision);
 724 };
 725
 726
 727 class  wxGridCellBoolRenderer : public wxGridCellRenderer
 728 {
 729 public:
 730     %pythonAppend wxGridCellBoolRenderer "self._setOORInfo(self)"
 731     wxGridCellBoolRenderer();
 732 };
 733
 734
 735 class wxGridCellDateTimeRenderer : public wxGridCellStringRenderer
 736 {
 737 public:
 738     %pythonAppend wxGridCellDateTimeRenderer "self._setOORInfo(self)"
 739     wxGridCellDateTimeRenderer(wxString outformat = wxPyDateTimeFormatStr,
 740                                wxString informat =  wxPyDateTimeFormatStr);
 741 };
 742
 743
 744 class wxGridCellEnumRenderer : public wxGridCellStringRenderer
 745 {
 746 public:
 747     %pythonAppend wxGridCellEnumRenderer "self._setOORInfo(self)"
 748     wxGridCellEnumRenderer( const wxString& choices = wxPyEmptyString );
 749 };
 750
 751
 752 class wxGridCellAutoWrapStringRenderer : public wxGridCellStringRenderer
 753 {
 754 public:
 755     %pythonAppend wxGridCellAutoWrapStringRenderer "self._setOORInfo(self)"
 756     wxGridCellAutoWrapStringRenderer();
 757 };
 758
 759
 760 //---------------------------------------------------------------------------
 761 // wxGridCellEditor is an ABC, and several derived classes are available.
 762 // Classes implemented in Python should be derived from wxPyGridCellEditor.
 763
 764 class  wxGridCellEditor
 765 {
 766 public:
 767     %extend {
 768         void _setOORInfo(PyObject* _self) {
 769             if (!self->GetClientObject())
 770                 self->SetClientObject(new wxPyOORClientData(_self));
 771         }
 772     }
 773
 774     bool IsCreated();
 775     wxControl* GetControl();
 776     void SetControl(wxControl* control);
 777
 778     wxGridCellAttr* GetCellAttr();
 779     void SetCellAttr(wxGridCellAttr* attr);
 780
 781     void SetParameters(const wxString& params);
 782     void IncRef();
 783     void DecRef();
 784
 785     virtual void Create(wxWindow* parent,
 786                         wxWindowID id,
 787                         wxEvtHandler* evtHandler);
 788     virtual void BeginEdit(int row, int col, wxGrid* grid);
 789     virtual bool EndEdit(int row, int col, wxGrid* grid);
 790     virtual void Reset();
 791     virtual wxGridCellEditor *Clone() const;
 792
 793     virtual void SetSize(const wxRect& rect);
 794     virtual void Show(bool show, wxGridCellAttr *attr = NULL);
 795     virtual void PaintBackground(const wxRect& rectCell, wxGridCellAttr *attr);
 796     virtual bool IsAcceptedKey(wxKeyEvent& event);
 797     virtual void StartingKey(wxKeyEvent& event);
 798     virtual void StartingClick();
 799     virtual void HandleReturn(wxKeyEvent& event);
 800     virtual void Destroy();
 801
 802 };
 803
 804
 805 // The C++ version of wxPyGridCellEditor
 806 %{
 807 class wxPyGridCellEditor : public wxGridCellEditor
 808 {
 809 public:
 810     wxPyGridCellEditor() : wxGridCellEditor() {}
 811
 812     void Create(wxWindow* parent, wxWindowID id, wxEvtHandler* evtHandler) {
 813         bool blocked = wxPyBeginBlockThreads();
 814         if (wxPyCBH_findCallback(m_myInst, "Create")) {
 815             PyObject* po = wxPyMake_wxObject(parent,false);
 816             PyObject* eo = wxPyMake_wxObject(evtHandler,false);
 817
 818             wxPyCBH_callCallback(m_myInst, Py_BuildValue("(OiO)", po, id, eo));
 819             Py_DECREF(po);
 820             Py_DECREF(eo);
 821         }
 822         wxPyEndBlockThreads(blocked);
 823     }
 824
 825
 826     void BeginEdit(int row, int col, wxGrid* grid) {
 827         bool blocked = wxPyBeginBlockThreads();
 828         if (wxPyCBH_findCallback(m_myInst, "BeginEdit")) {
 829             PyObject* go = wxPyMake_wxObject(grid,false);
 830             wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iiO)", row, col, go));
 831             Py_DECREF(go);
 832         }
 833         wxPyEndBlockThreads(blocked);
 834     }
 835
 836
 837     bool EndEdit(int row, int col, wxGrid* grid) {
 838         bool rv = false;
 839         bool blocked = wxPyBeginBlockThreads();
 840         if (wxPyCBH_findCallback(m_myInst, "EndEdit")) {
 841             PyObject* go = wxPyMake_wxObject(grid,false);
 842             rv = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iiO)", row, col, go));
 843             Py_DECREF(go);
 844         }
 845         wxPyEndBlockThreads(blocked);
 846         return rv;
 847     }
 848
 849
 850     wxGridCellEditor* Clone() const {
 851         wxGridCellEditor* rval = NULL;
 852         bool blocked = wxPyBeginBlockThreads();
 853         if (wxPyCBH_findCallback(m_myInst, "Clone")) {
 854             PyObject* ro;
 855             wxGridCellEditor* ptr;
 856             ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("()"));
 857             if (ro) {
 858                 if (wxPyConvertSwigPtr(ro, (void **)&ptr, wxT("wxGridCellEditor")))
 859                     rval = ptr;
 860                 Py_DECREF(ro);
 861             }
 862         }
 863         wxPyEndBlockThreads(blocked);
 864         return rval;
 865     }
 866
 867
 868     void Show(bool show, wxGridCellAttr *attr) {
 869         bool found;
 870         bool blocked = wxPyBeginBlockThreads();
 871         if ((found = wxPyCBH_findCallback(m_myInst, "Show"))) {
 872             PyObject* ao = wxPyMake_wxGridCellAttr(attr,false);
 873             wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iO)", show, ao));
 874             Py_DECREF(ao);
 875         }
 876         wxPyEndBlockThreads(blocked);
 877         if (! found)
 878             wxGridCellEditor::Show(show, attr);
 879     }
 880     void base_Show(bool show, wxGridCellAttr *attr) {
 881         wxGridCellEditor::Show(show, attr);
 882     }
 883
 884
 885     void PaintBackground(const wxRect& rectCell, wxGridCellAttr *attr) {
 886         bool found;
 887         bool blocked = wxPyBeginBlockThreads();
 888         if ((found = wxPyCBH_findCallback(m_myInst, "PaintBackground)"))) {
 889             PyObject* ao = wxPyMake_wxGridCellAttr(attr,false);
 890             PyObject* ro = wxPyConstructObject((void*)&rectCell, wxT("wxRect"), 0);
 891
 892             wxPyCBH_callCallback(m_myInst, Py_BuildValue("(OO)", ro, ao));
 893
 894             Py_DECREF(ro);
 895             Py_DECREF(ao);
 896         }
 897         wxPyEndBlockThreads(blocked);
 898         if (! found)
 899             wxGridCellEditor::PaintBackground(rectCell, attr);
 900     }
 901     void base_PaintBackground(const wxRect& rectCell, wxGridCellAttr *attr) {
 902         wxGridCellEditor::PaintBackground(rectCell, attr);
 903     }
 904
 905
 906     DEC_PYCALLBACK___pure(Reset);
 907     DEC_PYCALLBACK__constany(SetSize, wxRect);
 908     DEC_PYCALLBACK_bool_any(IsAcceptedKey, wxKeyEvent);
 909     DEC_PYCALLBACK__any(StartingKey, wxKeyEvent);
 910     DEC_PYCALLBACK__any(HandleReturn, wxKeyEvent);
 911     DEC_PYCALLBACK__(StartingClick);
 912     DEC_PYCALLBACK__(Destroy);
 913     DEC_PYCALLBACK__STRING(SetParameters);
 914     DEC_PYCALLBACK_STRING__constpure(GetValue);
 915
 916     PYPRIVATE;
 917 };
 918
 919
 920 IMP_PYCALLBACK__STRING( wxPyGridCellEditor, wxGridCellEditor, SetParameters);
 921 IMP_PYCALLBACK___pure(wxPyGridCellEditor, wxGridCellEditor, Reset);
 922 IMP_PYCALLBACK__constany(wxPyGridCellEditor, wxGridCellEditor, SetSize, wxRect);
 923 IMP_PYCALLBACK_bool_any(wxPyGridCellEditor, wxGridCellEditor, IsAcceptedKey, wxKeyEvent);
 924 IMP_PYCALLBACK__any(wxPyGridCellEditor, wxGridCellEditor, StartingKey, wxKeyEvent);
 925 IMP_PYCALLBACK__any(wxPyGridCellEditor, wxGridCellEditor, HandleReturn, wxKeyEvent);
 926 IMP_PYCALLBACK__(wxPyGridCellEditor, wxGridCellEditor, StartingClick);
 927 IMP_PYCALLBACK__(wxPyGridCellEditor, wxGridCellEditor, Destroy);
 928 IMP_PYCALLBACK_STRING__constpure(wxPyGridCellEditor, wxGridCellEditor, GetValue);
 929
 930 %}
 931
 932
 933 // Let SWIG know about it so it can create the Python version
 934 class wxPyGridCellEditor : public wxGridCellEditor {
 935 public:
 936     %pythonAppend wxPyGridCellEditor  "self._setCallbackInfo(self, PyGridCellEditor);self._setOORInfo(self)"
 937
 938     wxPyGridCellEditor();
 939     void _setCallbackInfo(PyObject* self, PyObject* _class);
 940
 941     void base_SetSize(const wxRect& rect);
 942     void base_Show(bool show, wxGridCellAttr *attr = NULL);
 943     void base_PaintBackground(const wxRect& rectCell, wxGridCellAttr *attr);
 944     bool base_IsAcceptedKey(wxKeyEvent& event);
 945     void base_StartingKey(wxKeyEvent& event);
 946     void base_StartingClick();
 947     void base_HandleReturn(wxKeyEvent& event);
 948     void base_Destroy();
 949     void base_SetParameters(const wxString& params);
 950 };
 951
 952 //---------------------------------------------------------------------------
 953 //  Predefined Editors
 954
 955 class wxGridCellTextEditor : public wxGridCellEditor
 956 {
 957 public:
 958     %pythonAppend wxGridCellTextEditor  "self._setOORInfo(self)"
 959     wxGridCellTextEditor();
 960     virtual wxString GetValue();
 961 };
 962
 963
 964 class wxGridCellNumberEditor : public wxGridCellTextEditor
 965 {
 966 public:
 967     %pythonAppend wxGridCellNumberEditor  "self._setOORInfo(self)"
 968     wxGridCellNumberEditor(int min = -1, int max = -1);
 969     virtual wxString GetValue();
 970 };
 971
 972
 973 class wxGridCellFloatEditor : public wxGridCellTextEditor
 974 {
 975 public:
 976     %pythonAppend wxGridCellFloatEditor  "self._setOORInfo(self)"
 977     wxGridCellFloatEditor(int width = -1, int precision = -1);
 978     virtual wxString GetValue();
 979 };
 980
 981
 982 class wxGridCellBoolEditor : public wxGridCellEditor
 983 {
 984 public:
 985     %pythonAppend wxGridCellBoolEditor  "self._setOORInfo(self)"
 986     wxGridCellBoolEditor();
 987     virtual wxString GetValue();
 988 };
 989
 990 class wxGridCellChoiceEditor : public wxGridCellEditor
 991 {
 992 public:
 993     %pythonAppend wxGridCellChoiceEditor  "self._setOORInfo(self)"
 994     wxGridCellChoiceEditor(int choices = 0,
 995                            const wxString* choices_array = NULL,
 996                            bool allowOthers = false);
 997     virtual wxString GetValue();
 998 };
 999
1000
1001 class wxGridCellEnumEditor : public wxGridCellChoiceEditor
1002 {
1003 public:
1004     %pythonAppend wxGridCellEnumEditor  "self._setOORInfo(self)"
1005     wxGridCellEnumEditor( const wxString& choices = wxPyEmptyString );
1006     virtual wxString GetValue();
1007 };
1008
1009
1010 class wxGridCellAutoWrapStringEditor : public wxGridCellTextEditor
1011 {
1012 public:
1013     %pythonAppend wxGridCellAutoWrapStringEditor  "self._setOORInfo(self)"
1014     wxGridCellAutoWrapStringEditor();
1015     virtual wxString GetValue();
1016 };
1017
1018
1019
1020 //---------------------------------------------------------------------------
1021
1022
1023 class wxGridCellAttr
1024 {
1025 public:
1026     enum wxAttrKind
1027     {
1028         Any,
1029         Default,
1030         Cell,
1031         Row,
1032         Col,
1033         Merged
1034     };
1035
1036     %extend {
1037         void _setOORInfo(PyObject* _self) {
1038             if (!self->GetClientObject())
1039                 self->SetClientObject(new wxPyOORClientData(_self));
1040         }
1041     }
1042
1043     %pythonAppend wxGridCellAttr  "self._setOORInfo(self)"
1044
1045     wxGridCellAttr(wxGridCellAttr *attrDefault = NULL);
1046
1047     wxGridCellAttr *Clone() const;
1048     void MergeWith(wxGridCellAttr *mergefrom);
1049     void IncRef();
1050     void DecRef();
1051     void SetTextColour(const wxColour& colText);
1052     void SetBackgroundColour(const wxColour& colBack);
1053     void SetFont(const wxFont& font);
1054     void SetAlignment(int hAlign, int vAlign);
1055     void SetSize(int num_rows, int num_cols);
1056     void SetOverflow( bool allow = true );
1057     void SetReadOnly(bool isReadOnly = true);
1058
1059     void SetRenderer(wxGridCellRenderer *renderer);
1060     void SetEditor(wxGridCellEditor* editor);
1061     void SetKind(wxAttrKind kind);
1062
1063     bool HasTextColour() const;
1064     bool HasBackgroundColour() const;
1065     bool HasFont() const;
1066     bool HasAlignment() const;
1067     bool HasRenderer() const;
1068     bool HasEditor() const;
1069     bool HasReadWriteMode() const;
1070     bool HasOverflowMode() const;
1071
1072     wxColour GetTextColour() const;
1073     wxColour GetBackgroundColour() const;
1074     wxFont GetFont() const;
1075
1076     DocDeclA(
1077         void, GetAlignment(int *OUTPUT, int *OUTPUT) const,
1078         "GetAlignment() -> (hAlign, vAlign)");
1079
1080     DocDeclA(
1081         void, GetSize(int *OUTPUT, int *OUTPUT) const,
1082         "GetSize() -> (num_rows, num_cols)");
1083
1084     bool GetOverflow() const;
1085     wxGridCellRenderer *GetRenderer(wxGrid* grid, int row, int col) const;
1086     wxGridCellEditor *GetEditor(wxGrid* grid, int row, int col) const;
1087
1088     bool IsReadOnly() const;
1089     wxAttrKind GetKind();
1090     void SetDefAttr(wxGridCellAttr* defAttr);
1091 };
1092
1093 //---------------------------------------------------------------------------
1094
1095 class wxGridCellAttrProvider
1096 {
1097 public:
1098     %pythonAppend wxGridCellAttrProvider "self._setOORInfo(self)"
1099     wxGridCellAttrProvider();
1100     // ???? virtual ~wxGridCellAttrProvider();
1101
1102     %extend {
1103         void _setOORInfo(PyObject* _self) {
1104             if (!self->GetClientObject())
1105                 self->SetClientObject(new wxPyOORClientData(_self));
1106         }
1107     }
1108
1109     wxGridCellAttr *GetAttr(int row, int col,
1110                             wxGridCellAttr::wxAttrKind  kind) const;
1111     void SetAttr(wxGridCellAttr *attr, int row, int col);
1112     void SetRowAttr(wxGridCellAttr *attr, int row);
1113     void SetColAttr(wxGridCellAttr *attr, int col);
1114
1115     void UpdateAttrRows( size_t pos, int numRows );
1116     void UpdateAttrCols( size_t pos, int numCols );
1117
1118 };
1119
1120
1121 // A Python-aware version
1122 %{
1123 class wxPyGridCellAttrProvider : public wxGridCellAttrProvider
1124 {
1125 public:
1126     wxPyGridCellAttrProvider() : wxGridCellAttrProvider() {};
1127
1128     PYCALLBACK_GCA_INTINTKIND(wxGridCellAttrProvider, GetAttr);
1129     PYCALLBACK__GCAINTINT(wxGridCellAttrProvider, SetAttr);
1130     PYCALLBACK__GCAINT(wxGridCellAttrProvider, SetRowAttr);
1131     PYCALLBACK__GCAINT(wxGridCellAttrProvider, SetColAttr);
1132
1133     PYPRIVATE;
1134 };
1135 %}
1136
1137
1138 // The python-aware version get's SWIGified
1139 class wxPyGridCellAttrProvider : public wxGridCellAttrProvider
1140 {
1141 public:
1142     %pythonAppend wxPyGridCellAttrProvider  "self._setCallbackInfo(self, PyGridCellAttrProvider)"
1143     wxPyGridCellAttrProvider();
1144     void _setCallbackInfo(PyObject* self, PyObject* _class);
1145
1146     wxGridCellAttr *base_GetAttr(int row, int col,
1147                                  wxGridCellAttr::wxAttrKind kind);
1148     void base_SetAttr(wxGridCellAttr *attr, int row, int col);
1149     void base_SetRowAttr(wxGridCellAttr *attr, int row);
1150     void base_SetColAttr(wxGridCellAttr *attr, int col);
1151 };
1152
1153
1154 //---------------------------------------------------------------------------
1155 // Grid Table Base class and Python aware version
1156
1157
1158 class wxGridTableBase : public wxObject
1159 {
1160 public:
1161     // wxGridTableBase();   This is an ABC
1162     //~wxGridTableBase();
1163
1164     %extend {
1165         void _setOORInfo(PyObject* _self) {
1166             if (!self->GetClientObject())
1167                 self->SetClientObject(new wxPyOORClientData(_self));
1168         }
1169     }
1170
1171     void SetAttrProvider(wxGridCellAttrProvider *attrProvider);
1172     wxGridCellAttrProvider *GetAttrProvider() const;
1173     void SetView( wxGrid *grid );
1174     wxGrid * GetView() const;
1175
1176
1177     // pure virtuals
1178     virtual int GetNumberRows();
1179     virtual int GetNumberCols();
1180     virtual bool IsEmptyCell( int row, int col );
1181     virtual wxString GetValue( int row, int col );
1182     virtual void SetValue( int row, int col, const wxString& value );
1183
1184     // virtuals overridable in wxPyGridTableBase
1185     virtual wxString GetTypeName( int row, int col );
1186     virtual bool CanGetValueAs( int row, int col, const wxString& typeName );
1187     virtual bool CanSetValueAs( int row, int col, const wxString& typeName );
1188     virtual long GetValueAsLong( int row, int col );
1189     virtual double GetValueAsDouble( int row, int col );
1190     virtual bool GetValueAsBool( int row, int col );
1191     virtual void SetValueAsLong( int row, int col, long value );
1192     virtual void SetValueAsDouble( int row, int col, double value );
1193     virtual void SetValueAsBool( int row, int col, bool value );
1194
1195     //virtual void* GetValueAsCustom( int row, int col, const wxString& typeName );
1196     //virtual void  SetValueAsCustom( int row, int col, const wxString& typeName, void* value );
1197
1198
1199     virtual void Clear();
1200     virtual bool InsertRows( size_t pos = 0, size_t numRows = 1 );
1201     virtual bool AppendRows( size_t numRows = 1 );
1202     virtual bool DeleteRows( size_t pos = 0, size_t numRows = 1 );
1203     virtual bool InsertCols( size_t pos = 0, size_t numCols = 1 );
1204     virtual bool AppendCols( size_t numCols = 1 );
1205     virtual bool DeleteCols( size_t pos = 0, size_t numCols = 1 );
1206
1207     virtual wxString GetRowLabelValue( int row );
1208     virtual wxString GetColLabelValue( int col );
1209     virtual void SetRowLabelValue( int row, const wxString& value );
1210     virtual void SetColLabelValue( int col, const wxString& value );
1211
1212     virtual bool CanHaveAttributes();
1213
1214     virtual wxGridCellAttr *GetAttr( int row, int col,
1215                                      wxGridCellAttr::wxAttrKind  kind);
1216     virtual void SetAttr(wxGridCellAttr* attr, int row, int col);
1217     virtual void SetRowAttr(wxGridCellAttr *attr, int row);
1218     virtual void SetColAttr(wxGridCellAttr *attr, int col);
1219
1220 };
1221
1222
1223
1224 // Python-aware version
1225 %{
1226 class wxPyGridTableBase : public wxGridTableBase
1227 {
1228 public:
1229     wxPyGridTableBase() : wxGridTableBase() {}
1230
1231     PYCALLBACK_INT__pure(GetNumberRows);
1232     PYCALLBACK_INT__pure(GetNumberCols);
1233     PYCALLBACK_BOOL_INTINT_pure(IsEmptyCell);
1234     PYCALLBACK_STRING_INTINT(wxGridTableBase, GetTypeName);
1235     PYCALLBACK_BOOL_INTINTSTRING(wxGridTableBase, CanGetValueAs);
1236     PYCALLBACK_BOOL_INTINTSTRING(wxGridTableBase, CanSetValueAs);
1237     PYCALLBACK__(wxGridTableBase, Clear);
1238     PYCALLBACK_BOOL_SIZETSIZET(wxGridTableBase, InsertRows);
1239     PYCALLBACK_BOOL_SIZETSIZET(wxGridTableBase, DeleteRows);
1240     PYCALLBACK_BOOL_SIZETSIZET(wxGridTableBase, InsertCols);
1241     PYCALLBACK_BOOL_SIZETSIZET(wxGridTableBase, DeleteCols);
1242     PYCALLBACK_BOOL_SIZET(wxGridTableBase, AppendRows);
1243     PYCALLBACK_BOOL_SIZET(wxGridTableBase, AppendCols);
1244     PYCALLBACK_STRING_INT(wxGridTableBase, GetRowLabelValue);
1245     PYCALLBACK_STRING_INT(wxGridTableBase, GetColLabelValue);
1246     PYCALLBACK__INTSTRING(wxGridTableBase, SetRowLabelValue);
1247     PYCALLBACK__INTSTRING(wxGridTableBase, SetColLabelValue);
1248     PYCALLBACK_BOOL_(wxGridTableBase, CanHaveAttributes);
1249     PYCALLBACK_GCA_INTINTKIND(wxGridTableBase, GetAttr);
1250     PYCALLBACK__GCAINTINT(wxGridTableBase, SetAttr);
1251     PYCALLBACK__GCAINT(wxGridTableBase, SetRowAttr);
1252     PYCALLBACK__GCAINT(wxGridTableBase, SetColAttr);
1253
1254
1255     wxString GetValue(int row, int col) {
1256         bool blocked = wxPyBeginBlockThreads();
1257         wxString rval;
1258         if (wxPyCBH_findCallback(m_myInst, "GetValue")) {
1259             PyObject* ro;
1260             ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(ii)",row,col));
1261             if (ro) {
1262                 if (!PyString_Check(ro) && !PyUnicode_Check(ro)) {
1263                     PyObject* old = ro;
1264                     ro = PyObject_Str(ro);
1265                     Py_DECREF(old);
1266                 }
1267                 rval = Py2wxString(ro);
1268                 Py_DECREF(ro);
1269             }
1270         }
1271         wxPyEndBlockThreads(blocked);
1272         return rval;
1273     }
1274
1275     void SetValue(int row, int col, const wxString& val) {
1276         bool blocked = wxPyBeginBlockThreads();
1277         if (wxPyCBH_findCallback(m_myInst, "SetValue")) {
1278             PyObject* s = wx2PyString(val);
1279             wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iiO)",row,col,s));
1280             Py_DECREF(s);
1281         }
1282         wxPyEndBlockThreads(blocked);
1283     }
1284
1285
1286     // Map the Get/Set methods for the standard non-string types to
1287     // the GetValue and SetValue python methods.
1288     long GetValueAsLong( int row, int col ) {
1289         long rval = 0;
1290         bool blocked = wxPyBeginBlockThreads();
1291         if (wxPyCBH_findCallback(m_myInst, "GetValue")) {
1292             PyObject* ro;
1293             PyObject* num;
1294             ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(ii)", row, col));
1295             if (ro && PyNumber_Check(ro)) {
1296                 num = PyNumber_Int(ro);
1297                 if (num) {
1298                     rval = PyInt_AsLong(num);
1299                     Py_DECREF(num);
1300                 }
1301                 Py_DECREF(ro);
1302             }
1303         }
1304         wxPyEndBlockThreads(blocked);
1305         return rval;
1306     }
1307
1308     double GetValueAsDouble( int row, int col ) {
1309         double rval = 0.0;
1310         bool blocked = wxPyBeginBlockThreads();
1311         if (wxPyCBH_findCallback(m_myInst, "GetValue")) {
1312             PyObject* ro;
1313             PyObject* num;
1314             ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(ii)", row, col));
1315             if (ro && PyNumber_Check(ro)) {
1316                 num = PyNumber_Float(ro);
1317                 if (num) {
1318                     rval = PyFloat_AsDouble(num);
1319                     Py_DECREF(num);
1320                 }
1321                 Py_DECREF(ro);
1322             }
1323         }
1324         wxPyEndBlockThreads(blocked);
1325         return rval;
1326     }
1327
1328     bool GetValueAsBool( int row, int col ) {
1329         return (bool)GetValueAsLong(row, col);
1330     }
1331
1332     void SetValueAsLong( int row, int col, long value ) {
1333         bool blocked = wxPyBeginBlockThreads();
1334         if (wxPyCBH_findCallback(m_myInst, "SetValue")) {
1335             wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iii)", row, col, value));
1336         }
1337         wxPyEndBlockThreads(blocked);
1338     }
1339
1340     void SetValueAsDouble( int row, int col, double value ) {
1341         bool blocked = wxPyBeginBlockThreads();
1342         if (wxPyCBH_findCallback(m_myInst, "SetValue")) {
1343             wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iid)", row, col, value));
1344         }
1345         wxPyEndBlockThreads(blocked);
1346     }
1347
1348     void SetValueAsBool( int row, int col, bool value ) {
1349         SetValueAsLong( row, col, (long)value );
1350     }
1351
1352
1353     PYPRIVATE;
1354 };
1355 %}
1356
1357
1358 // The python-aware version get's SWIGified
1359 class wxPyGridTableBase : public wxGridTableBase
1360 {
1361 public:
1362     %pythonAppend wxPyGridTableBase "self._setCallbackInfo(self, PyGridTableBase);self._setOORInfo(self)"
1363     wxPyGridTableBase();
1364     void _setCallbackInfo(PyObject* self, PyObject* _class);
1365
1366     %extend { void Destroy() { delete self; } }
1367
1368     wxString base_GetTypeName( int row, int col );
1369     bool base_CanGetValueAs( int row, int col, const wxString& typeName );
1370     bool base_CanSetValueAs( int row, int col, const wxString& typeName );
1371     void base_Clear();
1372     bool base_InsertRows( size_t pos = 0, size_t numRows = 1 );
1373     bool base_AppendRows( size_t numRows = 1 );
1374     bool base_DeleteRows( size_t pos = 0, size_t numRows = 1 );
1375     bool base_InsertCols( size_t pos = 0, size_t numCols = 1 );
1376     bool base_AppendCols( size_t numCols = 1 );
1377     bool base_DeleteCols( size_t pos = 0, size_t numCols = 1 );
1378     wxString base_GetRowLabelValue( int row );
1379     wxString base_GetColLabelValue( int col );
1380     void base_SetRowLabelValue( int row, const wxString& value );
1381     void base_SetColLabelValue( int col, const wxString& value );
1382     bool base_CanHaveAttributes();
1383     wxGridCellAttr *base_GetAttr( int row, int col,
1384                                   wxGridCellAttr::wxAttrKind kind );
1385     void base_SetAttr(wxGridCellAttr* attr, int row, int col);
1386     void base_SetRowAttr(wxGridCellAttr *attr, int row);
1387     void base_SetColAttr(wxGridCellAttr *attr, int col);
1388 };
1389
1390
1391 //---------------------------------------------------------------------------
1392 // Predefined Tables
1393
1394 class  wxGridStringTable : public wxGridTableBase
1395 {
1396 public:
1397     %pythonAppend wxGridStringTable "self._setOORInfo(self)"
1398     wxGridStringTable( int numRows=0, int numCols=0 );
1399 };
1400
1401 //---------------------------------------------------------------------------
1402 // The Table can pass messages to the grid to tell it to update itself if
1403 // something has changed.
1404
1405 enum wxGridTableRequest
1406 {
1407     wxGRIDTABLE_REQUEST_VIEW_GET_VALUES = 2000,
1408     wxGRIDTABLE_REQUEST_VIEW_SEND_VALUES,
1409     wxGRIDTABLE_NOTIFY_ROWS_INSERTED,
1410     wxGRIDTABLE_NOTIFY_ROWS_APPENDED,
1411     wxGRIDTABLE_NOTIFY_ROWS_DELETED,
1412     wxGRIDTABLE_NOTIFY_COLS_INSERTED,
1413     wxGRIDTABLE_NOTIFY_COLS_APPENDED,
1414     wxGRIDTABLE_NOTIFY_COLS_DELETED
1415 };
1416
1417
1418 class wxGridTableMessage
1419 {
1420 public:
1421     wxGridTableMessage( wxGridTableBase *table, int id,
1422                         int comInt1 = -1,
1423                         int comInt2 = -1 );
1424     ~wxGridTableMessage();
1425
1426     void SetTableObject( wxGridTableBase *table );
1427     wxGridTableBase * GetTableObject() const;
1428     void SetId( int id );
1429     int  GetId();
1430     void SetCommandInt( int comInt1 );
1431     int  GetCommandInt();
1432     void SetCommandInt2( int comInt2 );
1433     int  GetCommandInt2();
1434 };
1435
1436
1437 //---------------------------------------------------------------------------
1438
1439
1440 // Typemap to allow conversion of sequence objects to wxGridCellCoords...
1441 %typemap(in) wxGridCellCoords& (wxGridCellCoords temp) {
1442     $1 = &temp;
1443     if (! wxGridCellCoords_helper($input, &$1)) SWIG_fail;
1444 }
1445 %typemap(typecheck, precedence=SWIG_TYPECHECK_POINTER) wxGridCellCoords& {
1446     $1 = wxGridCellCoords_typecheck($input);
1447 }
1448
1449
1450 // ...and here is the associated helper.
1451 %{
1452 bool wxGridCellCoords_helper(PyObject* source, wxGridCellCoords** obj) {
1453
1454     if (source == Py_None) {
1455         **obj = wxGridCellCoords(-1,-1);
1456         return true;
1457     }
1458
1459     // If source is an object instance then it may already be the right type
1460     if (wxPySwigInstance_Check(source)) {
1461         wxGridCellCoords* ptr;
1462         if (! wxPyConvertSwigPtr(source, (void **)&ptr, wxT("wxGridCellCoords")))
1463             goto error;
1464         *obj = ptr;
1465         return true;
1466     }
1467     // otherwise a 2-tuple of integers is expected
1468     else if (PySequence_Check(source) && PyObject_Length(source) == 2) {
1469         PyObject* o1 = PySequence_GetItem(source, 0);
1470         PyObject* o2 = PySequence_GetItem(source, 1);
1471         if (!PyNumber_Check(o1) || !PyNumber_Check(o2)) {
1472             Py_DECREF(o1);
1473             Py_DECREF(o2);
1474             goto error;
1475         }
1476         **obj = wxGridCellCoords(PyInt_AsLong(o1), PyInt_AsLong(o2));
1477         Py_DECREF(o1);
1478         Py_DECREF(o2);
1479         return true;
1480     }
1481
1482  error:
1483     PyErr_SetString(PyExc_TypeError, "Expected a 2-tuple of integers or a wxGridCellCoords object.");
1484     return false;
1485 }
1486
1487
1488 bool wxGridCellCoords_typecheck(PyObject* source) {
1489     void* ptr;
1490
1491     if (wxPySwigInstance_Check(source) &&
1492         wxPyConvertSwigPtr(source, (void **)&ptr, wxT("wxGridCellCoords")))
1493         return true;
1494
1495     PyErr_Clear();
1496     if (PySequence_Check(source) && PySequence_Length(source) == 2)
1497         return true;
1498
1499     return false;
1500 }
1501 %}
1502
1503
1504 // Typemap to convert an array of cells coords to a list of tuples...
1505 %typemap(out) wxGridCellCoordsArray {
1506     $result = wxGridCellCoordsArray_helper($1);
1507 }
1508
1509 // %typemap(ret) wxGridCellCoordsArray {
1510 //     delete $1;
1511 // }
1512
1513
1514 // ...and the helper function for the above typemap.
1515 %{
1516 PyObject* wxGridCellCoordsArray_helper(const wxGridCellCoordsArray& source)
1517 {
1518     PyObject* list = PyList_New(0);
1519     size_t idx;
1520     for (idx = 0; idx < source.GetCount(); idx += 1) {
1521         wxGridCellCoords& coord = source.Item(idx);
1522         PyObject* tup = PyTuple_New(2);
1523         PyTuple_SET_ITEM(tup, 0, PyInt_FromLong(coord.GetRow()));
1524         PyTuple_SET_ITEM(tup, 1, PyInt_FromLong(coord.GetCol()));
1525         PyList_Append(list, tup);
1526         Py_DECREF(tup);
1527     }
1528     return list;
1529 }
1530 %}
1531
1532
1533
1534
1535
1536 class wxGridCellCoords
1537 {
1538 public:
1539     wxGridCellCoords( int r=-1, int c=-1 );
1540     ~wxGridCellCoords();
1541
1542     int GetRow() const;
1543     void SetRow( int n );
1544     int GetCol() const;
1545     void SetCol( int n );
1546     void Set( int row, int col );
1547
1548     bool operator==( const wxGridCellCoords& other ) const;
1549     bool operator!=( const wxGridCellCoords& other ) const;
1550
1551     %extend {
1552         PyObject* Get() {
1553             PyObject* tup = PyTuple_New(2);
1554             PyTuple_SET_ITEM(tup, 0, PyInt_FromLong(self->GetRow()));
1555             PyTuple_SET_ITEM(tup, 1, PyInt_FromLong(self->GetCol()));
1556             return tup;
1557         }
1558     }
1559     %pythoncode {
1560     asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
1561     def __str__(self):                   return str(self.Get())
1562     def __repr__(self):                  return 'wxGridCellCoords'+str(self.Get())
1563     def __len__(self):                   return len(self.Get())
1564     def __getitem__(self, index):        return self.asTuple()[index]
1565     def __setitem__(self, index, val):
1566         if index == 0: self.SetRow(val)
1567         elif index == 1: self.SetCol(val)
1568         else: raise IndexError
1569     }
1570
1571 };
1572
1573
1574 //---------------------------------------------------------------------------
1575 //---------------------------------------------------------------------------
1576 // The grid itself
1577
1578
1579 // Fool SWIG into treating this enum as an int
1580 typedef int WXGRIDSELECTIONMODES;
1581
1582 // but let the C++ code know what it really is.
1583 %{
1584 typedef wxGrid::wxGridSelectionModes WXGRIDSELECTIONMODES;
1585 %}
1586
1587
1588
1589 MustHaveApp(wxGrid);
1590
1591 class wxGrid : public wxScrolledWindow
1592 {
1593 public:
1594     %pythonAppend wxGrid "self._setOORInfo(self)"
1595     %pythonAppend wxGrid() ""
1596
1597     %typemap(out) wxGrid*;    // turn off this typemap
1598
1599     wxGrid( wxWindow *parent,
1600             wxWindowID id=-1,
1601             const wxPoint& pos = wxDefaultPosition,
1602             const wxSize& size = wxDefaultSize,
1603             long style = wxWANTS_CHARS,
1604             const wxString& name = wxPyPanelNameStr);
1605
1606     %name(PreGrid) wxGrid();
1607
1608
1609     // Turn it back on again
1610     %typemap(out) wxGrid* { $result = wxPyMake_wxObject($1, $owner); }
1611
1612
1613     bool Create( wxWindow *parent,
1614                  wxWindowID id=-1,
1615                  const wxPoint& pos = wxDefaultPosition,
1616                  const wxSize& size = wxDefaultSize,
1617                  long style = wxWANTS_CHARS,
1618                  const wxString& name = wxPyPanelNameStr );
1619
1620
1621     enum wxGridSelectionModes {
1622         wxGridSelectCells,
1623         wxGridSelectRows,
1624         wxGridSelectColumns
1625     };
1626     %pythoncode {
1627         SelectCells =   wxGridSelectCells
1628         SelectRows =    wxGridSelectRows
1629         SelectColumns = wxGridSelectColumns
1630     }
1631
1632     bool CreateGrid( int numRows, int numCols,
1633                      WXGRIDSELECTIONMODES selmode = wxGrid::wxGridSelectCells );
1634     void SetSelectionMode(WXGRIDSELECTIONMODES selmode);
1635     WXGRIDSELECTIONMODES GetSelectionMode();
1636
1637
1638     // ------ grid dimensions
1639     //
1640     int      GetNumberRows();
1641     int      GetNumberCols();
1642
1643
1644     bool ProcessTableMessage( wxGridTableMessage& );
1645
1646
1647     wxGridTableBase * GetTable() const;
1648     bool SetTable( wxGridTableBase *table, bool takeOwnership=false,
1649                    WXGRIDSELECTIONMODES selmode =
1650                    wxGrid::wxGridSelectCells );
1651
1652     void ClearGrid();
1653     bool InsertRows( int pos = 0, int numRows = 1, bool updateLabels=true );
1654     bool AppendRows( int numRows = 1, bool updateLabels=true );
1655     bool DeleteRows( int pos = 0, int numRows = 1, bool updateLabels=true );
1656     bool InsertCols( int pos = 0, int numCols = 1, bool updateLabels=true );
1657     bool AppendCols( int numCols = 1, bool updateLabels=true );
1658     bool DeleteCols( int pos = 0, int numCols = 1, bool updateLabels=true );
1659
1660
1661     // this function is called when the current cell highlight must be redrawn
1662     // and may be overridden by the user
1663     virtual void DrawCellHighlight( wxDC& dc, const wxGridCellAttr *attr );
1664
1665
1666     // ------ Cell text drawing functions
1667     //
1668     void DrawTextRectangle( wxDC& dc, const wxString&, const wxRect&,
1669                             int horizontalAlignment = wxLEFT,
1670                             int verticalAlignment = wxTOP,
1671                             int textOrientation = wxHORIZONTAL );
1672
1673 //      // Split a string containing newline chararcters into an array of
1674 //      // strings and return the number of lines
1675 //      //
1676 //      void StringToLines( const wxString& value, wxArrayString& lines );
1677
1678     DocDeclA(
1679         void, GetTextBoxSize( wxDC& dc, wxArrayString& lines,
1680                               long *OUTPUT, long *OUTPUT ),
1681         "GetTextBoxSize(DC dc, list lines) -> (width, height)");
1682
1683
1684     // ------
1685     // Code that does a lot of grid modification can be enclosed
1686     // between BeginBatch() and EndBatch() calls to avoid screen
1687     // flicker
1688     //
1689     void     BeginBatch();
1690     void     EndBatch();
1691     int      GetBatchCount();
1692     void     ForceRefresh();
1693
1694
1695     // ------ edit control functions
1696     //
1697     bool IsEditable();
1698     void EnableEditing( bool edit );
1699
1700     void EnableCellEditControl( bool enable = true );
1701     void DisableCellEditControl();
1702     bool CanEnableCellControl() const;
1703     bool IsCellEditControlEnabled() const;
1704     bool IsCellEditControlShown() const;
1705
1706     bool IsCurrentCellReadOnly() const;
1707
1708     void ShowCellEditControl();
1709     void HideCellEditControl();
1710     void SaveEditControlValue();
1711
1712
1713     // ------ grid location functions
1714     //  Note that all of these functions work with the logical coordinates of
1715     //  grid cells and labels so you will need to convert from device
1716     //  coordinates for mouse events etc.
1717     //
1718
1719     //void XYToCell( int x, int y, wxGridCellCoords& );
1720     %extend {
1721         wxGridCellCoords XYToCell(int x, int y) {
1722             wxGridCellCoords rv;
1723             self->XYToCell(x, y, rv);
1724             return rv;
1725         }
1726     }
1727
1728     int  YToRow( int y );
1729     int  XToCol( int x );
1730
1731     int  YToEdgeOfRow( int y );
1732     int  XToEdgeOfCol( int x );
1733
1734     wxRect CellToRect( int row, int col );
1735     // TODO: ??? wxRect CellToRect( const wxGridCellCoords& coords );
1736
1737
1738     int  GetGridCursorRow();
1739     int  GetGridCursorCol();
1740
1741     // check to see if a cell is either wholly visible (the default arg) or
1742     // at least partially visible in the grid window
1743     //
1744     bool IsVisible( int row, int col, bool wholeCellVisible = true );
1745     // TODO: ??? bool IsVisible( const wxGridCellCoords& coords, bool wholeCellVisible = true );
1746     void MakeCellVisible( int row, int col );
1747     // TODO: ??? void MakeCellVisible( const wxGridCellCoords& coords );
1748
1749
1750     // ------ grid cursor movement functions
1751     //
1752     void SetGridCursor( int row, int col );
1753     bool MoveCursorUp( bool expandSelection );
1754     bool MoveCursorDown( bool expandSelection );
1755     bool MoveCursorLeft( bool expandSelection );
1756     bool MoveCursorRight( bool expandSelection );
1757     bool MovePageDown();
1758     bool MovePageUp();
1759     bool MoveCursorUpBlock( bool expandSelection );
1760     bool MoveCursorDownBlock( bool expandSelection );
1761     bool MoveCursorLeftBlock( bool expandSelection );
1762     bool MoveCursorRightBlock( bool expandSelection );
1763
1764
1765     // ------ label and gridline formatting
1766     //
1767     int      GetDefaultRowLabelSize();
1768     int      GetRowLabelSize();
1769     int      GetDefaultColLabelSize();
1770     int      GetColLabelSize();
1771     wxColour GetLabelBackgroundColour();
1772     wxColour GetLabelTextColour();
1773     wxFont   GetLabelFont();
1774
1775     DocDeclA(
1776         void, GetRowLabelAlignment( int *OUTPUT, int *OUTPUT ),
1777         "GetRowLabelAlignment() -> (horiz, vert)");
1778
1779     DocDeclA(
1780         void, GetColLabelAlignment( int *OUTPUT, int *OUTPUT ),
1781         "GetColLabelAlignment() -> (horiz, vert)");
1782
1783     int      GetColLabelTextOrientation();
1784     wxString GetRowLabelValue( int row );
1785     wxString GetColLabelValue( int col );
1786     wxColour GetGridLineColour();
1787     wxColour GetCellHighlightColour();
1788     int      GetCellHighlightPenWidth();
1789     int      GetCellHighlightROPenWidth();
1790
1791     void     SetRowLabelSize( int width );
1792     void     SetColLabelSize( int height );
1793     void     SetLabelBackgroundColour( const wxColour& );
1794     void     SetLabelTextColour( const wxColour& );
1795     void     SetLabelFont( const wxFont& );
1796     void     SetRowLabelAlignment( int horiz, int vert );
1797     void     SetColLabelAlignment( int horiz, int vert );
1798     void     SetColLabelTextOrientation( int textOrientation );
1799     void     SetRowLabelValue( int row, const wxString& );
1800     void     SetColLabelValue( int col, const wxString& );
1801     void     SetGridLineColour( const wxColour& );
1802     void     SetCellHighlightColour( const wxColour& );
1803     void     SetCellHighlightPenWidth(int width);
1804     void     SetCellHighlightROPenWidth(int width);
1805
1806     void     EnableDragRowSize( bool enable = true );
1807     void     DisableDragRowSize();
1808     bool     CanDragRowSize();
1809     void     EnableDragColSize( bool enable = true );
1810     void     DisableDragColSize();
1811     bool     CanDragColSize();
1812     void     EnableDragGridSize(bool enable = true);
1813     void     DisableDragGridSize();
1814     bool     CanDragGridSize();
1815
1816     void     EnableDragCell( bool enable = true );
1817     void     DisableDragCell();
1818     bool     CanDragCell();
1819
1820     // this sets the specified attribute for all cells in this row/col
1821     void     SetAttr(int row, int col, wxGridCellAttr *attr);
1822     void     SetRowAttr(int row, wxGridCellAttr *attr);
1823     void     SetColAttr(int col, wxGridCellAttr *attr);
1824
1825     // returns the attribute we may modify in place: a new one if this cell
1826     // doesn't have any yet or the existing one if it does
1827     //
1828     // DecRef() must be called on the returned pointer, as usual
1829     wxGridCellAttr *GetOrCreateCellAttr(int row, int col) const;
1830
1831
1832     // shortcuts for setting the column parameters
1833
1834     // set the format for the data in the column: default is string
1835     void     SetColFormatBool(int col);
1836     void     SetColFormatNumber(int col);
1837     void     SetColFormatFloat(int col, int width = -1, int precision = -1);
1838     void     SetColFormatCustom(int col, const wxString& typeName);
1839
1840     void     EnableGridLines( bool enable = true );
1841     bool     GridLinesEnabled();
1842
1843     // ------ row and col formatting
1844     //
1845     int      GetDefaultRowSize();
1846     int      GetRowSize( int row );
1847     int      GetDefaultColSize();
1848     int      GetColSize( int col );
1849     wxColour GetDefaultCellBackgroundColour();
1850     wxColour GetCellBackgroundColour( int row, int col );
1851     wxColour GetDefaultCellTextColour();
1852     wxColour GetCellTextColour( int row, int col );
1853     wxFont   GetDefaultCellFont();
1854     wxFont   GetCellFont( int row, int col );
1855
1856     DocDeclA(
1857         void, GetDefaultCellAlignment( int *OUTPUT, int *OUTPUT ),
1858         "GetDefaultCellAlignment() -> (horiz, vert)");
1859
1860     DocDeclA(
1861         void, GetCellAlignment( int row, int col, int *OUTPUT, int *OUTPUT ),
1862         "GetCellAlignment() -> (horiz, vert)");
1863
1864     bool     GetDefaultCellOverflow();
1865     bool     GetCellOverflow( int row, int col );
1866
1867     DocDeclA(
1868         void, GetCellSize( int row, int col, int *OUTPUT, int *OUTPUT ),
1869         "GetCellSize(int row, int col) -> (num_rows, num_cols)");
1870
1871     void     SetDefaultRowSize( int height, bool resizeExistingRows = false );
1872     void     SetRowSize( int row, int height );
1873     void     SetDefaultColSize( int width, bool resizeExistingCols = false );
1874
1875     void     SetColSize( int col, int width );
1876
1877     // automatically size the column or row to fit to its contents, if
1878     // setAsMin is True, this optimal width will also be set as minimal width
1879     // for this column
1880     void     AutoSizeColumn( int col, bool setAsMin = true );
1881     void     AutoSizeRow( int row, bool setAsMin = true );
1882
1883
1884     // auto size all columns (very ineffective for big grids!)
1885     void     AutoSizeColumns( bool setAsMin = true );
1886     void     AutoSizeRows( bool setAsMin = true );
1887
1888     // auto size the grid, that is make the columns/rows of the "right" size
1889     // and also set the grid size to just fit its contents
1890     void     AutoSize();
1891
1892     // autosize row height depending on label text
1893     void     AutoSizeRowLabelSize( int row );
1894
1895     // autosize column width depending on label text
1896     void     AutoSizeColLabelSize( int col );
1897
1898
1899     // column won't be resized to be lesser width - this must be called during
1900     // the grid creation because it won't resize the column if it's already
1901     // narrower than the minimal width
1902     void     SetColMinimalWidth( int col, int width );
1903     void     SetRowMinimalHeight( int row, int width );
1904
1905     void     SetColMinimalAcceptableWidth( int width );
1906     void     SetRowMinimalAcceptableHeight( int width );
1907     int      GetColMinimalAcceptableWidth() const;
1908     int      GetRowMinimalAcceptableHeight() const;
1909
1910     void     SetDefaultCellBackgroundColour( const wxColour& );
1911     void     SetCellBackgroundColour( int row, int col, const wxColour& );
1912     void     SetDefaultCellTextColour( const wxColour& );
1913
1914     void     SetCellTextColour( int row, int col, const wxColour& );
1915     void     SetDefaultCellFont( const wxFont& );
1916     void     SetCellFont( int row, int col, const wxFont& );
1917     void     SetDefaultCellAlignment( int horiz, int vert );
1918     void     SetCellAlignment( int row, int col, int horiz, int vert );
1919     void     SetDefaultCellOverflow( bool allow );
1920     void     SetCellOverflow( int row, int col, bool allow );
1921     void     SetCellSize( int row, int col, int num_rows, int num_cols );
1922
1923     // takes ownership of the pointer
1924     void SetDefaultRenderer(wxGridCellRenderer *renderer);
1925     void SetCellRenderer(int row, int col, wxGridCellRenderer *renderer);
1926     wxGridCellRenderer *GetDefaultRenderer() const;
1927     wxGridCellRenderer* GetCellRenderer(int row, int col);
1928
1929     // takes ownership of the pointer
1930     void SetDefaultEditor(wxGridCellEditor *editor);
1931     void SetCellEditor(int row, int col, wxGridCellEditor *editor);
1932     wxGridCellEditor *GetDefaultEditor() const;
1933     wxGridCellEditor* GetCellEditor(int row, int col);
1934
1935
1936
1937     // ------ cell value accessors
1938     //
1939     wxString GetCellValue( int row, int col );
1940     // TODO: ??? wxString GetCellValue( const wxGridCellCoords& coords )
1941
1942     void SetCellValue( int row, int col, const wxString& s );
1943     // TODO: ??? void SetCellValue( const wxGridCellCoords& coords, const wxString& s )
1944
1945     // returns True if the cell can't be edited
1946     bool IsReadOnly(int row, int col) const;
1947
1948     // make the cell editable/readonly
1949     void SetReadOnly(int row, int col, bool isReadOnly = true);
1950
1951     // ------ selections of blocks of cells
1952     //
1953     void SelectRow( int row, bool addToSelected = false );
1954     void SelectCol( int col, bool addToSelected = false );
1955
1956     void SelectBlock( int topRow, int leftCol, int bottomRow, int rightCol,
1957                       bool addToSelected = false );
1958     // TODO: ??? void SelectBlock( const wxGridCellCoords& topLeft,
1959     // TODO: ???                   const wxGridCellCoords& bottomRight )
1960
1961     void SelectAll();
1962     bool IsSelection();
1963     void ClearSelection();
1964     bool IsInSelection( int row, int col );
1965     // TODO: ??? bool IsInSelection( const wxGridCellCoords& coords )
1966
1967     const wxGridCellCoordsArray GetSelectedCells() const;
1968     const wxGridCellCoordsArray GetSelectionBlockTopLeft() const;
1969     const wxGridCellCoordsArray GetSelectionBlockBottomRight() const;
1970     const wxArrayInt GetSelectedRows() const;
1971     const wxArrayInt GetSelectedCols() const;
1972
1973     void DeselectRow( int row );
1974     void DeselectCol( int col );
1975     void DeselectCell( int row, int col );
1976
1977
1978     // This function returns the rectangle that encloses the block of cells
1979     // limited by TopLeft and BottomRight cell in device coords and clipped
1980     //  to the client size of the grid window.
1981     //
1982     wxRect BlockToDeviceRect( const wxGridCellCoords & topLeft,
1983                               const wxGridCellCoords & bottomRight );
1984
1985
1986     // Access or update the selection fore/back colours
1987     wxColour GetSelectionBackground() const;
1988     wxColour GetSelectionForeground() const;
1989
1990     void SetSelectionBackground(const wxColour& c);
1991     void SetSelectionForeground(const wxColour& c);
1992
1993
1994     // Methods for a registry for mapping data types to Renderers/Editors
1995     void RegisterDataType(const wxString& typeName,
1996                           wxGridCellRenderer* renderer,
1997                           wxGridCellEditor* editor);
1998     wxGridCellEditor* GetDefaultEditorForCell(int row, int col) const;
1999     // TODO: ??? wxGridCellEditor* GetDefaultEditorForCell(const wxGridCellCoords& c) const
2000     wxGridCellRenderer* GetDefaultRendererForCell(int row, int col) const;
2001     wxGridCellEditor* GetDefaultEditorForType(const wxString& typeName) const;
2002     wxGridCellRenderer* GetDefaultRendererForType(const wxString& typeName) const;
2003
2004     // grid may occupy more space than needed for its rows/columns, this
2005     // function allows to set how big this extra space is
2006     void SetMargins(int extraWidth, int extraHeight);
2007
2008
2009     // Accessors for component windows
2010     wxWindow* GetGridWindow();
2011     wxWindow* GetGridRowLabelWindow();
2012     wxWindow* GetGridColLabelWindow();
2013     wxWindow* GetGridCornerLabelWindow();
2014
2015     // Allow adjustment of scroll increment. The default is (15, 15).
2016     void SetScrollLineX(int x);
2017     void SetScrollLineY(int y);
2018     int GetScrollLineX() const;
2019     int GetScrollLineY() const;
2020
2021     int GetScrollX(int x) const;
2022     int GetScrollY(int y) const;
2023
2024     static wxVisualAttributes
2025     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
2026 };
2027
2028
2029 //---------------------------------------------------------------------------
2030 //---------------------------------------------------------------------------
2031 // Grid events and stuff
2032
2033
2034
2035 class wxGridEvent : public wxNotifyEvent
2036 {
2037 public:
2038     wxGridEvent(int id, wxEventType type, wxGrid* obj,
2039                 int row=-1, int col=-1, int x=-1, int y=-1, bool sel = true,
2040                 bool control=false, bool shift=false, bool alt=false, bool meta=false);
2041
2042     virtual int GetRow();
2043     virtual int GetCol();
2044     wxPoint     GetPosition();
2045     bool        Selecting();
2046     bool        ControlDown();
2047     bool        MetaDown();
2048     bool        ShiftDown();
2049     bool        AltDown();
2050
2051 };
2052
2053
2054 class  wxGridSizeEvent : public wxNotifyEvent
2055 {
2056 public:
2057     wxGridSizeEvent(int id, wxEventType type, wxGrid* obj,
2058                 int rowOrCol=-1, int x=-1, int y=-1,
2059                 bool control=false, bool shift=false, bool alt=false, bool meta=false);
2060
2061     int         GetRowOrCol();
2062     wxPoint     GetPosition();
2063     bool        ControlDown();
2064     bool        MetaDown();
2065     bool        ShiftDown();
2066     bool        AltDown();
2067
2068 };
2069
2070
2071 class wxGridRangeSelectEvent : public wxNotifyEvent
2072 {
2073 public:
2074     wxGridRangeSelectEvent(int id, wxEventType type, wxGrid* obj,
2075                            const wxGridCellCoords& topLeft,
2076                            const wxGridCellCoords& bottomRight,
2077                            bool sel = true,
2078                            bool control=false, bool shift=false,
2079                            bool alt=false, bool meta=false);
2080
2081     wxGridCellCoords GetTopLeftCoords();
2082     wxGridCellCoords GetBottomRightCoords();
2083     int         GetTopRow();
2084     int         GetBottomRow();
2085     int         GetLeftCol();
2086     int         GetRightCol();
2087     bool        Selecting();
2088     bool        ControlDown();
2089     bool        MetaDown();
2090     bool        ShiftDown();
2091     bool        AltDown();
2092 };
2093
2094
2095 class wxGridEditorCreatedEvent : public wxCommandEvent {
2096 public:
2097     wxGridEditorCreatedEvent(int id, wxEventType type, wxObject* obj,
2098                              int row, int col, wxControl* ctrl);
2099
2100     int GetRow();
2101     int GetCol();
2102     wxControl* GetControl();
2103     void SetRow(int row);
2104     void SetCol(int col);
2105     void SetControl(wxControl* ctrl);
2106 };
2107
2108
2109
2110 %constant wxEventType wxEVT_GRID_CELL_LEFT_CLICK;
2111 %constant wxEventType wxEVT_GRID_CELL_RIGHT_CLICK;
2112 %constant wxEventType wxEVT_GRID_CELL_LEFT_DCLICK;
2113 %constant wxEventType wxEVT_GRID_CELL_RIGHT_DCLICK;
2114 %constant wxEventType wxEVT_GRID_LABEL_LEFT_CLICK;
2115 %constant wxEventType wxEVT_GRID_LABEL_RIGHT_CLICK;
2116 %constant wxEventType wxEVT_GRID_LABEL_LEFT_DCLICK;
2117 %constant wxEventType wxEVT_GRID_LABEL_RIGHT_DCLICK;
2118 %constant wxEventType wxEVT_GRID_ROW_SIZE;
2119 %constant wxEventType wxEVT_GRID_COL_SIZE;
2120 %constant wxEventType wxEVT_GRID_RANGE_SELECT;
2121 %constant wxEventType wxEVT_GRID_CELL_CHANGE;
2122 %constant wxEventType wxEVT_GRID_SELECT_CELL;
2123 %constant wxEventType wxEVT_GRID_EDITOR_SHOWN;
2124 %constant wxEventType wxEVT_GRID_EDITOR_HIDDEN;
2125 %constant wxEventType wxEVT_GRID_EDITOR_CREATED;
2126 %constant wxEventType wxEVT_GRID_CELL_BEGIN_DRAG;
2127
2128
2129
2130 %pythoncode {
2131 EVT_GRID_CELL_LEFT_CLICK = wx.PyEventBinder( wxEVT_GRID_CELL_LEFT_CLICK )
2132 EVT_GRID_CELL_RIGHT_CLICK = wx.PyEventBinder( wxEVT_GRID_CELL_RIGHT_CLICK )
2133 EVT_GRID_CELL_LEFT_DCLICK = wx.PyEventBinder( wxEVT_GRID_CELL_LEFT_DCLICK )
2134 EVT_GRID_CELL_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_GRID_CELL_RIGHT_DCLICK )
2135 EVT_GRID_LABEL_LEFT_CLICK = wx.PyEventBinder( wxEVT_GRID_LABEL_LEFT_CLICK )
2136 EVT_GRID_LABEL_RIGHT_CLICK = wx.PyEventBinder( wxEVT_GRID_LABEL_RIGHT_CLICK )
2137 EVT_GRID_LABEL_LEFT_DCLICK = wx.PyEventBinder( wxEVT_GRID_LABEL_LEFT_DCLICK )
2138 EVT_GRID_LABEL_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_GRID_LABEL_RIGHT_DCLICK )
2139 EVT_GRID_ROW_SIZE = wx.PyEventBinder( wxEVT_GRID_ROW_SIZE )
2140 EVT_GRID_COL_SIZE = wx.PyEventBinder( wxEVT_GRID_COL_SIZE )
2141 EVT_GRID_RANGE_SELECT = wx.PyEventBinder( wxEVT_GRID_RANGE_SELECT )
2142 EVT_GRID_CELL_CHANGE = wx.PyEventBinder( wxEVT_GRID_CELL_CHANGE )
2143 EVT_GRID_SELECT_CELL = wx.PyEventBinder( wxEVT_GRID_SELECT_CELL )
2144 EVT_GRID_EDITOR_SHOWN = wx.PyEventBinder( wxEVT_GRID_EDITOR_SHOWN )
2145 EVT_GRID_EDITOR_HIDDEN = wx.PyEventBinder( wxEVT_GRID_EDITOR_HIDDEN )
2146 EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED )
2147 EVT_GRID_CELL_BEGIN_DRAG = wx.PyEventBinder( wxEVT_GRID_CELL_BEGIN_DRAG )
2148
2149
2150 %# The same as above but with the ability to specify an identifier
2151 EVT_GRID_CMD_CELL_LEFT_CLICK =     wx.PyEventBinder( wxEVT_GRID_CELL_LEFT_CLICK,    1 )
2152 EVT_GRID_CMD_CELL_RIGHT_CLICK =    wx.PyEventBinder( wxEVT_GRID_CELL_RIGHT_CLICK,   1 )
2153 EVT_GRID_CMD_CELL_LEFT_DCLICK =    wx.PyEventBinder( wxEVT_GRID_CELL_LEFT_DCLICK,   1 )
2154 EVT_GRID_CMD_CELL_RIGHT_DCLICK =   wx.PyEventBinder( wxEVT_GRID_CELL_RIGHT_DCLICK,  1 )
2155 EVT_GRID_CMD_LABEL_LEFT_CLICK =    wx.PyEventBinder( wxEVT_GRID_LABEL_LEFT_CLICK,   1 )
2156 EVT_GRID_CMD_LABEL_RIGHT_CLICK =   wx.PyEventBinder( wxEVT_GRID_LABEL_RIGHT_CLICK,  1 )
2157 EVT_GRID_CMD_LABEL_LEFT_DCLICK =   wx.PyEventBinder( wxEVT_GRID_LABEL_LEFT_DCLICK,  1 )
2158 EVT_GRID_CMD_LABEL_RIGHT_DCLICK =  wx.PyEventBinder( wxEVT_GRID_LABEL_RIGHT_DCLICK, 1 )
2159 EVT_GRID_CMD_ROW_SIZE =            wx.PyEventBinder( wxEVT_GRID_ROW_SIZE,           1 )
2160 EVT_GRID_CMD_COL_SIZE =            wx.PyEventBinder( wxEVT_GRID_COL_SIZE,           1 )
2161 EVT_GRID_CMD_RANGE_SELECT =        wx.PyEventBinder( wxEVT_GRID_RANGE_SELECT,       1 )
2162 EVT_GRID_CMD_CELL_CHANGE =         wx.PyEventBinder( wxEVT_GRID_CELL_CHANGE,        1 )
2163 EVT_GRID_CMD_SELECT_CELL =         wx.PyEventBinder( wxEVT_GRID_SELECT_CELL,        1 )
2164 EVT_GRID_CMD_EDITOR_SHOWN =        wx.PyEventBinder( wxEVT_GRID_EDITOR_SHOWN,       1 )
2165 EVT_GRID_CMD_EDITOR_HIDDEN =       wx.PyEventBinder( wxEVT_GRID_EDITOR_HIDDEN,      1 )
2166 EVT_GRID_CMD_EDITOR_CREATED =      wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED,     1 )
2167 EVT_GRID_CMD_CELL_BEGIN_DRAG =     wx.PyEventBinder( wxEVT_GRID_CELL_BEGIN_DRAG,    1 )
2168
2169 }
2170
2171 //---------------------------------------------------------------------------
2172
2173 %init %{
2174 %}
2175
2176 //---------------------------------------------------------------------------
2177 //---------------------------------------------------------------------------
2178