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

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

diff --git a/include/wx/sizer.h b/include/wx/sizer.h
index ffd8442e988875e1b32a79881ea2e8dae6a69e5e..29facff1e2278a182cd152c3d52c1762a4058f1f 100644 (file)
--- a/include/wx/sizer.h
+++ b/include/wx/sizer.h
@@ -125,6 +125,10 @@ public:
 
     wxSizerFlags& Border(int direction, int borderInPixels)
     {
 
     wxSizerFlags& Border(int direction, int borderInPixels)
     {

+        wxCHECK_MSG( !(direction & ~wxALL), *this,
+                     wxS("direction must be a combination of wxDirection ")
+                     wxS("enum values.") );
+

         m_flags &= ~wxALL;
         m_flags |= direction;
 
         m_flags &= ~wxALL;
         m_flags |= direction;
 


@@ -251,10 +255,10 @@ class WXDLLIMPEXP_CORE wxSizerItem : public wxObject
 public:
     // window
     wxSizerItem( wxWindow *window,
 public:
     // window
     wxSizerItem( wxWindow *window,

-                 int proportion,
-                 int flag,
-                 int border,
-                 wxObject* userData );
+                 int proportion=0,
+                 int flag=0,
+                 int border=0,
+                 wxObject* userData=NULL );

 
     // window with flags
     wxSizerItem(wxWindow *window, const wxSizerFlags& flags)
 
     // window with flags
     wxSizerItem(wxWindow *window, const wxSizerFlags& flags)


@@ -266,10 +270,10 @@ public:
 
     // subsizer
     wxSizerItem( wxSizer *sizer,
 
     // subsizer
     wxSizerItem( wxSizer *sizer,

-                 int proportion,
-                 int flag,
-                 int border,
-                 wxObject* userData );
+                 int proportion=0,
+                 int flag=0,
+                 int border=0,
+                 wxObject* userData=NULL );

 
     // sizer with flags
     wxSizerItem(wxSizer *sizer, const wxSizerFlags& flags)
 
     // sizer with flags
     wxSizerItem(wxSizer *sizer, const wxSizerFlags& flags)


@@ -282,10 +286,10 @@ public:
     // spacer
     wxSizerItem( int width,
                  int height,
     // spacer
     wxSizerItem( int width,
                  int height,

-                 int proportion,
-                 int flag,
-                 int border,
-                 wxObject* userData);
+                 int proportion=0,
+                 int flag=0,
+                 int border=0,
+                 wxObject* userData=NULL);

 
     // spacer with flags
     wxSizerItem(int width, int height, const wxSizerFlags& flags)
 
     // spacer with flags
     wxSizerItem(int width, int height, const wxSizerFlags& flags)


@@ -311,6 +315,10 @@ public:
         { return m_minSize; }
     wxSize GetMinSizeWithBorder() const;
 
         { return m_minSize; }
     wxSize GetMinSizeWithBorder() const;
 

+    wxSize GetMaxSize() const
+        { return IsWindow() ? m_window->GetMaxSize() : wxDefaultSize; }
+    wxSize GetMaxSizeWithBorder() const;
+

     void SetMinSize(const wxSize& size)
     {
         if ( IsWindow() )
     void SetMinSize(const wxSize& size)
     {
         if ( IsWindow() )


@@ -436,6 +444,10 @@ protected:
     void DoSetSizer(wxSizer *sizer);
     void DoSetSpacer(const wxSize& size);
 
     void DoSetSizer(wxSizer *sizer);
     void DoSetSpacer(const wxSize& size);
 

+    // Add the border specified for this item to the given size
+    // if it's != wxDefaultSize, just return wxDefaultSize otherwise.
+    wxSize AddBorderToSize(const wxSize& size) const;
+

     // discriminated union: depending on m_kind one of the fields is valid
     enum
     {
     // discriminated union: depending on m_kind one of the fields is valid
     enum
     {


@@ -510,7 +522,7 @@ public:
     wxSizerItem* Add( int width, int height, const wxSizerFlags& flags);
     wxSizerItem* Add( wxSizerItem *item);
 
     wxSizerItem* Add( int width, int height, const wxSizerFlags& flags);
     wxSizerItem* Add( wxSizerItem *item);
 

-    wxSizerItem* AddSpacer(int size);
+    virtual wxSizerItem *AddSpacer(int size);

     wxSizerItem* AddStretchSpacer(int prop = 1);
 
     wxSizerItem* Insert(size_t index,
     wxSizerItem* AddStretchSpacer(int prop = 1);
 
     wxSizerItem* Insert(size_t index,


@@ -542,7 +554,11 @@ public:
                         int width,
                         int height,
                         const wxSizerFlags& flags);
                         int width,
                         int height,
                         const wxSizerFlags& flags);

-    virtual wxSizerItem* Insert( size_t index, wxSizerItem *item);
+
+    // NB: do _not_ override this function in the derived classes, this one is
+    //     virtual for compatibility reasons only to allow old code overriding
+    //     it to continue to work, override DoInsert() instead in the new code
+    virtual wxSizerItem* Insert(size_t index, wxSizerItem *item);

 
     wxSizerItem* InsertSpacer(size_t index, int size);
     wxSizerItem* InsertStretchSpacer(size_t index, int prop = 1);
 
     wxSizerItem* InsertSpacer(size_t index, int size);
     wxSizerItem* InsertStretchSpacer(size_t index, int prop = 1);


@@ -597,7 +613,7 @@ public:
     virtual void DeleteWindows();
 
     // Inform sizer about the first direction that has been decided (by parent item)
     virtual void DeleteWindows();
 
     // Inform sizer about the first direction that has been decided (by parent item)

-    // Returns true if it made use of the informtion (and recalculated min size)
+    // Returns true if it made use of the information (and recalculated min size)

     virtual bool InformFirstDirection( int WXUNUSED(direction), int WXUNUSED(size), int WXUNUSED(availableOtherDir) )
         { return false; }
 
     virtual bool InformFirstDirection( int WXUNUSED(direction), int WXUNUSED(size), int WXUNUSED(availableOtherDir) )
         { return false; }
 


@@ -661,6 +677,10 @@ public:
         m_position = pos;
         m_size = size;
         Layout();
         m_position = pos;
         m_size = size;
         Layout();

+
+        // This call is required for wxWrapSizer to be able to calculate its
+        // minimal size correctly.
+        InformFirstDirection(wxHORIZONTAL, size.x, size.y);

     }
     void SetDimension(int x, int y, int width, int height)
         { SetDimension(wxPoint(x, y), wxSize(width, height)); }
     }
     void SetDimension(int x, int y, int width, int height)
         { SetDimension(wxPoint(x, y), wxSize(width, height)); }


@@ -695,6 +715,10 @@ public:
 
     void Show(bool show) { ShowItems(show); }
 
 
     void Show(bool show) { ShowItems(show); }
 

+    // This is the ShowItems() counterpart and returns true if any of the sizer
+    // items are shown.
+    virtual bool AreAnyItemsShown() const;
+

 protected:
     wxSize              m_size;
     wxSize              m_minSize;
 protected:
     wxSize              m_size;
     wxSize              m_minSize;


@@ -713,6 +737,10 @@ protected:
     virtual bool DoSetItemMinSize( wxSizer *sizer, int width, int height );
     virtual bool DoSetItemMinSize( size_t index, int width, int height );
 
     virtual bool DoSetItemMinSize( wxSizer *sizer, int width, int height );
     virtual bool DoSetItemMinSize( size_t index, int width, int height );
 

+    // insert a new item into m_children at given index and return the item
+    // itself
+    virtual wxSizerItem* DoInsert(size_t index, wxSizerItem *item);
+

 private:
     DECLARE_CLASS(wxSizer)
 };
 private:
     DECLARE_CLASS(wxSizer)
 };


@@ -733,8 +761,6 @@ public:
     wxGridSizer( int rows, int cols, int vgap, int hgap );
     wxGridSizer( int rows, int cols, const wxSize& gap );
 
     wxGridSizer( int rows, int cols, int vgap, int hgap );
     wxGridSizer( int rows, int cols, const wxSize& gap );
 

-    virtual wxSizerItem *Insert(size_t index, wxSizerItem *item);
-

     virtual void RecalcSizes();
     virtual wxSize CalcMin();
 
     virtual void RecalcSizes();
     virtual wxSize CalcMin();
 


@@ -757,18 +783,51 @@ public:
     int GetVGap() const         { return m_vgap; }
     int GetHGap() const         { return m_hgap; }
 
     int GetVGap() const         { return m_vgap; }
     int GetHGap() const         { return m_hgap; }
 

+    int GetEffectiveColsCount() const   { return m_cols ? m_cols : CalcCols(); }
+    int GetEffectiveRowsCount() const   { return m_rows ? m_rows : CalcRows(); }
+

     // return the number of total items and the number of columns and rows
     // (for internal use only)
     int CalcRowsCols(int& rows, int& cols) const;
 
 protected:
     // return the number of total items and the number of columns and rows
     // (for internal use only)
     int CalcRowsCols(int& rows, int& cols) const;
 
 protected:

+    // the number of rows/columns in the sizer, if 0 then it is determined
+    // dynamically depending on the total number of items

     int    m_rows;
     int    m_cols;
     int    m_rows;
     int    m_cols;

+
+    // gaps between rows and columns

     int    m_vgap;
     int    m_hgap;
 
     int    m_vgap;
     int    m_hgap;
 

+    virtual wxSizerItem *DoInsert(size_t index, wxSizerItem *item);
+

     void SetItemBounds( wxSizerItem *item, int x, int y, int w, int h );
 
     void SetItemBounds( wxSizerItem *item, int x, int y, int w, int h );
 

+    // returns the number of columns/rows needed for the current total number
+    // of children (and the fixed number of rows/columns)
+    int CalcCols() const
+    {
+        wxCHECK_MSG
+        (
+            m_rows, 0,
+            "Can't calculate number of cols if number of rows is not specified"
+        );
+
+        return (m_children.GetCount() + m_rows - 1) / m_rows;
+    }
+
+    int CalcRows() const
+    {
+        wxCHECK_MSG
+        (
+            m_cols, 0,
+            "Can't calculate number of cols if number of rows is not specified"
+        );
+
+        return (m_children.GetCount() + m_cols - 1) / m_cols;
+    }
+

 private:
     DECLARE_CLASS(wxGridSizer)
 };
 private:
     DECLARE_CLASS(wxGridSizer)
 };


