utils/wxPython/src/windows.i

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        windows.i
   3 // Purpose:     SWIG definitions of various window classes
   4 //
   5 // Author:      Robin Dunn
   6 //
   7 // Created:     6/24/97
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 1998 by Total Control Software
  10 // Licence:     wxWindows license
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13
  14 %module windows
  15
  16 %{
  17 #include "helpers.h"
  18 #include <wx/menuitem.h>
  19 %}
  20
  21 //----------------------------------------------------------------------
  22
  23 %include typemaps.i
  24 %include my_typemaps.i
  25
  26 // Import some definitions of other classes, etc.
  27 %import _defs.i
  28 %import misc.i
  29 %import gdi.i
  30 %import clip_dnd.i
  31
  32 %pragma(python) code = "import wx"
  33
  34 //---------------------------------------------------------------------------
  35
  36 class wxEvtHandler {
  37 public:
  38     bool ProcessEvent(wxEvent& event);
  39     //bool SearchEventTable(wxEventTable& table, wxEvent& event);
  40
  41     bool GetEvtHandlerEnabled();
  42     void SetEvtHandlerEnabled(bool enabled);
  43
  44     wxEvtHandler* GetNextHandler();
  45     wxEvtHandler* GetPreviousHandler();
  46     void SetNextHandler(wxEvtHandler* handler);
  47     void SetPreviousHandler(wxEvtHandler* handler);
  48
  49
  50     %addmethods {
  51         void Connect( int id, int lastId, int eventType, PyObject* func) {
  52             if (PyCallable_Check(func)) {
  53                 self->Connect(id, lastId, eventType,
  54                           (wxObjectEventFunction) &wxPyCallback::EventThunker,
  55                           new wxPyCallback(func));
  56             }
  57         }
  58
  59         bool Disconnect(int id, int lastId = -1,
  60                         wxEventType eventType = wxEVT_NULL) {
  61             return self->Disconnect(id, lastId, eventType,
  62                                    (wxObjectEventFunction)
  63                                     &wxPyCallback::EventThunker);
  64         }
  65
  66     }
  67 };
  68
  69
  70 //----------------------------------------------------------------------
  71
  72 class wxValidator : public wxEvtHandler {
  73 public:
  74     wxValidator();
  75     //~wxValidator();
  76
  77     wxValidator* Clone();
  78     wxWindow* GetWindow();
  79     void SetWindow(wxWindow* window);
  80 };
  81
  82 %inline %{
  83     bool wxValidator_IsSilent() {
  84         return wxValidator::IsSilent();
  85     }
  86
  87     void wxValidator_SetBellOnError(int doIt = TRUE) {
  88         wxValidator::SetBellOnError(doIt);
  89     }
  90 %}
  91
  92 //----------------------------------------------------------------------
  93 %{
  94 class wxPyValidator : public wxValidator {
  95     DECLARE_DYNAMIC_CLASS(wxPyValidator);
  96 public:
  97     wxPyValidator() {
  98     }
  99 //    wxPyValidator(const wxPyValidator& other);
 100
 101     ~wxPyValidator() {
 102     }
 103
 104     wxObject* wxPyValidator::Clone() const {
 105         wxPyValidator* ptr = NULL;
 106         wxPyValidator* self = (wxPyValidator*)this;
 107
 108         bool doSave = wxPyRestoreThread();
 109         if (self->m_myInst.findCallback("Clone")) {
 110             PyObject* ro;
 111             ro = self->m_myInst.callCallbackObj(Py_BuildValue("()"));
 112             SWIG_GetPtrObj(ro, (void **)&ptr, "_wxPyValidator_p");
 113         }
 114         // This is very dangerous!!! But is the only way I could find
 115         // to squash a memory leak.  Currently it is okay, but if the
 116         // validator architecture in wxWindows ever changes, problems
 117         // could arise.
 118         delete self;
 119
 120         wxPySaveThread(doSave);
 121         return ptr;
 122     }
 123
 124     DEC_PYCALLBACK_BOOL_WXWIN(Validate);
 125     DEC_PYCALLBACK_BOOL_(TransferToWindow);
 126     DEC_PYCALLBACK_BOOL_(TransferFromWindow);
 127
 128     PYPRIVATE;
 129 //    PyObject*   m_data;
 130 };
 131
 132 IMP_PYCALLBACK_BOOL_WXWIN(wxPyValidator, wxValidator, Validate);
 133 IMP_PYCALLBACK_BOOL_(wxPyValidator, wxValidator, TransferToWindow);
 134 IMP_PYCALLBACK_BOOL_(wxPyValidator, wxValidator, TransferFromWindow);
 135
 136 IMPLEMENT_DYNAMIC_CLASS(wxPyValidator, wxValidator);
 137
 138 %}
 139
 140 class wxPyValidator : public wxValidator {
 141 public:
 142     wxPyValidator();
 143 //    ~wxPyValidator();
 144
 145     %addmethods { void Destroy() { delete self; } }
 146
 147     void _setSelf(PyObject* self, int incref=TRUE);
 148     %pragma(python) addtomethod = "__init__:self._setSelf(self, 0)"
 149
 150 };
 151
 152 //----------------------------------------------------------------------
 153
 154 %apply int * INOUT { int* x, int* y };
 155
 156 class wxWindow : public wxEvtHandler {
 157 public:
 158
 159     wxWindow(wxWindow* parent, const wxWindowID id,
 160              const wxPoint& pos = wxPyDefaultPosition,
 161              const wxSize& size = wxPyDefaultSize,
 162              long style = 0,
 163              char* name = "panel");
 164
 165     %pragma(python) addtomethod = "__init__:wx._StdWindowCallbacks(self)"
 166
 167     void CaptureMouse();
 168     void Center(int direction = wxBOTH);
 169     void Centre(int direction = wxBOTH);
 170     void CentreOnParent(int direction = wxBOTH );
 171     void CenterOnParent(int direction = wxBOTH );
 172
 173     // (uses apply'ed INOUT typemap, see above)
 174     %name(ClientToScreenXY)void ClientToScreen(int* x, int* y);
 175     wxPoint ClientToScreen(const wxPoint& pt);
 176
 177     bool Close(int force = FALSE);
 178     bool Destroy();
 179     void DestroyChildren();
 180 #ifdef __WXMSW__
 181     void DragAcceptFiles(bool accept);
 182 #endif
 183     void Enable(bool enable);
 184     //bool FakePopupMenu(wxMenu* menu, int x, int y);
 185     %name(FindWindowById) wxWindow* FindWindow(long id);
 186     %name(FindWindowByName) wxWindow* FindWindow(const wxString& name);
 187     void Fit();
 188     wxColour GetBackgroundColour();
 189
 190     //wxList& GetChildren();
 191     %addmethods {
 192         PyObject* GetChildren() {
 193             wxWindowList& list = self->GetChildren();
 194             return wxPy_ConvertList(&list, "wxWindow");
 195         }
 196     }
 197
 198     int  GetCharHeight();
 199     int  GetCharWidth();
 200     %name(GetClientSizeTuple) void GetClientSize(int *OUTPUT, int *OUTPUT);
 201     wxSize GetClientSize();
 202     wxLayoutConstraints * GetConstraints();
 203     wxEvtHandler* GetEventHandler();
 204
 205     wxFont& GetFont();
 206     wxColour GetForegroundColour();
 207     wxWindow * GetGrandParent();
 208     %addmethods {
 209         long GetHandle() {
 210             return wxPyGetWinHandle(self); //(long)self->GetHandle();
 211         }
 212     }
 213     int GetId();
 214     wxString GetLabel();
 215     void SetLabel(const wxString& label);
 216     wxString GetName();
 217     wxWindow * GetParent();
 218     %name(GetPositionTuple) void GetPosition(int *OUTPUT, int *OUTPUT);
 219     wxPoint GetPosition();
 220     wxRect GetRect();
 221     int GetScrollThumb(int orientation);
 222     int GetScrollPos(int orientation);
 223     int GetScrollRange(int orientation);
 224     %name(GetSizeTuple) void GetSize(int *OUTPUT, int *OUTPUT);
 225     wxSize GetSize();
 226     void GetTextExtent(const wxString& string, int *OUTPUT, int *OUTPUT);
 227     %name(GetFullTextExtent)void GetTextExtent(const wxString& string,
 228                        int *OUTPUT, int *OUTPUT, int *OUTPUT, int* OUTPUT,
 229                        const wxFont* font = NULL); //, bool use16 = FALSE)
 230     wxString GetTitle();
 231     wxRegion GetUpdateRegion();
 232     long GetWindowStyleFlag();
 233     bool Hide();
 234     void InitDialog();
 235     bool IsEnabled();
 236     bool IsExposed( int x, int y, int w=0, int h=0 );
 237     %name(IsExposedPoint) bool IsExposed( const wxPoint& pt );
 238     %name(IsExposedRect)  bool IsExposed( const wxRect& rect );
 239     bool IsRetained();
 240     bool IsShown();
 241     bool IsTopLevel();
 242     void Layout();
 243     bool LoadFromResource(wxWindow* parent, const wxString& resourceName, const wxResourceTable* resourceTable = NULL);
 244     void Lower();
 245     void MakeModal(bool flag);
 246     %name(MoveXY)void Move(int x, int y);
 247     void Move(const wxPoint& point);
 248
 249     wxEvtHandler* PopEventHandler(bool deleteHandler = FALSE);
 250     void PushEventHandler(wxEvtHandler* handler);
 251
 252     %name(PopupMenuXY)bool PopupMenu(wxMenu *menu, int x, int y);
 253     bool PopupMenu(wxMenu *menu, const wxPoint& pos);
 254
 255     void Raise();
 256     void Refresh(bool eraseBackground = TRUE, const wxRect* rect = NULL);
 257     void ReleaseMouse();
 258     bool Reparent( wxWindow* newParent );
 259
 260     // (uses apply'ed INOUT typemap, see above)
 261     %name(ScreenToClientXY)void ScreenToClient(int *x, int *y);
 262     wxPoint ScreenToClient(const wxPoint& pt);
 263
 264     void ScrollWindow(int dx, int dy, const wxRect* rect = NULL);
 265     void SetAcceleratorTable(const wxAcceleratorTable& accel);
 266     void SetAutoLayout(bool autoLayout);
 267     bool GetAutoLayout();
 268     void SetBackgroundColour(const wxColour& colour);
 269     void SetConstraints(wxLayoutConstraints *constraints);
 270     void UnsetConstraints(wxLayoutConstraints *constraints);
 271     void SetFocus();
 272     bool AcceptsFocus();
 273     void SetFont(const wxFont& font);
 274     void SetForegroundColour(const wxColour& colour);
 275     void SetId(int id);
 276     void SetName(const wxString& name);
 277     void SetScrollbar(int orientation, int position, int thumbSize, int range, int refresh = TRUE);
 278     void SetScrollPos(int orientation, int pos, bool refresh = TRUE);
 279
 280     %name(SetDimensions) void SetSize(int x, int y, int width, int height, int sizeFlags=wxSIZE_AUTO);
 281     %addmethods {
 282         void SetSize(const wxSize& size) {
 283             self->SetSize(size.x, size.y);
 284         }
 285
 286         void SetPosition(const wxPoint& pos) {
 287             self->SetSize(pos.x, pos.y, -1, -1);
 288         }
 289     }
 290
 291     void SetSizeHints(int minW=-1, int minH=-1, int maxW=-1, int maxH=-1, int incW=-1, int incH=-1);
 292     %name(SetClientSizeWH)void SetClientSize(int width, int height);
 293     void SetClientSize(const wxSize& size);
 294     //void SetPalette(wxPalette* palette);
 295     void SetCursor(const wxCursor&cursor);
 296     void SetEventHandler(wxEvtHandler* handler);
 297     void SetTitle(const wxString& title);
 298     bool Show(bool show);
 299     bool TransferDataFromWindow();
 300     bool TransferDataToWindow();
 301     bool Validate();
 302     void WarpPointer(int x, int y);
 303
 304     %name(ConvertDialogPointToPixels) wxPoint ConvertDialogToPixels(const wxPoint& pt);
 305     %name(ConvertDialogSizeToPixels)  wxSize  ConvertDialogToPixels(const wxSize& sz);
 306
 307     %name(DLG_PNT) wxPoint ConvertDialogToPixels(const wxPoint& pt);
 308     %name(DLG_SZE) wxSize  ConvertDialogToPixels(const wxSize& sz);
 309
 310     %name(ConvertPixelPointToDialog) wxPoint ConvertPixelsToDialog(const wxPoint& pt);
 311     %name(ConvertPixelSizeToDialog)  wxSize  ConvertPixelsToDialog(const wxSize& sz);
 312
 313     %name(SetToolTipString)void SetToolTip(const wxString &tip);
 314     void SetToolTip(wxToolTip *tooltip);
 315     wxToolTip* GetToolTip();
 316
 317     void SetSizer(wxSizer* sizer);
 318     wxValidator* GetValidator();
 319     void SetValidator(const wxValidator& validator);
 320
 321     void SetDropTarget(wxDropTarget* target);
 322     wxDropTarget* GetDropTarget();
 323     %pragma(python) addtomethod = "SetDropTarget:_args[0].thisown = 0"
 324
 325     wxSize GetBestSize();
 326 };
 327
 328 //%clear int* x, int* y;
 329
 330
 331
 332 %pragma(python) code = "
 333 def wxDLG_PNT(win, point_or_x, y=None):
 334     if y is None:
 335         return win.ConvertDialogPointToPixels(point_or_x)
 336     else:
 337         return win.ConvertDialogPointToPixels(wxPoint(point_or_x, y))
 338
 339 def wxDLG_SZE(win, size_width, height=None):
 340     if height is None:
 341         return win.ConvertDialogSizeToPixels(size_width)
 342     else:
 343         return win.ConvertDialogSizeToPixels(wxSize(size_width, height))
 344 "
 345
 346 #ifdef __WXMSW__
 347 %inline %{
 348     wxWindow* wxWindow_FindFocus() {
 349         return wxWindow::FindFocus();
 350     }
 351 %}
 352
 353
 354 %inline %{
 355 wxWindow* wxWindow_FromHWND(unsigned long hWnd) {
 356     wxWindow* win = new wxWindow;
 357     win->SetHWND(hWnd);
 358     win->SubclassWin(hWnd);
 359     return win;
 360 }
 361 %}
 362 #endif
 363
 364
 365
 366 //---------------------------------------------------------------------------
 367
 368 class wxPanel : public wxWindow {
 369 public:
 370     wxPanel(wxWindow* parent,
 371             const wxWindowID id,
 372             const wxPoint& pos = wxPyDefaultPosition,
 373             const wxSize& size = wxPyDefaultSize,
 374             long style = wxTAB_TRAVERSAL,
 375             const char* name = "panel");
 376
 377     %pragma(python) addtomethod = "__init__:wx._StdWindowCallbacks(self)"
 378
 379     void InitDialog();
 380     wxButton* GetDefaultItem();
 381     void SetDefaultItem(wxButton *btn);
 382
 383     // fix some SWIG trouble...
 384     %pragma(python) addtoclass = "
 385     def GetDefaultItem(self):
 386         import controls
 387         val = windowsc.wxPanel_GetDefaultItem(self.this)
 388         val = controls.wxButtonPtr(val)
 389         return val
 390 "
 391 };
 392
 393 //---------------------------------------------------------------------------
 394
 395 class wxDialog : public wxPanel {
 396 public:
 397     wxDialog(wxWindow* parent,
 398              const wxWindowID id,
 399              const wxString& title,
 400              const wxPoint& pos = wxPyDefaultPosition,
 401              const wxSize& size = wxPyDefaultSize,
 402              long style = wxDEFAULT_DIALOG_STYLE,
 403              const char* name = "dialogBox");
 404
 405     %pragma(python) addtomethod = "__init__:wx._StdDialogCallbacks(self)"
 406
 407     void Centre(int direction = wxBOTH);
 408     void EndModal(int retCode);
 409     wxString GetTitle();
 410     void Iconize(bool iconize);
 411     bool IsIconized();
 412     void SetModal(bool flag);
 413     bool IsModal();
 414     void SetTitle(const wxString& title);
 415     bool Show(bool show);
 416     int ShowModal();
 417
 418     int  GetReturnCode();
 419     void SetReturnCode(int retCode);
 420 };
 421
 422 //---------------------------------------------------------------------------
 423
 424 class wxScrolledWindow : public wxPanel {
 425 public:
 426     wxScrolledWindow(wxWindow* parent,
 427                      const wxWindowID id = -1,
 428                      const wxPoint& pos = wxPyDefaultPosition,
 429                      const wxSize& size = wxPyDefaultSize,
 430                      long style = wxHSCROLL | wxVSCROLL,
 431                      char* name = "scrolledWindow");
 432
 433     %pragma(python) addtomethod = "__init__:wx._StdWindowCallbacks(self)"
 434     %pragma(python) addtomethod = "__init__:wx._StdOnScrollCallbacks(self)"
 435
 436     void EnableScrolling(bool xScrolling, bool yScrolling);
 437     void GetScrollPixelsPerUnit(int* OUTPUT, int* OUTPUT);
 438     void GetVirtualSize(int* OUTPUT, int* OUTPUT);
 439     bool IsRetained();
 440     void PrepareDC(wxDC& dc);
 441     void Scroll(int x, int y);
 442     void SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY,
 443                        int noUnitsX, int noUnitsY,
 444                        int xPos = 0, int yPos = 0);
 445     void SetTargetWindow(wxWindow* window);
 446     void ViewStart(int* OUTPUT, int* OUTPUT);
 447
 448     void CalcScrolledPosition( int x, int y, int *OUTPUT, int *OUTPUT);
 449     void CalcUnscrolledPosition( int x, int y, int *OUTPUT, int *OUTPUT);
 450
 451 };
 452
 453 //----------------------------------------------------------------------
 454
 455
 456 class wxMenu : public wxEvtHandler {
 457 public:
 458     wxMenu(const wxString& title = wxPyEmptyStr, long style = 0);
 459
 460     void Append(int id, const wxString& item,
 461                 const wxString& helpString = wxPyEmptyStr,
 462                 int checkable = FALSE);
 463     %name(AppendMenu)void Append(int id, const wxString& item, wxMenu *subMenu,
 464                 const wxString& helpString = wxPyEmptyStr);
 465     %name(AppendItem)void Append(const wxMenuItem* item);
 466
 467     void AppendSeparator();
 468     void Break();
 469     void Check(int id, bool flag);
 470     bool IsChecked(int id);
 471     void Enable(int id, bool enable);
 472     bool IsEnabled(int id);
 473
 474     int FindItem(const wxString& itemString);
 475     %name(FindItemById)wxMenuItem* FindItem(int id/*, wxMenu **menu = NULL*/);
 476
 477     wxString GetTitle();
 478     void SetTitle(const wxString& title);
 479
 480     wxString GetLabel(int id);
 481     void SetLabel(int id, const wxString& label);
 482
 483     wxString GetHelpString(int id);
 484     void SetHelpString(int id, const wxString& helpString);
 485     void UpdateUI(wxEvtHandler* source = NULL);
 486
 487     bool Delete(int id);
 488     %name(DeleteItem)bool Delete(wxMenuItem *item);
 489     bool Insert(size_t pos, wxMenuItem *item);
 490     wxMenuItem *Remove(int id);
 491     %name(RemoveItem) wxMenuItem *Remove(wxMenuItem *item);
 492
 493     %addmethods {
 494         void Destroy() { delete self; }
 495     }
 496     %name(DestroyId)bool Destroy(int id);
 497     %name(DestroyItem)bool Destroy(wxMenuItem *item);
 498
 499     size_t GetMenuItemCount();
 500     //wxMenuItemList& GetMenuItems();
 501     %addmethods {
 502         PyObject* GetMenuItems() {
 503             wxMenuItemList& list = self->GetMenuItems();
 504             return wxPy_ConvertList(&list, "wxMenuItem");
 505         }
 506     }
 507
 508     void SetEventHandler(wxEvtHandler *handler);
 509     wxEvtHandler *GetEventHandler();
 510
 511     void SetInvokingWindow(wxWindow *win);
 512     wxWindow *GetInvokingWindow();
 513
 514     long GetStyle();
 515
 516     bool IsAttached();
 517
 518     void SetParent(wxMenu *parent);
 519     wxMenu *GetParent();
 520 };
 521
 522
 523 //----------------------------------------------------------------------
 524
 525 class wxMenuBar : public wxWindow {
 526 public:
 527     wxMenuBar();
 528
 529     bool Append(wxMenu *menu, const wxString& title);
 530     bool Insert(size_t pos, wxMenu *menu, const wxString& title);
 531     size_t GetMenuCount();
 532     wxMenu *GetMenu(size_t pos);
 533     wxMenu *Replace(size_t pos, wxMenu *menu, const wxString& title);
 534     wxMenu *Remove(size_t pos);
 535     void EnableTop(size_t pos, bool enable);
 536     void SetLabelTop(size_t pos, const wxString& label);
 537     wxString GetLabelTop(size_t pos);
 538     int FindMenuItem(const wxString& menuString, const wxString& itemString);
 539     %name(FindItemById)wxMenuItem* FindItem(int id/*, wxMenu **menu = NULL*/);
 540     void Enable(int id, bool enable);
 541     void Check(int id, bool check);
 542     bool IsChecked(int id);
 543     bool IsEnabled(int id);
 544
 545     void SetLabel(int id, const wxString &label);
 546     wxString GetLabel(int id);
 547
 548     void SetHelpString(int id, const wxString& helpString);
 549     wxString GetHelpString(int id);
 550
 551 };
 552
 553
 554 //----------------------------------------------------------------------
 555
 556 class wxMenuItem {
 557 public:
 558     wxMenuItem(wxMenu* parentMenu=NULL, int id=ID_SEPARATOR,
 559                const wxString& text = wxPyEmptyStr,
 560                const wxString& help = wxPyEmptyStr,
 561                bool isCheckable = FALSE, wxMenu* subMenu = NULL);
 562
 563
 564     wxMenu *GetMenu();
 565     void SetId(int id);
 566     int  GetId();
 567     bool IsSeparator();
 568     void SetText(const wxString& str);
 569     wxString GetLabel();
 570     const wxString& GetText();
 571     void SetCheckable(bool checkable);
 572     bool IsCheckable();
 573     bool IsSubMenu();
 574     void SetSubMenu(wxMenu *menu);
 575     wxMenu *GetSubMenu();
 576     void Enable(bool enable = TRUE);
 577     bool IsEnabled();
 578     void Check(bool check = TRUE);
 579     bool IsChecked();
 580     void Toggle();
 581     void SetHelp(const wxString& str);
 582     const wxString& GetHelp();
 583     wxAcceleratorEntry *GetAccel();
 584     void SetAccel(wxAcceleratorEntry *accel);
 585
 586 };
 587
 588 //---------------------------------------------------------------------------
 589
 590
 591