fix child window redraw glitches during scrolling (bug 1944002)

[wxWidgets.git] / src / common / gbsizer.cpp

diff --git a/src/common/gbsizer.cpp b/src/common/gbsizer.cpp
index 34ad57d700d295c502c9a13b5255f0525f592689..81c88b1d3cc3eb515b7bf4fe79d974468de77e5e 100644 (file)
--- a/src/common/gbsizer.cpp
+++ b/src/common/gbsizer.cpp
@@ -8,14 +8,9 @@
 // Created:     03-Nov-2003
 // RCS-ID:      $Id$
 // Copyright:   (c) Robin Dunn
 // Created:     03-Nov-2003
 // RCS-ID:      $Id$
 // Copyright:   (c) Robin Dunn

-// Licence:     wxWidgets licence
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

-
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma implementation "gbsizer.h"
-#endif
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 


@@ -177,63 +172,63 @@ void wxGBSizerItem::GetEndPos(int& row, int& col)
 wxGridBagSizer::wxGridBagSizer(int vgap, int hgap )
     : wxFlexGridSizer(1, vgap, hgap),
       m_emptyCellSize(10,20)
 wxGridBagSizer::wxGridBagSizer(int vgap, int hgap )
     : wxFlexGridSizer(1, vgap, hgap),
       m_emptyCellSize(10,20)

-    
+

 {
 }
 
 
 {
 }
 
 

-bool wxGridBagSizer::Add( wxWindow *window,
-                          const wxGBPosition& pos, const wxGBSpan& span,
-                          int flag, int border,  wxObject* userData )
+wxSizerItem* wxGridBagSizer::Add( wxWindow *window,
+                                  const wxGBPosition& pos, const wxGBSpan& span,
+                                  int flag, int border,  wxObject* userData )

 {
     wxGBSizerItem* item = new wxGBSizerItem(window, pos, span, flag, border, userData);
     if ( Add(item) )
 {
     wxGBSizerItem* item = new wxGBSizerItem(window, pos, span, flag, border, userData);
     if ( Add(item) )

-        return true;
+        return item;

     else
     {
         delete item;
     else
     {
         delete item;

-        return false;
+        return (wxSizerItem*)NULL;

     }
 }
 
     }
 }
 

-bool wxGridBagSizer::Add( wxSizer *sizer,
+wxSizerItem* wxGridBagSizer::Add( wxSizer *sizer,

                           const wxGBPosition& pos, const wxGBSpan& span,
                           int flag, int border,  wxObject* userData )
 {
     wxGBSizerItem* item = new wxGBSizerItem(sizer, pos, span, flag, border, userData);
     if ( Add(item) )
                           const wxGBPosition& pos, const wxGBSpan& span,
                           int flag, int border,  wxObject* userData )
 {
     wxGBSizerItem* item = new wxGBSizerItem(sizer, pos, span, flag, border, userData);
     if ( Add(item) )

-        return true;
+        return item;

     else
     {
         delete item;
     else
     {
         delete item;

-        return false;
+        return (wxSizerItem*)NULL;

     }
 }
 
     }
 }
 

-bool wxGridBagSizer::Add( int width, int height,
+wxSizerItem* wxGridBagSizer::Add( int width, int height,

                           const wxGBPosition& pos, const wxGBSpan& span,
                           int flag, int border,  wxObject* userData )
 {
     wxGBSizerItem* item = new wxGBSizerItem(width, height, pos, span, flag, border, userData);
     if ( Add(item) )
                           const wxGBPosition& pos, const wxGBSpan& span,
                           int flag, int border,  wxObject* userData )
 {
     wxGBSizerItem* item = new wxGBSizerItem(width, height, pos, span, flag, border, userData);
     if ( Add(item) )

-        return true;
+        return item;

     else
     {
         delete item;
     else
     {
         delete item;

-        return false;
+        return (wxSizerItem*)NULL;

     }
 }
 
     }
 }
 

-bool wxGridBagSizer::Add( wxGBSizerItem *item )
+wxSizerItem* wxGridBagSizer::Add( wxGBSizerItem *item )

 {
 {

-    wxCHECK_MSG( !CheckForIntersection(item), false,
+    wxCHECK_MSG( !CheckForIntersection(item), NULL,

                  wxT("An item is already at that position") );
     m_children.Append(item);
     item->SetGBSizer(this);
     if ( item->GetWindow() )
         item->GetWindow()->SetContainingSizer( this );
 
                  wxT("An item is already at that position") );
     m_children.Append(item);
     item->SetGBSizer(this);
     if ( item->GetWindow() )
         item->GetWindow()->SetContainingSizer( this );
 

-    return true;
+    return item;

 }
 
 
 }
 
 


