]> git.saurik.com Git - wxWidgets.git/blobdiff - wxPython/src/windows2.i
Added more meta-data for PyPi
[wxWidgets.git] / wxPython / src / windows2.i
index d8b73f326b717ad96b7b650d9b3117b89ef15b8b..20d6329a905ba573fd33db89d89bf07d3a889c26 100644 (file)
 
 %{
 #include "helpers.h"
-#ifdef OLD_GRID
-#include <wx/grid.h>
-#endif
 #include <wx/notebook.h>
+#include <wx/listbook.h>
 #include <wx/splitter.h>
 #include <wx/imaglist.h>
 #ifdef __WXMSW__
-#include <wx/msw/taskbar.h>
+#include <wx/taskbar.h>
 #endif
 %}
 
 
 %pragma(python) code = "import wx"
 
+//---------------------------------------------------------------------------
 //---------------------------------------------------------------------------
 
-enum {
-     /* notebook control event types */
-    wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED,
-    wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING,
+// TODO:  Virtualize this class so other book controls can be derived in Python
+
+class wxBookCtrl : public wxControl
+{
+public:
+    // This is an ABC, it can't be constructed...
+//     wxBookCtrl(wxWindow *parent,
+//                wxWindowID id,
+//                const wxPoint& pos = wxDefaultPosition,
+//                const wxSize& size = wxDefaultSize,
+//                long style = 0,
+//                const wxString& name = wxPyEmptyString);
+//     %name(wxPreBookCtrl)wxBookCtrl();
+//     bool Create(wxWindow *parent,
+//                 wxWindowID id,
+//                 const wxPoint& pos = wxDefaultPosition,
+//                 const wxSize& size = wxDefaultSize,
+//                 long style = 0,
+//                 const wxString& name = wxPyEmptyString);
+//     %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
+//     %pragma(python) addtomethod = "wxPreBookCtrl:val._setOORInfo(val)"
+
+
+    // get number of pages in the dialog
+    virtual size_t GetPageCount() const;
+
+    // get the panel which represents the given page
+    virtual wxWindow *GetPage(size_t n);
+
+    // get the currently selected page or wxNOT_FOUND if none
+    virtual int GetSelection() const = 0;
+
+    // set/get the title of a page
+    virtual bool SetPageText(size_t n, const wxString& strText) = 0;
+    virtual wxString GetPageText(size_t n) const = 0;
+
+
+    // image list stuff: each page may have an image associated with it (all
+    // images belong to the same image list)
+
+    // sets the image list to use, it is *not* deleted by the control
+    virtual void SetImageList(wxImageList *imageList);
+
+    // as SetImageList() but we will delete the image list ourselves
+    void AssignImageList(wxImageList *imageList);
+    %pragma(python) addtomethod = "AssignImageList:_args[0].thisown = 0"
+
+    // get pointer (may be NULL) to the associated image list
+    wxImageList* GetImageList() const;
+
+    // sets/returns item's image index in the current image list
+    virtual int GetPageImage(size_t n) const = 0;
+    virtual bool SetPageImage(size_t n, int imageId) = 0;
+
+
+    // resize the notebook so that all pages will have the specified size
+    virtual void SetPageSize(const wxSize& size);
+
+    // calculate the size of the control from the size of its page
+    virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const = 0;
+
+
+
+    // remove one page from the control and delete it
+    virtual bool DeletePage(size_t n);
+
+    // remove one page from the notebook, without deleting it
+    virtual bool RemovePage(size_t n);
+
+    // remove all pages and delete them
+    virtual bool DeleteAllPages();
+
+    // adds a new page to the control
+    virtual bool AddPage(wxWindow *page,
+                         const wxString& text,
+                         bool select = false,
+                         int imageId = -1);
+
+    // the same as AddPage(), but adds the page at the specified position
+    virtual bool InsertPage(size_t n,
+                            wxWindow *page,
+                            const wxString& text,
+                            bool select = false,
+                            int imageId = -1) = 0;
+
+    // set the currently selected page, return the index of the previously
+    // selected one (or -1 on error)
+    //
+    // NB: this function will _not_ generate PAGE_CHANGING/ED events
+    virtual int SetSelection(size_t n) = 0;
+
+
+    // cycle thru the pages
+    void AdvanceSelection(bool forward = true);
 };
 
 
-class wxNotebookEvent : public wxNotifyEvent {
+
+class wxBookCtrlEvent : public wxNotifyEvent
+{
 public:
-    wxNotebookEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
+    wxBookCtrlEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
                     int nSel = -1, int nOldSel = -1);
 
-    int GetSelection();
-    int GetOldSelection();
-    void SetOldSelection(int page);
-    void SetSelection(int page);
+        // the currently selected page (-1 if none)
+    int GetSelection() const;
+    void SetSelection(int nSel);
+        // the page that was selected before the change (-1 if none)
+    int GetOldSelection() const;
+    void SetOldSelection(int nOldSel);
 };
 
 
+//---------------------------------------------------------------------------
+
+enum {
+    // notebook control event types
+    wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED,
+    wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING,
+
+    // styles
+    wxNB_FIXEDWIDTH,
+    wxNB_TOP,
+    wxNB_LEFT,
+    wxNB_RIGHT,
+    wxNB_BOTTOM,
+    wxNB_MULTILINE,
+
+    // hittest flags
+    wxNB_HITTEST_NOWHERE = 1,   // not on tab
+    wxNB_HITTEST_ONICON  = 2,   // on icon
+    wxNB_HITTEST_ONLABEL = 4,   // on label
+    wxNB_HITTEST_ONITEM  = wxNB_HITTEST_ONICON | wxNB_HITTEST_ONLABEL,
+
+};
 
-class wxNotebook : public wxControl {
+
+
+class wxNotebook : public wxBookCtrl {
 public:
     wxNotebook(wxWindow *parent,
                wxWindowID id,
@@ -95,48 +212,129 @@ public:
     %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
     %pragma(python) addtomethod = "wxPreNotebook:val._setOORInfo(val)"
 
-    int GetPageCount();
-    int SetSelection(int nPage);
-    void AdvanceSelection(bool bForward = TRUE);
+
+    // get the number of rows for a control with wxNB_MULTILINE style (not all
+    // versions support it - they will always return 1 then)
+    virtual int GetRowCount() const;
+
+    // set the padding between tabs (in pixels)
+    virtual void SetPadding(const wxSize& padding);
+
+    // set the size of the tabs for wxNB_FIXEDWIDTH controls
+    virtual void SetTabSize(const wxSize& sz);
+
+    // hit test, returns which tab is hit and, optionally, where (icon, label)
+    // (not implemented on all platforms)
+    virtual int HitTest(const wxPoint& pt, long* OUTPUT) const;
+
+    // implement some base class functions
+    virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const;
+
+#ifdef __WXMSW__
+    // Windows only: attempts to apply the UX theme page background to this page
+  void ApplyThemeBackground(wxWindow* window, const wxColour& colour);
+#endif
+};
+
+
+
+
+
+class wxNotebookEvent : public wxNotifyEvent {
+public:
+    wxNotebookEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
+                    int sel = -1, int oldSel = -1);
+
     int GetSelection();
-    bool SetPageText(int nPage, const wxString& strText);
-    wxString GetPageText(int nPage) const;
+    int GetOldSelection();
+    void SetOldSelection(int page);
+    void SetSelection(int page);
+};
 
-    void SetImageList(wxImageList* imageList);
-    void AssignImageList(wxImageList *imageList) ;
-    %pragma(python) addtomethod = "AssignImageList:_args[0].thisown = 0"
 
-    wxImageList* GetImageList();
-    int  GetPageImage(int nPage);
-    bool SetPageImage(int nPage, int nImage);
-    int GetRowCount();
-
-    void SetPageSize(const wxSize& size);
-    void SetPadding(const wxSize& padding);
-    bool DeletePage(int nPage);
-    bool RemovePage(int nPage);
-    bool DeleteAllPages();
-    bool AddPage(/*wxNotebookPage*/ wxWindow *pPage,
-                 const wxString& strText,
-                 int bSelect = FALSE,
-                 int imageId = -1);
-    bool InsertPage(int nPage,
-                    /*wxNotebookPage*/ wxWindow *pPage,
-                    const wxString& strText,
-                    bool bSelect = FALSE,
-                    int imageId = -1);
-    /*wxNotebookPage*/ wxWindow *GetPage(int nPage);
-
-    %addmethods {
-        void ResizeChildren() {
-            wxSizeEvent evt(self->GetClientSize());
-            self->GetEventHandler()->ProcessEvent(evt);
-        }
-    }
+%pragma(python) code = "
+# wxNotebook events
+def EVT_NOTEBOOK_PAGE_CHANGED(win, id, func):
+    win.Connect(id, -1, wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, func)
+
+def EVT_NOTEBOOK_PAGE_CHANGING(win, id, func):
+    win.Connect(id, -1, wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, func)
+"
+
+
+//---------------------------------------------------------------------------
+
+
+enum
+{
+    // default alignment: left everywhere except Mac where it is top
+    wxLB_DEFAULT = 0,
+
+    // put the list control to the left/right/top/bottom of the page area
+    wxLB_TOP    = 0x1,
+    wxLB_BOTTOM = 0x2,
+    wxLB_LEFT   = 0x4,
+    wxLB_RIGHT  = 0x8,
+
+    // the mask which can be used to extract the alignment from the style
+    wxLB_ALIGN_MASK = 0xf,
+
+
+    wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED,
+    wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING,
+
+};
+
 
 
+class wxListbook : public wxBookCtrl
+{
+public:
+    wxListbook(wxWindow *parent,
+               wxWindowID id,
+               const wxPoint& pos = wxDefaultPosition,
+               const wxSize& size = wxDefaultSize,
+               long style = 0,
+               const wxString& name = wxPyEmptyString);
+    %name(wxPreListbook)wxListbook();
+
+    %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
+    %pragma(python) addtomethod = "wxPreListbook:val._setOORInfo(val)"
+
+
+    bool Create(wxWindow *parent,
+                wxWindowID id,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = 0,
+                const wxString& name = wxPyEmptyString);
+
+    // returns true if we have wxLB_TOP or wxLB_BOTTOM style
+    bool IsVertical() const;
+
 };
 
+
+
+class wxListbookEvent : public wxBookCtrlEvent
+{
+public:
+    wxListbookEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
+                    int nSel = -1, int nOldSel = -1);
+};
+
+
+
+%pragma(python) code = "
+#wxListbook events
+def EVT_LISTBOOK_PAGE_CHANGED(win, id, func):
+    win.Connect(id, -1, wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED, func)
+
+def EVT_LISTBOOK_PAGE_CHANGING(win, id, func):
+    win.Connect(id, -1, wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING, func)
+"
+
+//---------------------------------------------------------------------------
 //---------------------------------------------------------------------------
 
 
@@ -146,16 +344,25 @@ enum {
     wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED,
     wxEVT_COMMAND_SPLITTER_UNSPLIT,
     wxEVT_COMMAND_SPLITTER_DOUBLECLICKED,
-};
 
-
-enum
-{
     wxSPLIT_HORIZONTAL,
     wxSPLIT_VERTICAL,
     wxSPLIT_DRAG_NONE,
     wxSPLIT_DRAG_DRAGGING,
-    wxSPLIT_DRAG_LEFT_DOWN
+    wxSPLIT_DRAG_LEFT_DOWN,
+
+    wxSP_VERTICAL,
+    wxSP_HORIZONTAL,
+    wxSP_ARROW_KEYS,
+    wxSP_WRAP,
+    wxSP_NOBORDER,
+    wxSP_3D,
+    wxSP_3DSASH,
+    wxSP_3DBORDER,
+    wxSP_FULLSASH,
+    wxSP_BORDER,
+    wxSP_LIVE_UPDATE,
+    wxSP_PERMIT_UNSPLIT
 };
 
 
@@ -263,6 +470,7 @@ public:
 
 //---------------------------------------------------------------------------
 
+// TODO:  This should be usable on wxGTK now too...
 #ifdef __WXMSW__
 
 enum {
@@ -276,6 +484,13 @@ enum {
 };
 
 
+class wxTaskBarIconEvent : public wxEvent
+{
+public:
+    wxTaskBarIconEvent(wxEventType evtType, wxTaskBarIcon *tbIcon);
+};
+
+
 class wxTaskBarIcon : public wxEvtHandler {
 public:
     wxTaskBarIcon();
@@ -298,6 +513,33 @@ public:
     bool IsIconInstalled();
     bool IsOK();
 };
+
+
+
+%pragma(python) code = "
+def EVT_TASKBAR_MOVE(win, func):
+    win.Connect(-1, -1, wxEVT_TASKBAR_MOVE, func)
+
+def EVT_TASKBAR_LEFT_DOWN(win, func):
+    win.Connect(-1, -1, wxEVT_TASKBAR_LEFT_DOWN, func)
+
+def EVT_TASKBAR_LEFT_UP(win, func):
+    win.Connect(-1, -1, wxEVT_TASKBAR_LEFT_UP, func)
+
+def EVT_TASKBAR_RIGHT_DOWN(win, func):
+    win.Connect(-1, -1, wxEVT_TASKBAR_RIGHT_DOWN, func)
+
+def EVT_TASKBAR_RIGHT_UP(win, func):
+    win.Connect(-1, -1, wxEVT_TASKBAR_RIGHT_UP, func)
+
+def EVT_TASKBAR_LEFT_DCLICK(win, func):
+    win.Connect(-1, -1, wxEVT_TASKBAR_LEFT_DCLICK, func)
+
+def EVT_TASKBAR_RIGHT_DCLICK(win, func):
+    win.Connect(-1, -1, wxEVT_TASKBAR_RIGHT_DCLICK, func)
+"
+
+
 #endif
 
 //---------------------------------------------------------------------------
@@ -305,8 +547,7 @@ public:
 // wxPyWindow derives from wxWindow and adds support for overriding many of
 // the virtual methods in Python derived classes.
 
-//      Which of these should be done???
-//      AddChild
+//      Which (any?) of these should be done also???
 //      Destroy
 //      DoCaptureMouse
 //      DoClientToScreen
@@ -323,7 +564,6 @@ public:
 //      GetClientAreaOrigin
 //      GetDefaultItem
 //      IsTopLevel
-//      RemoveChild
 //      SetBackgroundColour
 //      SetDefaultItem
 //      SetFocus
@@ -369,6 +609,9 @@ public:
     DEC_PYCALLBACK_BOOL_const(AcceptsFocusFromKeyboard);
     DEC_PYCALLBACK_SIZE_const(GetMaxSize);
 
+    DEC_PYCALLBACK_VOID_WXWINBASE(AddChild);
+    DEC_PYCALLBACK_VOID_WXWINBASE(RemoveChild);
+
     PYPRIVATE;
 };
 
@@ -395,6 +638,9 @@ IMP_PYCALLBACK_BOOL_const(wxPyWindow, wxWindow, AcceptsFocus);
 IMP_PYCALLBACK_BOOL_const(wxPyWindow, wxWindow, AcceptsFocusFromKeyboard);
 IMP_PYCALLBACK_SIZE_const(wxPyWindow, wxWindow, GetMaxSize);
 
+IMP_PYCALLBACK_VOID_WXWINBASE(wxPyWindow, wxWindow, AddChild);
+IMP_PYCALLBACK_VOID_WXWINBASE(wxPyWindow, wxWindow, RemoveChild);
+
 %}
 
 // And now the one for SWIG to see
