]> git.saurik.com Git - wxWidgets.git/blobdiff - wxPython/src/windows.i
Better doc
[wxWidgets.git] / wxPython / src / windows.i
index 94a77bef2ea40e383c98a2ce40c81305dec15ce0..a72fb75ab5178e4a2ea25831dea10f525687209f 100644 (file)
 %pragma(python) code = "import wx"
 
 
-%{
-    static wxString wxPyEmptyStr("");
-%}
-
 //---------------------------------------------------------------------------
 
 class wxEvtHandler : public wxObject {
@@ -63,6 +59,14 @@ public:
                           (wxObjectEventFunction) &wxPyCallback::EventThunker,
                           new wxPyCallback(func));
             }
+            else if (func == Py_None) {
+                self->Disconnect(id, lastId, eventType,
+                                 (wxObjectEventFunction)
+                                 &wxPyCallback::EventThunker);
+            }
+            else {
+                PyErr_SetString(PyExc_TypeError, "Expected callable object or None.");
+            }
         }
 
         bool Disconnect(int id, int lastId = -1,
@@ -73,30 +77,11 @@ public:
         }
     }
 
-//      %pragma(python) addtoclass = "
-//      _prop_list_ = {}
-//      "
-//      %pragma(python) addtoclass = "
-//      def __getattr__(self, name):
-//          pl = self._prop_list_
-//          if pl.has_key(name):
-//              getFunc, setFunc = pl[name]
-//              if getFunc:
-//                  return getattr(self, getFunc)()
-//              else:
-//                  raise TypeError, '%s property is write-only' % name
-//          raise AttributeError, name
-
-//      def __setattr__(self, name, value):
-//          pl = self._prop_list_
-//          if pl.has_key(name):
-//              getFunc, setFunc = pl[name]
-//              if setFunc:
-//                  return getattr(self, setFunc)(value)
-//              else:
-//                  raise TypeError, '%s property is read-only' % name
-//          self.__dict__[name] = value
-//      "
+    %addmethods {
+        void _setOORInfo(PyObject* _self) {
+            self->SetClientObject(new wxPyClientData(_self));
+        }
+    }
 };
 
 
@@ -107,6 +92,8 @@ public:
     wxValidator();
     //~wxValidator();
 
+    %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
+
     wxValidator* Clone();
     wxWindow* GetWindow();
     void SetWindow(wxWindow* window);
@@ -114,13 +101,6 @@ public:
     static bool IsSilent();
     static void SetBellOnError(int doIt = TRUE);
 
-//      // Properties list
-//      %pragma(python) addtoclass = "
-//      _prop_list_ = {
-//          'window' : ('GetWindow', 'SetWindow'),
-//      }
-//      _prop_list_.update(wxEvtHandler._prop_list_)
-//      "
 };
 
 
@@ -135,11 +115,11 @@ public:
     ~wxPyValidator() {
     }
 
-    wxObject* wxPyValidator::Clone() const {
+    wxObject* Clone() const {
         wxPyValidator* ptr = NULL;
         wxPyValidator* self = (wxPyValidator*)this;
 
-        bool doSave = wxPyRestoreThread();
+        wxPyBeginBlockThreads();
         if (self->m_myInst.findCallback("Clone")) {
             PyObject* ro;
             ro = self->m_myInst.callCallbackObj(Py_BuildValue("()"));
@@ -148,13 +128,13 @@ public:
                 Py_DECREF(ro);
             }
         }
+        wxPyEndBlockThreads();
+
         // This is very dangerous!!! But is the only way I could find
         // to squash a memory leak.  Currently it is okay, but if the
         // validator architecture in wxWindows ever changes, problems
         // could arise.
         delete self;
-
-        wxPySaveThread(doSave);
         return ptr;
     }
 
