]> git.saurik.com Git - wxWidgets.git/blobdiff - wxPython/contrib/gizmos/gizmos.i
Docstring fixes
[wxWidgets.git] / wxPython / contrib / gizmos / gizmos.i
index 48b33f4e7c588f80092fb2258b30ba713f26ca7d..485613b3854697271e59c91c52ddab803aa7b59b 100644 (file)
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
-%module gizmos
+%define DOCSTRING
+"Various *gizmo* classes: `DynamicSashWindow`, `EditableListBox`,
+`LEDNumberCtrl`, `TreeListCtrl`, etc."
+%enddef
+
+%module(package="wx", docstring=DOCSTRING) gizmos
 
 
 %{
-#include "wxPython.h"
+#include "wx/wxPython/wxPython.h"
+#include "wx/wxPython/pyclasses.h"
+
 #include <wx/gizmos/dynamicsash.h>
 #include <wx/gizmos/editlbox.h>
 #include <wx/gizmos/splittree.h>
 #include <wx/gizmos/ledctrl.h>
+#include <wx/gizmos/statpict.h>
+
 #include <wx/listctrl.h>
+#include <wx/treectrl.h>
+#include <wx/imaglist.h>
+
 %}
 
 //---------------------------------------------------------------------------
 
-%include typemaps.i
-%include my_typemaps.i
-
-%extern wx.i
-%extern windows.i
-%extern _defs.i
-%extern events.i
-%extern controls.i
+%import windows.i
+%import controls.i
+%pythoncode { import wx }
+%pythoncode { __docfilter__ = wx._core.__DocFilter(globals()) }
 
 
-//----------------------------------------------------------------------
-
-%{
-    // Put some wx default wxChar* values into wxStrings.
-    static const wxString wxPyDynamicSashNameStr(wxT("dynamicSashWindow"));
-    static const wxString wxPyEditableListBoxNameStr(wxT("editableListBox"));
-%}
+MAKE_CONST_WXSTRING2(DynamicSashNameStr,     wxT("dynamicSashWindow"));
+MAKE_CONST_WXSTRING2(EditableListBoxNameStr, wxT("editableListBox"));
+MAKE_CONST_WXSTRING(StaticPictureNameStr);                     
+    
+MAKE_CONST_WXSTRING_NOSWIG(EmptyString);
 
-///----------------------------------------------------------------------
+//---------------------------------------------------------------------------
 
 enum {
-    wxEVT_DYNAMIC_SASH_SPLIT,
-    wxEVT_DYNAMIC_SASH_UNIFY,
-
     wxDS_MANAGE_SCROLLBARS,
     wxDS_DRAG_CORNER,
 };
 
+%constant wxEventType wxEVT_DYNAMIC_SASH_SPLIT;
+%constant wxEventType wxEVT_DYNAMIC_SASH_UNIFY;
+
 
 /*
     wxDynamicSashSplitEvents are sent to your view by wxDynamicSashWindow
@@ -128,41 +134,37 @@ public:
 
 */
 