@@ -272,7 +267,7 @@ wxGBPosition wxGridBagSizer::GetItemPosition(size_t index)
     wxGBPosition badpos(-1,-1);
     wxSizerItemList::compatibility_iterator node = m_children.Item( index );
     wxCHECK_MSG( node, badpos, _T("Failed to find item.") );
     wxGBPosition badpos(-1,-1);
     wxSizerItemList::compatibility_iterator node = m_children.Item( index );
     wxCHECK_MSG( node, badpos, _T("Failed to find item.") );

-    wxGBSizerItem* item = (wxGBSizerItem*)node->GetData();    
+    wxGBSizerItem* item = (wxGBSizerItem*)node->GetData();

     return item->GetPos();
 }
 
     return item->GetPos();
 }
 


@@ -298,7 +293,7 @@ bool wxGridBagSizer::SetItemPosition(size_t index, const wxGBPosition& pos)
 {
     wxSizerItemList::compatibility_iterator node = m_children.Item( index );
     wxCHECK_MSG( node, false, _T("Failed to find item.") );
 {
     wxSizerItemList::compatibility_iterator node = m_children.Item( index );
     wxCHECK_MSG( node, false, _T("Failed to find item.") );

-    wxGBSizerItem* item = (wxGBSizerItem*)node->GetData();    
+    wxGBSizerItem* item = (wxGBSizerItem*)node->GetData();

     return item->SetPos(pos);
 }
 
     return item->SetPos(pos);
 }
 


@@ -327,7 +322,7 @@ wxGBSpan wxGridBagSizer::GetItemSpan(size_t index)
     wxGBSpan badspan(-1,-1);
     wxSizerItemList::compatibility_iterator node = m_children.Item( index );
     wxCHECK_MSG( node, badspan, _T("Failed to find item.") );
     wxGBSpan badspan(-1,-1);
     wxSizerItemList::compatibility_iterator node = m_children.Item( index );
     wxCHECK_MSG( node, badspan, _T("Failed to find item.") );

-    wxGBSizerItem* item = (wxGBSizerItem*)node->GetData();    
+    wxGBSizerItem* item = (wxGBSizerItem*)node->GetData();

     return item->GetSpan();
 }
 
     return item->GetSpan();
 }
 


@@ -353,7 +348,7 @@ bool wxGridBagSizer::SetItemSpan(size_t index, const wxGBSpan& span)
 {
     wxSizerItemList::compatibility_iterator node = m_children.Item( index );
     wxCHECK_MSG( node, false, _T("Failed to find item.") );
 {
     wxSizerItemList::compatibility_iterator node = m_children.Item( index );
     wxCHECK_MSG( node, false, _T("Failed to find item.") );

-    wxGBSizerItem* item = (wxGBSizerItem*)node->GetData();    
+    wxGBSizerItem* item = (wxGBSizerItem*)node->GetData();

     return item->SetSpan(span);
 }
 
     return item->SetSpan(span);
 }
 


@@ -414,7 +409,7 @@ wxGBSizerItem* wxGridBagSizer::FindItemAtPoint(const wxPoint& pt)
         wxGBSizerItem* item = (wxGBSizerItem*)node->GetData();
         wxRect rect(item->GetPosition(), item->GetSize());
         rect.Inflate(m_hgap, m_vgap);
         wxGBSizerItem* item = (wxGBSizerItem*)node->GetData();
         wxRect rect(item->GetPosition(), item->GetSize());
         rect.Inflate(m_hgap, m_vgap);

-        if ( rect.Inside(pt) )
+        if ( rect.Contains(pt) )

             return item;
         node = node->GetNext();
     }
             return item;
         node = node->GetNext();
     }