@@ -882,6 +941,8 @@ public:
                       wxT("invalid value for wxBoxSizer orientation") );
     }
 
                       wxT("invalid value for wxBoxSizer orientation") );
     }
 

+    virtual wxSizerItem *AddSpacer(int size);
+

     int GetOrientation() const { return m_orient; }
 
     bool IsVertical() const { return m_orient == wxVERTICAL; }
     int GetOrientation() const { return m_orient; }
 
     bool IsVertical() const { return m_orient == wxVERTICAL; }


@@ -976,6 +1037,7 @@ public:
 
     // override to hide/show the static box as well
     virtual void ShowItems (bool show);
 
     // override to hide/show the static box as well
     virtual void ShowItems (bool show);

+    virtual bool AreAnyItemsShown() const;

 
     virtual bool Detach( wxWindow *window );
     virtual bool Detach( wxSizer *sizer ) { return wxBoxSizer::Detach(sizer); }
 
     virtual bool Detach( wxWindow *window );
     virtual bool Detach( wxSizer *sizer ) { return wxBoxSizer::Detach(sizer); }


@@ -1072,6 +1134,12 @@ inline void wxSizerItem::SetSpacer(int width, int height)
 
 #endif // WXWIN_COMPATIBILITY_2_8
 
 
 #endif // WXWIN_COMPATIBILITY_2_8
 

+inline wxSizerItem*
+wxSizer::Insert(size_t index, wxSizerItem *item)
+{
+    return DoInsert(index, item);
+}
+

 
 inline wxSizerItem*
 wxSizer::Add( wxSizerItem *item )
 
 inline wxSizerItem*
 wxSizer::Add( wxSizerItem *item )