@@ -178,9 +158,10 @@ class wxPyValidator : public wxValidator {
 public:
     wxPyValidator();
 
-    void _setSelf(PyObject* self, PyObject* _class, int incref=TRUE);
-    %pragma(python) addtomethod = "__init__:self._setSelf(self, wxPyValidator, 1)"
+    void _setCallbackInfo(PyObject* self, PyObject* _class, int incref=TRUE);
+    %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxPyValidator, 1)"
 
+    %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
 };
 
 //----------------------------------------------------------------------
@@ -189,14 +170,22 @@ public:
 
 class wxWindow : public wxEvtHandler {
 public:
-
     wxWindow(wxWindow* parent, const wxWindowID id,
              const wxPoint& pos = wxDefaultPosition,
              const wxSize& size = wxDefaultSize,
              long style = 0,
              char* name = "panel");
+    %name(wxPreWindow)wxWindow();
+
+    bool Create(wxWindow* parent, const wxWindowID id,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = 0,
+                char* name = "panel");
+
+    %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
+    %pragma(python) addtomethod = "wxPreWindow:val._setOORInfo(val)"
 
-    %pragma(python) addtomethod = "__init__:#wx._StdWindowCallbacks(self)"
 
     void CaptureMouse();
     void Center(int direction = wxBOTH);
@@ -225,6 +214,7 @@ public:
     %name(FindWindowByName) wxWindow* FindWindow(const wxString& name);
     void Fit();
     wxColour GetBackgroundColour();
+    wxBorder GetBorder() const;
 
     //wxList& GetChildren();
     %addmethods {
@@ -238,10 +228,19 @@ public:
     int  GetCharWidth();
     %name(GetClientSizeTuple) void GetClientSize(int *OUTPUT, int *OUTPUT);
     wxSize GetClientSize();
+
+    // get the origin of the client area of the window relative to the
+    // window top left corner (the client area may be shifted because of
+    // the borders, scrollbars, other decorations...)
+    wxPoint GetClientAreaOrigin() const;
+
+    // get the client rectangle in window (i.e. client) coordinates
+    wxRect GetClientRect() const;
+
     wxLayoutConstraints * GetConstraints();
     wxEvtHandler* GetEventHandler();
 
-    wxFont& GetFont();
+    wxFont GetFont();
     wxColour GetForegroundColour();
     wxWindow * GetGrandParent();
     %addmethods {
@@ -271,7 +270,9 @@ public:
     long GetWindowStyleFlag();
     void SetWindowStyleFlag(long style);
     void SetWindowStyle(long style);
+    bool HasScrollbar(int orient) const;
     bool Hide();
+    wxHitTest HitTest(const wxPoint& pt);
     void InitDialog();
     bool IsEnabled();
     bool IsExposed( int x, int y, int w=0, int h=0 );
@@ -283,18 +284,27 @@ public:
     void Layout();
     bool LoadFromResource(wxWindow* parent, const wxString& resourceName, const wxResourceTable* resourceTable = NULL);
     void Lower();
-    void MakeModal(bool flag);
-    %name(MoveXY)void Move(int x, int y);
-    void Move(const wxPoint& point);
+    void MakeModal(bool flag=TRUE);
+    %name(MoveXY)void Move(int x, int y, int flags = wxSIZE_USE_EXISTING);
+    void Move(const wxPoint& point, int flags = wxSIZE_USE_EXISTING);
 
     wxEvtHandler* PopEventHandler(bool deleteHandler = FALSE);
     void PushEventHandler(wxEvtHandler* handler);
 
+        // find the given handler in the event handler chain and remove (but
+        // not delete) it from the event handler chain, return TRUE if it was
+        // found and FALSE otherwise (this also results in an assert failure so
+        // this function should only be called when the handler is supposed to
+        // be there)
+    bool RemoveEventHandler(wxEvtHandler *handler);
+
     %name(PopupMenuXY)bool PopupMenu(wxMenu *menu, int x, int y);
     bool PopupMenu(wxMenu *menu, const wxPoint& pos);
 
     void Raise();
     void Refresh(bool eraseBackground = TRUE, const wxRect* rect = NULL);
+    void RefreshRect(const wxRect& rect);
+
     void ReleaseMouse();
     void RemoveChild(wxWindow* child);
     bool Reparent( wxWindow* newParent );
@@ -304,7 +314,6 @@ public:
     wxPoint ScreenToClient(const wxPoint& pt);
 
     void ScrollWindow(int dx, int dy, const wxRect* rect = NULL);
-    void SetAcceleratorTable(const wxAcceleratorTable& accel);
     void SetAutoLayout(bool autoLayout);
     bool GetAutoLayout();
     void SetBackgroundColour(const wxColour& colour);
@@ -325,8 +334,8 @@ public:
             self->SetSize(size);
         }
 
-        void SetPosition(const wxPoint& pos) {
-            self->Move(pos);
+        void SetPosition(const wxPoint& pos, int flags = wxSIZE_USE_EXISTING) {
+            self->Move(pos, flags);
         }
 
         void SetRect(const wxRect& rect, int sizeFlags=wxSIZE_AUTO) {
@@ -338,13 +347,14 @@ public:
     %name(SetClientSizeWH)void SetClientSize(int width, int height);
     void SetClientSize(const wxSize& size);
     //void SetPalette(wxPalette* palette);
-    void SetCursor(const wxCursor&cursor);
+    void SetCursor(const wxCursor& cursor);
     void SetEventHandler(wxEvtHandler* handler);
     void SetExtraStyle(long exStyle);
     void SetTitle(const wxString& title);
-    bool Show(bool show);
+    bool Show(bool show=TRUE);
     bool TransferDataFromWindow();
     bool TransferDataToWindow();
+    void UpdateWindowUI();
     bool Validate();
     void WarpPointer(int x, int y);
 
@@ -364,12 +374,18 @@ public:
     void SetSizer(wxSizer* sizer);
     wxSizer* GetSizer();
 
+        // Track if this window is a member of a sizer
+    void SetContainingSizer(wxSizer* sizer) { m_containingSizer = sizer; }
+    wxSizer *GetContainingSizer() const { return m_containingSizer; }
+
     wxValidator* GetValidator();
     void SetValidator(const wxValidator& validator);
 
+#ifndef __WXMAC__
     void SetDropTarget(wxDropTarget* target);
     wxDropTarget* GetDropTarget();
     %pragma(python) addtomethod = "SetDropTarget:_args[0].thisown = 0"
+#endif
 
     wxSize GetBestSize();
 
@@ -385,40 +401,34 @@ public:
 
     void Freeze();
     void Thaw();
+    void Update();
+
+    wxString GetHelpText();
+    void SetHelpText(const wxString& helpText);
+    void SetHelpTextForId(const wxString& text);
+
+    bool ScrollLines(int lines);
+    bool ScrollPages(int pages);
+    bool LineUp();
+    bool LineDown();
+    bool PageUp();
+    bool PageDown();
 
+    static wxWindow* FindFocus();
+    static int NewControlId();
+    static int NextControlId(int id);
+    static int PrevControlId(int id);
 
-//      // Properties list
-//      %pragma(python) addtoclass = "
-//      _prop_list_ = {
-//          'size'          : ('GetSize',                  'SetSize'),
-//          'enabled'       : ('IsEnabled',                'Enable'),
-//          'background'    : ('GetBackgroundColour',      'SetBackgroundColour'),
-//          'foreground'    : ('GetForegroundColour',      'SetForegroundColour'),
-//          'children'      : ('GetChildren',              None),
-//          'charHeight'    : ('GetCharHeight',            None),
-//          'charWidth'     : ('GetCharWidth',             None),
-//          'clientSize'    : ('GetClientSize',            'SetClientSize'),
-//          'font'          : ('GetFont',                  'SetFont'),
-//          'grandParent'   : ('GetGrandParent',           None),
-//          'handle'        : ('GetHandle',                None),
-//          'label'         : ('GetLabel',                 'SetLabel'),
-//          'name'          : ('GetName',                  'SetName'),
-//          'parent'        : ('GetParent',                None),
-//          'position'      : ('GetPosition',              'SetPosition'),
-//          'title'         : ('GetTitle',                 'SetTitle'),
-//          'style'         : ('GetWindowStyleFlag',       'SetWindowStyleFlag'),
-//          'visible'       : ('IsShown',                  'Show'),
-//          'toolTip'       : ('GetToolTip',               'SetToolTip'),
-//          'sizer'         : ('GetSizer',                 'SetSizer'),
-//          'validator'     : ('GetValidator',             'SetValidator'),
-//          'dropTarget'    : ('GetDropTarget',            'SetDropTarget'),
-//          'caret'         : ('GetCaret',                 'SetCaret'),
-//          'autoLayout'    : ('GetAutoLayout',            'SetAutoLayout'),
-//          'constraints'   : ('GetConstraints',           'SetConstraints'),
-
-//      }
-//      _prop_list_.update(wxEvtHandler._prop_list_)
-//      "
+    void SetAcceleratorTable(const wxAcceleratorTable& accel);
+    wxAcceleratorTable *GetAcceleratorTable();
+
+#ifdef __WXMSW__
+    // A way to do the native draw first...  Too bad it isn't in wxGTK too.
+    void OnPaint(wxPaintEvent& event);
+#endif
+
+    wxButton* GetDefaultItem();
+    void SetDefaultItem(wxButton *btn);
 };
 
 
@@ -438,12 +448,6 @@ def wxDLG_SZE(win, size_width, height=None):
         return win.ConvertDialogSizeToPixels(wxSize(size_width, height))
 "
 
-%inline %{
-    wxWindow* wxWindow_FindFocus() {
-        return wxWindow::FindFocus();
-    }
-%}
-
 
 #ifdef __WXMSW__
 %inline %{
@@ -456,18 +460,6 @@ wxWindow* wxWindow_FromHWND(unsigned long hWnd) {
 %}
 #endif
 
-%inline %{
-    int wxWindow_NewControlId() {
-        return wxWindow::NewControlId();
-    }
-    int wxWindow_NextControlId(int id) {
-        return wxWindow::NextControlId(id);
-    }
-    int wxWindow_PrevControlId(int id) {
-        return wxWindow::PrevControlId(id);
-    }
-%}
-
 
 //---------------------------------------------------------------------------
 
@@ -479,45 +471,19 @@ public:
             const wxSize& size = wxDefaultSize,
             long style = wxTAB_TRAVERSAL,
             const char* name = "panel");
+    %name(wxPrePanel)wxPanel();
 
-    %pragma(python) addtomethod = "__init__:#wx._StdWindowCallbacks(self)"
-
-    void InitDialog();
-    wxButton* GetDefaultItem();
-    void SetDefaultItem(wxButton *btn);
+    bool Create(wxWindow* parent,
+                const wxWindowID id,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = wxTAB_TRAVERSAL,
+                const char* name = "panel");
 
-};
+    %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
+    %pragma(python) addtomethod = "wxPrePanel:val._setOORInfo(val)"
 
-//---------------------------------------------------------------------------
-
-class wxDialog : public wxPanel {
-public:
-    wxDialog(wxWindow* parent,
-             const wxWindowID id,
-             const wxString& title,
-             const wxPoint& pos = wxDefaultPosition,
-             const wxSize& size = wxDefaultSize,
-             long style = wxDEFAULT_DIALOG_STYLE,
-             const char* name = "dialogBox");
-
-    %pragma(python) addtomethod = "__init__:#wx._StdDialogCallbacks(self)"
-
-    void Centre(int direction = wxBOTH);
-    void EndModal(int retCode);
-    wxString GetTitle();
-    void Iconize(bool iconize);
-    bool IsIconized();
-    void SetModal(bool flag);
-    bool IsModal();
-    void SetTitle(const wxString& title);
-    bool Show(bool show);
-    int ShowModal();
-
-    int  GetReturnCode();
-    void SetReturnCode(int retCode);
-
-    wxSizer* CreateTextSizer( const wxString &message );
-    wxSizer* CreateButtonSizer( long flags );
+    void InitDialog();
 
 };
 
@@ -536,9 +502,17 @@ public:
                      const wxSize& size = wxDefaultSize,
                      long style = wxHSCROLL | wxVSCROLL,
                      char* name = "scrolledWindow");
+    %name(wxPreScrolledWindow)wxScrolledWindow();
 
-    %pragma(python) addtomethod = "__init__:#wx._StdWindowCallbacks(self)"
-    %pragma(python) addtomethod = "__init__:#wx._StdOnScrollCallbacks(self)"
+    bool Create(wxWindow* parent,
+                const wxWindowID id = -1,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = wxHSCROLL | wxVSCROLL,
+                char* name = "scrolledWindow");
+
+    %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
+    %pragma(python) addtomethod = "wxPreScrolledWindow:val._setOORInfo(val)"
 
     void EnableScrolling(bool xScrolling, bool yScrolling);
     int GetScrollPageSize(int orient);
@@ -571,13 +545,15 @@ public:
 
 class wxMenu : public wxEvtHandler {
 public:
-    wxMenu(const wxString& title = wxPyEmptyStr, long style = 0);
+    wxMenu(const wxString& title = wxEmptyString, long style = 0);
+
+    %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
 
     void Append(int id, const wxString& item,
-                const wxString& helpString = wxPyEmptyStr,
+                const wxString& helpString = wxEmptyString,
                 int checkable = FALSE);
     %name(AppendMenu)void Append(int id, const wxString& item, wxMenu *subMenu,
-                const wxString& helpString = wxPyEmptyStr);
+                const wxString& helpString = wxEmptyString);
     %name(AppendItem)void Append(const wxMenuItem* item);
 
     void AppendSeparator();
@@ -642,6 +618,8 @@ class wxMenuBar : public wxWindow {
 public:
     wxMenuBar(long style = 0);
 
+    %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
+
     bool Append(wxMenu *menu, const wxString& title);
     bool Insert(size_t pos, wxMenu *menu, const wxString& title);
     size_t GetMenuCount();
@@ -673,8 +651,8 @@ public:
 class wxMenuItem : public wxObject {
 public:
     wxMenuItem(wxMenu* parentMenu=NULL, int id=wxID_SEPARATOR,
-               const wxString& text = wxPyEmptyStr,
-               const wxString& help = wxPyEmptyStr,
+               const wxString& text = wxEmptyString,
+               const wxString& help = wxEmptyString,
                bool isCheckable = FALSE, wxMenu* subMenu = NULL);
 
 
@@ -705,7 +683,7 @@ public:
     // wxOwnerDrawn methods
 #ifdef __WXMSW__
     void SetFont(const wxFont& font);
-    wxFont& GetFont();
+    wxFont GetFont();
     void SetTextColour(const wxColour& colText);
     wxColour GetTextColour();
     void SetBackgroundColour(const wxColour& colBack);
@@ -713,7 +691,7 @@ public:
     void SetBitmaps(const wxBitmap& bmpChecked,
                     const wxBitmap& bmpUnchecked = wxNullBitmap);
     void SetBitmap(const wxBitmap& bmpChecked);
-    const wxBitmap& GetBitmap(bool bChecked = TRUE);
+    wxBitmap GetBitmap(bool bChecked = TRUE);
     void SetMarginWidth(int nWidth);
     int GetMarginWidth();
     static int GetDefaultMarginWidth();