docstrings and other minor tweaks

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

diff --git a/wxPython/src/_gdicmn.i b/wxPython/src/_gdicmn.i
index 20c67d6bf7fc6aab4e1436444ba9dcb0a41251f2..40b3874e1650c0f9f4400ab1d49c2d68b33c49a5 100644 (file)
--- a/wxPython/src/_gdicmn.i
+++ b/wxPython/src/_gdicmn.i
@@ -516,10 +516,19 @@ public:
     wxPoint GetBottomRight() const;
     void SetBottomRight(const wxPoint &p);
 
     wxPoint GetBottomRight() const;
     void SetBottomRight(const wxPoint &p);
 

+    wxPoint GetTopRight() const;
+    void SetTopRight(const wxPoint &p);
+    wxPoint GetBottomLeft() const;
+    void SetBottomLeft(const wxPoint &p);
+    

 //    wxPoint GetLeftTop() const;
 //    void SetLeftTop(const wxPoint &p);
 //    wxPoint GetRightBottom() const;
 //    void SetRightBottom(const wxPoint &p);
 //    wxPoint GetLeftTop() const;
 //    void SetLeftTop(const wxPoint &p);
 //    wxPoint GetRightBottom() const;
 //    void SetRightBottom(const wxPoint &p);

+//    wxPoint GetRightTop() const;
+//    void SetRightTop(const wxPoint &p);
+//    wxPoint GetLeftBottom() const;
+//    void SetLeftBottom(const wxPoint &p);

 
     int GetLeft()   const;
     int GetTop()    const;
 
     int GetLeft()   const;
     int GetTop()    const;


@@ -644,15 +653,20 @@ bottom, otherwise it is moved to the left or top respectively.", "",
     }
 
     
     }
 
     

-    DocStr( Inside, "Return True if the point is (not strcitly) inside the rect.", "");
-    %Rename(InsideXY, bool, Inside(int x, int y) const);
-    bool Inside(const wxPoint& pt) const;
+    DocStr( Contains, "Return True if the point is inside the rect.", "");
+    %Rename(ContainsXY, bool, Contains(int x, int y) const);
+    bool Contains(const wxPoint& pt) const;

 
     DocDeclStrName(
 
     DocDeclStrName(

-        bool, Inside(const wxRect& rect) const,
+        bool, Contains(const wxRect& rect) const,

         "Returns ``True`` if the given rectangle is completely inside this
 rectangle or touches its boundary.", "",
         "Returns ``True`` if the given rectangle is completely inside this
 rectangle or touches its boundary.", "",

-        InsideRect);
+        ContainsRect);
+    %pythoncode {
+        Inside = wx._deprecated(Contains, "Use `Contains` instead.")
+        InsideXY = wx._deprecated(ContainsXY, "Use `ContainsXY` instead.")
+        InsideRect = wx._deprecated(ContainsRect, "Use `ContainsRect` instead.")
+    }

     
     DocDeclStr(    
         bool, Intersects(const wxRect& rect) const,
     
     DocDeclStr(    
         bool, Intersects(const wxRect& rect) const,


@@ -708,6 +722,24 @@ usually, but not necessarily, the larger one.", "");
     __safe_for_unpickling__ = True
     def __reduce__(self):                return (wx.Rect, self.Get())
     }
     __safe_for_unpickling__ = True
     def __reduce__(self):                return (wx.Rect, self.Get())
     }

+
+    
+    %property(Bottom, GetBottom, SetBottom, doc="See `GetBottom` and `SetBottom`");
+    %property(BottomRight, GetBottomRight, SetBottomRight, doc="See `GetBottomRight` and `SetBottomRight`");
+    %property(BottomLeft, GetBottomLeft, SetBottomLeft, doc="See `GetBottomLeft` and `SetBottomLeft`");
+    %property(Height, GetHeight, SetHeight, doc="See `GetHeight` and `SetHeight`");
+    %property(Left, GetLeft, SetLeft, doc="See `GetLeft` and `SetLeft`");
+    %property(Position, GetPosition, SetPosition, doc="See `GetPosition` and `SetPosition`");
+    %property(Right, GetRight, SetRight, doc="See `GetRight` and `SetRight`");
+    %property(Size, GetSize, SetSize, doc="See `GetSize` and `SetSize`");
+    %property(Top, GetTop, SetTop, doc="See `GetTop` and `SetTop`");
+    %property(TopLeft, GetTopLeft, SetTopLeft, doc="See `GetTopLeft` and `SetTopLeft`");
+    %property(TopRight, GetTopRight, SetTopRight, doc="See `GetTopRight` and `SetTopRight`");
+    %property(Width, GetWidth, SetWidth, doc="See `GetWidth` and `SetWidth`");
+    %property(X, GetX, SetX, doc="See `GetX` and `SetX`");
+    %property(Y, GetY, SetY, doc="See `GetY` and `SetY`");
+
+    %property(Empty, IsEmpty, doc="See `IsEmpty`");

 };
 
 
 };
 
 


@@ -857,6 +889,12 @@ public:
     __safe_for_unpickling__ = True
     def __reduce__(self):                return (wx.Point2D, self.Get())
     }
     __safe_for_unpickling__ = True
     def __reduce__(self):                return (wx.Point2D, self.Get())
     }

+
+    %property(Floor, GetFloor, doc="See `GetFloor`");
+    %property(Rounded, GetRounded, doc="See `GetRounded`");
+    %property(VectorAngle, GetVectorAngle, SetVectorAngle, doc="See `GetVectorAngle` and `SetVectorAngle`");
+    %property(VectorLength, GetVectorLength, SetVectorLength, doc="See `GetVectorLength` and `SetVectorLength`");
+    

 };
 
 
 };