Typos

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

diff --git a/wxPython/src/_panel.i b/wxPython/src/_panel.i
index 828c81e908dbccb36e299563f49d4b3af2e38594..76a7fb4d5f6a04c7ea96e3f3164b609856cbb634 100644 (file)
--- a/wxPython/src/_panel.i
+++ b/wxPython/src/_panel.i
@@ -18,7 +18,6 @@
 %{
 %}
 
-
 //---------------------------------------------------------------------------
 %newgroup
 
@@ -26,11 +25,11 @@
 class wxPanel : public wxWindow
 {
 public:
-    %addtofunc wxPanel         "self._setOORInfo(self)"
-    %addtofunc wxPanel()       ""
+    %pythonAppend wxPanel         "self._setOORInfo(self)"
+    %pythonAppend wxPanel()       ""
 
     wxPanel(wxWindow* parent,
-            const wxWindowID id,
+            const wxWindowID id=-1,
             const wxPoint& pos = wxDefaultPosition,
             const wxSize& size = wxDefaultSize,
             long style = wxTAB_TRAVERSAL | wxNO_BORDER,
@@ -54,13 +53,13 @@ public:
 
 // TODO: Add wrappers for the wxScrollHelper class, make wxScrolledWindow
 //       derive from it and wxPanel.  But what to do about wxGTK where this
-//       is not true?
+//       is not True?
 
 class wxScrolledWindow : public wxPanel
 {
 public:
-    %addtofunc wxScrolledWindow         "self._setOORInfo(self)"
-    %addtofunc wxScrolledWindow()       ""
+    %pythonAppend wxScrolledWindow         "self._setOORInfo(self)"
+    %pythonAppend wxScrolledWindow()       ""
 
     wxScrolledWindow(wxWindow* parent,
                      const wxWindowID id = -1,
@@ -82,7 +81,7 @@ public:
     virtual void SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY,
                                int noUnitsX, int noUnitsY,
                                int xPos = 0, int yPos = 0,
-                               bool noRefresh = FALSE );
+                               bool noRefresh = False );
 
     // scroll to the given (in logical coords) position
     virtual void Scroll(int x, int y);
@@ -94,20 +93,24 @@ public:
     // Set the x, y scrolling increments.
     void SetScrollRate( int xstep, int ystep );
 
-    // get the size of one logical unit in physical ones
-    virtual void GetScrollPixelsPerUnit(int *OUTPUT,
-                                        int *OUTPUT) const;
+    DocDeclAStr(
+        virtual void, GetScrollPixelsPerUnit(int *OUTPUT, int *OUTPUT) const,
+        "GetScrollPixelsPerUnit() -> (xUnit, yUnit)",
+        "Get the size of one logical unit in physical units.");
 
-    // Enable/disable Windows scrolling in either direction. If TRUE, wxWindows
+    // Enable/disable Windows scrolling in either direction. If True, wxWindows
     // scrolls the canvas and only a bit of the canvas is invalidated; no
-    // Clear() is necessary. If FALSE, the whole canvas is invalidated and a
+    // Clear() is necessary. If False, the whole canvas is invalidated and a
     // Clear() is necessary. Disable for when the scroll increment is used to
     // actually scroll a non-constant distance
     virtual void EnableScrolling(bool x_scrolling, bool y_scrolling);
 
-    // Get the view start
-    virtual void GetViewStart(int *OUTPUT, int *OUTPUT) const;
 
+    DocDeclAStr( 
+        virtual void, GetViewStart(int *OUTPUT, int *OUTPUT) const,
+        "GetViewStart() -> (x,y)",
+        "Get the view start");
+    
     // Set the scale factor, used in PrepareDC
     void SetScale(double xs, double ys);
     double GetScaleX() const;
@@ -117,12 +120,21 @@ public:
     %nokwargs CalcScrolledPosition;
     %nokwargs CalcUnscrolledPosition;
     
-    // translate between scrolled and unscrolled coordinates
-    void CalcScrolledPosition(int x, int y, int *OUTPUT, int *OUTPUT) const;
+    DocStr(CalcScrolledPosition, "Translate between scrolled and unscrolled coordinates.");
     wxPoint CalcScrolledPosition(const wxPoint& pt) const;
-    void CalcUnscrolledPosition(int x, int y, int *OUTPUT, int *OUTPUT) const;
+    DocDeclA(
+        void, CalcScrolledPosition(int x, int y, int *OUTPUT, int *OUTPUT) const,
+        "CalcScrolledPosition(int x, int y) -> (sx, sy)");
+
+    
+    DocStr(CalcUnscrolledPosition, "Translate between scrolled and unscrolled coordinates.");
     wxPoint CalcUnscrolledPosition(const wxPoint& pt) const;
+    DocDeclA(
+        void, CalcUnscrolledPosition(int x, int y, int *OUTPUT, int *OUTPUT) const,
+        "CalcUnscrolledPosition(int x, int y) -> (ux, uy)");
+
 
+    
 // TODO: use directors?
 //     virtual void DoCalcScrolledPosition(int x, int y, int *xx, int *yy) const;
 //     virtual void DoCalcUnscrolledPosition(int x, int y, int *xx, int *yy) const;