]> git.saurik.com Git - wxWidgets.git/blobdiff - wxPython/src/windows.i
Updated note about wxSTC using wxPopupWindow
[wxWidgets.git] / wxPython / src / windows.i
index c941ed2e6d91c1cf7562d0708c5c0b7a751bc34b..702922d27b361933c5dd4018de3e0667ea0dccb9 100644 (file)
 %pragma(python) code = "import wx"
 
 
+//----------------------------------------------------------------------
+
 %{
-    static wxString wxPyEmptyStr("");
+    // Put some wx default wxChar* values into wxStrings.
+    DECLARE_DEF_STRING(PanelNameStr);
+    static const wxString wxPyEmptyString(wxT(""));
 %}
 
 //---------------------------------------------------------------------------
@@ -83,7 +87,7 @@ public:
 
     %addmethods {
         void _setOORInfo(PyObject* _self) {
-            self->SetClientObject(new wxPyClientData(_self));
+            self->SetClientObject(new wxPyOORClientData(_self));
         }
     }
 };
@@ -123,7 +127,7 @@ public:
         wxPyValidator* ptr = NULL;
         wxPyValidator* self = (wxPyValidator*)this;
 
-        wxPyTState* state = wxPyBeginBlockThreads();
+        wxPyBeginBlockThreads();
         if (self->m_myInst.findCallback("Clone")) {
             PyObject* ro;
             ro = self->m_myInst.callCallbackObj(Py_BuildValue("()"));
@@ -132,7 +136,7 @@ public:
                 Py_DECREF(ro);
             }
         }
-        wxPyEndBlockThreads(state);
+        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
@@ -178,20 +182,19 @@ public:
              const wxPoint& pos = wxDefaultPosition,
              const wxSize& size = wxDefaultSize,
              long style = 0,
-             char* name = "panel");
+             const wxString& name = wxPyPanelNameStr);
     %name(wxPreWindow)wxWindow();
 
     bool Create(wxWindow* parent, const wxWindowID id,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = 0,
-                char* name = "panel");
+                const wxString& name = wxPyPanelNameStr);
 
     %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
     %pragma(python) addtomethod = "wxPreWindow:val._setOORInfo(val)"
 
 
-    void CaptureMouse();
     void Center(int direction = wxBOTH);
     void Centre(int direction = wxBOTH);
     void CentreOnParent(int direction = wxBOTH );
@@ -213,11 +216,14 @@ public:
     void DragAcceptFiles(bool accept);
 #endif
     void Enable(bool enable);
-    //bool FakePopupMenu(wxMenu* menu, int x, int y);
+
+    // Find child window by ID or name
     %name(FindWindowById) wxWindow* FindWindow(long id);
     %name(FindWindowByName) wxWindow* FindWindow(const wxString& name);
+
     void Fit();
     wxColour GetBackgroundColour();
+    wxBorder GetBorder() const;
 
     //wxList& GetChildren();
     %addmethods {
@@ -231,10 +237,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 {
@@ -264,7 +279,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 );
@@ -277,12 +294,19 @@ public:
     bool LoadFromResource(wxWindow* parent, const wxString& resourceName, const wxResourceTable* resourceTable = NULL);
     void Lower();
     void MakeModal(bool flag=TRUE);
-    %name(MoveXY)void Move(int x, int y);
-    void Move(const wxPoint& point);
+    %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);
 
@@ -290,7 +314,7 @@ public:
     void Refresh(bool eraseBackground = TRUE, const wxRect* rect = NULL);
     void RefreshRect(const wxRect& rect);
 
-    void ReleaseMouse();
+    void AddChild(wxWindow* child);
     void RemoveChild(wxWindow* child);
     bool Reparent( wxWindow* newParent );
 
@@ -305,6 +329,7 @@ public:
     void SetConstraints(wxLayoutConstraints *constraints);
     void UnsetConstraints(wxLayoutConstraints *constraints);
     void SetFocus();
+    void SetFocusFromKbd();
     bool AcceptsFocus();
     void SetFont(const wxFont& font);
     void SetForegroundColour(const wxColour& colour);
@@ -319,8 +344,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) {
@@ -328,19 +353,31 @@ public:
         }
     }
 