@@ -433,6 +679,9 @@ public:
     bool base_AcceptsFocus() const;
     bool base_AcceptsFocusFromKeyboard() const;
     wxSize base_GetMaxSize() const;
+
+    void base_AddChild(wxWindow* child);
+    void base_RemoveChild(wxWindow* child);
 }
 
 //---------------------------------------------------------------------------
@@ -475,6 +724,9 @@ public:
     DEC_PYCALLBACK_BOOL_const(AcceptsFocusFromKeyboard);
     DEC_PYCALLBACK_SIZE_const(GetMaxSize);
 
+    DEC_PYCALLBACK_VOID_WXWINBASE(AddChild);
+    DEC_PYCALLBACK_VOID_WXWINBASE(RemoveChild);
+
     PYPRIVATE;
 };
 
@@ -501,6 +753,9 @@ IMP_PYCALLBACK_BOOL_const(wxPyControl, wxControl, AcceptsFocus);
 IMP_PYCALLBACK_BOOL_const(wxPyControl, wxControl, AcceptsFocusFromKeyboard);
 IMP_PYCALLBACK_SIZE_const(wxPyControl, wxControl, GetMaxSize);
 
+IMP_PYCALLBACK_VOID_WXWINBASE(wxPyControl, wxControl, AddChild);
+IMP_PYCALLBACK_VOID_WXWINBASE(wxPyControl, wxControl, RemoveChild);
+
 %}
 
 // And now the one for SWIG to see
