mac paths updated

[wxWidgets.git] / interface / gbsizer.h

diff --git a/interface/gbsizer.h b/interface/gbsizer.h
index 02a33e85fcabb823e7811b0f70f6f5b6a6a2b66b..30ffb83eab2840d9532904a5a294843a75cc67f2 100644 (file)
--- a/interface/gbsizer.h
+++ b/interface/gbsizer.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        gbsizer.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        gbsizer.h

-// Purpose:     documentation for wxGBPosition class
+// Purpose:     interface of wxGBPosition

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -9,34 +9,34 @@
 /**
     @class wxGBPosition
     @wxheader{gbsizer.h}
 /**
     @class wxGBPosition
     @wxheader{gbsizer.h}

-    
-    This class represents the position of an item in a virtual grid of
-    rows and columns managed by a wxGridBagSizer.
-    
+
+    This class represents the position of an item in a virtual grid of rows and
+    columns managed by a wxGridBagSizer.
+

     @library{wxcore}
     @library{wxcore}

-    @category{FIXME}
+    @category{winlayout}

 */
 */

-class wxGBPosition 
+class wxGBPosition

 {
 public:
 {
 public:

-    //@{

     /**
     /**

-        Construct a new wxGBPosition, optionally setting the row and column.
-        The default is (0,0).
+        Default constructor, setting the row and column to (0,0).

     */
     wxGBPosition();
     */
     wxGBPosition();

-        wxGBPosition(int row, int col);
-    //@}
+    /**
+        Construct a new wxGBPosition, setting the row and column.
+    */
+    wxGBPosition(int row, int col);

 
     /**
         Get the current column value.
     */
 
     /**
         Get the current column value.
     */

-    int GetCol();
+    int GetCol() const;

 
     /**
         Get the current row value.
     */
 
     /**
         Get the current row value.
     */

-    int GetRow();
+    int GetRow() const;

 
     /**
         Set a new column value.
 
     /**
         Set a new column value.


@@ -49,27 +49,27 @@ public:
     void SetRow(int row);
 
     /**
     void SetRow(int row);
 
     /**

-        Is the wxGBPosition valid?  (An invalid wxGBPosition is (-1,-1). )
+        Checks if the position is valid. An invalid position is (-1,-1).

     */
     */

-    bool operator!(const wxGBPosition& p);
+    bool operator!(const wxGBPosition& p) const;

 
     /**
         Compare equality of two wxGBPositions.
     */
 
     /**
         Compare equality of two wxGBPositions.
     */

-    bool operator operator==(const wxGBPosition& p);
+    bool operator==(const wxGBPosition& p) const;

 };
 
 
 };
 
 

+

 /**
     @class wxGridBagSizer
     @wxheader{gbsizer.h}
 /**
     @class wxGridBagSizer
     @wxheader{gbsizer.h}

-    
-    A wxSizer that can lay out items in a virtual grid
-    like a wxFlexGridSizer but in this case
-    explicit positioning of the items is allowed using 
-    wxGBPosition, and items can optionally span
-    more than one row and/or column using wxGBSpan.
-    
+
+    A wxSizer that can lay out items in a virtual grid like a wxFlexGridSizer
+    but in this case explicit positioning of the items is allowed using
+    wxGBPosition, and items can optionally span more than one row and/or column
+    using wxGBSpan.
+

     @library{wxcore}
     @category{winlayout}
 */
     @library{wxcore}
     @category{winlayout}
 */


