///////////////////////////////////////////////////////////////////////////// // Name: wizard.i // Purpose: Classes for wxWizard and etc. // // Author: Robin Dunn // // Created: 16-Aug-2002 // RCS-ID: $Id$ // Copyright: (c) 2002 by Total Control Software // Licence: wxWindows license ///////////////////////////////////////////////////////////////////////////// %define DOCSTRING "`Wizard` is a dialog class that guides the user through a sequence of steps, or pages." %enddef %module(package="wx", docstring=DOCSTRING) wizard %{ #include "wx/wxPython/wxPython.h" #include "wx/wxPython/pyclasses.h" #include "wx/wxPython/printfw.h" #include %} //---------------------------------------------------------------------- %import windows.i %pythoncode { wx = _core } %pythoncode { __docfilter__ = wx.__DocFilter(globals()) } MAKE_CONST_WXSTRING_NOSWIG(EmptyString); //---------------------------------------------------------------------- enum { wxWIZARD_EX_HELPBUTTON, }; %constant wxEventType wxEVT_WIZARD_PAGE_CHANGED; %constant wxEventType wxEVT_WIZARD_PAGE_CHANGING; %constant wxEventType wxEVT_WIZARD_CANCEL; %constant wxEventType wxEVT_WIZARD_HELP; %constant wxEventType wxEVT_WIZARD_FINISHED; %pythoncode { EVT_WIZARD_PAGE_CHANGED = wx.PyEventBinder( wxEVT_WIZARD_PAGE_CHANGED, 1) EVT_WIZARD_PAGE_CHANGING = wx.PyEventBinder( wxEVT_WIZARD_PAGE_CHANGING, 1) EVT_WIZARD_CANCEL = wx.PyEventBinder( wxEVT_WIZARD_CANCEL, 1) EVT_WIZARD_HELP = wx.PyEventBinder( wxEVT_WIZARD_HELP, 1) EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1) } //---------------------------------------------------------------------- class wxWizardEvent : public wxNotifyEvent { public: wxWizardEvent(wxEventType type = wxEVT_NULL, int id = -1, bool direction = true, wxWizardPage* page = NULL); // for EVT_WIZARD_PAGE_CHANGING, return True if we're going forward or // False otherwise and for EVT_WIZARD_PAGE_CHANGED return True if we came // from the previous page and False if we returned from the next one // (this function doesn't make sense for CANCEL events) bool GetDirection() const { return m_direction; } wxWizardPage* GetPage() const { return m_page; } }; //---------------------------------------------------------------------- // wxWizardPage is one of the wizards screen: it must know what are the // following and preceding pages (which may be NULL for the first/last page). // // Other than GetNext/Prev() functions, wxWizardPage is just a panel and may be // used as such (i.e. controls may be placed directly on it &c). MustHaveApp(wxWizardPage); class wxWizardPage : public wxPanel { public: // // ctor accepts an optional bitmap which will be used for this page instead // // of the default one for this wizard (should be of the same size). Notice // // that no other parameters are needed because the wizard will resize and // // reposition the page anyhow // wxWizardPage(wxWizard *parent, // const wxBitmap& bitmap = wxNullBitmap, // const char* resource = NULL); // %RenameCtor(PreWizardPage, wxWizardPage()); %extend { bool Create(wxWizard *parent, const wxBitmap& bitmap = wxNullBitmap, const wxString& resource = wxPyEmptyString) { wxChar* res = NULL; if (resource.length()) res = (wxChar*)resource.c_str(); return self->Create(parent, bitmap, res); } } // these functions are used by the wizard to show another page when the // user chooses "Back" or "Next" button virtual wxWizardPage *GetPrev() const; virtual wxWizardPage *GetNext() const; // default GetBitmap() will just return m_bitmap which is ok in 99% of // cases - override this method if you want to create the bitmap to be used // dynamically or to do something even more fancy. It's ok to return // wxNullBitmap from here - the default one will be used then. virtual wxBitmap GetBitmap() const; }; %{ // C++ Version of a Python aware class class wxPyWizardPage : public wxWizardPage { DECLARE_ABSTRACT_CLASS(wxPyWizardPage) public: wxPyWizardPage() : wxWizardPage() {} wxPyWizardPage(wxWizard *parent, const wxBitmap& bitmap = wxNullBitmap, const wxChar* resource = NULL) : wxWizardPage(parent, bitmap, resource) {} DEC_PYCALLBACK_WIZPG__pure(GetPrev); DEC_PYCALLBACK_WIZPG__pure(GetNext); DEC_PYCALLBACK_BITMAP__pure(GetBitmap); DEC_PYCALLBACK_VOID_INT4(DoMoveWindow); DEC_PYCALLBACK_VOID_INT5(DoSetSize); DEC_PYCALLBACK_VOID_INTINT(DoSetClientSize); DEC_PYCALLBACK_VOID_INTINT(DoSetVirtualSize); DEC_PYCALLBACK_VOID_INTPINTP_const(DoGetSize); DEC_PYCALLBACK_VOID_INTPINTP_const(DoGetClientSize); DEC_PYCALLBACK_VOID_INTPINTP_const(DoGetPosition); DEC_PYCALLBACK_SIZE_const(DoGetVirtualSize); DEC_PYCALLBACK_SIZE_const(DoGetBestSize); DEC_PYCALLBACK__(InitDialog); DEC_PYCALLBACK_BOOL_(TransferDataFromWindow); DEC_PYCALLBACK_BOOL_(TransferDataToWindow); DEC_PYCALLBACK_BOOL_(Validate); DEC_PYCALLBACK_BOOL_const(AcceptsFocus); DEC_PYCALLBACK_BOOL_const(AcceptsFocusFromKeyboard); DEC_PYCALLBACK_SIZE_const(GetMaxSize); DEC_PYCALLBACK_VOID_WXWINBASE(AddChild); DEC_PYCALLBACK_VOID_WXWINBASE(RemoveChild); PYPRIVATE; }; IMPLEMENT_ABSTRACT_CLASS(wxPyWizardPage, wxWizardPage); IMP_PYCALLBACK_WIZPG__pure(wxPyWizardPage, wxWizardPage, GetPrev); IMP_PYCALLBACK_WIZPG__pure(wxPyWizardPage, wxWizardPage, GetNext); IMP_PYCALLBACK_BITMAP__pure(wxPyWizardPage, wxWizardPage, GetBitmap); IMP_PYCALLBACK_VOID_INT4(wxPyWizardPage, wxWizardPage, DoMoveWindow); IMP_PYCALLBACK_VOID_INT5(wxPyWizardPage, wxWizardPage, DoSetSize); IMP_PYCALLBACK_VOID_INTINT(wxPyWizardPage, wxWizardPage, DoSetClientSize); IMP_PYCALLBACK_VOID_INTINT(wxPyWizardPage, wxWizardPage, DoSetVirtualSize); IMP_PYCALLBACK_VOID_INTPINTP_const(wxPyWizardPage, wxWizardPage, DoGetSize); IMP_PYCALLBACK_VOID_INTPINTP_const(wxPyWizardPage, wxWizardPage, DoGetClientSize); IMP_PYCALLBACK_VOID_INTPINTP_const(wxPyWizardPage, wxWizardPage, DoGetPosition); IMP_PYCALLBACK_SIZE_const(wxPyWizardPage, wxWizardPage, DoGetVirtualSize); IMP_PYCALLBACK_SIZE_const(wxPyWizardPage, wxWizardPage, DoGetBestSize); IMP_PYCALLBACK__(wxPyWizardPage, wxWizardPage, InitDialog); IMP_PYCALLBACK_BOOL_(wxPyWizardPage, wxWizardPage, TransferDataFromWindow); IMP_PYCALLBACK_BOOL_(wxPyWizardPage, wxWizardPage, TransferDataToWindow); IMP_PYCALLBACK_BOOL_(wxPyWizardPage, wxWizardPage, Validate); IMP_PYCALLBACK_BOOL_const(wxPyWizardPage, wxWizardPage, AcceptsFocus); IMP_PYCALLBACK_BOOL_const(wxPyWizardPage, wxWizardPage, AcceptsFocusFromKeyboard); IMP_PYCALLBACK_SIZE_const(wxPyWizardPage, wxWizardPage, GetMaxSize); IMP_PYCALLBACK_VOID_WXWINBASE(wxPyWizardPage, wxWizardPage, AddChild); IMP_PYCALLBACK_VOID_WXWINBASE(wxPyWizardPage, wxWizardPage, RemoveChild); %} MustHaveApp(wxPyWizardPage); class wxPyWizardPage : public wxWizardPage { public: %pythonAppend wxPyWizardPage "self._setCallbackInfo(self, PyWizardPage);self._setOORInfo(self)" %pythonAppend wxPyWizardPage() "" %typemap(out) wxPyWizardPage*; // turn off this typemap // ctor accepts an optional bitmap which will be used for this page instead // of the default one for this wizard (should be of the same size). Notice // that no other parameters are needed because the wizard will resize and // reposition the page anyhow %extend { wxPyWizardPage(wxWizard *parent, const wxBitmap* bitmap = &wxNullBitmap, const wxString* resource = &wxPyEmptyString) { wxChar* res = NULL; if (resource->length()) res = (wxChar*)resource->c_str(); return new wxPyWizardPage(parent, *bitmap, res); } } %RenameCtor(PrePyWizardPage, wxPyWizardPage()); // Turn it back on again %typemap(out) wxPyWizardPage* { $result = wxPyMake_wxObject($1, $owner); } %extend { bool Create(wxWizard *parent, const wxBitmap& bitmap = wxNullBitmap, const wxString& resource = wxPyEmptyString) { wxChar* res = NULL; if (resource.length()) res = (wxChar*)resource.c_str(); return self->Create(parent, bitmap, res); } } void _setCallbackInfo(PyObject* self, PyObject* _class); void DoMoveWindow(int x, int y, int width, int height); void DoSetSize(int x, int y, int width, int height, int sizeFlags = wxSIZE_AUTO); void DoSetClientSize(int width, int height); void DoSetVirtualSize( int x, int y ); DocDeclA( void, DoGetSize( int *OUTPUT, int *OUTPUT ) const, "DoGetSize() -> (width, height)"); DocDeclA( void, DoGetClientSize( int *OUTPUT, int *OUTPUT ) const, "DoGetClientSize() -> (width, height)"); DocDeclA( void, DoGetPosition( int *OUTPUT, int *OUTPUT ) const, "DoGetPosition() -> (x,y)"); wxSize DoGetVirtualSize() const; wxSize DoGetBestSize() const; void InitDialog(); bool TransferDataToWindow(); bool TransferDataFromWindow(); bool Validate(); bool AcceptsFocus() const; bool AcceptsFocusFromKeyboard() const; wxSize GetMaxSize() const; void AddChild(wxWindow* child); void RemoveChild(wxWindow* child); bool ShouldInheritColours() const; wxVisualAttributes GetDefaultAttributes(); void OnInternalIdle(); %MAKE_BASE_FUNC(PyWizardPage, DoMoveWindow); %MAKE_BASE_FUNC(PyWizardPage, DoSetSize); %MAKE_BASE_FUNC(PyWizardPage, DoSetClientSize); %MAKE_BASE_FUNC(PyWizardPage, DoSetVirtualSize); %MAKE_BASE_FUNC(PyWizardPage, DoGetSize); %MAKE_BASE_FUNC(PyWizardPage, DoGetClientSize); %MAKE_BASE_FUNC(PyWizardPage, DoGetPosition); %MAKE_BASE_FUNC(PyWizardPage, DoGetVirtualSize); %MAKE_BASE_FUNC(PyWizardPage, DoGetBestSize); %MAKE_BASE_FUNC(PyWizardPage, InitDialog); %MAKE_BASE_FUNC(PyWizardPage, TransferDataToWindow); %MAKE_BASE_FUNC(PyWizardPage, TransferDataFromWindow); %MAKE_BASE_FUNC(PyWizardPage, Validate); %MAKE_BASE_FUNC(PyWizardPage, AcceptsFocus); %MAKE_BASE_FUNC(PyWizardPage, AcceptsFocusFromKeyboard); %MAKE_BASE_FUNC(PyWizardPage, GetMaxSize); %MAKE_BASE_FUNC(PyWizardPage, AddChild); %MAKE_BASE_FUNC(PyWizardPage, RemoveChild); %MAKE_BASE_FUNC(PyWizardPage, ShouldInheritColours); %MAKE_BASE_FUNC(PyWizardPage, GetDefaultAttributes); %MAKE_BASE_FUNC(PyWizardPage, OnInternalIdle); }; //---------------------------------------------------------------------- // wxWizardPageSimple just returns the pointers given to the ctor and is useful // to create a simple wizard where the order of pages never changes. // // OTOH, it is also possible to dynamicly decide which page to return (i.e. // depending on the user's choices) as the wizard sample shows - in order to do // this, you must derive from wxWizardPage directly. MustHaveApp(wxWizardPageSimple); class wxWizardPageSimple : public wxWizardPage { public: %pythonAppend wxWizardPageSimple "self._setOORInfo(self)" %pythonAppend wxWizardPageSimple() "" // ctor takes the previous and next pages wxWizardPageSimple(wxWizard *parent, wxWizardPage *prev = NULL, wxWizardPage *next = NULL, const wxBitmap& bitmap = wxNullBitmap, const wxChar* resource = NULL); %RenameCtor(PreWizardPageSimple, wxWizardPageSimple()); bool Create(wxWizard *parent = NULL, wxWizardPage *prev = NULL, wxWizardPage *next = NULL, const wxBitmap& bitmap = wxNullBitmap, const wxChar* resource = NULL); // the pointers may be also set later - but before starting the wizard void SetPrev(wxWizardPage *prev); void SetNext(wxWizardPage *next); // a convenience function to make the pages follow each other static void Chain(wxWizardPageSimple *first, wxWizardPageSimple *second); }; //---------------------------------------------------------------------- MustHaveApp(wxWizard); class wxWizard : public wxDialog { public: %pythonAppend wxWizard "self._setOORInfo(self)" %pythonAppend wxWizard() "" // ctor wxWizard(wxWindow *parent, int id = -1, const wxString& title = wxPyEmptyString, const wxBitmap& bitmap = wxNullBitmap, const wxPoint& pos = wxDefaultPosition, long style = wxDEFAULT_DIALOG_STYLE); %RenameCtor(PreWizard, wxWizard()); bool Create(wxWindow *parent, int id = -1, const wxString& title = wxPyEmptyString, const wxBitmap& bitmap = wxNullBitmap, const wxPoint& pos = wxDefaultPosition); void Init(); // executes the wizard starting from the given page, returns True if it was // successfully finished, False if user cancelled it virtual bool RunWizard(wxWizardPage *firstPage); // get the current page (NULL if RunWizard() isn't running) virtual wxWizardPage *GetCurrentPage() const; // set the min size which should be available for the pages: a // wizard will take into account the size of the bitmap (if any) // itself and will never be less than some predefined fixed size virtual void SetPageSize(const wxSize& size); // get the size available for the page: the wizards are not resizeable, so // this size doesn't change virtual wxSize GetPageSize() const; // set the best size for the wizard, i.e. make it big enough to contain all // of the pages starting from the given one // // this function may be called several times and possible with different // pages in which case it will only increase the page size if needed (this // may be useful if not all pages are accessible from the first one by // default) virtual void FitToPage(const wxWizardPage *firstPage); // Adding pages to page area sizer enlarges wizard virtual wxSizer *GetPageAreaSizer() const; // Set border around page area. Default is 0 if you add at least one // page to GetPageAreaSizer and 5 if you don't. virtual void SetBorder(int border); // is the wizard running? bool IsRunning() const; // show the prev/next page, but call TransferDataFromWindow on the current // page first and return False without changing the page if // TransferDataFromWindow() returns False - otherwise, returns True bool ShowPage(wxWizardPage *page, bool goingForward = true); bool HasNextPage(wxWizardPage* page); bool HasPrevPage(wxWizardPage* page); }; //---------------------------------------------------------------------- %init %{ %} //---------------------------------------------------------------------------