Restrict button size restrictions documentation to OSX/Carbon only.

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

diff --git a/interface/wx/gbsizer.h b/interface/wx/gbsizer.h
index 30ffb83eab2840d9532904a5a294843a75cc67f2..338376a69496c2294a0435647d60885170cc0a9d 100644 (file)
--- a/interface/wx/gbsizer.h
+++ b/interface/wx/gbsizer.h
@@ -3,12 +3,11 @@
 // Purpose:     interface of wxGBPosition
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxGBPosition
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
     @class wxGBPosition
 /////////////////////////////////////////////////////////////////////////////
 
 /**
     @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.


@@ -63,7 +62,6 @@ public:
 
 /**
     @class wxGridBagSizer
 
 /**
     @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
 
     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


@@ -216,11 +214,10 @@ public:
 
 /**
     @class wxGBSizerItem
 
 /**
     @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
 
     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
+    normal wxSizerItem by adding wxGBPosition and wxGBSpan attributes. 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 time you will not need to use a wxGBSizerItem directly in your code,
     but there are a couple of cases where it is handy.
 


@@ -234,20 +231,20 @@ public:
         Construct a sizer item for tracking a spacer.
     */
     wxGBSizerItem(int width, int height, const wxGBPosition& pos,
         Construct a sizer item for tracking a spacer.
     */
     wxGBSizerItem(int width, int height, const wxGBPosition& pos,

-                  const wxGBSpan& span, int flag, int border,
-                  wxObject* userData);
+                  const wxGBSpan& span=wxDefaultSpan, int flag=0, int border=0,
+                  wxObject* userData=NULL);

     /**
         Construct a sizer item for tracking a window.
     */
     wxGBSizerItem(wxWindow* window, const wxGBPosition& pos,
     /**
         Construct a sizer item for tracking a window.
     */
     wxGBSizerItem(wxWindow* window, const wxGBPosition& pos,

-                  const wxGBSpan& span, int flag, int border,
-                  wxObject* userData);
+                  const wxGBSpan& span=wxDefaultSpan, int flag=0, int border=0,
+                  wxObject* userData=NULL);

     /**
         Construct a sizer item for tracking a subsizer.
     */
     wxGBSizerItem(wxSizer* sizer, const wxGBPosition& pos,
     /**
         Construct a sizer item for tracking a subsizer.
     */
     wxGBSizerItem(wxSizer* sizer, const wxGBPosition& pos,

-                  const wxGBSpan& span, int flag, int border,
-                  wxObject* userData);
+                  const wxGBSpan& span=wxDefaultSpan, int flag=0, int border=0,
+                  wxObject* userData=NULL);

 
     /**
         Get the row and column of the endpoint of this item.
 
     /**
         Get the row and column of the endpoint of this item.


@@ -271,7 +268,7 @@ public:
     //@}
 
     /**
     //@}
 
     /**

-        Returns @true if this item and the @a other item instersect.
+        Returns @true if this item and the @a other item intersect.

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


@@ -294,13 +291,16 @@ public:
         is successful and after the next Layout the item will be resized.
     */
     bool SetSpan(const wxGBSpan& span);
         is successful and after the next Layout the item will be resized.
     */
     bool SetSpan(const wxGBSpan& span);

+
+    
+    wxGridBagSizer* GetGBSizer() const;
+    void SetGBSizer(wxGridBagSizer* sizer);

 };
 
 
 
 /**
     @class wxGBSpan
 };
 
 
 
 /**
     @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.


@@ -352,3 +352,5 @@ public:
     bool operator==(const wxGBSpan& o) const;
 };
 
     bool operator==(const wxGBSpan& o) const;
 };
 

+
+const wxGBSpan wxDefaultSpan;