1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: SWIG definitions of various window classes
9 // Copyright: (c) 1998 by Total Control Software
10 // Licence: wxWindows license
11 /////////////////////////////////////////////////////////////////////////////
18 #include <wx/menuitem.h>
21 //----------------------------------------------------------------------
24 %include my_typemaps.i
26 // Import some definitions of other classes, etc.
32 %pragma(python) code = "import wx"
36 static wxString wxPyEmptyStr("");
39 //---------------------------------------------------------------------------
45 bool ProcessEvent(wxEvent& event);
46 void AddPendingEvent(wxEvent& event);
47 //bool SearchEventTable(wxEventTable& table, wxEvent& event);
49 bool GetEvtHandlerEnabled();
50 void SetEvtHandlerEnabled(bool enabled);
52 wxEvtHandler* GetNextHandler();
53 wxEvtHandler* GetPreviousHandler();
54 void SetNextHandler(wxEvtHandler* handler);
55 void SetPreviousHandler(wxEvtHandler* handler);
59 void Connect( int id, int lastId, int eventType, PyObject* func) {
60 if (PyCallable_Check(func)) {
61 self->Connect(id, lastId, eventType,
62 (wxObjectEventFunction) &wxPyCallback::EventThunker,
63 new wxPyCallback(func));
67 bool Disconnect(int id, int lastId = -1,
68 wxEventType eventType = wxEVT_NULL) {
69 return self->Disconnect(id, lastId, eventType,
70 (wxObjectEventFunction)
71 &wxPyCallback::EventThunker);
76 %pragma(python) addtoclass = "
80 // %pragma(python) addtoclass = "
81 // def __getattr__(self, name):
82 // pl = self._prop_list_
83 // if pl.has_key(name):
84 // getFunc, setFunc = pl[name]
86 // return getattr(self, getFunc)()
88 // raise TypeError, '%s property is write-only' % name
89 // raise AttributeError, name
91 // def __setattr__(self, name, value):
92 // pl = self._prop_list_
93 // if pl.has_key(name):
94 // getFunc, setFunc = pl[name]
96 // return getattr(self, setFunc)(value)
98 // raise TypeError, '%s property is read-only' % name
99 // self.__dict__[name] = value
104 //----------------------------------------------------------------------
106 class wxValidator : public wxEvtHandler {
111 wxValidator* Clone();
112 wxWindow* GetWindow();
113 void SetWindow(wxWindow* window);
115 // // Properties list
116 // %pragma(python) addtoclass = "
118 // 'window' : ('GetWindow', 'SetWindow'),
120 // _prop_list_.update(wxEvtHandler._prop_list_)
125 bool wxValidator_IsSilent() {
126 return wxValidator::IsSilent();
129 void wxValidator_SetBellOnError(int doIt = TRUE) {
130 wxValidator::SetBellOnError(doIt);
134 //----------------------------------------------------------------------
136 class wxPyValidator : public wxValidator {
137 DECLARE_DYNAMIC_CLASS(wxPyValidator);
141 // wxPyValidator(const wxPyValidator& other);
146 wxObject* wxPyValidator::Clone() const {
147 wxPyValidator* ptr = NULL;
148 wxPyValidator* self = (wxPyValidator*)this;
150 bool doSave = wxPyRestoreThread();
151 if (self->m_myInst.findCallback("Clone")) {
153 ro = self->m_myInst.callCallbackObj(Py_BuildValue("()"));
155 SWIG_GetPtrObj(ro, (void **)&ptr, "_wxPyValidator_p");
159 // This is very dangerous!!! But is the only way I could find
160 // to squash a memory leak. Currently it is okay, but if the
161 // validator architecture in wxWindows ever changes, problems
165 wxPySaveThread(doSave);
169 DEC_PYCALLBACK_BOOL_WXWIN(Validate);
170 DEC_PYCALLBACK_BOOL_(TransferToWindow);
171 DEC_PYCALLBACK_BOOL_(TransferFromWindow);
177 IMP_PYCALLBACK_BOOL_WXWIN(wxPyValidator, wxValidator, Validate);
178 IMP_PYCALLBACK_BOOL_(wxPyValidator, wxValidator, TransferToWindow);
179 IMP_PYCALLBACK_BOOL_(wxPyValidator, wxValidator, TransferFromWindow);
181 IMPLEMENT_DYNAMIC_CLASS(wxPyValidator, wxValidator);
185 class wxPyValidator : public wxValidator {
190 %addmethods { void Destroy() { delete self; } }
192 void _setSelf(PyObject* self, PyObject* _class, int incref=TRUE);
193 %pragma(python) addtomethod = "__init__:self._setSelf(self, wxPyValidator, 0)"
197 //----------------------------------------------------------------------
199 %apply int * INOUT { int* x, int* y };
201 class wxWindow : public wxEvtHandler {
204 wxWindow(wxWindow* parent, const wxWindowID id,
205 const wxPoint& pos = wxDefaultPosition,
206 const wxSize& size = wxDefaultSize,
208 char* name = "panel");
210 %pragma(python) addtomethod = "__init__:#wx._StdWindowCallbacks(self)"
213 void Center(int direction = wxBOTH);
214 void Centre(int direction = wxBOTH);
215 void CentreOnParent(int direction = wxBOTH );
216 void CenterOnParent(int direction = wxBOTH );
217 void CentreOnScreen(int direction = wxBOTH );
218 void CenterOnScreen(int direction = wxBOTH );
220 // (uses apply'ed INOUT typemap, see above)
221 %name(ClientToScreenXY)void ClientToScreen(int* x, int* y);
222 wxPoint ClientToScreen(const wxPoint& pt);
224 bool Close(int force = FALSE);
226 void DestroyChildren();
228 void DragAcceptFiles(bool accept);
230 void Enable(bool enable);
231 //bool FakePopupMenu(wxMenu* menu, int x, int y);
232 %name(FindWindowById) wxWindow* FindWindow(long id);
233 %name(FindWindowByName) wxWindow* FindWindow(const wxString& name);
235 wxColour GetBackgroundColour();
237 //wxList& GetChildren();
239 PyObject* GetChildren() {
240 wxWindowList& list = self->GetChildren();
241 return wxPy_ConvertList(&list, "wxWindow");
247 %name(GetClientSizeTuple) void GetClientSize(int *OUTPUT, int *OUTPUT);
248 wxSize GetClientSize();
249 wxLayoutConstraints * GetConstraints();
250 wxEvtHandler* GetEventHandler();
253 wxColour GetForegroundColour();
254 wxWindow * GetGrandParent();
257 return wxPyGetWinHandle(self); //(long)self->GetHandle();
262 void SetLabel(const wxString& label);
264 wxWindow * GetParent();
265 %name(GetPositionTuple) void GetPosition(int *OUTPUT, int *OUTPUT);
266 wxPoint GetPosition();
268 int GetScrollThumb(int orientation);
269 int GetScrollPos(int orientation);
270 int GetScrollRange(int orientation);
271 %name(GetSizeTuple) void GetSize(int *OUTPUT, int *OUTPUT);
273 void GetTextExtent(const wxString& string, int *OUTPUT, int *OUTPUT);
274 %name(GetFullTextExtent)void GetTextExtent(const wxString& string,
275 int *OUTPUT, int *OUTPUT, int *OUTPUT, int* OUTPUT,
276 const wxFont* font = NULL); //, bool use16 = FALSE)
278 wxRegion GetUpdateRegion();
279 long GetWindowStyleFlag();
280 void SetWindowStyleFlag(long style);
281 void SetWindowStyle(long style);
285 bool IsExposed( int x, int y, int w=0, int h=0 );
286 %name(IsExposedPoint) bool IsExposed( const wxPoint& pt );
287 %name(IsExposedRect) bool IsExposed( const wxRect& rect );
292 bool LoadFromResource(wxWindow* parent, const wxString& resourceName, const wxResourceTable* resourceTable = NULL);
294 void MakeModal(bool flag);
295 %name(MoveXY)void Move(int x, int y);
296 void Move(const wxPoint& point);
298 wxEvtHandler* PopEventHandler(bool deleteHandler = FALSE);
299 void PushEventHandler(wxEvtHandler* handler);
301 %name(PopupMenuXY)bool PopupMenu(wxMenu *menu, int x, int y);
302 bool PopupMenu(wxMenu *menu, const wxPoint& pos);
305 void Refresh(bool eraseBackground = TRUE, const wxRect* rect = NULL);
307 void RemoveChild(wxWindow* child);
308 bool Reparent( wxWindow* newParent );
310 // (uses apply'ed INOUT typemap, see above)
311 %name(ScreenToClientXY)void ScreenToClient(int *x, int *y);
312 wxPoint ScreenToClient(const wxPoint& pt);
314 void ScrollWindow(int dx, int dy, const wxRect* rect = NULL);
315 void SetAcceleratorTable(const wxAcceleratorTable& accel);
316 void SetAutoLayout(bool autoLayout);
317 bool GetAutoLayout();
318 void SetBackgroundColour(const wxColour& colour);
319 void SetConstraints(wxLayoutConstraints *constraints);
320 void UnsetConstraints(wxLayoutConstraints *constraints);
323 void SetFont(const wxFont& font);
324 void SetForegroundColour(const wxColour& colour);
326 void SetName(const wxString& name);
327 void SetScrollbar(int orientation, int position, int thumbSize, int range, int refresh = TRUE);
328 void SetScrollPos(int orientation, int pos, bool refresh = TRUE);
330 %name(SetDimensions) void SetSize(int x, int y, int width, int height, int sizeFlags=wxSIZE_AUTO);
332 void SetSize(const wxSize& size) {
336 void SetPosition(const wxPoint& pos) {
340 void SetRect(const wxRect& rect, int sizeFlags=wxSIZE_AUTO) {
341 self->SetSize(rect, sizeFlags);
345 void SetSizeHints(int minW=-1, int minH=-1, int maxW=-1, int maxH=-1, int incW=-1, int incH=-1);
346 %name(SetClientSizeWH)void SetClientSize(int width, int height);
347 void SetClientSize(const wxSize& size);
348 //void SetPalette(wxPalette* palette);
349 void SetCursor(const wxCursor&cursor);
350 void SetEventHandler(wxEvtHandler* handler);
351 void SetExtraStyle(long exStyle);
352 void SetTitle(const wxString& title);
353 bool Show(bool show);
354 bool TransferDataFromWindow();
355 bool TransferDataToWindow();
357 void WarpPointer(int x, int y);
359 %name(ConvertDialogPointToPixels) wxPoint ConvertDialogToPixels(const wxPoint& pt);
360 %name(ConvertDialogSizeToPixels) wxSize ConvertDialogToPixels(const wxSize& sz);
362 %name(DLG_PNT) wxPoint ConvertDialogToPixels(const wxPoint& pt);
363 %name(DLG_SZE) wxSize ConvertDialogToPixels(const wxSize& sz);
365 %name(ConvertPixelPointToDialog) wxPoint ConvertPixelsToDialog(const wxPoint& pt);
366 %name(ConvertPixelSizeToDialog) wxSize ConvertPixelsToDialog(const wxSize& sz);
368 %name(SetToolTipString)void SetToolTip(const wxString &tip);
369 void SetToolTip(wxToolTip *tooltip);
370 wxToolTip* GetToolTip();
372 void SetSizer(wxSizer* sizer);
375 wxValidator* GetValidator();
376 void SetValidator(const wxValidator& validator);
378 void SetDropTarget(wxDropTarget* target);
379 wxDropTarget* GetDropTarget();
380 %pragma(python) addtomethod = "SetDropTarget:_args[0].thisown = 0"
382 wxSize GetBestSize();
384 void SetCaret(wxCaret *caret);
386 %pragma(python) addtoclass = "# replaces broken shadow methods
387 def GetCaret(self, *_args, **_kwargs):
388 from misc2 import wxCaretPtr
389 val = apply(windowsc.wxWindow_GetCaret,(self,) + _args, _kwargs)
390 if val: val = wxCaretPtr(val)
393 def GetSizer(self, *_args, **_kwargs):
394 from sizers import wxSizerPtr
395 val = apply(windowsc.wxWindow_GetSizer,(self,) + _args, _kwargs)
396 if val: val = wxSizerPtr(val)
399 def GetToolTip(self, *_args, **_kwargs):
400 from misc2 import wxToolTipPtr
401 val = apply(windowsc.wxWindow_GetToolTip,(self,) + _args, _kwargs)
402 if val: val = wxToolTipPtr(val)
407 // // Properties list
408 // %pragma(python) addtoclass = "
410 // 'size' : ('GetSize', 'SetSize'),
411 // 'enabled' : ('IsEnabled', 'Enable'),
412 // 'background' : ('GetBackgroundColour', 'SetBackgroundColour'),
413 // 'foreground' : ('GetForegroundColour', 'SetForegroundColour'),
414 // 'children' : ('GetChildren', None),
415 // 'charHeight' : ('GetCharHeight', None),
416 // 'charWidth' : ('GetCharWidth', None),
417 // 'clientSize' : ('GetClientSize', 'SetClientSize'),
418 // 'font' : ('GetFont', 'SetFont'),
419 // 'grandParent' : ('GetGrandParent', None),
420 // 'handle' : ('GetHandle', None),
421 // 'label' : ('GetLabel', 'SetLabel'),
422 // 'name' : ('GetName', 'SetName'),
423 // 'parent' : ('GetParent', None),
424 // 'position' : ('GetPosition', 'SetPosition'),
425 // 'title' : ('GetTitle', 'SetTitle'),
426 // 'style' : ('GetWindowStyleFlag', 'SetWindowStyleFlag'),
427 // 'visible' : ('IsShown', 'Show'),
428 // 'toolTip' : ('GetToolTip', 'SetToolTip'),
429 // 'sizer' : ('GetSizer', 'SetSizer'),
430 // 'validator' : ('GetValidator', 'SetValidator'),
431 // 'dropTarget' : ('GetDropTarget', 'SetDropTarget'),
432 // 'caret' : ('GetCaret', 'SetCaret'),
433 // 'autoLayout' : ('GetAutoLayout', 'SetAutoLayout'),
434 // 'constraints' : ('GetConstraints', 'SetConstraints'),
437 // _prop_list_.update(wxEvtHandler._prop_list_)
444 %pragma(python) code = "
445 def wxDLG_PNT(win, point_or_x, y=None):
447 return win.ConvertDialogPointToPixels(point_or_x)
449 return win.ConvertDialogPointToPixels(wxPoint(point_or_x, y))
451 def wxDLG_SZE(win, size_width, height=None):
453 return win.ConvertDialogSizeToPixels(size_width)
455 return win.ConvertDialogSizeToPixels(wxSize(size_width, height))
459 wxWindow* wxWindow_FindFocus() {
460 return wxWindow::FindFocus();
467 wxWindow* wxWindow_FromHWND(unsigned long hWnd) {
468 wxWindow* win = new wxWindow;
470 win->SubclassWin(hWnd);
477 int wxWindow_NewControlId() {
478 return wxWindow::NewControlId();
480 int wxWindow_NextControlId(int id) {
481 return wxWindow::NextControlId(id);
483 int wxWindow_PrevControlId(int id) {
484 return wxWindow::PrevControlId(id);
489 //---------------------------------------------------------------------------
491 class wxPanel : public wxWindow {
493 wxPanel(wxWindow* parent,
495 const wxPoint& pos = wxDefaultPosition,
496 const wxSize& size = wxDefaultSize,
497 long style = wxTAB_TRAVERSAL,
498 const char* name = "panel");
500 %pragma(python) addtomethod = "__init__:#wx._StdWindowCallbacks(self)"
503 wxButton* GetDefaultItem();
504 void SetDefaultItem(wxButton *btn);
506 // fix some SWIG trouble...
507 %pragma(python) addtoclass = "
508 def GetDefaultItem(self):
510 val = windowsc.wxPanel_GetDefaultItem(self.this)
511 val = controls.wxButtonPtr(val)
516 //---------------------------------------------------------------------------
518 class wxDialog : public wxPanel {
520 wxDialog(wxWindow* parent,
522 const wxString& title,
523 const wxPoint& pos = wxDefaultPosition,
524 const wxSize& size = wxDefaultSize,
525 long style = wxDEFAULT_DIALOG_STYLE,
526 const char* name = "dialogBox");
528 %pragma(python) addtomethod = "__init__:#wx._StdDialogCallbacks(self)"
530 void Centre(int direction = wxBOTH);
531 void EndModal(int retCode);
533 void Iconize(bool iconize);
535 void SetModal(bool flag);
537 void SetTitle(const wxString& title);
538 bool Show(bool show);
542 void SetReturnCode(int retCode);
545 //---------------------------------------------------------------------------
547 class wxScrolledWindow : public wxPanel {
549 wxScrolledWindow(wxWindow* parent,
550 const wxWindowID id = -1,
551 const wxPoint& pos = wxDefaultPosition,
552 const wxSize& size = wxDefaultSize,
553 long style = wxHSCROLL | wxVSCROLL,
554 char* name = "scrolledWindow");
556 %pragma(python) addtomethod = "__init__:#wx._StdWindowCallbacks(self)"
557 %pragma(python) addtomethod = "__init__:#wx._StdOnScrollCallbacks(self)"
559 void EnableScrolling(bool xScrolling, bool yScrolling);
560 int GetScrollPageSize(int orient);
561 void GetScrollPixelsPerUnit(int* OUTPUT, int* OUTPUT);
562 wxWindow* GetTargetWindow();
563 void GetVirtualSize(int* OUTPUT, int* OUTPUT);
565 void PrepareDC(wxDC& dc);
566 void Scroll(int x, int y);
567 void SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY,
568 int noUnitsX, int noUnitsY,
569 int xPos = 0, int yPos = 0, int noRefresh=FALSE);
570 void SetScrollPageSize(int orient, int pageSize);
571 void SetTargetWindow(wxWindow* window);
572 void GetViewStart(int* OUTPUT, int* OUTPUT);
573 void ViewStart(int* OUTPUT, int* OUTPUT);
575 void CalcScrolledPosition( int x, int y, int *OUTPUT, int *OUTPUT);
576 void CalcUnscrolledPosition( int x, int y, int *OUTPUT, int *OUTPUT);
580 //----------------------------------------------------------------------
583 class wxMenu : public wxEvtHandler {
585 wxMenu(const wxString& title = wxPyEmptyStr, long style = 0);
587 void Append(int id, const wxString& item,
588 const wxString& helpString = wxPyEmptyStr,
589 int checkable = FALSE);
590 %name(AppendMenu)void Append(int id, const wxString& item, wxMenu *subMenu,
591 const wxString& helpString = wxPyEmptyStr);
592 %name(AppendItem)void Append(const wxMenuItem* item);
594 void AppendSeparator();
596 void Check(int id, bool flag);
597 bool IsChecked(int id);
598 void Enable(int id, bool enable);
599 bool IsEnabled(int id);
601 int FindItem(const wxString& itemString);
602 %name(FindItemById)wxMenuItem* FindItem(int id/*, wxMenu **menu = NULL*/);
605 void SetTitle(const wxString& title);
607 wxString GetLabel(int id);
608 void SetLabel(int id, const wxString& label);
610 wxString GetHelpString(int id);
611 void SetHelpString(int id, const wxString& helpString);
612 void UpdateUI(wxEvtHandler* source = NULL);
615 %name(DeleteItem)bool Delete(wxMenuItem *item);
616 bool Insert(size_t pos, wxMenuItem *item);
617 wxMenuItem *Remove(int id);
618 %name(RemoveItem) wxMenuItem *Remove(wxMenuItem *item);
621 void Destroy() { delete self; }
623 %name(DestroyId)bool Destroy(int id);
624 %name(DestroyItem)bool Destroy(wxMenuItem *item);
626 size_t GetMenuItemCount();
627 //wxMenuItemList& GetMenuItems();
629 PyObject* GetMenuItems() {
630 wxMenuItemList& list = self->GetMenuItems();
631 return wxPy_ConvertList(&list, "wxMenuItem");
635 void SetEventHandler(wxEvtHandler *handler);
636 wxEvtHandler *GetEventHandler();
638 void SetInvokingWindow(wxWindow *win);
639 wxWindow *GetInvokingWindow();
645 void SetParent(wxMenu *parent);
650 //----------------------------------------------------------------------
652 class wxMenuBar : public wxWindow {
654 wxMenuBar(long style = 0);
656 bool Append(wxMenu *menu, const wxString& title);
657 bool Insert(size_t pos, wxMenu *menu, const wxString& title);
658 size_t GetMenuCount();
659 wxMenu *GetMenu(size_t pos);
660 wxMenu *Replace(size_t pos, wxMenu *menu, const wxString& title);
661 wxMenu *Remove(size_t pos);
662 void EnableTop(size_t pos, bool enable);
663 void SetLabelTop(size_t pos, const wxString& label);
664 wxString GetLabelTop(size_t pos);
665 int FindMenuItem(const wxString& menuString, const wxString& itemString);
666 %name(FindItemById)wxMenuItem* FindItem(int id/*, wxMenu **menu = NULL*/);
667 void Enable(int id, bool enable);
668 void Check(int id, bool check);
669 bool IsChecked(int id);
670 bool IsEnabled(int id);
672 void SetLabel(int id, const wxString &label);
673 wxString GetLabel(int id);
675 void SetHelpString(int id, const wxString& helpString);
676 wxString GetHelpString(int id);
681 //----------------------------------------------------------------------
685 wxMenuItem(wxMenu* parentMenu=NULL, int id=wxID_SEPARATOR,
686 const wxString& text = wxPyEmptyStr,
687 const wxString& help = wxPyEmptyStr,
688 bool isCheckable = FALSE, wxMenu* subMenu = NULL);
695 void SetText(const wxString& str);
697 const wxString& GetText();
698 void SetCheckable(bool checkable);
701 void SetSubMenu(wxMenu *menu);
702 wxMenu *GetSubMenu();
703 void Enable(bool enable = TRUE);
705 void Check(bool check = TRUE);
708 void SetHelp(const wxString& str);
709 const wxString& GetHelp();
710 wxAcceleratorEntry *GetAccel();
711 void SetAccel(wxAcceleratorEntry *accel);
713 static wxString GetLabelFromText(const wxString& text);
715 // TODO: Add wxOwnerDrawn methods, also look at other ownerdrawn classes...
719 //---------------------------------------------------------------------------