-    void SetSizeHints(int minW=-1, int minH=-1, int maxW=-1, int maxH=-1, int incW=-1, int incH=-1);
+    void SetSizeHints(int minW,    int minH,
+                      int maxW=-1, int maxH=-1,
+                      int incW=-1, int incH=-1);
+    void SetVirtualSizeHints( int minW, int minH,
+                              int maxW = -1, int maxH = -1 );
+
+    void SetVirtualSize( const wxSize &size );
+    %name(SetVirtualSizeWH)void SetVirtualSize( int x, int y );
+
+    wxSize GetVirtualSize() const;
+    %name(GetVirtualSizeTuple)void GetVirtualSize( int *OUTPUT, int *OUTPUT ) const;
+
     %name(SetClientSizeWH)void SetClientSize(int width, int height);
     void SetClientSize(const wxSize& size);
     //void SetPalette(wxPalette* palette);
-    void SetCursor(const wxCursor&cursor);
+    bool SetCursor(const wxCursor& cursor);
+    wxCursor& GetCursor();
     void SetEventHandler(wxEvtHandler* handler);
     void SetExtraStyle(long exStyle);
     void SetTitle(const wxString& title);
     bool Show(bool show=TRUE);
     bool TransferDataFromWindow();
     bool TransferDataToWindow();
+    void UpdateWindowUI();
     bool Validate();
-    void WarpPointer(int x, int y);
 
     %name(ConvertDialogPointToPixels) wxPoint ConvertDialogToPixels(const wxPoint& pt);
     %name(ConvertDialogSizeToPixels)  wxSize  ConvertDialogToPixels(const wxSize& sz);
@@ -355,19 +392,23 @@ public:
     void SetToolTip(wxToolTip *tooltip);
     wxToolTip* GetToolTip();
 
-    void SetSizer(wxSizer* sizer);
+    void SetSizer(wxSizer* sizer, bool deleteOld=TRUE);
+    void SetSizerAndFit(wxSizer *sizer, bool deleteOld=TRUE);
     wxSizer* GetSizer();
 
+        // Track if this window is a member of a sizer
+    void SetContainingSizer(wxSizer* sizer);
+    wxSizer *GetContainingSizer() const;
+
     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();
+    wxSize GetMaxSize();
 
     void SetCaret(wxCaret *caret);
     wxCaret *GetCaret();
@@ -385,6 +426,7 @@ public:
 
     wxString GetHelpText();
     void SetHelpText(const wxString& helpText);
+    void SetHelpTextForId(const wxString& text);
 
     bool ScrollLines(int lines);
     bool ScrollPages(int pages);
@@ -400,6 +442,31 @@ public:
 
     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
+
+    wxWindow* GetDefaultItem();
+    wxWindow* SetDefaultItem(wxWindow *btn);
+    void SetTmpDefaultItem(wxWindow *win);
+
+    // move the mouse to the specified position
+    void WarpPointer(int x, int y);
+
+    // start or end mouse capture, these functions maintain the stack of
+    // windows having captured the mouse and after calling ReleaseMouse()
+    // the mouse is not released but returns to the window which had had
+    // captured it previously (if any)
+    void CaptureMouse();
+    void ReleaseMouse();
+
+    // get the window which currently captures the mouse or NULL
+    static wxWindow *GetCapture();
+
+    // does this window have the capture?
+    bool HasCapture() const;
 };
 
 
@@ -432,6 +499,27 @@ wxWindow* wxWindow_FromHWND(unsigned long hWnd) {
 #endif
 
 
+// Unfortunatly the names of these new static methods clash with the
+// names wxPython has been using forever for the overloaded
+// wxWindow::FindWindow, so instead of swigging them as statics create
+// standalone functions for them.
+%inline %{
+wxWindow* wxFindWindowById( long id, const wxWindow *parent = NULL ) {
+    return wxWindow::FindWindowById(id, parent);
+}
+
+wxWindow* wxFindWindowByName( const wxString& name,
+                              const wxWindow *parent = NULL ) {
+     return wxWindow::FindWindowByName(name, parent);
+}
+
+wxWindow* wxFindWindowByLabel( const wxString& label,
+                               const wxWindow *parent = NULL ) {
+    return wxWindow::FindWindowByLabel(label, parent);
+}
+%}
+
+
 //---------------------------------------------------------------------------
 
 class wxPanel : public wxWindow {
@@ -441,7 +529,7 @@ public:
             const wxPoint& pos = wxDefaultPosition,
             const wxSize& size = wxDefaultSize,
             long style = wxTAB_TRAVERSAL,
-            const char* name = "panel");
+            const wxString& name = wxPyPanelNameStr);
     %name(wxPrePanel)wxPanel();
 
     bool Create(wxWindow* parent,
@@ -449,14 +537,12 @@ public:
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = wxTAB_TRAVERSAL,
-                const char* name = "panel");
+                const wxString& name = wxPyPanelNameStr);
 
     %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
     %pragma(python) addtomethod = "wxPrePanel:val._setOORInfo(val)"
 
     void InitDialog();