@@ -84,27 +84,21 @@ public:
 
     //@{
     /**
 
     //@{
     /**

-        The Add methods return a valid pointer if the item was successfully placed at
-        the
-        given position, @NULL if something was already there.
+        Adds the given item to the given position.
+        
+        @return A valid pointer if the item was successfully placed at the
+                 given position, or @NULL if something was already there.

     */
     wxSizerItem* Add(wxWindow* window, const wxGBPosition& pos,
                      const wxGBSpan& span = wxDefaultSpan,
     */
     wxSizerItem* Add(wxWindow* window, const wxGBPosition& pos,
                      const wxGBSpan& span = wxDefaultSpan,

-                     int flag = 0,
-                     int border = 0,
-                     wxObject* userData = @NULL);
-        wxSizerItem* Add(wxSizer* sizer, const wxGBPosition& pos,
-                         const wxGBSpan& span = wxDefaultSpan,
-                         int flag = 0,
-                         int border = 0,
-                         wxObject* userData = @NULL);
-        wxSizerItem* Add(int width, int height,
-                         const wxGBPosition& pos,
-                         const wxGBSpan& span = wxDefaultSpan,
-                         int flag = 0,
-                         int border = 0,
-                         wxObject* userData = @NULL);
-        wxSizerItem* Add(wxGBSizerItem* item);
+                     int flag = 0, int border = 0, wxObject* userData = NULL);
+    wxSizerItem* Add(wxSizer* sizer, const wxGBPosition& pos,
+                     const wxGBSpan& span = wxDefaultSpan,
+                     int flag = 0, int border = 0, wxObject* userData = NULL);
+    wxSizerItem* Add(int width, int height, const wxGBPosition& pos,
+                     const wxGBSpan& span = wxDefaultSpan,
+                     int flag = 0, int border = 0, wxObject* userData = NULL);
+    wxSizerItem* Add(wxGBSizerItem* item);

     //@}
 
     /**
     //@}
 
     /**


@@ -117,14 +111,13 @@ public:
     /**
         Look at all items and see if any intersect (or would overlap) the given
         item. Returns @true if so, @false if there would be no overlap. If an
     /**
         Look at all items and see if any intersect (or would overlap) the given
         item. Returns @true if so, @false if there would be no overlap. If an

-        excludeItem is given then it will not be checked for intersection, for
-        example it may be the item we are checking the position of.
+        @a excludeItem is given then it will not be checked for intersection,
+        for example it may be the item we are checking the position of.

     */
     bool CheckForIntersection(wxGBSizerItem* item,
     */
     bool CheckForIntersection(wxGBSizerItem* item,

-                              wxGBSizerItem* excludeItem = @NULL);
-        bool CheckForIntersection(const wxGBPosition& pos,
-                                  const wxGBSpan& span,
-                                  wxGBSizerItem* excludeItem = @NULL);
+                              wxGBSizerItem* excludeItem = NULL);
+    bool CheckForIntersection(const wxGBPosition& pos, const wxGBSpan& span,
+                              wxGBSizerItem* excludeItem = NULL);

     //@}
 
     //@{
     //@}
 
     //@{


@@ -133,13 +126,13 @@ public:
         not found. (non-recursive)
     */
     wxGBSizerItem* FindItem(wxWindow* window);
         not found. (non-recursive)
     */
     wxGBSizerItem* FindItem(wxWindow* window);

-        wxGBSizerItem* FindItem(wxSizer* sizer);
+    wxGBSizerItem* FindItem(wxSizer* sizer);

     //@}
 
     /**
         Return the sizer item located at the point given in pt, or @NULL if
     //@}
 
     /**
         Return the sizer item located at the point given in pt, or @NULL if

-        there is no item at that point. The (x,y) coordinates in pt correspond
-        to the client coordinates of the window using the sizer for
+        there is no item at that point. The (x,y) coordinates in @a pt
+        correspond to the client coordinates of the window using the sizer for

         layout. (non-recursive)
     */
     wxGBSizerItem* FindItemAtPoint(const wxPoint& pt);
         layout. (non-recursive)
     */
     wxGBSizerItem* FindItemAtPoint(const wxPoint& pt);


@@ -157,32 +150,32 @@ public:
     wxGBSizerItem* FindItemWithData(const wxObject* userData);
 
     /**
     wxGBSizerItem* FindItemWithData(const wxObject* userData);
 
     /**

-        Get the size of the specified cell, including hgap and vgap. Only
-        valid after a Layout.
+        Get the size of the specified cell, including hgap and vgap. Only valid
+        after window layout has been performed.

     */
     */

-    wxSize GetCellSize(int row, int col);
+    wxSize GetCellSize(int row, int col) const;

 
     /**
         Get the size used for cells in the grid with no item.
     */
 
     /**
         Get the size used for cells in the grid with no item.
     */

-    wxSize GetEmptyCellSize();
+    wxSize GetEmptyCellSize() const;

 
     //@{
     /**
         Get the grid position of the specified item.
     */
     wxGBPosition GetItemPosition(wxWindow* window);
 
     //@{
     /**
         Get the grid position of the specified item.
     */
     wxGBPosition GetItemPosition(wxWindow* window);

-        wxGBPosition GetItemPosition(wxSizer* sizer);
-        wxGBPosition GetItemPosition(size_t index);
+    wxGBPosition GetItemPosition(wxSizer* sizer);
+    wxGBPosition GetItemPosition(size_t index);

     //@}
 
     //@{
     /**
     //@}
 
     //@{
     /**

-        Get the row/col spanning of the specified item
+        Get the row/col spanning of the specified item.

     */
     wxGBSpan GetItemSpan(wxWindow* window);
     */
     wxGBSpan GetItemSpan(wxWindow* window);