@@ -447,7 +442,7 @@ wxGBSizerItem* wxGridBagSizer::FindItemWithData(const wxObject* userData)
 wxSize wxGridBagSizer::CalcMin()
 {
     int idx;
 wxSize wxGridBagSizer::CalcMin()
 {
     int idx;

-    
+

     if (m_children.GetCount() == 0)
         return m_emptyCellSize;
 
     if (m_children.GetCount() == 0)
         return m_emptyCellSize;
 


@@ -461,7 +456,7 @@ wxSize wxGridBagSizer::CalcMin()
         if ( item->IsShown() )
         {
             int row, col, endrow, endcol;
         if ( item->IsShown() )
         {
             int row, col, endrow, endcol;

-        
+

             item->GetPos(row, col);
             item->GetEndPos(endrow, endcol);
 
             item->GetPos(row, col);
             item->GetEndPos(endrow, endcol);
 


@@ -481,6 +476,7 @@ wxSize wxGridBagSizer::CalcMin()
         node = node->GetNext();
     }
 
         node = node->GetNext();
     }
 

+    AdjustForOverflow();

     AdjustForFlexDirection();
 
     // Now traverse the heights and widths arrays calcing the totals, including gaps
     AdjustForFlexDirection();
 
     // Now traverse the heights and widths arrays calcing the totals, including gaps


@@ -494,7 +490,8 @@ wxSize wxGridBagSizer::CalcMin()
     for (idx=0; idx < m_rows; idx++)
         height += m_rowHeights[idx] + ( idx == m_rows-1 ? 0 : m_vgap );
 
     for (idx=0; idx < m_rows; idx++)
         height += m_rowHeights[idx] + ( idx == m_rows-1 ? 0 : m_vgap );
 

-    return wxSize(width, height);   
+    m_calculatedMinSize = wxSize(width, height);
+    return m_calculatedMinSize;

 }
 
 
 }
 
 


@@ -504,17 +501,14 @@ void wxGridBagSizer::RecalcSizes()
     if (m_children.GetCount() == 0)
         return;
 
     if (m_children.GetCount() == 0)
         return;
 

-    // Calculates minsize and populates m_rowHeights and m_colWidths
-    wxSize  minsz( CalcMin() ); 
-

     wxPoint pt( GetPosition() );
     wxSize  sz( GetSize() );
     wxPoint pt( GetPosition() );
     wxSize  sz( GetSize() );

-   
+

     m_rows = m_rowHeights.GetCount();
     m_cols = m_colWidths.GetCount();
     int idx, width, height;
 
     m_rows = m_rowHeights.GetCount();
     m_cols = m_colWidths.GetCount();
     int idx, width, height;
 

-    AdjustForGrowables(sz, minsz, m_rows, m_cols);
+    AdjustForGrowables(sz);

 
     // Find the start positions on the window of the rows and columns
     wxArrayInt rowpos;
 
     // Find the start positions on the window of the rows and columns
     wxArrayInt rowpos;


@@ -544,24 +538,122 @@ void wxGridBagSizer::RecalcSizes()
     {
         int row, col, endrow, endcol;
         wxGBSizerItem* item = (wxGBSizerItem*)node->GetData();
     {
         int row, col, endrow, endcol;
         wxGBSizerItem* item = (wxGBSizerItem*)node->GetData();

-        item->GetPos(row, col);
-        item->GetEndPos(endrow, endcol);
-
-        height = 0;
-        for(idx=row; idx <= endrow; idx++)
-            height += m_rowHeights[idx] + m_vgap;
-        
-        width = 0;
-        for (idx=col; idx <= endcol; idx++)
-            width += m_colWidths[idx] + m_hgap;
-    
-        SetItemBounds(item, colpos[col], rowpos[row], width, height);
+
+        if ( item->IsShown() )
+        {
+            item->GetPos(row, col);
+            item->GetEndPos(endrow, endcol);
+
+            height = 0;
+            for(idx=row; idx <= endrow; idx++)
+                height += m_rowHeights[idx];
+            height += (endrow - row) * m_vgap; // add a vgap for every row spanned
+
+            width = 0;
+            for (idx=col; idx <= endcol; idx++)
+                width += m_colWidths[idx];
+            width += (endcol - col) * m_hgap; // add a hgap for every col spanned
+
+            SetItemBounds(item, colpos[col], rowpos[row], width, height);
+        }

 
         node = node->GetNext();
 
         node = node->GetNext();

-    }        
+    }

 }
 
 
 }
 
 