-    wxButton* GetDefaultItem();
-    void SetDefaultItem(wxButton *btn);
 
 };
 
@@ -474,7 +560,7 @@ public:
                      const wxPoint& pos = wxDefaultPosition,
                      const wxSize& size = wxDefaultSize,
                      long style = wxHSCROLL | wxVSCROLL,
-                     char* name = "scrolledWindow");
+                     const wxString& name = wxPyPanelNameStr);
     %name(wxPreScrolledWindow)wxScrolledWindow();
 
     bool Create(wxWindow* parent,
@@ -482,7 +568,7 @@ public:
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = wxHSCROLL | wxVSCROLL,
-                char* name = "scrolledWindow");
+                const wxString& name = wxPyPanelNameStr);
 
     %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
     %pragma(python) addtomethod = "wxPreScrolledWindow:val._setOORInfo(val)"
@@ -491,7 +577,6 @@ public:
     int GetScrollPageSize(int orient);
     void GetScrollPixelsPerUnit(int* OUTPUT, int* OUTPUT);
     wxWindow* GetTargetWindow();
-    void GetVirtualSize(int* OUTPUT, int* OUTPUT);
     bool IsRetained();
     void PrepareDC(wxDC& dc);
     void Scroll(int x, int y);
@@ -503,14 +588,41 @@ public:
     void GetViewStart(int* OUTPUT, int* OUTPUT);
     %pragma(python) addtoclass = "ViewStart = GetViewStart"
 
-    void CalcScrolledPosition( int x, int y, int *OUTPUT, int *OUTPUT);
-    void CalcUnscrolledPosition( int x, int y, int *OUTPUT, int *OUTPUT);
+    %name(CalcScrolledPosition1)wxPoint CalcScrolledPosition(const wxPoint& pt);
+    %name(CalcScrolledPosition2)void CalcScrolledPosition( int x, int y, int *OUTPUT, int *OUTPUT);
+
+    %name(CalcUnscrolledPosition1)wxPoint CalcUnscrolledPosition(const wxPoint& pt);
+    %name(CalcUnscrolledPosition2)void CalcUnscrolledPosition( int x, int y, int *OUTPUT, int *OUTPUT);
+
+    %pragma(python) addtoclass = "
+    def CalcScrolledPosition(self, *args):
+        if len(args) == 1:
+            return apply(self.CalcScrolledPosition1, args)
+        elif len(args) == 2:
+            return apply(self.CalcScrolledPosition2, args)
+        else:
+            raise TypeError, 'Invalid parameters: only (x,y) or (point) allowed'
+
+    def CalcUnscrolledPosition(self, *args):
+        if len(args) == 1:
+            return apply(self.CalcUnscrolledPosition1, args)
+        elif len(args) == 2:
+            return apply(self.CalcUnscrolledPosition2, args)
+        else:
+            raise TypeError, 'Invalid parameters: only (x,y) or (point) allowed'
+"
 
     void SetScale(double xs, double ys);
     double GetScaleX();
     double GetScaleY();
 
     void AdjustScrollbars();
+
+    bool Layout();
+
+    // Set the x, y scrolling increments.
+    void SetScrollRate( int xstep, int ystep );
+
 };
 
 //----------------------------------------------------------------------
@@ -518,18 +630,65 @@ public:
 
 class wxMenu : public wxEvtHandler {
 public:
-    wxMenu(const wxString& title = wxPyEmptyStr, long style = 0);
+    wxMenu(const wxString& title = wxPyEmptyString, long style = 0);
 
     %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
 
     void Append(int id, const wxString& item,
-                const wxString& helpString = wxPyEmptyStr,
-                int checkable = FALSE);
+                const wxString& helpString = wxPyEmptyString,
+                wxItemKind kind = wxITEM_NORMAL);
     %name(AppendMenu)void Append(int id, const wxString& item, wxMenu *subMenu,
-                const wxString& helpString = wxPyEmptyStr);
+                                 const wxString& helpString = wxPyEmptyString);
     %name(AppendItem)void Append(const wxMenuItem* item);
