Patch from Utensil Candel with large improvements to the samples documentation, and...

[wxWidgets.git] / interface / position.h

diff --git a/interface/position.h b/interface/position.h
index bf9dec7ee1e1826c0f1eeb55454d33582f11de54..ba5dfbd499d57b4710b4eee35593ecd95e97fb6b 100644 (file)
--- a/interface/position.h
+++ b/interface/position.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        position.h
-// Purpose:     documentation for wxPosition class
+// Purpose:     interface of wxPosition
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -11,57 +11,45 @@
     @wxheader{position.h}
 
     This class represents the position of an item in any kind of grid of rows and
-    columns such as wxGridBagSizer, or
-    wxHVScrolledWindow.
+    columns such as wxGridBagSizer, or wxHVScrolledWindow.
+
+    @todo rename this class to wxItemPosition or such, wxPosition is too generic
 
     @library{wxbase}
-    @category{FIXME}
+    @category{data}
 
-    @seealso
-    wxPoint, wxSize
+    @see wxPoint, wxSize
 */
 class wxPosition
 {
 public:
-    //@{
+
     /**
-        Construct a new wxPosition, optionally setting the row and column. The
-        default value is (0, 0).
+        Construct a new wxPosition, setting the row and column to the
+        default value of (0, 0).
     */
     wxPosition();
+
+    /**
+        Construct a new wxPosition, setting the row and column to the
+        value of (@a row, @a col).
+    */
     wxPosition(int row, int col);
-    //@}
 
     /**
         A synonym for GetColumn().
     */
-    int GetCol();
+    int GetCol() const;
 
     /**
         Get the current row value.
     */
-    int GetColumn();
+    int GetColumn() const;
 
     /**
         Get the current row value.
     */
-    int GetRow();
-
-    //@{
-    /**
-        
-    */
-    bool operator ==(const wxPosition& p);
-    bool operator !=(const wxPosition& p);
-    wxPosition operator +=(const wxPosition& p);
-    wxPosition operator -=(const wxPosition& p);
-    wxPosition operator +=(const wxSize& s);
-    wxPosition operator -=(const wxSize& s);
-    wxPosition operator +(const wxPosition& p);
-    wxPosition operator -(const wxPosition& p);
-    wxPosition operator +(const wxSize& s);
-    wxPosition operator -(const wxSize& s);
-    //@}
+    int GetRow() const;
 
     /**
         A synonym for SetColumn().
@@ -77,4 +65,23 @@ public:
         Set a new row value.
     */
     void SetRow(int row);
+
+
+    /**
+        @name Miscellaneous operators
+
+        @{
+    */
+    bool operator ==(const wxPosition& p) const;
+    bool operator !=(const wxPosition& p) const;
+    wxPosition& operator +=(const wxPosition& p) const;
+    wxPosition& operator -=(const wxPosition& p) const;
+    wxPosition& operator +=(const wxSize& s) const;
+    wxPosition& operator -=(const wxSize& s) const;
+    wxPosition& operator +(const wxPosition& p) const;
+    wxPosition& operator -(const wxPosition& p) const;
+    wxPosition& operator +(const wxSize& s) const;
+    wxPosition& operator -(const wxSize& s) const;
+    //@}
 };
+