**Usage**
The following example shows a simple implementation that utilizes
-`wx.aui.FrameManager` to manage three text controls in a frame window::
+`wx.aui.AuiManager` to manage three text controls in a frame window::
import wx
import wx.aui
//---------------------------------------------------------------------------
-
+// Preprocessor stuff so SWIG doesn't get confused when %include-ing
+// the aui .h files.
+%ignore wxUSE_AUI;
+%ignore wxUSE_MENUS;
+%ignore wxABI_VERSION;
#define wxUSE_AUI 1
+#define wxUSE_MENUS 1
+#define wxABI_VERSION 99999
+
#define WXDLLIMPEXP_AUI
#define unsigned
#define wxDEPRECATED(decl)
+#define DECLARE_EVENT_TABLE()
+#define DECLARE_DYNAMIC_CLASS(foo)
+
// We'll skip making wrappers for these, they have overloads that take a
const wxPaneInfo& pane_info,
const wxPoint& drop_pos);
-// A typemap for the return value of wxFrameManager::GetAllPanes
+// A typemap for the return value of wxAuiManager::GetAllPanes
%typemap(out) wxAuiPaneInfoArray& {
$result = PyList_New(0);
for (size_t i=0; i < $1->GetCount(); i++) {
}
}
+//%ignore wxAuiManager::~wxAuiManager;
%nokwargs wxAuiTabContainer::SetActivePage;
%pythonAppend wxAuiTabCtrl::wxAuiTabCtrl "self._setOORInfo(self)";
%pythonAppend wxAuiNotebook::wxAuiNotebook "self._setOORInfo(self)";
-%pythonAppend wxAuiNotebook::wxAuiNotebook() "self._setOORInfo(self)";
+%pythonAppend wxAuiNotebook::wxAuiNotebook() "val._setOORInfo(val)";
%ignore wxAuiiNotebook::~wxAuiNotebook;
%rename(PreAuiNotebook) wxAuiNotebook::wxAuiNotebook();
+// Link error...
+%ignore wxAuiDefaultTabArt::SetWindow;
+
+// ignore this overload
+%ignore wxAuiTabContainer::GetPage(size_t idx) const;
+
+
+
+%pythonAppend wxAuiMDIParentFrame::wxAuiMDIParentFrame "self._setOORInfo(self)";
+%pythonAppend wxAuiMDIParentFrame::wxAuiMDIParentFrame() "val._setOORInfo(val)";
+%ignore wxAuiMDIParentFrame::~wxAuiMDIParentFrame;
+%rename(PreAuiMDIParentFrame) wxAuiMDIParentFrame::wxAuiMDIParentFrame();
+
+// Ignore these for now because they need a typemap for the return value, see below.
+%ignore wxAuiMDIParentFrame::GetNotebook;
+%ignore wxAuiMDIParentFrame::GetActiveChild;
+%ignore wxAuiMDIParentFrame::GetClientWindow;
+
+%pythonAppend wxAuiMDIChildFrame::wxAuiMDIChildFrame "self._setOORInfo(self)";
+%pythonAppend wxAuiMDIChildFrame::wxAuiMDIChildFrame() "val._setOORInfo(val)";
+%ignore wxAuiMDIChildFrame::~wxAuiMDIChildFrame;
+%rename(PreAuiMDIChildFrame) wxAuiMDIChildFrame::wxAuiMDIChildFrame();
+
+%pythonAppend wxAuiMDIClientWindow::wxAuiMDIClientWindow "self._setOORInfo(self)";
+%pythonAppend wxAuiMDIClientWindow::wxAuiMDIClientWindow() "val._setOORInfo(val)";
+%ignore wxAuiMDIClientWindow::~wxAuiMDIClientWindow;
+%rename(PreAuiMDIClientWindow) wxAuiMDIClientWindow::wxAuiMDIClientWindow();
+
+
+%typemap(out) wxEvtHandler* { $result = wxPyMake_wxObject($1, $owner); }
+
//---------------------------------------------------------------------------
// Get all our defs from the REAL header files.
+
+#define wxColor wxColour // fix problem in dockart.h
+
%include framemanager.h
%include dockart.h
%include floatpane.h
%include auibook.h
+%include tabmdi.h
+
+#undef wxColor
//---------------------------------------------------------------------------
-// Methods to inject into the FrameManager class that will sort out calls to
+// Methods to inject into the AuiManager class that will sort out calls to
// the overloaded versions of GetPane and AddPane
%extend wxAuiManager {
widget reference or by pane name, which acts as a unique id
for a window pane. The returned `PaneInfo` object may then be
modified to change a pane's look, state or position. After one
- or more modifications to the `PaneInfo`, `FrameManager.Update`
+ or more modifications to the `PaneInfo`, `AuiManager.Update`
should be called to realize the changes to the user interface.
If the lookup failed (meaning the pane could not be found in
~wxAuiPaneButton() {}
}
+%extend wxAuiMDIParentFrame {
+ %typemap(out) wxAuiNotebook* { $result = wxPyMake_wxObject($1, $owner); }
+ %typemap(out) wxAuiMDIChildFrame* { $result = wxPyMake_wxObject($1, $owner); }
+ %typemap(out) wxAuiMDIClientWindow* { $result = wxPyMake_wxObject($1, $owner); }
+
+ %rename(GetNotebook) _GetNotebook;
+ %rename(GetActiveChild) _GetActiveChild;
+ %rename(GetClientWindow) _GetClientWindow;
+
+ wxAuiNotebook* _GetNotebook() const
+ {
+ return self->GetNotebook();
+ }
+
+ wxAuiMDIChildFrame* _GetActiveChild() const
+ {
+ return self->GetActiveChild();
+ }
+
+ wxAuiMDIClientWindow* _GetClientWindow() const
+ {
+ return self->GetClientWindow();
+ }
+
+ %typemap(out) wxAuiNotebook*;
+ %typemap(out) wxAuiMDIChildFrame*;
+ %typemap(out) wxAuiMDIClientWindow*;
+}
+
+
//---------------------------------------------------------------------------
%{
// A wxDocArt class that knows how to forward virtuals to Python methods
class wxPyAuiDockArt : public wxAuiDefaultDockArt
{
+public:
wxPyAuiDockArt() : wxAuiDefaultDockArt() {}
DEC_PYCALLBACK_INT_INT(GetMetric);
class wxPyAuiDockArt : public wxAuiDefaultDockArt
{
- %pythonAppend wxPyAuiDockArt "self._setCallbackInfo(self, PyAuiDockArt)"
- wxPyAuiDocArt();
+public:
+ %pythonAppend wxPyAuiDockArt setCallbackInfo(PyAuiDockArt)
+ wxPyAuiDockArt();
+ void _setCallbackInfo(PyObject* self, PyObject* _class);
};
// A wxTabArt class that knows how to forward virtuals to Python methods
class wxPyAuiTabArt : public wxAuiDefaultTabArt
{
+public:
wxPyAuiTabArt() : wxAuiDefaultTabArt() {}
- virtual void DrawBackground( wxDC* dc,
+ virtual void DrawBackground( wxDC& dc,
+ wxWindow* wnd,
const wxRect& rect )
{
bool found;
wxPyBlock_t blocked = wxPyBeginBlockThreads();
if ((found = wxPyCBH_findCallback(m_myInst, "DrawBackground"))) {
- PyObject* odc = wxPyMake_wxObject(dc, false);
+ PyObject* odc = wxPyMake_wxObject(&dc, false);
+ PyObject* ownd = wxPyMake_wxObject(wnd, false);
PyObject* orect = wxPyConstructObject((void*)&rect, wxT("wxRect"), 0);
- wxPyCBH_callCallback(m_myInst, Py_BuildValue("(OO)", odc, orect));
+ wxPyCBH_callCallback(m_myInst, Py_BuildValue("(OOO)", odc, ownd, orect));
Py_DECREF(odc);
+ Py_DECREF(ownd);
Py_DECREF(orect);
}
wxPyEndBlockThreads(blocked);
if (!found)
- wxAuiDefaultTabArt::DrawBackground(dc, rect);
+ wxAuiDefaultTabArt::DrawBackground(dc, wnd, rect);
}
- virtual void DrawTab( wxDC* dc,
+ virtual void DrawTab( wxDC& dc,
+ wxWindow* wnd,
+ const wxAuiNotebookPage& pane,
const wxRect& in_rect,
- const wxString& caption,
- bool active,
- bool with_close_button,
- wxRect* out_rect,
+ int close_button_state,
+ wxRect* out_tab_rect,
+ wxRect* out_button_rect,
int* x_extent)
{
bool found;
- const char* errmsg = "DrawTab should return a sequence containing (out_rect, x_extent)";
+ const char* errmsg = "DrawTab should return a sequence containing (tab_rect, button_rect, x_extent)";
wxPyBlock_t blocked = wxPyBeginBlockThreads();
if ((found = wxPyCBH_findCallback(m_myInst, "DrawTab"))) {
- PyObject* odc = wxPyMake_wxObject(dc, false);
+ PyObject* odc = wxPyMake_wxObject(&dc, false);
+ PyObject* ownd = wxPyMake_wxObject(wnd, false);
+ PyObject* opane = wxPyConstructObject((void*)&pane, wxT("wxAuiNotebookPage"), 0);
PyObject* orect = wxPyConstructObject((void*)&in_rect, wxT("wxRect"), 0);
- PyObject* otext = wx2PyString(caption);
PyObject* ro;
ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue(
- "(OOOii)",
- odc, orect, otext,
- (int)active, (int)with_close_button));
+ "(OOOOOii)",
+ odc, ownd, orect, opane,
+ close_button_state));
if (ro) {
- if (PySequence_Check(ro) && PyObject_Length(ro) == 2) {
+ if (PySequence_Check(ro) && PyObject_Length(ro) == 3) {
PyObject* o1 = PySequence_GetItem(ro, 0);
PyObject* o2 = PySequence_GetItem(ro, 1);
- if (!wxRect_helper(o1, &out_rect))
+ PyObject* o3 = PySequence_GetItem(ro, 2);
+ if (!wxRect_helper(o1, &out_tab_rect))
PyErr_SetString(PyExc_TypeError, errmsg);
- else if (!PyInt_Check(o2))
+ else if (!wxRect_helper(o2, &out_button_rect))
+ PyErr_SetString(PyExc_TypeError, errmsg);
+ else if (!PyInt_Check(o3))
PyErr_SetString(PyExc_TypeError, errmsg);
else
- *x_extent = PyInt_AsLong(o2);
+ *x_extent = PyInt_AsLong(o3);
Py_DECREF(o1);
Py_DECREF(o2);
+ Py_DECREF(o3);
}
else {
PyErr_SetString(PyExc_TypeError, errmsg);
}
Py_DECREF(odc);
+ Py_DECREF(ownd);
Py_DECREF(orect);
- Py_DECREF(otext);
+ Py_DECREF(opane);
}
wxPyEndBlockThreads(blocked);
if (!found)
- wxAuiDefaultTabArt::DrawTab(dc, in_rect, caption, active, with_close_button, out_rect, x_extent);
+ wxAuiDefaultTabArt::DrawTab(dc, wnd, pane, in_rect, close_button_state, out_tab_rect, out_button_rect, x_extent);
}
- virtual void DrawButton( wxDC* dc,
+ virtual void DrawButton( wxDC& dc,
+ wxWindow* wnd,
const wxRect& in_rect,
int bitmap_id,
int button_state,
int orientation,
- const wxBitmap& bitmap_override,
wxRect* out_rect)
{
bool found;
const char* errmsg = "DrawButton should return a wxRect";
wxPyBlock_t blocked = wxPyBeginBlockThreads();
if ((found = wxPyCBH_findCallback(m_myInst, "DrawButton"))) {
- PyObject* odc = wxPyMake_wxObject(dc, false);
+ PyObject* odc = wxPyMake_wxObject(&dc, false);
+ PyObject* ownd = wxPyMake_wxObject(wnd, false);
PyObject* orect = wxPyConstructObject((void*)&in_rect, wxT("wxRect"), 0);
- PyObject* obmp = wxPyConstructObject((void*)&bitmap_override, wxT("wxBitmap"), 0);
PyObject* ro;
- ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(OOiiiO)", odc, orect,
- bitmap_id, button_state, orientation,
- obmp));
+ ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(OOOiiiO)", odc, ownd, orect,
+ bitmap_id, button_state, orientation));
if (ro) {
if (!wxRect_helper(ro, &out_rect))
PyErr_SetString(PyExc_TypeError, errmsg);
}
Py_DECREF(odc);
+ Py_DECREF(ownd);
Py_DECREF(orect);
- Py_DECREF(obmp);
}
wxPyEndBlockThreads(blocked);
if (!found)
- wxAuiDefaultTabArt::DrawButton(dc, in_rect, bitmap_id, button_state, orientation, bitmap_override, out_rect);
+ wxAuiDefaultTabArt::DrawButton(dc, wnd, in_rect, bitmap_id, button_state, orientation, out_rect);
}
-
- virtual wxSize GetTabSize( wxDC* dc,
+
+ virtual wxSize GetTabSize( wxDC& dc,
+ wxWindow* wnd,
const wxString& caption,
+ const wxBitmap& bitmap,
bool active,
- bool with_close_button,
+ int close_button_state,
int* x_extent)
{
bool found;
const char* errmsg = "GetTabSize should return a sequence containing (size, x_extent)";
wxPyBlock_t blocked = wxPyBeginBlockThreads();
if ((found = wxPyCBH_findCallback(m_myInst, "GetTabSize"))) {
- PyObject* odc = wxPyMake_wxObject(dc, false);
+ PyObject* odc = wxPyMake_wxObject(&dc, false);
+ PyObject* ownd = wxPyMake_wxObject(wnd, false);
PyObject* otext = wx2PyString(caption);
+ PyObject* obmp = wxPyMake_wxObject((wxObject*)&bitmap, false);
PyObject* ro;
ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue(
- "(OOi)", odc, otext, (int)active, (int)with_close_button));
+ "(OOOOii)", odc, ownd, otext, obmp, (int)active, close_button_state));
if (ro) {
if (PySequence_Check(ro) && PyObject_Length(ro) == 2) {
PyObject* o1 = PySequence_GetItem(ro, 0);
}
Py_DECREF(odc);
+ Py_DECREF(ownd);
Py_DECREF(otext);
+ Py_DECREF(obmp);
}
wxPyEndBlockThreads(blocked);
if (!found)
- rv = wxAuiDefaultTabArt::GetTabSize(dc, caption, active, with_close_button, x_extent);
+ rv = wxAuiDefaultTabArt::GetTabSize(dc, wnd, caption, bitmap, active, close_button_state, x_extent);
return rv;
}
-
-
+
+// TODO
+// virtual int ShowDropDown(
+// wxWindow* wnd,
+// const wxAuiNotebookPageArray& items,
+// int active_idx);
+
+// virtual int GetIndentSize();
+
+// virtual int GetBestTabCtrlSize(wxWindow* wnd,
+// const wxAuiNotebookPageArray& pages,
+// const wxSize& required_bmp_size);
+// virtual wxAuiTabArt* Clone();
+// virtual void SetFlags(unsigned int flags);
+// virtual void SetSizingInfo(const wxSize& tab_ctrl_size,
+// size_t tab_count);
+// virtual int GetIndentSize();
+
+
DEC_PYCALLBACK__FONT(SetNormalFont);
DEC_PYCALLBACK__FONT(SetSelectedFont);
DEC_PYCALLBACK__FONT(SetMeasuringFont);
- DEC_PYCALLBACK_INT_WIN(GetBestTabCtrlSize);
PYPRIVATE;
};
IMP_PYCALLBACK__FONT(wxPyAuiTabArt, wxAuiDefaultTabArt, SetNormalFont);
IMP_PYCALLBACK__FONT(wxPyAuiTabArt, wxAuiDefaultTabArt, SetSelectedFont);
IMP_PYCALLBACK__FONT(wxPyAuiTabArt, wxAuiDefaultTabArt, SetMeasuringFont);
-IMP_PYCALLBACK_INT_WIN(wxPyAuiTabArt, wxAuiDefaultTabArt, GetBestTabCtrlSize);
%}
class wxPyAuiTabArt : public wxAuiDefaultTabArt
{
- %pythonAppend wxPyAuiTabArt "self._setCallbackInfo(self, PyAuiTabArt)"
+public:
+ %pythonAppend wxPyAuiTabArt setCallbackInfo(PyAuiTabArt)
wxPyAuiTabArt();
+ void _setCallbackInfo(PyObject* self, PyObject* _class);
};
//---------------------------------------------------------------------------
-#undef wxUSE_AUI
-#undef WXDLLIMPEXP_AUI
-
-//---------------------------------------------------------------------------