Factory some of wxFilterClassFactory into a base class.

[wxWidgets.git] / wxPython / src / wizard.i

diff --git a/wxPython/src/wizard.i b/wxPython/src/wizard.i
index 309da8bac3a6e46628de591cbb384a929f119bc8..18677ef176f0b83091faf78f40df9b6448fbebd4 100644 (file)
--- a/wxPython/src/wizard.i
+++ b/wxPython/src/wizard.i
@@ -10,7 +10,12 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 

-%module wizard
+%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/wxPython.h"


@@ -25,8 +30,7 @@
 
 %import windows.i
 %pythoncode { wx = _core }
 
 %import windows.i
 %pythoncode { wx = _core }

-
-%include _wizard_rename.i
+%pythoncode { __docfilter__ = wx.__DocFilter(globals()) }

 
 MAKE_CONST_WXSTRING_NOSWIG(EmptyString);
 
 
 MAKE_CONST_WXSTRING_NOSWIG(EmptyString);
 


@@ -59,16 +63,19 @@ class wxWizardEvent : public wxNotifyEvent
 public:
     wxWizardEvent(wxEventType type = wxEVT_NULL,
                   int id = -1,
 public:
     wxWizardEvent(wxEventType type = wxEVT_NULL,
                   int id = -1,

-                  bool direction = True,
+                  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)
                   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; }
+    bool GetDirection() const;

 
 

-    wxWizardPage*   GetPage() const { return m_page; }
+    wxWizardPage*   GetPage() const;
+
+    %property(Direction, GetDirection, doc="See `GetDirection`");
+    %property(Page, GetPage, doc="See `GetPage`");

 };
 
 
 };
 
 


@@ -79,6 +86,7 @@ public:
 //
 // 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).
 //
 // 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:
 class wxWizardPage : public wxPanel
 {
 public:


@@ -89,14 +97,14 @@ public:
 //     wxWizardPage(wxWizard *parent,
 //                  const wxBitmap& bitmap = wxNullBitmap,
 //                  const char* resource = NULL);
 //     wxWizardPage(wxWizard *parent,
 //                  const wxBitmap& bitmap = wxNullBitmap,
 //                  const char* resource = NULL);

-//     %name(PreWizardPage)wxWizardPage();
+//     %RenameCtor(PreWizardPage, wxWizardPage());

 
     %extend {
         bool Create(wxWizard *parent,
                     const wxBitmap& bitmap = wxNullBitmap,
                     const wxString& resource = wxPyEmptyString) {
             wxChar* res = NULL;
 
     %extend {
         bool Create(wxWizard *parent,
                     const wxBitmap& bitmap = wxNullBitmap,
                     const wxString& resource = wxPyEmptyString) {
             wxChar* res = NULL;

-            if (resource.Length())
+            if (resource.length())

                 res = (wxChar*)resource.c_str();
             return self->Create(parent, bitmap, res);
         }
                 res = (wxChar*)resource.c_str();
             return self->Create(parent, bitmap, res);
         }


@@ -113,13 +121,17 @@ public:
     // 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;
     // 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;

+
+    %property(Bitmap, GetBitmap, doc="See `GetBitmap`");
+    %property(Next, GetNext, doc="See `GetNext`");
+    %property(Prev, GetPrev, doc="See `GetPrev`");

 };
 
 
 
 %{  // C++ Version of a Python aware class
 class wxPyWizardPage : public wxWizardPage {
 };
 
 
 
 %{  // C++ Version of a Python aware class
 class wxPyWizardPage : public wxWizardPage {

-    DECLARE_ABSTRACT_CLASS(wxPyWizardPage);
+    DECLARE_ABSTRACT_CLASS(wxPyWizardPage)

 public:
     wxPyWizardPage() : wxWizardPage() {}
     wxPyWizardPage(wxWizard *parent,
 public:
     wxPyWizardPage() : wxWizardPage() {}
     wxPyWizardPage(wxWizard *parent,


@@ -193,11 +205,14 @@ 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() ""
 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
     
     // 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


@@ -208,20 +223,23 @@ public:
                        const wxBitmap* bitmap = &wxNullBitmap,
                        const wxString* resource = &wxPyEmptyString) {
             wxChar* res = NULL;
                        const wxBitmap* bitmap = &wxNullBitmap,
                        const wxString* resource = &wxPyEmptyString) {
             wxChar* res = NULL;

-            if (resource->Length())
+            if (resource->length())

                 res = (wxChar*)resource->c_str();
             return new wxPyWizardPage(parent, *bitmap, res);
         }
     }
 
                 res = (wxChar*)resource->c_str();
             return new wxPyWizardPage(parent, *bitmap, res);
         }
     }
 

-    %name(PrePyWizardPage)wxPyWizardPage();
+    %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;
 
     %extend {
         bool Create(wxWizard *parent,
                     const wxBitmap& bitmap = wxNullBitmap,
                     const wxString& resource = wxPyEmptyString) {
             wxChar* res = NULL;

-            if (resource.Length())
+            if (resource.length())

                 res = (wxChar*)resource.c_str();
             return self->Create(parent, bitmap, res);
         }
                 res = (wxChar*)resource.c_str();
             return self->Create(parent, bitmap, res);
         }


@@ -229,36 +247,64 @@ public:
 
     void _setCallbackInfo(PyObject* self, PyObject* _class);
 
 
     void _setCallbackInfo(PyObject* self, PyObject* _class);
 

-    void base_DoMoveWindow(int x, int y, int width, int height);
-    void base_DoSetSize(int x, int y, int width, int height,
+    void DoMoveWindow(int x, int y, int width, int height);
+    void DoSetSize(int x, int y, int width, int height,

                         int sizeFlags = wxSIZE_AUTO);
                         int sizeFlags = wxSIZE_AUTO);

-    void base_DoSetClientSize(int width, int height);
-    void base_DoSetVirtualSize( int x, int y );
+    void DoSetClientSize(int width, int height);
+    void DoSetVirtualSize( int x, int y );

 
     DocDeclA(
 
     DocDeclA(

-        void, base_DoGetSize( int *OUTPUT, int *OUTPUT ) const,
-        "base_DoGetSize() -> (width, height)");
+        void, DoGetSize( int *OUTPUT, int *OUTPUT ) const,
+        "DoGetSize() -> (width, height)");

     DocDeclA(
     DocDeclA(

-        void, base_DoGetClientSize( int *OUTPUT, int *OUTPUT ) const,
-        "base_DoGetClientSize() -> (width, height)");
+        void, DoGetClientSize( int *OUTPUT, int *OUTPUT ) const,
+        "DoGetClientSize() -> (width, height)");

     DocDeclA(
     DocDeclA(

-        void, base_DoGetPosition( int *OUTPUT, int *OUTPUT ) const,
-        "base_DoGetPosition() -> (x,y)");
-
-    wxSize base_DoGetVirtualSize() const;
-    wxSize base_DoGetBestSize() const;
-
-    void base_InitDialog();
-    bool base_TransferDataToWindow();
-    bool base_TransferDataFromWindow();
-    bool base_Validate();
-
-    bool base_AcceptsFocus() const;
-    bool base_AcceptsFocusFromKeyboard() const;
-    wxSize base_GetMaxSize() const;
-
-    void base_AddChild(wxWindow* child);
-    void base_RemoveChild(wxWindow* child);
+        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);
+    

 };
 
 //----------------------------------------------------------------------
 };
 
 //----------------------------------------------------------------------


@@ -270,6 +316,7 @@ public:
 // 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.
 // 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:
 class wxWizardPageSimple : public wxWizardPage
 {
 public:


@@ -283,7 +330,7 @@ public:
                        wxWizardPage *next = NULL,
                        const wxBitmap& bitmap = wxNullBitmap,
                        const wxChar* resource = NULL);
                        wxWizardPage *next = NULL,
                        const wxBitmap& bitmap = wxNullBitmap,
                        const wxChar* resource = NULL);

