Updated note about wxSTC using wxPopupWindow

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

diff --git a/wxPython/src/windows.i b/wxPython/src/windows.i
index a72fb75ab5178e4a2ea25831dea10f525687209f..702922d27b361933c5dd4018de3e0667ea0dccb9 100644 (file)
--- a/wxPython/src/windows.i
+++ b/wxPython/src/windows.i
@@ -33,6 +33,14 @@
 %pragma(python) code = "import wx"
 
 
 %pragma(python) code = "import wx"
 
 

+//----------------------------------------------------------------------
+
+%{
+    // Put some wx default wxChar* values into wxStrings.
+    DECLARE_DEF_STRING(PanelNameStr);
+    static const wxString wxPyEmptyString(wxT(""));
+%}
+

 //---------------------------------------------------------------------------
 
 class wxEvtHandler : public wxObject {
 //---------------------------------------------------------------------------
 
 class wxEvtHandler : public wxObject {


@@ -79,7 +87,7 @@ public:
 
     %addmethods {
         void _setOORInfo(PyObject* _self) {
 
     %addmethods {
         void _setOORInfo(PyObject* _self) {

-            self->SetClientObject(new wxPyClientData(_self));
+            self->SetClientObject(new wxPyOORClientData(_self));

         }
     }
 };
         }
     }
 };


@@ -174,20 +182,19 @@ public:
              const wxPoint& pos = wxDefaultPosition,
              const wxSize& size = wxDefaultSize,
              long style = 0,
              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,
     %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)"
 
 
 
     %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 );
     void Center(int direction = wxBOTH);
     void Centre(int direction = wxBOTH);
     void CentreOnParent(int direction = wxBOTH );


@@ -209,9 +216,11 @@ public:
     void DragAcceptFiles(bool accept);
 #endif
     void Enable(bool enable);
     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);
     %name(FindWindowById) wxWindow* FindWindow(long id);
     %name(FindWindowByName) wxWindow* FindWindow(const wxString& name);

+

     void Fit();
     wxColour GetBackgroundColour();
     wxBorder GetBorder() const;
     void Fit();
     wxColour GetBackgroundColour();
     wxBorder GetBorder() const;


@@ -305,7 +314,7 @@ public:
     void Refresh(bool eraseBackground = TRUE, const wxRect* rect = NULL);
     void RefreshRect(const wxRect& rect);
 
     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 );
 
     void RemoveChild(wxWindow* child);
     bool Reparent( wxWindow* newParent );
 


@@ -320,6 +329,7 @@ public:
     void SetConstraints(wxLayoutConstraints *constraints);
     void UnsetConstraints(wxLayoutConstraints *constraints);
     void SetFocus();
     void SetConstraints(wxLayoutConstraints *constraints);
     void UnsetConstraints(wxLayoutConstraints *constraints);
     void SetFocus();

+    void SetFocusFromKbd();

     bool AcceptsFocus();
     void SetFont(const wxFont& font);
     void SetForegroundColour(const wxColour& colour);
     bool AcceptsFocus();
     void SetFont(const wxFont& font);
     void SetForegroundColour(const wxColour& colour);


@@ -343,11 +353,23 @@ 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);
     %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);
     void SetEventHandler(wxEvtHandler* handler);
     void SetExtraStyle(long exStyle);
     void SetTitle(const wxString& title);


@@ -356,7 +378,6 @@ public:
     bool TransferDataToWindow();
     void UpdateWindowUI();
     bool Validate();
     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);
 
     %name(ConvertDialogPointToPixels) wxPoint ConvertDialogToPixels(const wxPoint& pt);
     %name(ConvertDialogSizeToPixels)  wxSize  ConvertDialogToPixels(const wxSize& sz);


@@ -371,23 +392,23 @@ public:
     void SetToolTip(wxToolTip *tooltip);
     wxToolTip* GetToolTip();
 
     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
     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; }
+    void SetContainingSizer(wxSizer* sizer);
+    wxSizer *GetContainingSizer() const;

 
     wxValidator* GetValidator();
     void SetValidator(const wxValidator& validator);
 
 
     wxValidator* GetValidator();
     void SetValidator(const wxValidator& validator);
 

-#ifndef __WXMAC__

     void SetDropTarget(wxDropTarget* target);
     wxDropTarget* GetDropTarget();
     %pragma(python) addtomethod = "SetDropTarget:_args[0].thisown = 0"
     void SetDropTarget(wxDropTarget* target);
     wxDropTarget* GetDropTarget();
     %pragma(python) addtomethod = "SetDropTarget:_args[0].thisown = 0"

-#endif

 
     wxSize GetBestSize();
 
     wxSize GetBestSize();

+    wxSize GetMaxSize();

 
     void SetCaret(wxCaret *caret);
     wxCaret *GetCaret();
 
     void SetCaret(wxCaret *caret);
     wxCaret *GetCaret();


@@ -427,8 +448,25 @@ public:
     void OnPaint(wxPaintEvent& event);
 #endif
 
     void OnPaint(wxPaintEvent& event);
 #endif
 

-    wxButton* GetDefaultItem();
-    void SetDefaultItem(wxButton *btn);
+    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;

 };
 
 
 };
 
 