-        wxGBSpan GetItemSpan(wxSizer* sizer);
-        wxGBSpan GetItemSpan(size_t index);
+    wxGBSpan GetItemSpan(wxSizer* sizer);
+    wxGBSpan GetItemSpan(size_t index);

     //@}
 
     /**
     //@}
 
     /**


@@ -203,8 +196,8 @@ public:
         @false is returned.
     */
     bool SetItemPosition(wxWindow* window, const wxGBPosition& pos);
         @false is returned.
     */
     bool SetItemPosition(wxWindow* window, const wxGBPosition& pos);

-        bool SetItemPosition(wxSizer* sizer, const wxGBPosition& pos);
-        bool SetItemPosition(size_t index, const wxGBPosition& pos);
+    bool SetItemPosition(wxSizer* sizer, const wxGBPosition& pos);
+    bool SetItemPosition(size_t index, const wxGBPosition& pos);

     //@}
 
     //@{
     //@}
 
     //@{


@@ -214,50 +207,50 @@ public:
         then @false is returned.
     */
     bool SetItemSpan(wxWindow* window, const wxGBSpan& span);
         then @false is returned.
     */
     bool SetItemSpan(wxWindow* window, const wxGBSpan& span);

-        bool SetItemSpan(wxSizer* sizer, const wxGBSpan& span);
-        bool SetItemSpan(size_t index, const wxGBSpan& span);
+    bool SetItemSpan(wxSizer* sizer, const wxGBSpan& span);
+    bool SetItemSpan(size_t index, const wxGBSpan& span);

     //@}
 };
 
 
     //@}
 };
 
 

