Don't create multiple parent-less top level frames in layout sample.

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

diff --git a/include/wx/gbsizer.h b/include/wx/gbsizer.h
index eaea7137b1b51bedfe12cfd073c30a794489b2d1..d9120a607b4a6d24197ae05d154669af35dc678c 100644 (file)
--- a/include/wx/gbsizer.h
+++ b/include/wx/gbsizer.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        gbsizer.h
+// Name:        wx/gbsizer.h

 // Purpose:     wxGridBagSizer:  A sizer that can lay out items in a grid,
 //              with items at specified cells, and with the option of row
 //              and/or column spanning
 // Purpose:     wxGridBagSizer:  A sizer that can lay out items in a grid,
 //              with items at specified cells, and with the option of row
 //              and/or column spanning


@@ -53,20 +53,61 @@ private:
 class WXDLLIMPEXP_CORE wxGBSpan
 {
 public:
 class WXDLLIMPEXP_CORE wxGBSpan
 {
 public:

-    wxGBSpan() : m_rowspan(1), m_colspan(1) {}
-    wxGBSpan(int rowspan, int colspan) : m_rowspan(rowspan), m_colspan(colspan) {}
+    wxGBSpan() { Init(); }
+    wxGBSpan(int rowspan, int colspan)
+    {
+        // Initialize the members to valid values as not doing it may result in
+        // infinite loop in wxGBSizer code if the user passed 0 for any of
+        // them, see #12934.
+        Init();
+
+        SetRowspan(rowspan);
+        SetColspan(colspan);
+    }

 
     // default copy ctor and assignment operator are okay.
 
 
     // default copy ctor and assignment operator are okay.
 

+    // Factor constructor creating an invalid wxGBSpan: this is mostly supposed
+    // to be used as return value for functions returning wxGBSpan in case of
+    // errors.
+    static wxGBSpan Invalid()
+    {
+        return wxGBSpan(NULL);
+    }
+

     int GetRowspan() const { return m_rowspan; }
     int GetColspan() const { return m_colspan; }
     int GetRowspan() const { return m_rowspan; }
     int GetColspan() const { return m_colspan; }

-    void SetRowspan(int rowspan) { m_rowspan = rowspan; }
-    void SetColspan(int colspan) { m_colspan = colspan; }
+    void SetRowspan(int rowspan)
+    {
+        wxCHECK_RET( rowspan > 0, "Row span should be strictly positive" );
+
+        m_rowspan = rowspan;
+    }
+
+    void SetColspan(int colspan)
+    {
+        wxCHECK_RET( colspan > 0, "Column span should be strictly positive" );
+
+        m_colspan = colspan;
+    }

 
     bool operator==(const wxGBSpan& o) const { return m_rowspan == o.m_rowspan && m_colspan == o.m_colspan; }
     bool operator!=(const wxGBSpan& o) const { return !(*this == o); }
 
 private:
 
     bool operator==(const wxGBSpan& o) const { return m_rowspan == o.m_rowspan && m_colspan == o.m_colspan; }
     bool operator!=(const wxGBSpan& o) const { return !(*this == o); }
 
 private:

+    // This private ctor is used by Invalid() only.
+    wxGBSpan(struct InvalidCtorTag*)
+    {
+        m_rowspan =
+        m_colspan = -1;
+    }
+
+    void Init()
+    {
+        m_rowspan =
+        m_colspan = 1;
+    }
+

     int m_rowspan;
     int m_colspan;
 };
     int m_rowspan;
     int m_colspan;
 };


@@ -89,26 +130,26 @@ public:
     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);
+                   const wxGBSpan& span=wxDefaultSpan,
+                   int flag=0,
+                   int border=0,
+                   wxObject* userData=NULL);

 
     // window
     wxGBSizerItem( wxWindow *window,
                    const wxGBPosition& pos,
 
     // 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 );

 
     // subsizer
     wxGBSizerItem( wxSizer *sizer,
                    const wxGBPosition& pos,
 
     // 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 );

 
     // default ctor
     wxGBSizerItem();
 
     // default ctor
     wxGBSizerItem();


@@ -134,7 +175,7 @@ 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 );
 

-    // Returns true if this item and the other item instersect
+    // Returns true if this item and the other item intersect

     bool Intersects(const wxGBSizerItem& other);
 
     // Returns true if the given pos/span would intersect with this item.
     bool Intersects(const wxGBSizerItem& other);
 
     // Returns true if the given pos/span would intersect with this item.