+MustHaveApp(wxDynamicSashWindow);
+
 class wxDynamicSashWindow : public wxWindow {
 public:
-    wxDynamicSashWindow(wxWindow *parent, wxWindowID id,
+    %pythonAppend wxDynamicSashWindow         "self._setOORInfo(self)"
+    %pythonAppend wxDynamicSashWindow()       ""
+
+    wxDynamicSashWindow(wxWindow *parent, wxWindowID id=-1,
                         const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
                         long style = wxCLIP_CHILDREN | wxDS_MANAGE_SCROLLBARS | wxDS_DRAG_CORNER,
                         const wxString& name = wxPyDynamicSashNameStr);
-    %name(wxPreDynamicSashWindow)wxDynamicSashWindow();
+    %RenameCtor(PreDynamicSashWindow, wxDynamicSashWindow());
 
-    bool Create(wxWindow *parent, wxWindowID id,
+    bool Create(wxWindow *parent, wxWindowID id=-1,
                 const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
                 long style = wxCLIP_CHILDREN | wxDS_MANAGE_SCROLLBARS | wxDS_DRAG_CORNER,
                 const wxString& name = wxPyDynamicSashNameStr);
 
-    %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
-    %pragma(python) addtomethod = "wxPreDynamicSashWindow:val._setOORInfo(val)"
-
     wxScrollBar *GetHScrollBar(const wxWindow *child) const;
     wxScrollBar *GetVScrollBar(const wxWindow *child) const;
 };
 
 
 
-//----------------------------------------------------------------------
-// Python functions to act like the event macros
-
-%pragma(python) code = "
-def EVT_DYNAMIC_SASH_SPLIT(win, id, func):
-    win.Connect(id, -1, wxEVT_DYNAMIC_SASH_SPLIT, func)
-
-def EVT_DYNAMIC_SASH_UNIFY(win, id, func):
-    win.Connect(id, -1, wxEVT_DYNAMIC_SASH_UNIFY, func)
-"
+%pythoncode {
+EVT_DYNAMIC_SASH_SPLIT = wx.PyEventBinder( wxEVT_DYNAMIC_SASH_SPLIT, 1 )
+EVT_DYNAMIC_SASH_UNIFY = wx.PyEventBinder( wxEVT_DYNAMIC_SASH_UNIFY, 1 )
+}
 
-//----------------------------------------------------------------------
-//----------------------------------------------------------------------
+//---------------------------------------------------------------------------
+//---------------------------------------------------------------------------
 
 enum {
     wxEL_ALLOW_NEW,
@@ -170,24 +172,32 @@ enum {
     wxEL_ALLOW_DELETE,
 };
 
+
+%typemap(out) wxPyListCtrl*
+{ $result = wxPyMake_wxObject((wxObject*)$1, (bool)$owner); }
+
+
 // This class provides a composite control that lets the
 // user easily enter list of strings
+MustHaveApp(wxEditableListBox);
 class wxEditableListBox : public wxPanel
 {
 public:
-    wxEditableListBox(wxWindow *parent, wxWindowID id,
-                      const wxString& label,
+    %pythonAppend wxEditableListBox         "self._setOORInfo(self)"
+    %pythonAppend wxEditableListBox()       ""
+
+    wxEditableListBox(wxWindow *parent, wxWindowID id=-1,
+                      const wxString& label = wxPyEmptyString,
                       const wxPoint& pos = wxDefaultPosition,
                       const wxSize& size = wxDefaultSize,
                       long style = wxEL_ALLOW_NEW | wxEL_ALLOW_EDIT | wxEL_ALLOW_DELETE,
                       const wxString& name = wxPyEditableListBoxNameStr);
 
-    %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
 
     void SetStrings(const wxArrayString& strings);
 
     //void GetStrings(wxArrayString& strings);
-    %addmethods {
+    %extend {
         PyObject* GetStrings() {
             wxArrayString strings;
             self->GetStrings(strings);
@@ -195,17 +205,25 @@ public:
         }
     }
 
-    wxListCtrl* GetListCtrl()       { return m_listCtrl; }
-    wxBitmapButton* GetDelButton()  { return m_bDel; }
-    wxBitmapButton* GetNewButton()  { return m_bNew; }
-    wxBitmapButton* GetUpButton()   { return m_bUp; }
-    wxBitmapButton* GetDownButton() { return m_bDown; }
-    wxBitmapButton* GetEditButton() { return m_bEdit; }
+    wxPyListCtrl* GetListCtrl();
+    wxBitmapButton* GetDelButton();
+    wxBitmapButton* GetNewButton();
+    wxBitmapButton* GetUpButton();
+    wxBitmapButton* GetDownButton();
+    wxBitmapButton* GetEditButton();
+
+    %property(DelButton, GetDelButton, doc="See `GetDelButton`");
+    %property(DownButton, GetDownButton, doc="See `GetDownButton`");
+    %property(EditButton, GetEditButton, doc="See `GetEditButton`");
+    %property(ListCtrl, GetListCtrl, doc="See `GetListCtrl`");
+    %property(NewButton, GetNewButton, doc="See `GetNewButton`");
+    %property(Strings, GetStrings, SetStrings, doc="See `GetStrings` and `SetStrings`");
+    %property(UpButton, GetUpButton, doc="See `GetUpButton`");
 };
 
 
 
-//----------------------------------------------------------------------
+//---------------------------------------------------------------------------
 
 
 /*
@@ -220,14 +238,18 @@ public:
     typedef wxTreeCtrl wxPyTreeCtrl;
 %}
 
+MustHaveApp(wxRemotelyScrolledTreeCtrl);
+
 class wxRemotelyScrolledTreeCtrl: public wxPyTreeCtrl
 {
 public:
+    %pythonAppend wxRemotelyScrolledTreeCtrl         "self._setOORInfo(self)"
+    %pythonAppend wxRemotelyScrolledTreeCtrl()       ""
+
     wxRemotelyScrolledTreeCtrl(wxWindow* parent, wxWindowID id,
                                const wxPoint& pos = wxDefaultPosition,
                                const wxSize& size = wxDefaultSize,
                                long style = wxTR_HAS_BUTTONS);
-    %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
 
 
     void HideVScrollbar();
@@ -246,6 +268,9 @@ public:
     // events happen such as node expansion
     void SetCompanionWindow(wxWindow* companion);
     wxWindow* GetCompanionWindow() const;
+
+    %property(CompanionWindow, GetCompanionWindow, SetCompanionWindow, doc="See `GetCompanionWindow` and `SetCompanionWindow`");
+    %property(ScrolledWindow, GetScrolledWindow, doc="See `GetScrolledWindow`");
 };
 
 
@@ -269,17 +294,17 @@ public:
 
     virtual void DrawItem(wxDC& dc, wxTreeItemId id, const wxRect& rect) {
         bool found;
-        wxPyBeginBlockThreads();
+        wxPyBlock_t blocked = wxPyBeginBlockThreads();
         if ((found = wxPyCBH_findCallback(m_myInst, "DrawItem"))) {
-            PyObject* dcobj = wxPyMake_wxObject(&dc);
-            PyObject* idobj = wxPyConstructObject((void*)&id, "wxTreeItemId", FALSE);
-            PyObject* recobj= wxPyConstructObject((void*)&rect, "wxRect", FALSE);
+            PyObject* dcobj = wxPyMake_wxObject(&dc,false);
+            PyObject* idobj = wxPyConstructObject((void*)&id, wxT("wxTreeItemId"), false);
+            PyObject* recobj= wxPyConstructObject((void*)&rect, wxT("wxRect"), false);
             wxPyCBH_callCallback(m_myInst, Py_BuildValue("(OOO)", dcobj, idobj, recobj));
             Py_DECREF(dcobj);
             Py_DECREF(idobj);
             Py_DECREF(recobj);
         }
-        wxPyEndBlockThreads();
+        wxPyEndBlockThreads(blocked);
         if (! found)
             wxTreeCompanionWindow::DrawItem(dc, id, rect);
     }
@@ -289,19 +314,25 @@ public:
 %}
 
 
-%name(wxTreeCompanionWindow) class wxPyTreeCompanionWindow: public wxWindow
+MustHaveApp(wxPyTreeCompanionWindow);
+
+%rename(TreeCompanionWindow) wxPyTreeCompanionWindow;
+class wxPyTreeCompanionWindow: public wxWindow
 {
 public:
+    %pythonAppend wxPyTreeCompanionWindow         "self._setOORInfo(self);" setCallbackInfo(TreeCompanionWindow)
+    %pythonAppend wxPyTreeCompanionWindow()       ""
+
     wxPyTreeCompanionWindow(wxWindow* parent, wxWindowID id = -1,
                             const wxPoint& pos = wxDefaultPosition,
                             const wxSize& size = wxDefaultSize,
                             long style = 0);
     void _setCallbackInfo(PyObject* self, PyObject* _class);
-    %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxTreeCompanionWindow)"
-    %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
 
     wxRemotelyScrolledTreeCtrl* GetTreeCtrl() const;
     void SetTreeCtrl(wxRemotelyScrolledTreeCtrl* treeCtrl);
+
+    %property(TreeCtrl, GetTreeCtrl, SetTreeCtrl, doc="See `GetTreeCtrl` and `SetTreeCtrl`");
 };
 
 
@@ -313,18 +344,22 @@ public:
  * than the usual one.
  */
 
+MustHaveApp(wxThinSplitterWindow);
+
 class wxThinSplitterWindow: public wxSplitterWindow
 {
 public:
+    %pythonAppend wxThinSplitterWindow         "self._setOORInfo(self)"
+    %pythonAppend wxThinSplitterWindow()       ""
+
     wxThinSplitterWindow(wxWindow* parent, wxWindowID id = -1,
                          const wxPoint& pos = wxDefaultPosition,
                          const wxSize& size = wxDefaultSize,
                          long style = wxSP_3D | wxCLIP_CHILDREN);
-    %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
-
 };
 
 
+
 /*
  * wxSplitterScrolledWindow
  *
@@ -334,19 +369,23 @@ public:
  * scroll appropriately.
  */
 
+MustHaveApp(wxSplitterScrolledWindow);
+
 class wxSplitterScrolledWindow: public wxScrolledWindow
 {
 public:
+    %pythonAppend wxSplitterScrolledWindow         "self._setOORInfo(self)"
+    %pythonAppend wxSplitterScrolledWindow()       ""
+
     wxSplitterScrolledWindow(wxWindow* parent, wxWindowID id = -1,
                              const wxPoint& pos = wxDefaultPosition,
                              const wxSize& size = wxDefaultSize,
                              long style = 0);
-    %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
 };
 
 
-//----------------------------------------------------------------------
-//----------------------------------------------------------------------
+//---------------------------------------------------------------------------
+//---------------------------------------------------------------------------
 
 
 enum wxLEDValueAlign
@@ -361,54 +400,106 @@ enum wxLEDValueAlign
 };
 
 
+MustHaveApp(wxLEDNumberCtrl);
+
 class wxLEDNumberCtrl :        public wxControl
 {
 public:
-    // Constructors.
+    %pythonAppend wxLEDNumberCtrl         "self._setOORInfo(self)"
+    %pythonAppend wxLEDNumberCtrl()       ""
+
     wxLEDNumberCtrl(wxWindow *parent, wxWindowID id = -1,
                     const wxPoint& pos = wxDefaultPosition,
                     const wxSize& size = wxDefaultSize,
                     long style =  wxLED_ALIGN_LEFT | wxLED_DRAW_FADED);
-    %name(wxPreLEDNumberCtrl) wxLEDNumberCtrl();
-
-    %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
-    %pragma(python) addtomethod = "wxPreLEDNumberCtrl:val._setOORInfo(val)"
+    %RenameCtor(PreLEDNumberCtrl,  wxLEDNumberCtrl());
 
-    // Create functions.
     bool Create(wxWindow *parent, wxWindowID id = -1,
                     const wxPoint& pos = wxDefaultPosition,
                     const wxSize& size = wxDefaultSize,
                     long style = wxLED_ALIGN_LEFT | wxLED_DRAW_FADED);
 
-    wxLEDValueAlign GetAlignment() const { return m_Alignment; }
-    bool GetDrawFaded() const { return m_DrawFaded; }
-    const wxString &GetValue() const { return m_Value; }
+    wxLEDValueAlign GetAlignment() const;
+    bool GetDrawFaded() const;
+    const wxString &GetValue() const;
 
     void SetAlignment(wxLEDValueAlign Alignment, bool Redraw = true);
     void SetDrawFaded(bool DrawFaded, bool Redraw = true);
     void SetValue(const wxString &Value, bool Redraw = true);
 
+    %property(Alignment, GetAlignment, SetAlignment, doc="See `GetAlignment` and `SetAlignment`");
+    %property(DrawFaded, GetDrawFaded, SetDrawFaded, doc="See `GetDrawFaded` and `SetDrawFaded`");
+    %property(Value, GetValue, SetValue, doc="See `GetValue` and `SetValue`");
 };
 
-//----------------------------------------------------------------------
-//----------------------------------------------------------------------
 
-%init %{
 
-    wxClassInfo::CleanUpClasses();
-    wxClassInfo::InitializeClasses();
+//----------------------------------------------------------------------
 
-    wxPyPtrTypeMap_Add("wxTreeCompanionWindow", "wxPyTreeCompanionWindow");
-%}
+%include _treelist.i
 
+//----------------------------------------------------------------------
 
-%pragma(python) include="_gizmoextras.py";
+enum
+{
+    wxSCALE_HORIZONTAL,
+    wxSCALE_VERTICAL,
+    wxSCALE_UNIFORM,
+    wxSCALE_CUSTOM    
+};
 
-//----------------------------------------------------------------------
-//----------------------------------------------------------------------
+MustHaveApp(wxStaticPicture);
 
+class wxStaticPicture : public wxControl
+{
+public:
+    %pythonAppend wxStaticPicture         "self._setOORInfo(self)"
+    %pythonAppend wxStaticPicture()       ""
+
+    wxStaticPicture( wxWindow* parent, wxWindowID id=-1,
+                     const wxBitmap& label=wxNullBitmap,
+                     const wxPoint& pos = wxDefaultPosition,
+                     const wxSize& size = wxDefaultSize,
+                     long style = 0,
+                     const wxString& name = wxPyStaticPictureNameStr );
+
+    %RenameCtor(PreStaticPicture, wxStaticPicture());
+
+    bool Create( wxWindow* parent, wxWindowID id=-1,
+                 const wxBitmap& label=wxNullBitmap,
+                 const wxPoint& pos = wxDefaultPosition,
+                 const wxSize& size = wxDefaultSize,
+                 long style = 0,
+                 const wxString& name = wxPyStaticPictureNameStr );
+
+    void SetBitmap( const wxBitmap& bmp );
+    wxBitmap GetBitmap() const;
+    void SetIcon( const wxIcon& icon );
+    wxIcon GetIcon() const;
+
+    void SetAlignment( int align );
+    int GetAlignment() const;
+
+    void SetScale( int scale );
+    int GetScale() const; 
+
+    void SetCustomScale( float sx, float sy );
+    void GetCustomScale( float* OUTPUT, float* OUTPUT ) const;
+
+    %property(Alignment, GetAlignment, SetAlignment, doc="See `GetAlignment` and `SetAlignment`");
+    %property(Bitmap, GetBitmap, SetBitmap, doc="See `GetBitmap` and `SetBitmap`");
+    %property(Icon, GetIcon, SetIcon, doc="See `GetIcon` and `SetIcon`");
+    %property(Scale, GetScale, SetScale, doc="See `GetScale` and `SetScale`");
+};
 
 
+//----------------------------------------------------------------------
+//----------------------------------------------------------------------
 
+%init %{
+    wxPyPtrTypeMap_Add("wxTreeCompanionWindow", "wxPyTreeCompanionWindow");
+%}
 
+//----------------------------------------------------------------------
+//----------------------------------------------------------------------