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
  31 %pragma(python) code = "import wx"
  32
  33 //---------------------------------------------------------------------------
  34
  35 class wxEvtHandler {
  36 public:
  37     bool ProcessEvent(wxEvent& event);
  38     %addmethods {
  39         void Connect( int id, int lastId, int eventType, PyObject* func) {
  40             if (PyCallable_Check(func)) {
  41                 self->Connect(id, lastId, eventType,
  42                           (wxObjectEventFunction) &wxPyCallback::EventThunker,
  43                           new wxPyCallback(func));
  44             }
  45         }
  46     }
  47 };
  48
  49
  50 //----------------------------------------------------------------------
  51
  52
  53 class wxWindow : public wxEvtHandler {
  54 public:
  55
  56     wxWindow(wxWindow* parent, const wxWindowID id,
  57              const wxPoint& pos = wxPyDefaultPosition,
  58              const wxSize& size = wxPyDefaultSize,
  59              long style = 0,
  60              char* name = "panel");
  61
  62     %pragma(python) addtomethod = "__init__:wx._StdWindowCallbacks(self)"
  63
  64     void CaptureMouse();
  65     void Center(int direction = wxHORIZONTAL);
  66     void Centre(int direction = wxHORIZONTAL);
  67     %name(ClientToScreenXY)void ClientToScreen(int *BOTH, int *BOTH);
  68 #ifndef __WXGTK__
  69     wxPoint ClientToScreen(const wxPoint& pt);
  70 #endif
  71     bool Close(int force = FALSE);
  72     bool Destroy();
  73     void DestroyChildren();
  74 #ifdef __WXMSW__
  75     void DragAcceptFiles(bool accept);
  76 #endif
  77     void Enable(bool enable);
  78     //bool FakePopupMenu(wxMenu* menu, int x, int y);
  79     %name(FindWindowById) wxWindow* FindWindow(long id);
  80     %name(FindWindowByName) wxWindow* FindWindow(const wxString& name);
  81     void Fit();
  82     wxColour GetBackgroundColour();
  83     int  GetCharHeight();
  84     int  GetCharWidth();
  85     %name(GetClientSizeTuple) void GetClientSize(int *OUTPUT, int *OUTPUT);
  86     wxSize GetClientSize();
  87     wxLayoutConstraints * GetConstraints();
  88 #ifdef __WXMSW__
  89     wxButton* GetDefaultItem();
  90 #endif
  91     //wxEvtHandler* GetEventHandler();
  92
  93     wxFont& GetFont();
  94     wxColour GetForegroundColour();
  95     wxWindow * GetGrandParent();
  96     int GetId();
  97     wxString GetLabel();
  98     wxString GetName();
  99     wxWindow * GetParent();
 100     %name(GetPositionTuple) void GetPosition(int *OUTPUT, int *OUTPUT);
 101     wxPoint GetPosition();
 102     wxRect GetRect();
 103     int GetScrollThumb(int orientation);
 104     int GetScrollPos(int orientation);
 105     int GetScrollRange(int orientation);
 106     %name(GetSizeTuple) void GetSize(int *OUTPUT, int *OUTPUT);
 107     wxSize GetSize();
 108     void GetTextExtent(const wxString& string, int *OUTPUT, int *OUTPUT);
 109     %name(GetFullTextExtent)void GetTextExtent(const wxString& string,
 110                        int *OUTPUT, int *OUTPUT, int *OUTPUT, int* OUTPUT,
 111                        const wxFont* font = NULL); //, bool use16 = FALSE)
 112     wxString GetTitle();
 113     long GetWindowStyleFlag();
 114     void InitDialog();
 115     bool IsEnabled();
 116     bool IsRetained();
 117     bool IsShown();
 118     void Layout();
 119     bool LoadFromResource(wxWindow* parent, const wxString& resourceName, const wxResourceTable* resourceTable = NULL);
 120     void Lower();
 121     void MakeModal(bool flag);
 122     %name(MoveXY)void Move(int x, int y);
 123     void Move(const wxPoint& point);
 124
 125     //wxEvtHandler* PopEventHandler(bool deleteHandler = FALSE);
 126     bool PopupMenu(wxMenu *menu, int x, int y);
 127     //void PushEventHandler(wxEvtHandler* handler);
 128
 129     void Raise();
 130     void Refresh(bool eraseBackground = TRUE, const wxRect* rect = NULL);
 131     void ReleaseMouse();
 132     %name(ScreenToClientXY)void ScreenToClient(int *BOTH, int *BOTH);
 133 #ifndef __WXGTK__
 134     wxPoint ScreenToClient(const wxPoint& pt);
 135 #endif
 136
 137     void ScrollWindow(int dx, int dy, const wxRect* rect = NULL);
 138     void SetAcceleratorTable(const wxAcceleratorTable& accel);
 139     void SetAutoLayout(bool autoLayout);
 140     void SetBackgroundColour(const wxColour& colour);
 141     void SetConstraints(wxLayoutConstraints *constraints);
 142 //    void SetDoubleClick(bool allowDoubleClick);
 143     void SetFocus();
 144     void SetFont(const wxFont& font);
 145     void SetForegroundColour(const wxColour& colour);
 146     void SetId(int id);
 147     void SetName(const wxString& name);
 148     void SetScrollbar(int orientation, int position, int thumbSize, int range, bool refresh = TRUE);
 149     void SetScrollPos(int orientation, int pos, bool refresh = TRUE);
 150
 151     %name(SetDimensions) void SetSize(int x, int y, int width, int height, int sizeFlags=wxSIZE_AUTO);
 152     %addmethods {
 153         void SetSize(const wxSize& size) {
 154             self->SetSize(size.x, size.y);
 155         }
 156
 157         void SetPosition(const wxPoint& pos) {
 158             self->SetSize(pos.x, pos.y, -1, -1);
 159         }
 160     }
 161
 162     void SetSizeHints(int minW=-1, int minH=-1, int maxW=-1, int maxH=-1, int incW=-1, int incH=-1);
 163     %name(SetClientSizeWH)void SetClientSize(int width, int height);
 164     void SetClientSize(const wxSize& size);
 165     //void SetPalette(wxPalette* palette);
 166     void SetCursor(const wxCursor&cursor);
 167     //void SetEventHandler(wxEvtHandler* handler);
 168     void SetTitle(const wxString& title);
 169     bool Show(bool show);
 170     bool TransferDataFromWindow();
 171     bool TransferDataToWindow();
 172     bool Validate();
 173     void WarpPointer(int x, int y);
 174
 175     %name(ConvertDialogPointToPixels) wxPoint ConvertDialogToPixels(const wxPoint& pt);
 176     %name(ConvertDialogSizeToPixels)  wxSize  ConvertDialogToPixels(const wxSize& sz);
 177
 178     %name(DLG_PNT) wxPoint ConvertDialogToPixels(const wxPoint& pt);
 179     %name(DLG_SZE) wxSize  ConvertDialogToPixels(const wxSize& sz);
 180
 181     %name(ConvertPixelPointToDialog) wxPoint ConvertPixelsToDialog(const wxPoint& pt);
 182     %name(ConvertPixelSizeToDialog)  wxSize  ConvertPixelsToDialog(const wxSize& sz);
 183
 184     %name(SetToolTipString)void SetToolTip(const wxString &tip);
 185     void SetToolTip(wxToolTip *tooltip);
 186     wxToolTip* GetToolTip();
 187 };
 188
 189 %pragma(python) code = "
 190 def wxDLG_PNT(win, point):
 191     return win.ConvertDialogPointToPixels(point)
 192
 193 def wxDLG_SZE(win, size):
 194     return win.ConvertDialogSizeToPixels(size)
 195 "
 196
 197 #ifdef __WXMSW__
 198 %inline %{
 199     wxWindow* wxWindow_FindFocus() {
 200         return wxWindow::FindFocus();
 201     }
 202 %}
 203
 204
 205 %inline %{
 206 wxWindow* wxWindow_FromHWND(unsigned long hWnd) {
 207     wxWindow* win = new wxWindow;
 208     win->SetHWND(hWnd);
 209     win->SubclassWin(hWnd);
 210     return win;
 211 }
 212 %}
 213 #endif
 214
 215
 216 //---------------------------------------------------------------------------
 217
 218 class wxPanel : public wxWindow {
 219 public:
 220     wxPanel(wxWindow* parent,
 221             const wxWindowID id,
 222             const wxPoint& pos = wxPyDefaultPosition,
 223             const wxSize& size = wxPyDefaultSize,
 224             long style = wxTAB_TRAVERSAL,
 225             const char* name = "panel");
 226
 227     %pragma(python) addtomethod = "__init__:wx._StdWindowCallbacks(self)"
 228
 229     void InitDialog();
 230
 231 };
 232
 233 //---------------------------------------------------------------------------
 234
 235 class wxDialog : public wxPanel {
 236 public:
 237     wxDialog(wxWindow* parent,
 238              const wxWindowID id,
 239              const wxString& title,
 240              const wxPoint& pos = wxPyDefaultPosition,
 241              const wxSize& size = wxPyDefaultSize,
 242              long style = wxDEFAULT_DIALOG_STYLE,
 243              const char* name = "dialogBox");
 244
 245     %pragma(python) addtomethod = "__init__:wx._StdDialogCallbacks(self)"
 246
 247     void Centre(int direction = wxBOTH);
 248     void EndModal(int retCode);
 249     wxString GetTitle();
 250     void Iconize(bool iconize);
 251     bool IsIconized();
 252     void SetModal(bool flag);
 253     bool IsModal();
 254     void SetTitle(const wxString& title);
 255     bool Show(bool show);
 256     int ShowModal();
 257
 258     int  GetReturnCode();
 259     void SetReturnCode(int retCode);
 260 };
 261
 262 //---------------------------------------------------------------------------
 263
 264 class wxScrolledWindow : public wxWindow {
 265 public:
 266     wxScrolledWindow(wxWindow* parent,
 267                      const wxWindowID id = -1,
 268                      const wxPoint& pos = wxPyDefaultPosition,
 269                      const wxSize& size = wxPyDefaultSize,
 270                      long style = wxHSCROLL | wxVSCROLL,
 271                      char* name = "scrolledWindow");
 272
 273     %pragma(python) addtomethod = "__init__:wx._StdWindowCallbacks(self)"
 274     %pragma(python) addtomethod = "__init__:wx._StdOnScrollCallbacks(self)"
 275
 276     void EnableScrolling(bool xScrolling, bool yScrolling);
 277     void GetScrollPixelsPerUnit(int* OUTPUT, int* OUTPUT);
 278     void GetVirtualSize(int* OUTPUT, int* OUTPUT);
 279     bool IsRetained();
 280     void PrepareDC(wxDC& dc);
 281     void Scroll(int x, int y);
 282     void SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY,
 283                        int noUnitsX, int noUnitsY,
 284                        int xPos = 0, int yPos = 0);
 285     void ViewStart(int* OUTPUT, int* OUTPUT);
 286 };
 287
 288 //----------------------------------------------------------------------
 289
 290
 291 class wxMenu : public wxEvtHandler {
 292 public:
 293     wxMenu(const wxString& title = wxPyEmptyStr);
 294
 295     void Append(int id, const wxString& item,
 296                 const wxString& helpString = wxPyEmptyStr,
 297                 int checkable = FALSE);
 298     %name(AppendMenu)void Append(int id, const wxString& item, wxMenu *subMenu,
 299                 const wxString& helpString = wxPyEmptyStr);
 300 #ifndef __WXGTK__
 301     %name(AppendItem)void Append(const wxMenuItem* item);
 302 #endif
 303
 304     void AppendSeparator();
 305     void Break();
 306     void Check(int id, bool flag);
 307     void Enable(int id, bool enable);
 308     int FindItem(const wxString& itemString);
 309     wxString GetTitle();
 310     void SetTitle(const wxString& title);
 311     wxMenuItem* FindItemForId(int id);
 312     wxString GetHelpString(int id);
 313     wxString GetLabel(int id);
 314     void SetHelpString(int id, const wxString& helpString);
 315     bool IsChecked(int id);
 316     bool IsEnabled(int id);
 317     void SetLabel(int id, const wxString& label);
 318 };
 319
 320
 321 //
 322 // This one knows how to set a callback and handle INC- and DECREFing it.  To
 323 // be used for PopupMenus, but you must retain a referece to it while using
 324 // it.
 325 //
 326 class wxPyMenu : public wxMenu {
 327 public:
 328     wxPyMenu(const wxString& title = wxPyEmptyStr, PyObject* func = NULL);
 329     ~wxPyMenu();
 330 };
 331
 332 //----------------------------------------------------------------------
 333
 334 class wxMenuBar : public wxEvtHandler {
 335 public:
 336     wxMenuBar();
 337
 338     void Append(wxMenu *menu, const wxString& title);
 339     void Check(int id, bool flag);
 340     bool Checked(int id);
 341     void Enable(int id, bool enable);
 342     bool Enabled(int id);
 343     int FindMenuItem(const wxString& menuString, const wxString& itemString);
 344     wxMenuItem * FindItemForId(int id);
 345 #ifdef __WXMSW__
 346     void EnableTop(int pos, bool enable);
 347     wxString GetHelpString(int id);
 348     wxString GetLabel(int id);
 349     void SetHelpString(int id, const wxString& helpString);
 350     void SetLabel(int id, const wxString& label);
 351     wxString GetLabelTop(int pos);
 352     void SetLabelTop(int pos, const wxString& label);
 353 #endif
 354     int GetMenuCount();
 355     wxMenu* GetMenu(int i);
 356 };
 357
 358
 359 //----------------------------------------------------------------------
 360
 361 class wxMenuItem {
 362 public:
 363 #ifndef __WXGTK__
 364     wxMenuItem(wxMenu* parentMenu=NULL, int id=ID_SEPARATOR,
 365                const wxString& text = wxPyEmptyStr,
 366                const wxString& helpString = wxPyEmptyStr,
 367                bool checkable = FALSE, wxMenu* subMenu = NULL);
 368 #else
 369     wxMenuItem();
 370 #endif
 371
 372     bool IsSeparator();
 373     bool IsEnabled();
 374     bool IsChecked();
 375     bool IsCheckable();
 376     int  GetId();
 377     wxMenu* GetSubMenu();
 378     void SetName(const wxString& strName);
 379     wxString GetName();
 380     wxString GetHelp();
 381     void SetHelp(const wxString& strHelp);
 382     void Enable(bool bDoEnable = TRUE);
 383     void Check(bool bDoCheck = TRUE);
 384
 385 #ifdef __WXMSW__
 386     wxColour& GetBackgroundColour();
 387     wxBitmap GetBitmap(bool checked = TRUE);
 388     wxFont& GetFont();
 389     int GetMarginWidth();
 390     wxColour& GetTextColour();
 391     void SetBackgroundColour(const wxColour& colour);
 392     void SetBitmaps(const wxBitmap& checked, const wxBitmap& unchecked = wxNullBitmap);
 393     void SetFont(const wxFont& font);
 394     void SetMarginWidth(int width);
 395     void SetTextColour(const wxColour& colour);
 396     void DeleteSubMenu();
 397 #endif
 398 };
 399
 400 //---------------------------------------------------------------------------
 401 /////////////////////////////////////////////////////////////////////////////
 402 //
 403 // $Log$
 404 // Revision 1.16  1999/05/15 00:56:04  RD
 405 // fixes for GetReturnCode/SetReturnCode
 406 //
 407 // Revision 1.15  1999/04/30 03:29:19  RD
 408 //
 409 // wxPython 2.0b9, first phase (win32)
 410 // Added gobs of stuff, see wxPython/README.txt for details
 411 //
 412 // Revision 1.14.4.3  1999/03/27 23:29:15  RD
 413 //
 414 // wxPython 2.0b8
 415 //     Python thread support
 416 //     various minor additions
 417 //     various minor fixes
 418 //
 419 // Revision 1.14.4.2  1999/03/16 06:26:29  RD
 420 //
 421 // wxPython 2.0b7
 422 //
 423 // Revision 1.14.4.1  1999/03/16 06:04:04  RD
 424 //
 425 // wxPython 2.0b7
 426 //
 427 // Revision 1.14  1999/02/23 23:48:33  RD
 428 //
 429 // reenabled some methods for wxPython on wxGTK
 430 //
 431 // Revision 1.13  1999/02/20 10:02:38  RD
 432 //
 433 // Changes needed to enable wxGTK compatibility.
 434 //
 435 // Revision 1.12  1999/02/20 09:03:03  RD
 436 // Added wxWindow_FromHWND(hWnd) for wxMSW to construct a wxWindow from a
 437 // window handle.  If you can get the window handle into the python code,
 438 // it should just work...  More news on this later.
 439 //
 440 // Added wxImageList, wxToolTip.
 441 //
 442 // Re-enabled wxConfig.DeleteAll() since it is reportedly fixed for the
 443 // wxRegConfig class.
 444 //
 445 // As usual, some bug fixes, tweaks, etc.
 446 //
 447 // Revision 1.11  1998/12/18 15:49:10  RR
 448 //
 449 //   wxClipboard now serves the primary selection as well
 450 //   wxPython fixes
 451 //   warning mesages
 452 //
 453 // Revision 1.10  1998/12/17 17:52:20  RD
 454 //
 455 // wxPython 0.5.2
 456 // Minor fixes and SWIG code generation for RR's changes.  MSW and GTK
 457 // versions are much closer now!
 458 //
 459 // Revision 1.9  1998/12/17 14:07:46  RR
 460 //
 461 //   Removed minor differences between wxMSW and wxGTK
 462 //
 463 // Revision 1.8  1998/12/16 22:10:56  RD
 464 //
 465 // Tweaks needed to be able to build wxPython with wxGTK.
 466 //
 467 // Revision 1.7  1998/12/15 20:41:25  RD
 468 // Changed the import semantics from "from wxPython import *" to "from
 469 // wxPython.wx import *"  This is for people who are worried about
 470 // namespace pollution, they can use "from wxPython import wx" and then
 471 // prefix all the wxPython identifiers with "wx."
 472 //
 473 // Added wxTaskbarIcon for wxMSW.
 474 //
 475 // Made the events work for wxGrid.
 476 //
 477 // Added wxConfig.
 478 //
 479 // Added wxMiniFrame for wxGTK, (untested.)
 480 //
 481 // Changed many of the args and return values that were pointers to gdi
 482 // objects to references to reflect changes in the wxWindows API.
 483 //
 484 // Other assorted fixes and additions.
 485 //
 486 // Revision 1.6  1998/10/02 06:40:43  RD
 487 //
 488 // Version 0.4 of wxPython for MSW.
 489 //
 490 // Revision 1.5  1998/08/17 18:29:40  RD
 491 // Removed an extra method definition
 492 //
 493 // Revision 1.4  1998/08/16 04:31:11  RD
 494 // More wxGTK work.
 495 //
 496 // Revision 1.3  1998/08/15 07:36:47  RD
 497 // - Moved the header in the .i files out of the code that gets put into
 498 // the .cpp files.  It caused CVS conflicts because of the RCS ID being
 499 // different each time.
 500 //
 501 // - A few minor fixes.
 502 //
 503 // Revision 1.2  1998/08/14 23:36:46  RD
 504 // Beginings of wxGTK compatibility
 505 //
 506 // Revision 1.1  1998/08/09 08:25:52  RD
 507 // Initial version
 508 //
 509 //
 510
 511