-    %name(PreWizardPageSimple)wxWizardPageSimple();
+    %RenameCtor(PreWizardPageSimple, wxWizardPageSimple());

 
     bool Create(wxWizard *parent = NULL,
                 wxWizardPage *prev = NULL,
 
     bool Create(wxWizard *parent = NULL,
                 wxWizardPage *prev = NULL,


@@ -302,6 +349,8 @@ public:
 
 //----------------------------------------------------------------------
 
 
 //----------------------------------------------------------------------
 

+MustHaveApp(wxWizard);
+

 class  wxWizard : public wxDialog
 {
 public:
 class  wxWizard : public wxDialog
 {
 public:


@@ -315,7 +364,7 @@ public:
              const wxBitmap& bitmap = wxNullBitmap,
              const wxPoint& pos = wxDefaultPosition,
              long style = wxDEFAULT_DIALOG_STYLE);
              const wxBitmap& bitmap = wxNullBitmap,
              const wxPoint& pos = wxDefaultPosition,
              long style = wxDEFAULT_DIALOG_STYLE);

-    %name(PreWizard)wxWizard();
+    %RenameCtor(PreWizard, wxWizard());

 
     bool Create(wxWindow *parent,
              int id = -1,
 
     bool Create(wxWindow *parent,
              int id = -1,


@@ -359,15 +408,19 @@ public:
     virtual void SetBorder(int border);
 
     // is the wizard running?
     virtual void SetBorder(int border);
 
     // is the wizard running?

-    bool IsRunning() const { return m_page != NULL; }
+    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
 
     // 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 ShowPage(wxWizardPage *page, bool goingForward = true);

 
     bool HasNextPage(wxWizardPage* page);
     bool HasPrevPage(wxWizardPage* page);
 
     bool HasNextPage(wxWizardPage* page);
     bool HasPrevPage(wxWizardPage* page);

+    
+    %property(CurrentPage, GetCurrentPage, doc="See `GetCurrentPage`");
+    %property(PageAreaSizer, GetPageAreaSizer, doc="See `GetPageAreaSizer`");
+    %property(PageSize, GetPageSize, SetPageSize, doc="See `GetPageSize` and `SetPageSize`");

 };
 
 
 };