]> git.saurik.com Git - wxWidgets.git/blob - wxPython/src/windows.i
added wx/defs.h include to correct compilation issues under Mac OS X
[wxWidgets.git] / 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 #include <wx/tooltip.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 %import misc.i
30 %import gdi.i
31 %import clip_dnd.i
32
33 %pragma(python) code = "import wx"
34
35
36 %{
37 static wxString wxPyEmptyStr("");
38 %}
39
40 //---------------------------------------------------------------------------
41
42 class wxEvtHandler : public wxObject {
43 public:
44 wxEvtHandler();
45
46 bool ProcessEvent(wxEvent& event);
47 void AddPendingEvent(wxEvent& event);
48 //bool SearchEventTable(wxEventTable& table, wxEvent& event);
49
50 bool GetEvtHandlerEnabled();
51 void SetEvtHandlerEnabled(bool enabled);
52
53 wxEvtHandler* GetNextHandler();
54 wxEvtHandler* GetPreviousHandler();
55 void SetNextHandler(wxEvtHandler* handler);
56 void SetPreviousHandler(wxEvtHandler* handler);
57
58
59 %addmethods {
60 void Connect( int id, int lastId, int eventType, PyObject* func) {
61 if (PyCallable_Check(func)) {
62 self->Connect(id, lastId, eventType,
63 (wxObjectEventFunction) &wxPyCallback::EventThunker,
64 new wxPyCallback(func));
65 }
66 }
67
68 bool Disconnect(int id, int lastId = -1,
69 wxEventType eventType = wxEVT_NULL) {
70 return self->Disconnect(id, lastId, eventType,
71 (wxObjectEventFunction)
72 &wxPyCallback::EventThunker);
73 }
74 }
75
76 };
77
78
79 //----------------------------------------------------------------------
80
81 class wxValidator : public wxEvtHandler {
82 public:
83 wxValidator();
84 //~wxValidator();
85
86 wxValidator* Clone();
87 wxWindow* GetWindow();
88 void SetWindow(wxWindow* window);
89
90 static bool IsSilent();
91 static void SetBellOnError(int doIt = TRUE);
92
93 };
94
95
96 //----------------------------------------------------------------------
97 %{
98 class wxPyValidator : public wxValidator {
99 DECLARE_DYNAMIC_CLASS(wxPyValidator);
100 public:
101 wxPyValidator() {
102 }
103
104 ~wxPyValidator() {
105 }
106
107 wxObject* Clone() const {
108 wxPyValidator* ptr = NULL;
109 wxPyValidator* self = (wxPyValidator*)this;
110
111 wxPyTState* state = wxPyBeginBlockThreads();
112 if (self->m_myInst.findCallback("Clone")) {
113 PyObject* ro;
114 ro = self->m_myInst.callCallbackObj(Py_BuildValue("()"));
115 if (ro) {
116 SWIG_GetPtrObj(ro, (void **)&ptr, "_wxPyValidator_p");
117 Py_DECREF(ro);
118 }
119 }
120 wxPyEndBlockThreads(state);
121
122 // This is very dangerous!!! But is the only way I could find
123 // to squash a memory leak. Currently it is okay, but if the
124 // validator architecture in wxWindows ever changes, problems
125 // could arise.
126 delete self;
127 return ptr;
128 }
129
130
131 DEC_PYCALLBACK_BOOL_WXWIN(Validate);
132 DEC_PYCALLBACK_BOOL_(TransferToWindow);
133 DEC_PYCALLBACK_BOOL_(TransferFromWindow);
134
135 PYPRIVATE;
136 };
137
138 IMP_PYCALLBACK_BOOL_WXWIN(wxPyValidator, wxValidator, Validate);
139 IMP_PYCALLBACK_BOOL_(wxPyValidator, wxValidator, TransferToWindow);
140 IMP_PYCALLBACK_BOOL_(wxPyValidator, wxValidator, TransferFromWindow);
141
142 IMPLEMENT_DYNAMIC_CLASS(wxPyValidator, wxValidator);
143
144 %}
145
146 class wxPyValidator : public wxValidator {
147 public:
148 wxPyValidator();
149
150 void _setSelf(PyObject* self, PyObject* _class, int incref=TRUE);
151 %pragma(python) addtomethod = "__init__:self._setSelf(self, wxPyValidator, 1)"
152
153 };
154
155 //----------------------------------------------------------------------
156
157 %apply int * INOUT { int* x, int* y };
158
159 class wxWindow : public wxEvtHandler {
160 public:
161 wxWindow(wxWindow* parent, const wxWindowID id,
162 const wxPoint& pos = wxDefaultPosition,
163 const wxSize& size = wxDefaultSize,
164 long style = 0,
165 char* name = "panel");
166 %name(wxPreWindow)wxWindow();
167
168 bool Create(wxWindow* parent, const wxWindowID id,
169 const wxPoint& pos = wxDefaultPosition,
170 const wxSize& size = wxDefaultSize,
171 long style = 0,
172 char* name = "panel");
173
174 void CaptureMouse();
175 void Center(int direction = wxBOTH);
176 void Centre(int direction = wxBOTH);
177 void CentreOnParent(int direction = wxBOTH );
178 void CenterOnParent(int direction = wxBOTH );
179 void CentreOnScreen(int direction = wxBOTH );
180 void CenterOnScreen(int direction = wxBOTH );
181
182 void Clear();
183
184 // (uses apply'ed INOUT typemap, see above)
185 %name(ClientToScreenXY)void ClientToScreen(int* x, int* y);
186 wxPoint ClientToScreen(const wxPoint& pt);
187
188 bool Close(int force = FALSE);
189 bool Destroy();
190 void DestroyChildren();
191 bool IsBeingDeleted();
192 #ifdef __WXMSW__
193 void DragAcceptFiles(bool accept);
194 #endif
195 void Enable(bool enable);
196 //bool FakePopupMenu(wxMenu* menu, int x, int y);
197 %name(FindWindowById) wxWindow* FindWindow(long id);
198 %name(FindWindowByName) wxWindow* FindWindow(const wxString& name);
199 void Fit();
200 wxColour GetBackgroundColour();
201
202 //wxList& GetChildren();
203 %addmethods {
204 PyObject* GetChildren() {
205 wxWindowList& list = self->GetChildren();
206 return wxPy_ConvertList(&list, "wxWindow");
207 }
208 }
209
210 int GetCharHeight();
211 int GetCharWidth();
212 %name(GetClientSizeTuple) void GetClientSize(int *OUTPUT, int *OUTPUT);
213 wxSize GetClientSize();
214 wxLayoutConstraints * GetConstraints();
215 wxEvtHandler* GetEventHandler();
216
217 wxFont& GetFont();
218 wxColour GetForegroundColour();
219 wxWindow * GetGrandParent();
220 %addmethods {
221 long GetHandle() {
222 return wxPyGetWinHandle(self); //(long)self->GetHandle();
223 }
224 }
225 int GetId();
226 wxString GetLabel();
227 void SetLabel(const wxString& label);
228 wxString GetName();
229 wxWindow * GetParent();
230 %name(GetPositionTuple) void GetPosition(int *OUTPUT, int *OUTPUT);
231 wxPoint GetPosition();
232 wxRect GetRect();
233 int GetScrollThumb(int orientation);
234 int GetScrollPos(int orientation);
235 int GetScrollRange(int orientation);
236 %name(GetSizeTuple) void GetSize(int *OUTPUT, int *OUTPUT);
237 wxSize GetSize();
238 void GetTextExtent(const wxString& string, int *OUTPUT, int *OUTPUT);
239 %name(GetFullTextExtent)void GetTextExtent(const wxString& string,
240 int *OUTPUT, int *OUTPUT, int *OUTPUT, int* OUTPUT,
241 const wxFont* font = NULL); //, bool use16 = FALSE)
242 wxString GetTitle();
243 wxRegion GetUpdateRegion();
244 long GetWindowStyleFlag();
245 void SetWindowStyleFlag(long style);
246 void SetWindowStyle(long style);
247 bool Hide();
248 void InitDialog();
249 bool IsEnabled();
250 bool IsExposed( int x, int y, int w=0, int h=0 );
251 %name(IsExposedPoint) bool IsExposed( const wxPoint& pt );
252 %name(IsExposedRect) bool IsExposed( const wxRect& rect );
253 bool IsRetained();
254 bool IsShown();
255 bool IsTopLevel();
256 void Layout();
257 bool LoadFromResource(wxWindow* parent, const wxString& resourceName, const wxResourceTable* resourceTable = NULL);
258 void Lower();
259 void MakeModal(bool flag=TRUE);
260 %name(MoveXY)void Move(int x, int y);
261 void Move(const wxPoint& point);
262
263 wxEvtHandler* PopEventHandler(bool deleteHandler = FALSE);
264 void PushEventHandler(wxEvtHandler* handler);
265
266 %name(PopupMenuXY)bool PopupMenu(wxMenu *menu, int x, int y);
267 bool PopupMenu(wxMenu *menu, const wxPoint& pos);
268
269 void Raise();
270 void Refresh(bool eraseBackground = TRUE, const wxRect* rect = NULL);
271 void RefreshRect(const wxRect& rect);
272
273 void ReleaseMouse();
274 void RemoveChild(wxWindow* child);
275 bool Reparent( wxWindow* newParent );
276
277 // (uses apply'ed INOUT typemap, see above)
278 %name(ScreenToClientXY)void ScreenToClient(int *x, int *y);
279 wxPoint ScreenToClient(const wxPoint& pt);
280
281 void ScrollWindow(int dx, int dy, const wxRect* rect = NULL);
282 void SetAutoLayout(bool autoLayout);
283 bool GetAutoLayout();
284 void SetBackgroundColour(const wxColour& colour);
285 void SetConstraints(wxLayoutConstraints *constraints);
286 void UnsetConstraints(wxLayoutConstraints *constraints);
287 void SetFocus();
288 bool AcceptsFocus();
289 void SetFont(const wxFont& font);
290 void SetForegroundColour(const wxColour& colour);
291 void SetId(int id);
292 void SetName(const wxString& name);
293 void SetScrollbar(int orientation, int position, int thumbSize, int range, int refresh = TRUE);
294 void SetScrollPos(int orientation, int pos, bool refresh = TRUE);
295
296 %name(SetDimensions) void SetSize(int x, int y, int width, int height, int sizeFlags=wxSIZE_AUTO);
297 %addmethods {
298 void SetSize(const wxSize& size) {
299 self->SetSize(size);
300 }
301
302 void SetPosition(const wxPoint& pos) {
303 self->Move(pos);
304 }
305
306 void SetRect(const wxRect& rect, int sizeFlags=wxSIZE_AUTO) {
307 self->SetSize(rect, sizeFlags);
308 }
309 }
310
311 void SetSizeHints(int minW=-1, int minH=-1, int maxW=-1, int maxH=-1, int incW=-1, int incH=-1);
312 %name(SetClientSizeWH)void SetClientSize(int width, int height);
313 void SetClientSize(const wxSize& size);
314 //void SetPalette(wxPalette* palette);
315 void SetCursor(const wxCursor&cursor);
316 void SetEventHandler(wxEvtHandler* handler);
317 void SetExtraStyle(long exStyle);
318 void SetTitle(const wxString& title);
319 bool Show(bool show);
320 bool TransferDataFromWindow();
321 bool TransferDataToWindow();
322 bool Validate();
323 void WarpPointer(int x, int y);
324
325 %name(ConvertDialogPointToPixels) wxPoint ConvertDialogToPixels(const wxPoint& pt);
326 %name(ConvertDialogSizeToPixels) wxSize ConvertDialogToPixels(const wxSize& sz);
327
328 %name(DLG_PNT) wxPoint ConvertDialogToPixels(const wxPoint& pt);
329 %name(DLG_SZE) wxSize ConvertDialogToPixels(const wxSize& sz);
330
331 %name(ConvertPixelPointToDialog) wxPoint ConvertPixelsToDialog(const wxPoint& pt);
332 %name(ConvertPixelSizeToDialog) wxSize ConvertPixelsToDialog(const wxSize& sz);
333
334 %name(SetToolTipString)void SetToolTip(const wxString &tip);
335 void SetToolTip(wxToolTip *tooltip);
336 wxToolTip* GetToolTip();
337
338 void SetSizer(wxSizer* sizer);
339 wxSizer* GetSizer();
340
341 wxValidator* GetValidator();
342 void SetValidator(const wxValidator& validator);
343
344 void SetDropTarget(wxDropTarget* target);
345 wxDropTarget* GetDropTarget();
346 %pragma(python) addtomethod = "SetDropTarget:_args[0].thisown = 0"
347
348 wxSize GetBestSize();
349
350 void SetCaret(wxCaret *caret);
351 wxCaret *GetCaret();
352 %pragma(python) addtoclass = "# replaces broken shadow method
353 def GetCaret(self, *_args, **_kwargs):
354 from misc2 import wxCaretPtr
355 val = apply(windowsc.wxWindow_GetCaret,(self,) + _args, _kwargs)
356 if val: val = wxCaretPtr(val)
357 return val
358 "
359
360 void Freeze();
361 void Thaw();
362 void Update();
363
364 wxString GetHelpText();
365 void SetHelpText(const wxString& helpText);
366
367 bool ScrollLines(int lines);
368 bool ScrollPages(int pages);
369 bool LineUp();
370 bool LineDown();
371 bool PageUp();
372 bool PageDown();
373
374 static wxWindow* FindFocus();
375 static int NewControlId();
376 static int NextControlId(int id);
377 static int PrevControlId(int id);
378
379 void SetAcceleratorTable(const wxAcceleratorTable& accel);
380 wxAcceleratorTable *GetAcceleratorTable();
381 };
382
383
384
385
386 %pragma(python) code = "
387 def wxDLG_PNT(win, point_or_x, y=None):
388 if y is None:
389 return win.ConvertDialogPointToPixels(point_or_x)
390 else:
391 return win.ConvertDialogPointToPixels(wxPoint(point_or_x, y))
392
393 def wxDLG_SZE(win, size_width, height=None):
394 if height is None:
395 return win.ConvertDialogSizeToPixels(size_width)
396 else:
397 return win.ConvertDialogSizeToPixels(wxSize(size_width, height))
398 "
399
400
401 #ifdef __WXMSW__
402 %inline %{
403 wxWindow* wxWindow_FromHWND(unsigned long hWnd) {
404 wxWindow* win = new wxWindow;
405 win->SetHWND(hWnd);
406 win->SubclassWin(hWnd);
407 return win;
408 }
409 %}
410 #endif
411
412
413 //---------------------------------------------------------------------------
414
415 class wxPanel : public wxWindow {
416 public:
417 wxPanel(wxWindow* parent,
418 const wxWindowID id,
419 const wxPoint& pos = wxDefaultPosition,
420 const wxSize& size = wxDefaultSize,
421 long style = wxTAB_TRAVERSAL,
422 const char* name = "panel");
423 %name(wxPrePanel)wxPanel();
424
425 bool Create(wxWindow* parent,
426 const wxWindowID id,
427 const wxPoint& pos = wxDefaultPosition,
428 const wxSize& size = wxDefaultSize,
429 long style = wxTAB_TRAVERSAL,
430 const char* name = "panel");
431
432 void InitDialog();
433 wxButton* GetDefaultItem();
434 void SetDefaultItem(wxButton *btn);
435
436 };
437
438 //---------------------------------------------------------------------------
439
440
441 // TODO: Add wrappers for the wxScrollHelper class, make wxScrolledWindow
442 // derive from it and wxPanel.
443
444
445 class wxScrolledWindow : public wxPanel {
446 public:
447 wxScrolledWindow(wxWindow* parent,
448 const wxWindowID id = -1,
449 const wxPoint& pos = wxDefaultPosition,
450 const wxSize& size = wxDefaultSize,
451 long style = wxHSCROLL | wxVSCROLL,
452 char* name = "scrolledWindow");
453 %name(wxPreScrolledWindow)wxScrolledWindow();
454
455 bool Create(wxWindow* parent,
456 const wxWindowID id = -1,
457 const wxPoint& pos = wxDefaultPosition,
458 const wxSize& size = wxDefaultSize,
459 long style = wxHSCROLL | wxVSCROLL,
460 char* name = "scrolledWindow");
461
462 void EnableScrolling(bool xScrolling, bool yScrolling);
463 int GetScrollPageSize(int orient);
464 void GetScrollPixelsPerUnit(int* OUTPUT, int* OUTPUT);
465 wxWindow* GetTargetWindow();
466 void GetVirtualSize(int* OUTPUT, int* OUTPUT);
467 bool IsRetained();
468 void PrepareDC(wxDC& dc);
469 void Scroll(int x, int y);
470 void SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY,
471 int noUnitsX, int noUnitsY,
472 int xPos = 0, int yPos = 0, int noRefresh=FALSE);
473 void SetScrollPageSize(int orient, int pageSize);
474 void SetTargetWindow(wxWindow* window);
475 void GetViewStart(int* OUTPUT, int* OUTPUT);
476 %pragma(python) addtoclass = "ViewStart = GetViewStart"
477
478 void CalcScrolledPosition( int x, int y, int *OUTPUT, int *OUTPUT);
479 void CalcUnscrolledPosition( int x, int y, int *OUTPUT, int *OUTPUT);
480
481 void SetScale(double xs, double ys);
482 double GetScaleX();
483 double GetScaleY();
484
485 void AdjustScrollbars();
486 };
487
488 //----------------------------------------------------------------------
489
490
491 class wxMenu : public wxEvtHandler {
492 public:
493 wxMenu(const wxString& title = wxPyEmptyStr, long style = 0);
494
495 void Append(int id, const wxString& item,
496 const wxString& helpString = wxPyEmptyStr,
497 int checkable = FALSE);
498 %name(AppendMenu)void Append(int id, const wxString& item, wxMenu *subMenu,
499 const wxString& helpString = wxPyEmptyStr);
500 %name(AppendItem)void Append(const wxMenuItem* item);
501
502 void AppendSeparator();
503 void Break();
504 void Check(int id, bool flag);
505 bool IsChecked(int id);
506 void Enable(int id, bool enable);
507 bool IsEnabled(int id);
508
509 int FindItem(const wxString& itemString);
510 %name(FindItemById)wxMenuItem* FindItem(int id/*, wxMenu **menu = NULL*/);
511
512 wxString GetTitle();
513 void SetTitle(const wxString& title);
514
515 wxString GetLabel(int id);
516 void SetLabel(int id, const wxString& label);
517
518 wxString GetHelpString(int id);
519 void SetHelpString(int id, const wxString& helpString);
520 void UpdateUI(wxEvtHandler* source = NULL);
521
522 bool Delete(int id);
523 %name(DeleteItem)bool Delete(wxMenuItem *item);
524 bool Insert(size_t pos, wxMenuItem *item);
525 wxMenuItem *Remove(int id);
526 %name(RemoveItem) wxMenuItem *Remove(wxMenuItem *item);
527
528 %addmethods {
529 void Destroy() { delete self; }
530 }
531 %name(DestroyId)bool Destroy(int id);
532 %name(DestroyItem)bool Destroy(wxMenuItem *item);
533
534 size_t GetMenuItemCount();
535 //wxMenuItemList& GetMenuItems();
536 %addmethods {
537 PyObject* GetMenuItems() {
538 wxMenuItemList& list = self->GetMenuItems();
539 return wxPy_ConvertList(&list, "wxMenuItem");
540 }
541 }
542
543 void SetEventHandler(wxEvtHandler *handler);
544 wxEvtHandler *GetEventHandler();
545
546 void SetInvokingWindow(wxWindow *win);
547 wxWindow *GetInvokingWindow();
548
549 long GetStyle();
550
551 bool IsAttached();
552
553 void SetParent(wxMenu *parent);
554 wxMenu *GetParent();
555 };
556
557
558 //----------------------------------------------------------------------
559
560 class wxMenuBar : public wxWindow {
561 public:
562 wxMenuBar(long style = 0);
563
564 bool Append(wxMenu *menu, const wxString& title);
565 bool Insert(size_t pos, wxMenu *menu, const wxString& title);
566 size_t GetMenuCount();
567 wxMenu *GetMenu(size_t pos);
568 wxMenu *Replace(size_t pos, wxMenu *menu, const wxString& title);
569 wxMenu *Remove(size_t pos);
570 void EnableTop(size_t pos, bool enable);
571 void SetLabelTop(size_t pos, const wxString& label);
572 wxString GetLabelTop(size_t pos);
573 int FindMenu(const wxString& title);
574 int FindMenuItem(const wxString& menuString, const wxString& itemString);
575 %name(FindItemById)wxMenuItem* FindItem(int id/*, wxMenu **menu = NULL*/);
576 void Enable(int id, bool enable);
577 void Check(int id, bool check);
578 bool IsChecked(int id);
579 bool IsEnabled(int id);
580
581 void SetLabel(int id, const wxString &label);
582 wxString GetLabel(int id);
583
584 void SetHelpString(int id, const wxString& helpString);
585 wxString GetHelpString(int id);
586
587 };
588
589
590 //----------------------------------------------------------------------
591
592 class wxMenuItem : public wxObject {
593 public:
594 wxMenuItem(wxMenu* parentMenu=NULL, int id=wxID_SEPARATOR,
595 const wxString& text = wxPyEmptyStr,
596 const wxString& help = wxPyEmptyStr,
597 bool isCheckable = FALSE, wxMenu* subMenu = NULL);
598
599
600 wxMenu *GetMenu();
601 void SetId(int id);
602 int GetId();
603 bool IsSeparator();
604 void SetText(const wxString& str);
605 wxString GetLabel();
606 const wxString& GetText();
607 void SetCheckable(bool checkable);
608 bool IsCheckable();
609 bool IsSubMenu();
610 void SetSubMenu(wxMenu *menu);
611 wxMenu *GetSubMenu();
612 void Enable(bool enable = TRUE);
613 bool IsEnabled();
614 void Check(bool check = TRUE);
615 bool IsChecked();
616 void Toggle();
617 void SetHelp(const wxString& str);
618 const wxString& GetHelp();
619 wxAcceleratorEntry *GetAccel();
620 void SetAccel(wxAcceleratorEntry *accel);
621
622 static wxString GetLabelFromText(const wxString& text);
623
624 // wxOwnerDrawn methods
625 #ifdef __WXMSW__
626 void SetFont(const wxFont& font);
627 wxFont& GetFont();
628 void SetTextColour(const wxColour& colText);
629 wxColour GetTextColour();
630 void SetBackgroundColour(const wxColour& colBack);
631 wxColour GetBackgroundColour();
632 void SetBitmaps(const wxBitmap& bmpChecked,
633 const wxBitmap& bmpUnchecked = wxNullBitmap);
634 void SetBitmap(const wxBitmap& bmpChecked);
635 const wxBitmap& GetBitmap(bool bChecked = TRUE);
636 void SetMarginWidth(int nWidth);
637 int GetMarginWidth();
638 static int GetDefaultMarginWidth();
639 //void SetName(const wxString& strName);
640 //const wxString& GetName();
641 //void SetCheckable(bool checkable);
642 //bool IsCheckable();
643 bool IsOwnerDrawn();
644 void ResetOwnerDrawn();
645 #endif
646 };
647
648 //---------------------------------------------------------------------------
649
650
651