+// Sometimes CalcMin can result in some rows or cols having too much space in
+// them because as it traverses the items it makes some assumptions when
+// items span to other cells.  But those assumptions can become invalid later
+// on when other items are fitted into the same rows or columns that the
+// spanning item occupies. This method tries to find those situations and
+// fixes them.
+void wxGridBagSizer::AdjustForOverflow()
+{
+    int row, col;
+    
+    for (row=0; row<(int)m_rowHeights.GetCount(); row++)
+    {
+        int rowExtra=INT_MAX;
+        int rowHeight = m_rowHeights[row];
+        for (col=0; col<(int)m_colWidths.GetCount(); col++)
+        {
+            wxGBPosition pos(row,col);
+            wxGBSizerItem* item = FindItemAtPosition(pos);
+            if ( !item )
+                continue;
+
+            int endrow, endcol;
+            item->GetEndPos(endrow, endcol);
+            
+            // If the item starts in this position and doesn't span rows, then
+            // just look at the whole item height
+            if ( item->GetPos() == pos && endrow == row )
+            {
+                int itemHeight = item->CalcMin().GetHeight();
+                rowExtra = wxMin(rowExtra, rowHeight - itemHeight);
+                continue;
+            }
+
+            // Otherwise, only look at spanning items if they end on this row
+            if ( endrow == row )
+            {
+                // first deduct the portions of the item that are on prior rows
+                int itemHeight = item->CalcMin().GetHeight();
+                for (int r=item->GetPos().GetRow(); r<row; r++)
+                    itemHeight -= (m_rowHeights[r] + GetHGap());
+
+                if ( itemHeight < 0 )
+                    itemHeight = 0;
+                
+                // and check how much is left
+                rowExtra = wxMin(rowExtra, rowHeight - itemHeight);
+            }
+        }
+        if ( rowExtra && rowExtra != INT_MAX )
+            m_rowHeights[row] -= rowExtra;
+    }
+
+    // Now do the same thing for columns
+    for (col=0; col<(int)m_colWidths.GetCount(); col++)
+    {
+        int colExtra=INT_MAX;
+        int colWidth = m_colWidths[col];
+        for (row=0; row<(int)m_rowHeights.GetCount(); row++)
+        {
+            wxGBPosition pos(row,col);
+            wxGBSizerItem* item = FindItemAtPosition(pos);
+            if ( !item )
+                continue;
+
+            int endrow, endcol;
+            item->GetEndPos(endrow, endcol);
+            
+            if ( item->GetPos() == pos && endcol == col )
+            {
+                int itemWidth = item->CalcMin().GetWidth();
+                colExtra = wxMin(colExtra, colWidth - itemWidth);
+                continue;
+            }
+
+            if ( endcol == col )
+            {
+                int itemWidth = item->CalcMin().GetWidth();
+                for (int c=item->GetPos().GetCol(); c<col; c++)
+                    itemWidth -= (m_colWidths[c] + GetVGap());
+
+                if ( itemWidth < 0 )
+                    itemWidth = 0;
+                
+                colExtra = wxMin(colExtra, colWidth - itemWidth);
+            }
+        }
+        if ( colExtra && colExtra != INT_MAX )
+            m_colWidths[col] -= colExtra;
+    }
+
+    
+}

 
 //---------------------------------------------------------------------------
 
 
 //---------------------------------------------------------------------------
 


