wxPython/src/misc.i

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        misc.i
   3 // Purpose:     Definitions of miscelaneous functions and classes
   4 //
   5 // Author:      Robin Dunn
   6 //
   7 // Created:     7/3/97
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 1998 by Total Control Software
  10 // Licence:     wxWindows license
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 %module misc
  14
  15 %{
  16 #include "helpers.h"
  17 #include <wx/resource.h>
  18 #include <wx/tooltip.h>
  19 #include <wx/busyinfo.h>
  20 %}
  21
  22 //----------------------------------------------------------------------
  23
  24 %include typemaps.i
  25 %include my_typemaps.i
  26
  27 // Import some definitions of other classes, etc.
  28 %import _defs.i
  29
  30
  31 %{
  32     static wxString wxPyEmptyStr("");
  33 %}
  34
  35 //---------------------------------------------------------------------------
  36
  37
  38 class wxSize {
  39 public:
  40     long x;
  41     long y;
  42     %name(width) long x;
  43     %name(height)long y;
  44
  45     wxSize(long w=0, long h=0);
  46     ~wxSize();
  47     void Set(long w, long h);
  48     long GetX();
  49     long GetY();
  50     long GetWidth();
  51     long GetHeight();
  52     void SetWidth(long w);
  53     void SetHeight(long h);
  54
  55     %addmethods {
  56         PyObject* asTuple() {
  57             PyObject* tup = PyTuple_New(2);
  58             PyTuple_SET_ITEM(tup, 0, PyInt_FromLong(self->x));
  59             PyTuple_SET_ITEM(tup, 1, PyInt_FromLong(self->y));
  60             return tup;
  61         }
  62     }
  63
  64     %pragma(python) addtoclass = "
  65     def __str__(self):                   return str(self.asTuple())
  66     def __repr__(self):                  return str(self.asTuple())
  67     def __len__(self):                   return len(self.asTuple())
  68     def __getitem__(self, index):        return self.asTuple()[index]
  69     def __setitem__(self, index, val):
  70         if index == 0: self.width = val
  71         elif index == 1: self.height = val
  72         else: raise IndexError
  73 "
  74
  75 };
  76
  77 //---------------------------------------------------------------------------
  78
  79 class wxRealPoint {
  80 public:
  81     double x;
  82     double y;
  83     wxRealPoint(double x=0.0, double y=0.0);
  84     ~wxRealPoint();
  85
  86     %addmethods {
  87         void Set(double x, double y) {
  88             self->x = x;
  89             self->y = y;
  90         }
  91         PyObject* asTuple() {
  92             PyObject* tup = PyTuple_New(2);
  93             PyTuple_SET_ITEM(tup, 0, PyFloat_FromDouble(self->x));
  94             PyTuple_SET_ITEM(tup, 1, PyFloat_FromDouble(self->y));
  95             return tup;
  96         }
  97
  98         wxRealPoint __add__(const wxRealPoint* p) {
  99             if (! p) return *self;
 100             return *self + *p;
 101         }
 102
 103         wxRealPoint __sub__(const wxRealPoint* p) {
 104             if (! p) return *self;
 105             return *self - *p;
 106         }
 107
 108         int __cmp__(const wxRealPoint* p) {
 109             if (! p) return 0;
 110             return *self == *p;
 111         }
 112     }
 113     %pragma(python) addtoclass = "
 114     def __str__(self):                   return str(self.asTuple())
 115     def __repr__(self):                  return str(self.asTuple())
 116     def __len__(self):                   return len(self.asTuple())
 117     def __getitem__(self, index):        return self.asTuple()[index]
 118     def __setitem__(self, index, val):
 119         if index == 0: self.width = val
 120         elif index == 1: self.height = val
 121         else: raise IndexError
 122 "
 123 };
 124
 125
 126 class wxPoint {
 127 public:
 128     long x;
 129     long y;
 130     wxPoint(long x=0, long y=0);
 131     ~wxPoint();
 132
 133     %addmethods {
 134         void Set(long x, long y) {
 135             self->x = x;
 136             self->y = y;
 137         }
 138         PyObject* asTuple() {
 139             PyObject* tup = PyTuple_New(2);
 140             PyTuple_SET_ITEM(tup, 0, PyInt_FromLong(self->x));
 141             PyTuple_SET_ITEM(tup, 1, PyInt_FromLong(self->y));
 142             return tup;
 143         }
 144
 145         wxPoint __add__(const wxPoint* p) {
 146             if (! p) return *self;
 147             return *self + *p;
 148         }
 149
 150         wxPoint __sub__(const wxPoint* p) {
 151             if (! p) return *self;
 152             return *self - *p;
 153         }
 154
 155         int __cmp__(const wxPoint* p) {
 156             if (! p) return 0;
 157             return *self == *p;
 158         }
 159     }
 160     %pragma(python) addtoclass = "
 161     def __str__(self):                   return str(self.asTuple())
 162     def __repr__(self):                  return str(self.asTuple())
 163     def __len__(self):                   return len(self.asTuple())
 164     def __getitem__(self, index):        return self.asTuple()[index]
 165     def __setitem__(self, index, val):
 166         if index == 0: self.x = val
 167         elif index == 1: self.y = val
 168         else: raise IndexError
 169 "
 170 };
 171
 172 //---------------------------------------------------------------------------
 173
 174 class wxRect {
 175 public:
 176     wxRect(int x=0, int y=0, int w=0, int h=0);
 177     // TODO: do this one too... wxRect(const wxPoint& pos, const wxSize& size);
 178     ~wxRect();
 179
 180     int  GetX();
 181     void SetX(int X);
 182     int  GetY();
 183     void SetY(int Y);
 184     int  GetWidth();
 185     void SetWidth(int w);
 186     int  GetHeight();
 187     void SetHeight(int h);
 188
 189
 190     wxPoint GetPosition();
 191     wxSize GetSize();
 192
 193     int  GetLeft();
 194     int  GetTop();
 195     int  GetBottom();
 196     int  GetRight();
 197
 198     void SetLeft(int left);
 199     void SetRight(int right);
 200     void SetTop(int top);
 201     void SetBottom(int bottom);
 202
 203     void Inflate(int dx, int dy);
 204     bool Inside(int cx, int cy);
 205
 206     int x, y, width, height;
 207
 208     %addmethods {
 209         PyObject* asTuple() {
 210             PyObject* tup = PyTuple_New(4);
 211             PyTuple_SET_ITEM(tup, 0, PyInt_FromLong(self->x));
 212             PyTuple_SET_ITEM(tup, 1, PyInt_FromLong(self->y));
 213             PyTuple_SET_ITEM(tup, 2, PyInt_FromLong(self->width));
 214             PyTuple_SET_ITEM(tup, 3, PyInt_FromLong(self->height));
 215             return tup;
 216         }
 217
 218         wxRect __add__(const wxRect* rect) {
 219             if (! rect) return *self;
 220             return *self + *rect;
 221         }
 222
 223         int __cmp__(const wxRect* rect) {
 224             if (! rect) return 0;
 225             return *self == *rect;
 226         }
 227     }
 228
 229     %pragma(python) addtoclass = "
 230     def __str__(self):                   return str(self.asTuple())
 231     def __repr__(self):                  return str(self.asTuple())
 232     def __len__(self):                   return len(self.asTuple())
 233     def __getitem__(self, index):        return self.asTuple()[index]
 234     def __setitem__(self, index, val):
 235         if index == 0: self.x = val
 236         elif index == 1: self.y = val
 237         elif index == 2: self.width = val
 238         elif index == 3: self.height = val
 239         else: raise IndexError
 240
 241     # override the __getattr__ made by SWIG
 242     def __getattr__(self, name):
 243         d = {
 244             'x' : miscc.wxRect_x_get,
 245             'y' : miscc.wxRect_y_get,
 246             'width' : miscc.wxRect_width_get,
 247             'height' : miscc.wxRect_height_get,
 248             'top' : miscc.wxRect_GetTop,
 249             'bottom' : miscc.wxRect_GetBottom,
 250             'left' : miscc.wxRect_GetLeft,
 251             'right' : miscc.wxRect_GetRight,
 252             }
 253         try:
 254             func = d[name]
 255         except KeyError:
 256             raise AttributeError,name
 257         return func(self)
 258
 259     # and also the __setattr__
 260     def __setattr__(self, name, value):
 261         d = {
 262             'x' : miscc.wxRect_x_set,
 263             'y' : miscc.wxRect_y_set,
 264             'width' : miscc.wxRect_width_set,
 265             'height' : miscc.wxRect_height_set,
 266             'top' : miscc.wxRect_SetTop,
 267             'bottom' : miscc.wxRect_SetBottom,
 268             'left' : miscc.wxRect_SetLeft,
 269             'right' : miscc.wxRect_SetRight,
 270             }
 271         try:
 272             func = d[name]
 273         except KeyError:
 274             self.__dict__[name] = value
 275             return
 276         func(self, value)
 277     "
 278
 279 };
 280
 281
 282 %inline %{
 283     PyObject* wxIntersectRect(wxRect* r1, wxRect* r2) {
 284         wxRegion  reg1(*r1);
 285         wxRegion  reg2(*r2);
 286         wxRect    dest(0,0,0,0);
 287         PyObject* obj;
 288
 289         reg1.Intersect(reg2);
 290         dest = reg1.GetBox();
 291
 292         if (dest != wxRect(0,0,0,0)) {
 293             bool doSave = wxPyRestoreThread();
 294             wxRect* newRect = new wxRect(dest);
 295             obj = wxPyConstructObject((void*)newRect, "wxRect");
 296             PyObject* one = PyInt_FromLong(1);
 297             PyObject_SetAttrString(obj, "thisown", one);
 298             Py_DECREF(one);
 299             wxPySaveThread(doSave);
 300             return obj;
 301         }
 302         Py_INCREF(Py_None);
 303         return Py_None;
 304     }
 305 %}
 306
 307
 308 //---------------------------------------------------------------------------
 309 // Miscellaneous functions
 310
 311 long wxNewId();
 312 void wxRegisterId(long id);
 313 %name(NewId) long wxNewId();
 314 %name(RegisterId) void wxRegisterId(long id);
 315
 316 void wxBell();
 317 void wxDisplaySize(int *OUTPUT, int *OUTPUT);
 318 void wxEndBusyCursor();
 319
 320 long wxGetElapsedTime(bool resetTimer = TRUE);
 321 #ifdef __WXMSW__
 322 long wxGetFreeMemory();
 323 #endif
 324 void wxGetMousePosition(int* OUTPUT, int* OUTPUT);
 325 bool wxIsBusy();
 326 wxString wxNow();
 327 bool wxShell(const wxString& command = wxPyEmptyStr);
 328 void wxStartTimer();
 329 int wxGetOsVersion(int *OUTPUT, int *OUTPUT);
 330 wxString wxGetOsDescription();
 331
 332 void wxSleep(int secs);
 333 void wxUsleep(unsigned long milliseconds);
 334 bool wxYield();
 335 void wxEnableTopLevelWindows(bool enable);
 336
 337 %inline %{
 338     char* wxGetResource(char *section, char *entry, char *file = NULL) {
 339         char * retval;
 340         wxGetResource(section, entry, &retval, file);
 341         return retval;
 342     }
 343 %}
 344
 345 wxString wxStripMenuCodes(const wxString& in);
 346
 347
 348 wxString wxGetEmailAddress();
 349 wxString wxGetHostName();
 350 wxString wxGetFullHostName();
 351 wxString wxGetUserId();
 352 wxString wxGetUserName();
 353 wxString wxGetHomeDir();
 354
 355
 356 //----------------------------------------------------------------------
 357
 358 enum wxEdge { wxLeft, wxTop, wxRight, wxBottom, wxWidth, wxHeight,
 359               wxCentre, wxCenter = wxCentre, wxCentreX, wxCentreY };
 360 enum wxRelationship { wxUnconstrained = 0,
 361                       wxAsIs,
 362                       wxPercentOf,
 363                       wxAbove,
 364                       wxBelow,
 365                       wxLeftOf,
 366                       wxRightOf,
 367                       wxSameAs,
 368                       wxAbsolute };
 369
 370
 371 class wxIndividualLayoutConstraint {
 372 public:
 373 //    wxIndividualLayoutConstraint();
 374 //    ~wxIndividualLayoutConstraint();
 375
 376     void Above(wxWindow *otherWin, int margin=0);
 377     void Absolute(int value);
 378     void AsIs();
 379     void Below(wxWindow *otherWin, int margin=0);
 380     void Unconstrained();
 381     void LeftOf(wxWindow *otherWin, int margin=0);
 382     void PercentOf(wxWindow *otherWin, wxEdge edge, int percent);
 383     void RightOf(wxWindow *otherWin, int margin=0);
 384     void SameAs(wxWindow *otherWin, wxEdge edge, int margin=0);
 385     void Set(wxRelationship rel, wxWindow *otherWin, wxEdge otherEdge, int value=0, int margin=0);
 386 };
 387
 388
 389 class wxLayoutConstraints {
 390 public:
 391     wxLayoutConstraints();
 392
 393 %readonly
 394     wxIndividualLayoutConstraint bottom;
 395     wxIndividualLayoutConstraint centreX;
 396     wxIndividualLayoutConstraint centreY;
 397     wxIndividualLayoutConstraint height;
 398     wxIndividualLayoutConstraint left;
 399     wxIndividualLayoutConstraint right;
 400     wxIndividualLayoutConstraint top;
 401     wxIndividualLayoutConstraint width;
 402 %readwrite
 403 }
 404
 405
 406 //---------------------------------------------------------------------------
 407 // Regions, etc.
 408
 409 enum wxRegionContain {
 410         wxOutRegion, wxPartRegion, wxInRegion
 411 };
 412
 413
 414 class wxRegion {
 415 public:
 416     wxRegion(long x=0, long y=0, long width=0, long height=0);
 417     ~wxRegion();
 418
 419     void Clear();
 420     wxRegionContain Contains(long x, long y);
 421     %name(ContainsPoint)wxRegionContain Contains(const wxPoint& pt);
 422     %name(ContainsRect)wxRegionContain Contains(const wxRect& rect);
 423     %name(ContainsRectDim)wxRegionContain Contains(long x, long y, long w, long h);
 424
 425     wxRect GetBox();
 426
 427     bool Intersect(long x, long y, long width, long height);
 428     %name(IntersectRect)bool Intersect(const wxRect& rect);
 429     %name(IntersectRegion)bool Intersect(const wxRegion& region);
 430
 431     bool IsEmpty();
 432
 433     bool Union(long x, long y, long width, long height);
 434     %name(UnionRect)bool Union(const wxRect& rect);
 435     %name(UnionRegion)bool Union(const wxRegion& region);
 436
 437     bool Subtract(long x, long y, long width, long height);
 438     %name(SubtractRect)bool Subtract(const wxRect& rect);
 439     %name(SubtractRegion)bool Subtract(const wxRegion& region);
 440
 441     bool Xor(long x, long y, long width, long height);
 442     %name(XorRect)bool Xor(const wxRect& rect);
 443     %name(XorRegion)bool Xor(const wxRegion& region);
 444 };
 445
 446
 447
 448 class wxRegionIterator {
 449 public:
 450     wxRegionIterator(const wxRegion& region);
 451     ~wxRegionIterator();
 452
 453     long GetX();
 454     long GetY();
 455     long GetW();
 456     long GetWidth();
 457     long GetH();
 458     long GetHeight();
 459     wxRect GetRect();
 460     bool HaveRects();
 461     void Reset();
 462
 463     %addmethods {
 464         void Next() {
 465             (*self) ++;
 466         }
 467     };
 468 };
 469
 470
 471
 472 //---------------------------------------------------------------------------
 473 // Accelerator Entry and Table
 474
 475 class wxAcceleratorEntry {
 476 public:
 477     wxAcceleratorEntry(int flags = 0, int keyCode = 0, int cmd = 0);
 478     ~wxAcceleratorEntry();
 479
 480     void Set(int flags, int keyCode, int Cmd);
 481     int GetFlags();
 482     int GetKeyCode();
 483     int GetCommand();
 484 };
 485
 486
 487 class wxAcceleratorTable {
 488 public:
 489     // Can also accept a list of 3-tuples
 490     wxAcceleratorTable(int LCOUNT, wxAcceleratorEntry* choices);
 491     ~wxAcceleratorTable();
 492
 493 };
 494
 495 wxAcceleratorEntry *wxGetAccelFromString(const wxString& label);
 496
 497 %readonly
 498 %{
 499 #if 0  // we want to use the definition from the header, not the
 500        // one SWIG will generate.
 501 %}
 502 extern wxAcceleratorTable wxNullAcceleratorTable;
 503 %{
 504 #endif
 505 %}
 506 %readwrite
 507
 508 //---------------------------------------------------------------------------
 509
 510 class wxBusyInfo {
 511 public:
 512     wxBusyInfo(const wxString& message);
 513     ~wxBusyInfo();
 514 };
 515
 516 //---------------------------------------------------------------------------
 517
 518
 519