Applied patch #15286: documentation and col/rowspan demo by dghart

[wxWidgets.git] / interface / wx / gdicmn.h

diff --git a/interface/wx/gdicmn.h b/interface/wx/gdicmn.h
index 80b93b3be7d9ff80d4cfdb17c1111532e0dbf58a..ec06e76c6f86501502e295b4ef3290827237fc4f 100644 (file)
--- a/interface/wx/gdicmn.h
+++ b/interface/wx/gdicmn.h
@@ -423,6 +423,11 @@ public:
     */
     void SetHeight(int height);
 
+    /**
+        Sets the position.
+    */
+    void SetPosition(const wxPoint& pos);
+
     /**
         Sets the size.
 
@@ -447,21 +452,35 @@ public:
 
     /**
        Set the left side of the rectangle.
+
+       Notice that because the rectangle stores its left side and width,
+       calling SetLeft() changes the right side position too -- but does
+       preserve the width.
     */
     void SetLeft(int left);
 
     /**
        Set the right side of the rectangle.
+
+       Notice that this doesn't affect GetLeft() return value but changes the
+       rectangle width to set its right side to the given position.
      */
     void SetRight(int right);
 
     /**
        Set the top edge of the rectangle.
+
+       Notice that because the rectangle stores its top side and height,
+       calling SetTop() changes the bottom side position too -- but does
+       preserve the height.
      */
     void SetTop(int top);
 
     /**
-       Set the bottome edge of th rectangle.
+       Set the bottom edge of the rectangle.
+
+       Notice that this doesn't affect GetTop() return value but changes the
+       rectangle height to set its bottom side to the given position.
      */
     void SetBottom(int bottom);
 
@@ -586,6 +605,16 @@ public:
     /**
         Converts the given wxRealPoint (with floating point coordinates) to a
         wxPoint instance.
+
+        Notice that this truncates the floating point values of @a pt
+        components, if you want to round them instead you need to do it
+        manually, e.g.
+        @code
+            #include <wx/math.h>    // for wxRound()
+
+            wxRealPoint rp = ...;
+            wxPoint p(wxRound(rp.x), wxRound(rp.y));
+        @endcode
     */
     wxPoint(const wxRealPoint& pt);
 
@@ -940,9 +969,8 @@ public:
     void Set(int width, int height);
 
     /**
-        Combine this size object with another one replacing the default (i.e.
-        equal to -1) components of this object with those of the other. It is
-        typically used like this:
+        Combine this size object with another one replacing the default (i.e.\ equal to -1)
+        components of this object with those of the other. It is typically used like this:
 
         @code
         if ( !size.IsFullySpecified() )