-
+    void AppendCheckItem(int id,
+                         const wxString& text,
+                         const wxString& help = wxPyEmptyString);
+    void AppendRadioItem(int id,
+                         const wxString& text,
+                         const wxString& help = wxPyEmptyString);
     void AppendSeparator();
+
+
+    void Insert(size_t pos,
+                int id,
+                const wxString& text,
+                const wxString& help = wxPyEmptyString,
+                wxItemKind kind = wxITEM_NORMAL);
+    void InsertSeparator(size_t pos);
+    void InsertCheckItem(size_t pos,
+                         int id,
+                         const wxString& text,
+                         const wxString& help = wxPyEmptyString);
+    void InsertRadioItem(size_t pos,
+                         int id,
+                         const wxString& text,
+                         const wxString& help = wxPyEmptyString);
+    %name(InsertMenu)void Insert(size_t pos,
+                                 int id,
+                                 const wxString& text,
+                                 wxMenu *submenu,
+                                 const wxString& help = wxPyEmptyString);
+    %name(InsertItem)bool Insert(size_t pos, wxMenuItem *item);
+
+
+    void Prepend(int id,
+                 const wxString& text,
+                 const wxString& help = wxPyEmptyString,
+                 wxItemKind kind = wxITEM_NORMAL);
+    void PrependSeparator();
+    void PrependCheckItem(int id,
+                          const wxString& text,
+                          const wxString& help = wxPyEmptyString);
+    void PrependRadioItem(int id,
+                          const wxString& text,
+                          const wxString& help = wxPyEmptyString);
+    %name(PrependMenu)void Prepend(int id,
+                                   const wxString& text,
+                                   wxMenu *submenu,
+                                   const wxString& help = wxPyEmptyString);
+    %name(PrependItem)void Prepend(wxMenuItem *item);
+
+
     void Break();
     void Check(int id, bool flag);
     bool IsChecked(int id);
@@ -551,10 +710,12 @@ public:
 
     bool Delete(int id);
     %name(DeleteItem)bool Delete(wxMenuItem *item);
-    bool Insert(size_t pos, wxMenuItem *item);
     wxMenuItem *Remove(int id);
     %name(RemoveItem) wxMenuItem *Remove(wxMenuItem *item);
 
+
+
+
     %addmethods {
         void Destroy() { delete self; }
     }
@@ -624,9 +785,10 @@ public:
 class wxMenuItem : public wxObject {
 public:
     wxMenuItem(wxMenu* parentMenu=NULL, int id=wxID_SEPARATOR,
-               const wxString& text = wxPyEmptyStr,
-               const wxString& help = wxPyEmptyStr,
-               bool isCheckable = FALSE, wxMenu* subMenu = NULL);
+               const wxString& text = wxPyEmptyString,
+               const wxString& help = wxPyEmptyString,
+               wxItemKind kind = wxITEM_NORMAL,
+               wxMenu* subMenu = NULL);
 
 
     wxMenu *GetMenu();
@@ -636,6 +798,7 @@ public:
     void SetText(const wxString& str);
     wxString GetLabel();
     const wxString& GetText();
+    wxItemKind GetKind();
     void SetCheckable(bool checkable);
     bool IsCheckable();
     bool IsSubMenu();
@@ -652,29 +815,30 @@ public:
     void SetAccel(wxAcceleratorEntry *accel);
 
     static wxString GetLabelFromText(const wxString& text);
+//    static wxAcceleratorEntry *GetAccelFromString(const wxString& label);
 
     // 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);
     wxColour GetBackgroundColour();
     void SetBitmaps(const wxBitmap& bmpChecked,
                     const wxBitmap& bmpUnchecked = wxNullBitmap);
-    void SetBitmap(const wxBitmap& bmpChecked);
-    const wxBitmap& GetBitmap(bool bChecked = TRUE);
+    //void SetBitmap(const wxBitmap& bmpChecked);
+    //wxBitmap GetBitmap(bool bChecked = TRUE);
     void SetMarginWidth(int nWidth);
     int GetMarginWidth();
     static int GetDefaultMarginWidth();
-    //void SetName(const wxString& strName);
-    //const wxString& GetName();
-    //void SetCheckable(bool checkable);
-    //bool IsCheckable();
     bool IsOwnerDrawn();
     void ResetOwnerDrawn();
 #endif
+
+    void SetBitmap(const wxBitmap& bitmap);
+    const wxBitmap& GetBitmap();
+
 };
 
 //---------------------------------------------------------------------------