@@ -461,6 +499,27 @@ wxWindow* wxWindow_FromHWND(unsigned long hWnd) {
 #endif
 
 
 #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 {
 //---------------------------------------------------------------------------
 
 class wxPanel : public wxWindow {


@@ -470,7 +529,7 @@ public:
             const wxPoint& pos = wxDefaultPosition,
             const wxSize& size = wxDefaultSize,
             long style = wxTAB_TRAVERSAL,
             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,
     %name(wxPrePanel)wxPanel();
 
     bool Create(wxWindow* parent,


@@ -478,7 +537,7 @@ public:
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = wxTAB_TRAVERSAL,
                 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)"
 
     %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
     %pragma(python) addtomethod = "wxPrePanel:val._setOORInfo(val)"


@@ -501,7 +560,7 @@ public:
                      const wxPoint& pos = wxDefaultPosition,
                      const wxSize& size = wxDefaultSize,
                      long style = wxHSCROLL | wxVSCROLL,
                      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,
     %name(wxPreScrolledWindow)wxScrolledWindow();
 
     bool Create(wxWindow* parent,


@@ -509,7 +568,7 @@ public:
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = wxHSCROLL | wxVSCROLL,
                 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)"
 
     %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
     %pragma(python) addtomethod = "wxPreScrolledWindow:val._setOORInfo(val)"


@@ -518,7 +577,6 @@ public:
     int GetScrollPageSize(int orient);
     void GetScrollPixelsPerUnit(int* OUTPUT, int* OUTPUT);
     wxWindow* GetTargetWindow();
     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);
     bool IsRetained();
     void PrepareDC(wxDC& dc);
     void Scroll(int x, int y);


@@ -530,14 +588,41 @@ public:
     void GetViewStart(int* OUTPUT, int* OUTPUT);
     %pragma(python) addtoclass = "ViewStart = GetViewStart"
 
     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();
 
     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 );
+

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


@@ -545,18 +630,65 @@ public:
 
 class wxMenu : public wxEvtHandler {
 public:
 
 class wxMenu : public wxEvtHandler {
 public:

-    wxMenu(const wxString& title = wxEmptyString, 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,
 
     %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
 
     void Append(int id, const wxString& item,

-                const wxString& helpString = wxEmptyString,
-                int checkable = FALSE);
+                const wxString& helpString = wxPyEmptyString,
+                wxItemKind kind = wxITEM_NORMAL);

     %name(AppendMenu)void Append(int id, const wxString& item, wxMenu *subMenu,
     %name(AppendMenu)void Append(int id, const wxString& item, wxMenu *subMenu,

-                const wxString& helpString = wxEmptyString);
+                                 const wxString& helpString = wxPyEmptyString);

     %name(AppendItem)void Append(const wxMenuItem* item);
     %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 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);
     void Break();
     void Check(int id, bool flag);
     bool IsChecked(int id);


@@ -578,10 +710,12 @@ public:
 
     bool Delete(int id);
     %name(DeleteItem)bool Delete(wxMenuItem *item);
 
     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);
 
     wxMenuItem *Remove(int id);
     %name(RemoveItem) wxMenuItem *Remove(wxMenuItem *item);
 

+
+
+

     %addmethods {
         void Destroy() { delete self; }
     }
     %addmethods {
         void Destroy() { delete self; }
     }


@@ -651,9 +785,10 @@ public:
 class wxMenuItem : public wxObject {
 public:
     wxMenuItem(wxMenu* parentMenu=NULL, int id=wxID_SEPARATOR,
 class wxMenuItem : public wxObject {
 public:
     wxMenuItem(wxMenu* parentMenu=NULL, int id=wxID_SEPARATOR,

-               const wxString& text = wxEmptyString,
-               const wxString& help = wxEmptyString,
-               bool isCheckable = FALSE, wxMenu* subMenu = NULL);
+               const wxString& text = wxPyEmptyString,
+               const wxString& help = wxPyEmptyString,
+               wxItemKind kind = wxITEM_NORMAL,
+               wxMenu* subMenu = NULL);

 
 
     wxMenu *GetMenu();
 
 
     wxMenu *GetMenu();


@@ -663,6 +798,7 @@ public:
     void SetText(const wxString& str);
     wxString GetLabel();
     const wxString& GetText();
     void SetText(const wxString& str);
     wxString GetLabel();
     const wxString& GetText();

+    wxItemKind GetKind();

     void SetCheckable(bool checkable);
     bool IsCheckable();
     bool IsSubMenu();
     void SetCheckable(bool checkable);
     bool IsCheckable();
     bool IsSubMenu();


@@ -679,6 +815,7 @@ public:
     void SetAccel(wxAcceleratorEntry *accel);
 
     static wxString GetLabelFromText(const wxString& text);
     void SetAccel(wxAcceleratorEntry *accel);
 
     static wxString GetLabelFromText(const wxString& text);

+//    static wxAcceleratorEntry *GetAccelFromString(const wxString& label);

 
     // wxOwnerDrawn methods
 #ifdef __WXMSW__
 
     // wxOwnerDrawn methods
 #ifdef __WXMSW__


@@ -690,18 +827,18 @@ public:
     wxColour GetBackgroundColour();
     void SetBitmaps(const wxBitmap& bmpChecked,
                     const wxBitmap& bmpUnchecked = wxNullBitmap);
     wxColour GetBackgroundColour();
     void SetBitmaps(const wxBitmap& bmpChecked,
                     const wxBitmap& bmpUnchecked = wxNullBitmap);

-    void SetBitmap(const wxBitmap& bmpChecked);
-    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 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
     bool IsOwnerDrawn();
     void ResetOwnerDrawn();
 #endif

+
+    void SetBitmap(const wxBitmap& bitmap);
+    const wxBitmap& GetBitmap();
+

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