@@ -580,7 +672,7 @@ bool wxGridBagSizer::CheckForIntersection(const wxGBPosition& pos, const wxGBSpa
 
         if ( excludeItem && item == excludeItem )
             continue;
 
         if ( excludeItem && item == excludeItem )
             continue;

-        
+

         if ( item->Intersects(pos, span) )
             return true;
 
         if ( item->Intersects(pos, span) )
             return true;
 


@@ -613,19 +705,19 @@ wxGBPosition wxGridBagSizer::FindEmptyCell()
 // we'll try to make them automatically select a location for the item
 // anyway.
 
 // we'll try to make them automatically select a location for the item
 // anyway.
 

-void wxGridBagSizer::Add( wxWindow *window, int, int flag, int border, wxObject* userData )
+wxSizerItem* wxGridBagSizer::Add( wxWindow *window, int, int flag, int border, wxObject* userData )

 {
 {

-    Add(window, FindEmptyCell(), wxDefaultSpan, flag, border, userData);
+    return Add(window, FindEmptyCell(), wxDefaultSpan, flag, border, userData);

 }
 
 }
 

-void wxGridBagSizer::Add( wxSizer *sizer, int, int flag, int border, wxObject* userData )
+wxSizerItem* wxGridBagSizer::Add( wxSizer *sizer, int, int flag, int border, wxObject* userData )

 {
 {

-    Add(sizer, FindEmptyCell(), wxDefaultSpan, flag, border, userData);
+    return Add(sizer, FindEmptyCell(), wxDefaultSpan, flag, border, userData);

 }
 
 }
 

-void wxGridBagSizer::Add( int width, int height, int, int flag, int border, wxObject* userData )
+wxSizerItem* wxGridBagSizer::Add( int width, int height, int, int flag, int border, wxObject* userData )

 {
 {

-    Add(width, height, FindEmptyCell(), wxDefaultSpan, flag, border, userData);
+    return Add(width, height, FindEmptyCell(), wxDefaultSpan, flag, border, userData);

 }
 
 
 }
 
 


@@ -634,33 +726,60 @@ void wxGridBagSizer::Add( int width, int height, int, int flag, int border, wxOb
 // this class and should not be used.  Their implementation in this class
 // simply fails.
 
 // this class and should not be used.  Their implementation in this class
 // simply fails.
 

-void wxGridBagSizer::Add( wxSizerItem * )
-{ wxFAIL_MSG(wxT("Invalid Add form called.")); }
+wxSizerItem* wxGridBagSizer::Add( wxSizerItem * )
+{
+    wxFAIL_MSG(wxT("Invalid Add form called."));
+    return (wxSizerItem*)NULL;
+}

 
 

-void wxGridBagSizer::Prepend( wxWindow *, int, int, int, wxObject*  )
-{ wxFAIL_MSG(wxT("Prepend should not be used with wxGridBagSizer.")); }
+wxSizerItem* wxGridBagSizer::Prepend( wxWindow *, int, int, int, wxObject*  )
+{
+    wxFAIL_MSG(wxT("Prepend should not be used with wxGridBagSizer."));
+    return (wxSizerItem*)NULL;
+}

 
 

-void wxGridBagSizer::Prepend( wxSizer *, int, int, int, wxObject*  )
-{ wxFAIL_MSG(wxT("Prepend should not be used with wxGridBagSizer.")); }
+wxSizerItem* wxGridBagSizer::Prepend( wxSizer *, int, int, int, wxObject*  )
+{
+    wxFAIL_MSG(wxT("Prepend should not be used with wxGridBagSizer."));
+    return (wxSizerItem*)NULL;
+}

 
 

-void wxGridBagSizer::Prepend( int, int, int, int, int, wxObject*  )
-{ wxFAIL_MSG(wxT("Prepend should not be used with wxGridBagSizer.")); }
+wxSizerItem* wxGridBagSizer::Prepend( int, int, int, int, int, wxObject*  )
+{
+    wxFAIL_MSG(wxT("Prepend should not be used with wxGridBagSizer."));
+    return (wxSizerItem*)NULL;
+}

 
 

-void wxGridBagSizer::Prepend( wxSizerItem * )
-{ wxFAIL_MSG(wxT("Prepend should not be used with wxGridBagSizer.")); }
+wxSizerItem* wxGridBagSizer::Prepend( wxSizerItem * )
+{
+    wxFAIL_MSG(wxT("Prepend should not be used with wxGridBagSizer."));
+    return (wxSizerItem*)NULL;
+}

 
 
 
 

-void wxGridBagSizer::Insert( size_t, wxWindow *, int, int, int, wxObject*  )
-{ wxFAIL_MSG(wxT("Insert should not be used with wxGridBagSizer.")); }
+wxSizerItem* wxGridBagSizer::Insert( size_t, wxWindow *, int, int, int, wxObject*  )
+{
+    wxFAIL_MSG(wxT("Insert should not be used with wxGridBagSizer."));
+    return (wxSizerItem*)NULL;
+}

 
 

-void wxGridBagSizer::Insert( size_t, wxSizer *, int, int, int, wxObject*  )
-{ wxFAIL_MSG(wxT("Insert should not be used with wxGridBagSizer.")); }
+wxSizerItem* wxGridBagSizer::Insert( size_t, wxSizer *, int, int, int, wxObject*  )
+{
+    wxFAIL_MSG(wxT("Insert should not be used with wxGridBagSizer."));
+    return (wxSizerItem*)NULL;
+}

 
 

-void wxGridBagSizer::Insert( size_t, int, int, int, int, int, wxObject*  )
-{ wxFAIL_MSG(wxT("Insert should not be used with wxGridBagSizer.")); }
+wxSizerItem* wxGridBagSizer::Insert( size_t, int, int, int, int, int, wxObject*  )
+{
+    wxFAIL_MSG(wxT("Insert should not be used with wxGridBagSizer."));
+    return (wxSizerItem*)NULL;
+}

 
 

-void wxGridBagSizer::Insert( size_t, wxSizerItem * )
-{ wxFAIL_MSG(wxT("Insert should not be used with wxGridBagSizer.")); }
+wxSizerItem* wxGridBagSizer::Insert( size_t, wxSizerItem * )
+{
+    wxFAIL_MSG(wxT("Insert should not be used with wxGridBagSizer."));
+    return (wxSizerItem*)NULL;
+}

 
 
 //---------------------------------------------------------------------------
 
 
 //---------------------------------------------------------------------------