+

 /**
     @class wxGBSizerItem
     @wxheader{gbsizer.h}
 /**
     @class wxGBSizerItem
     @wxheader{gbsizer.h}

-    
-    The wxGBSizerItem class is used by the 
-    wxGridBagSizer for tracking the items in the
-    sizer. It adds grid position and spanning information to the normal 
-    wxSizerItem by adding
-    wxGBPosition and wxGBSpan
-    attrbibutes. Most of the time you will not need to use a
-    wxGBSizerItem directly in your code, but there are a couple of cases
-    where it is handy.
-    
+
+    The wxGBSizerItem class is used by the wxGridBagSizer for tracking the
+    items in the sizer. It adds grid position and spanning information to the
+    normal wxSizerItem by adding wxGBPosition and wxGBSpan attrbibutes. Most of
+    the time you will not need to use a wxGBSizerItem directly in your code,
+    but there are a couple of cases where it is handy.
+

     @library{wxcore}
     @library{wxcore}

-    @category{FIXME}
+    @category{winlayout}

 */
 class wxGBSizerItem : public wxSizerItem
 {
 public:
 */
 class wxGBSizerItem : public wxSizerItem
 {
 public:

-    //@{

     /**
     /**

-        Construct a sizer item for tracking a subsizer.
+        Construct a sizer item for tracking a spacer.

     */
     wxGBSizerItem(int width, int height, const wxGBPosition& pos,
     */
     wxGBSizerItem(int width, int height, const wxGBPosition& pos,

-                  const wxGBSpan& span, int flag,
-                  int border, wxObject* userData);
-        wxGBSizerItem(wxWindow* window, const wxGBPosition& pos,
-                      const wxGBSpan& span,
-                      int flag, int border,
-                      wxObject* userData);
-        wxGBSizerItem(wxSizer* sizer, const wxGBPosition& pos,
-                      const wxGBSpan& span,
-                      int flag, int border,
-                      wxObject* userData);
-    //@}
+                  const wxGBSpan& span, int flag, int border,
+                  wxObject* userData);
+    /**
+        Construct a sizer item for tracking a window.
+    */
+    wxGBSizerItem(wxWindow* window, const wxGBPosition& pos,
+                  const wxGBSpan& span, int flag, int border,
+                  wxObject* userData);
+    /**
+        Construct a sizer item for tracking a subsizer.
+    */
+    wxGBSizerItem(wxSizer* sizer, const wxGBPosition& pos,
+                  const wxGBSpan& span, int flag, int border,
+                  wxObject* userData);

 
     /**
 
     /**

-        Get the row and column of the endpoint of this item
+        Get the row and column of the endpoint of this item.

     */
     void GetEndPos(int& row, int& col);
 
     */
     void GetEndPos(int& row, int& col);
 


@@ -265,38 +258,38 @@ public:
     /**
         Get the grid position of the item.
     */
     /**
         Get the grid position of the item.
     */

-    wxGBPosition GetPos();
-        void GetPos(int& row, int& col);
+    wxGBPosition GetPos() const;
+    void GetPos(int& row, int& col) const;

     //@}
 
     //@{
     /**
         Get the row and column spanning of the item.
     */
     //@}
 
     //@{
     /**
         Get the row and column spanning of the item.
     */

-    wxGBSpan GetSpan();
-        void GetSpan(int& rowspan, int& colspan);
+    wxGBSpan GetSpan() const;
+    void GetSpan(int& rowspan, int& colspan) const;

     //@}
 
     //@}
 

-    //@{

     /**
     /**

-        Returns @true if the given pos/span would intersect with this item.
+        Returns @true if this item and the @a other item instersect.

     */
     bool Intersects(const wxGBSizerItem& other);
     */
     bool Intersects(const wxGBSizerItem& other);

-        bool Intersects(const wxGBPosition& pos,
-                        const wxGBSpan& span);
-    //@}
+    /**
+        Returns @true if the given pos/span would intersect with this item.
+    */
+    bool Intersects(const wxGBPosition& pos, const wxGBSpan& span);

 
     /**
 
     /**

-        If the item is already a member of a sizer then first ensure that
-        there is no other item that would intersect with this one at the new
+        If the item is already a member of a sizer then first ensure that there
+        is no other item that would intersect with this one at the new

         position, then set the new position. Returns @true if the change is
         successful and after the next Layout the item will be moved.
     */
     bool SetPos(const wxGBPosition& pos);
 
     /**
         position, then set the new position. Returns @true if the change is
         successful and after the next Layout the item will be moved.
     */
     bool SetPos(const wxGBPosition& pos);
 
     /**

-        If the item is already a member of a sizer then first ensure that
-        there is no other item that would intersect with this one with its new
+        If the item is already a member of a sizer then first ensure that there
+        is no other item that would intersect with this one with its new

         spanning size, then set the new spanning. Returns @true if the change
         is successful and after the next Layout the item will be resized.
     */
         spanning size, then set the new spanning. Returns @true if the change
         is successful and after the next Layout the item will be resized.
     */


@@ -304,38 +297,39 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxGBSpan
     @wxheader{gbsizer.h}
 /**
     @class wxGBSpan
     @wxheader{gbsizer.h}

-    
-    This class is used to hold the row and column spanning attributes of
-    items in a wxGridBagSizer.
-    
+
+    This class is used to hold the row and column spanning attributes of items
+    in a wxGridBagSizer.
+

     @library{wxcore}
     @library{wxcore}

-    @category{FIXME}
+    @category{winlayout}

 */
 */

-class wxGBSpan 
+class wxGBSpan

 {
 public:
 {
 public:

-    //@{

     /**
     /**

-        Construct a new wxGBSpan, optionally setting the rowspan and colspan.
-        The default is (1,1).  (Meaning that the item occupies one cell in
-        each direction.
+        Default constructor, setting the rowspan and colspan to (1,1) meaning
+        that the item occupies one cell in each direction.

     */
     wxGBSpan();
     */
     wxGBSpan();

-        wxGBSpan(int rowspan, int colspan);
-    //@}
+    /**
+        Construct a new wxGBSpan, setting the @a rowspan and @a colspan.
+    */
+    wxGBSpan(int rowspan, int colspan);

 
     /**
         Get the current colspan value.
     */
 
     /**
         Get the current colspan value.
     */

-    int GetColspan();
+    int GetColspan() const;

 
     /**
         Get the current rowspan value.
     */
 
     /**
         Get the current rowspan value.
     */

-    int GetRowspan();
+    int GetRowspan() const;

 
     /**
         Set a new colspan value.
 
     /**
         Set a new colspan value.


@@ -348,12 +342,13 @@ public:
     void SetRowspan(int rowspan);
 
     /**
     void SetRowspan(int rowspan);
 
     /**

-        Is the wxGBSpan valid?  (An invalid wxGBSpan is (-1,-1). )
+        Checks if the span is valid. An invalid span is (-1,-1).

     */
     */

-    bool operator!(const wxGBSpan& o);
+    bool operator!(const wxGBSpan& o) const;

 
     /**
         Compare equality of two wxGBSpans.
     */
 
     /**
         Compare equality of two wxGBSpans.
     */

-    bool operator operator==(const wxGBSpan& o);
+    bool operator==(const wxGBSpan& o) const;

 };
 };

+