@@ -540,6 +795,123 @@ public:
     bool base_AcceptsFocus() const;
     bool base_AcceptsFocusFromKeyboard() const;
     wxSize base_GetMaxSize() const;
+
+    void base_AddChild(wxWindow* child);
+    void base_RemoveChild(wxWindow* child);
 }
 
+//---------------------------------------------------------------------------
+// and for wxPanel
+
+%{ // C++ version of Python aware wxPanel
+class wxPyPanel : public wxPanel
+{
+    DECLARE_DYNAMIC_CLASS(wxPyPanel)
+public:
+    wxPyPanel() : wxPanel() {}
+    wxPyPanel(wxWindow* parent, const wxWindowID id,
+               const wxPoint& pos = wxDefaultPosition,
+               const wxSize& size = wxDefaultSize,
+               long style = 0,
+               const wxString& name = wxPyPanelNameStr)
+        : wxPanel(parent, id, pos, size, style, name) {}
+
+
+    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_DYNAMIC_CLASS(wxPyPanel, wxPanel);
+
+IMP_PYCALLBACK_VOID_INT4(wxPyPanel, wxPanel, DoMoveWindow);
+IMP_PYCALLBACK_VOID_INT5(wxPyPanel, wxPanel, DoSetSize);
+IMP_PYCALLBACK_VOID_INTINT(wxPyPanel, wxPanel, DoSetClientSize);
+IMP_PYCALLBACK_VOID_INTINT(wxPyPanel, wxPanel, DoSetVirtualSize);
+
+IMP_PYCALLBACK_VOID_INTPINTP_const(wxPyPanel, wxPanel, DoGetSize);
+IMP_PYCALLBACK_VOID_INTPINTP_const(wxPyPanel, wxPanel, DoGetClientSize);
+IMP_PYCALLBACK_VOID_INTPINTP_const(wxPyPanel, wxPanel, DoGetPosition);
+
+IMP_PYCALLBACK_SIZE_const(wxPyPanel, wxPanel, DoGetVirtualSize);
+IMP_PYCALLBACK_SIZE_const(wxPyPanel, wxPanel, DoGetBestSize);
+
+IMP_PYCALLBACK__(wxPyPanel, wxPanel, InitDialog);
+IMP_PYCALLBACK_BOOL_(wxPyPanel, wxPanel, TransferDataFromWindow);
+IMP_PYCALLBACK_BOOL_(wxPyPanel, wxPanel, TransferDataToWindow);
+IMP_PYCALLBACK_BOOL_(wxPyPanel, wxPanel, Validate);
+
+IMP_PYCALLBACK_BOOL_const(wxPyPanel, wxPanel, AcceptsFocus);
+IMP_PYCALLBACK_BOOL_const(wxPyPanel, wxPanel, AcceptsFocusFromKeyboard);
+IMP_PYCALLBACK_SIZE_const(wxPyPanel, wxPanel, GetMaxSize);
+
+IMP_PYCALLBACK_VOID_WXWINBASE(wxPyPanel, wxPanel, AddChild);
+IMP_PYCALLBACK_VOID_WXWINBASE(wxPyPanel, wxPanel, RemoveChild);
+
+%}
+
+// And now the one for SWIG to see
+class wxPyPanel : public wxPanel
+{
+public:
+    wxPyPanel(wxWindow* parent, const wxWindowID id,
+               const wxPoint& pos = wxDefaultPosition,
+               const wxSize& size = wxDefaultSize,
+               long style = 0,
+               const wxString& name = wxPyPanelNameStr);
+
+    void _setCallbackInfo(PyObject* self, PyObject* _class);
+    %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxPyPanel)"
+    %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
+
+
+    void base_DoMoveWindow(int x, int y, int width, int height);
+    void base_DoSetSize(int x, int y, int width, int height,
+                        int sizeFlags = wxSIZE_AUTO);
+    void base_DoSetClientSize(int width, int height);
+    void base_DoSetVirtualSize( int x, int y );
+
+    void base_DoGetSize( int *OUTPUT, int *OUTPUT ) const;
+    void base_DoGetClientSize( int *OUTPUT, int *OUTPUT ) const;
+    void base_DoGetPosition( int *OUTPUT, int *OUTPUT ) const;
+
+    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);
+};
+
+
 //---------------------------------------------------------------------------