X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0274a7973da59746c55bc91ebceac64f622b6a34..0c60a0e2b726073be874f45e5227ea93b63623f4:/src/common/sizer.cpp diff --git a/src/common/sizer.cpp b/src/common/sizer.cpp index 01180b5374..31bed2c619 100644 --- a/src/common/sizer.cpp +++ b/src/common/sizer.cpp @@ -5,7 +5,6 @@ // Dirk Holtwick, Ron Lee // Modified by: Ron Lee // Created: -// RCS-ID: $Id$ // Copyright: (c) Robin Dunn, Robert Roebling // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// @@ -32,6 +31,7 @@ #endif // WX_PRECOMP #include "wx/display.h" +#include "wx/vector.h" #include "wx/listimpl.cpp" @@ -206,6 +206,33 @@ void wxSizerItem::DoSetSpacer(const wxSize& size) SetRatio(size); } +wxSize wxSizerItem::AddBorderToSize(const wxSize& size) const +{ + wxSize result = size; + + // Notice that we shouldn't modify the unspecified component(s) of the + // size, it's perfectly valid to have either min or max size specified in + // one direction only and it shouldn't be applied in the other one then. + + if ( result.x != wxDefaultCoord ) + { + if (m_flag & wxWEST) + result.x += m_border; + if (m_flag & wxEAST) + result.x += m_border; + } + + if ( result.y != wxDefaultCoord ) + { + if (m_flag & wxNORTH) + result.y += m_border; + if (m_flag & wxSOUTH) + result.y += m_border; + } + + return result; +} + wxSizerItem::wxSizerItem(int width, int height, int proportion, @@ -396,20 +423,13 @@ wxSize wxSizerItem::CalcMin() wxSize wxSizerItem::GetMinSizeWithBorder() const { - wxSize ret = m_minSize; - - if (m_flag & wxWEST) - ret.x += m_border; - if (m_flag & wxEAST) - ret.x += m_border; - if (m_flag & wxNORTH) - ret.y += m_border; - if (m_flag & wxSOUTH) - ret.y += m_border; - - return ret; + return AddBorderToSize(m_minSize); } +wxSize wxSizerItem::GetMaxSizeWithBorder() const +{ + return AddBorderToSize(GetMaxSize()); +} void wxSizerItem::SetDimension( const wxPoint& pos_, const wxSize& size_ ) { @@ -485,7 +505,7 @@ void wxSizerItem::SetDimension( const wxPoint& pos_, const wxSize& size_ ) // have changed alignment or some other property which would // not change the size of the window. In such a case, no // wxSizeEvent would normally be generated and thus the - // control wouldn't get layed out correctly here. + // control wouldn't get laid out correctly here. #if 1 m_window->SetSize(pos.x, pos.y, size.x, size.y, wxSIZE_ALLOW_MINUS_ONE|wxSIZE_FORCE_EVENT ); @@ -584,22 +604,7 @@ bool wxSizerItem::IsShown() const // arbitrarily decide that if at least one of our elements is // shown, so are we (this arbitrariness is the reason for // deprecating this function) - { - // Some apps (such as dialog editors) depend on an empty sizer still - // being laid out correctly and reporting the correct size and position. - if (m_sizer->GetChildren().GetCount() == 0) - return true; - - for ( wxSizerItemList::compatibility_iterator - node = m_sizer->GetChildren().GetFirst(); - node; - node = node->GetNext() ) - { - if ( node->GetData()->IsShown() ) - return true; - } - } - return false; + return m_sizer->AreAnyItemsShown(); case Item_Spacer: return m_spacer->IsShown(); @@ -634,7 +639,7 @@ wxSizer::~wxSizer() WX_CLEAR_LIST(wxSizerItemList, m_children); } -wxSizerItem* wxSizer::Insert( size_t index, wxSizerItem *item ) +wxSizerItem* wxSizer::DoInsert( size_t index, wxSizerItem *item ) { m_children.Insert( index, item ); @@ -844,6 +849,10 @@ bool wxSizer::Replace( size_t old, wxSizerItem *newitem ) wxSizerItem *item = node->GetData(); node->SetData(newitem); + + if (item->IsWindow() && item->GetWindow()) + item->GetWindow()->SetContainingSizer(NULL); + delete item; return true; @@ -909,6 +918,11 @@ wxSize wxSizer::ComputeFittingClientSize(wxWindow *window) sizeMax = wxDisplay(disp).GetClientArea().GetSize(); + // If determining the display size failed, skip the max size checks as + // we really don't want to create windows of (0, 0) size. + if ( !sizeMax.x || !sizeMax.y ) + return size; + // space for decorations and toolbars etc. sizeMax = tlw->WindowToClientSize(sizeMax); } @@ -961,6 +975,8 @@ void wxSizer::Layout() CalcMin(); // Applies the layout and repositions/resizes the items + wxWindow::ChildrenRepositioningGuard repositionGuard(m_containingWindow); + RecalcSizes(); } @@ -1265,6 +1281,19 @@ void wxSizer::ShowItems( bool show ) } } +bool wxSizer::AreAnyItemsShown() const +{ + wxSizerItemList::compatibility_iterator node = m_children.GetFirst(); + while (node) + { + if ( node->GetData()->IsShown() ) + return true; + node = node->GetNext(); + } + + return false; +} + bool wxSizer::IsShown( wxWindow *window ) const { wxSizerItemList::compatibility_iterator node = m_children.GetFirst(); @@ -1323,6 +1352,7 @@ wxGridSizer::wxGridSizer( int cols, int vgap, int hgap ) m_vgap( vgap ), m_hgap( hgap ) { + wxASSERT(cols >= 0); } wxGridSizer::wxGridSizer( int cols, const wxSize& gap ) @@ -1331,6 +1361,7 @@ wxGridSizer::wxGridSizer( int cols, const wxSize& gap ) m_vgap( gap.GetHeight() ), m_hgap( gap.GetWidth() ) { + wxASSERT(cols >= 0); } wxGridSizer::wxGridSizer( int rows, int cols, int vgap, int hgap ) @@ -1339,6 +1370,7 @@ wxGridSizer::wxGridSizer( int rows, int cols, int vgap, int hgap ) m_vgap( vgap ), m_hgap( hgap ) { + wxASSERT(rows >= 0 && cols >= 0); } wxGridSizer::wxGridSizer( int rows, int cols, const wxSize& gap ) @@ -1347,9 +1379,10 @@ wxGridSizer::wxGridSizer( int rows, int cols, const wxSize& gap ) m_vgap( gap.GetHeight() ), m_hgap( gap.GetWidth() ) { + wxASSERT(rows >= 0 && cols >= 0); } -wxSizerItem *wxGridSizer::Insert(size_t index, wxSizerItem *item) +wxSizerItem *wxGridSizer::DoInsert(size_t index, wxSizerItem *item) { // if only the number of columns or the number of rows is specified for a // sizer, arbitrarily many items can be added to it but if both of them are @@ -1379,7 +1412,7 @@ wxSizerItem *wxGridSizer::Insert(size_t index, wxSizerItem *item) } } - return wxSizer::Insert(index, item); + return wxSizer::DoInsert(index, item); } int wxGridSizer::CalcRowsCols(int& nrows, int& ncols) const @@ -1982,25 +2015,78 @@ void wxFlexGridSizer::RemoveGrowableRow( size_t idx ) // wxBoxSizer //--------------------------------------------------------------------------- +wxSizerItem *wxBoxSizer::AddSpacer(int size) +{ + return IsVertical() ? Add(0, size) : Add(size, 0); +} + +namespace +{ + +/* + Helper of RecalcSizes(): checks if there is enough remaining space for the + min size of the given item and returns its min size or the entire remaining + space depending on which one is greater. + + This function updates the remaining space parameter to account for the size + effectively allocated to the item. + */ +int +GetMinOrRemainingSize(int orient, const wxSizerItem *item, int *remainingSpace_) +{ + int& remainingSpace = *remainingSpace_; + + wxCoord size; + if ( remainingSpace > 0 ) + { + const wxSize sizeMin = item->GetMinSizeWithBorder(); + size = orient == wxHORIZONTAL ? sizeMin.x : sizeMin.y; + + if ( size >= remainingSpace ) + { + // truncate the item to fit in the remaining space, this is better + // than showing it only partially in general, even if both choices + // are bad -- but there is nothing else we can do + size = remainingSpace; + } + + remainingSpace -= size; + } + else // no remaining space + { + // no space at all left, no need to even query the item for its min + // size as we can't give it to it anyhow + size = 0; + } + + return size; +} + +} // anonymous namespace + void wxBoxSizer::RecalcSizes() { if ( m_children.empty() ) return; const wxCoord totalMinorSize = GetSizeInMinorDir(m_size); + const wxCoord totalMajorSize = GetSizeInMajorDir(m_size); // the amount of free space which we should redistribute among the // stretchable items (i.e. those with non zero proportion) - int delta = GetSizeInMajorDir(m_size) - GetSizeInMajorDir(m_minSize); + int delta = totalMajorSize - GetSizeInMajorDir(m_minSize); + // declare loop variables used below: + wxSizerItemList::const_iterator i; // iterator in m_children list + unsigned n = 0; // item index in majorSizes array - // Inform child items about the size in minor direction, that can - // change how much free space we have in major dir and how to distribute it. - int majorMinSum = 0; - wxSizerItemList::const_iterator i ; - for ( i = m_children.begin(); - i != m_children.end(); - ++i ) + + // First, inform item about the available size in minor direction as this + // can change their size in the major direction. Also compute the number of + // visible items and sum of their min sizes in major direction. + + int minMajorSize = 0; + for ( i = m_children.begin(); i != m_children.end(); ++i ) { wxSizerItem * const item = *i; @@ -2017,67 +2103,273 @@ void wxBoxSizer::RecalcSizes() // take too much, so delta should not become negative. delta -= deltaChange; } - majorMinSum += GetSizeInMajorDir(item->GetMinSizeWithBorder()); + minMajorSize += GetSizeInMajorDir(item->GetMinSizeWithBorder()); } - // And update our min size - SizeInMajorDir(m_minSize) = majorMinSum; + // update our min size have changed + SizeInMajorDir(m_minSize) = minMajorSize; - // might have a new delta now - delta = GetSizeInMajorDir(m_size) - GetSizeInMajorDir(m_minSize); - - // the position at which we put the next child - wxPoint pt(m_position); + // space and sum of proportions for the remaining items, both may change + // below + wxCoord remaining = totalMajorSize; int totalProportion = m_totalProportion; - for ( i = m_children.begin(); - i != m_children.end(); - ++i ) + + // size of the (visible) items in major direction, -1 means "not fixed yet" + wxVector majorSizes(GetItemCount(), wxDefaultCoord); + + + // Check for the degenerated case when we don't have enough space for even + // the min sizes of all the items: in this case we really can't do much + // more than to allocate the min size to as many of fixed size items as + // possible (on the assumption that variable size items such as text zones + // or list boxes may use scrollbars to show their content even if their + // size is less than min size but that fixed size items such as buttons + // will suffer even more if we don't give them their min size) + if ( totalMajorSize < minMajorSize ) { - wxSizerItem * const item = *i; + // Second degenerated case pass: allocate min size to all fixed size + // items. + for ( i = m_children.begin(), n = 0; i != m_children.end(); ++i, ++n ) + { + wxSizerItem * const item = *i; - if ( !item->IsShown() ) - continue; + if ( !item->IsShown() ) + continue; - const wxSize sizeThis(item->GetMinSizeWithBorder()); + // deal with fixed size items only during this pass + if ( item->GetProportion() ) + continue; + + majorSizes[n] = GetMinOrRemainingSize(m_orient, item, &remaining); + } - // adjust the size in the major direction using the proportion - wxCoord majorSize = GetSizeInMajorDir(sizeThis); - // if there is not enough space, don't try to distribute negative space - // among the children, this would result in overlapping windows which - // we don't want - if ( delta > 0 ) + // Third degenerated case pass: allocate min size to all the remaining, + // i.e. non-fixed size, items. + for ( i = m_children.begin(), n = 0; i != m_children.end(); ++i, ++n ) { + wxSizerItem * const item = *i; + + if ( !item->IsShown() ) + continue; + + // we've already dealt with fixed size items above + if ( !item->GetProportion() ) + continue; + + majorSizes[n] = GetMinOrRemainingSize(m_orient, item, &remaining); + } + } + else // we do have enough space to give at least min sizes to all items + { + // Second and maybe more passes in the non-degenerated case: deal with + // fixed size items and items whose min size is greater than what we + // would allocate to them taking their proportion into account. For + // both of them, we will just use their min size, but for the latter we + // also need to reexamine all the items as the items which fitted + // before we adjusted their size upwards might not fit any more. This + // does make for a quadratic algorithm but it's not obvious how to + // avoid it and hopefully it's not a huge problem in practice as the + // sizers don't have many items usually (and, of course, the algorithm + // still reduces into a linear one if there is enough space for all the + // min sizes). + bool nonFixedSpaceChanged = false; + for ( i = m_children.begin(), n = 0; ; ++i, ++n ) + { + if ( nonFixedSpaceChanged ) + { + i = m_children.begin(); + n = 0; + nonFixedSpaceChanged = false; + } + + // check for the end of the loop only after the check above as + // otherwise we wouldn't do another pass if the last child resulted + // in non fixed space reduction + if ( i == m_children.end() ) + break; + + wxSizerItem * const item = *i; + + if ( !item->IsShown() ) + continue; + + // don't check the item which we had already dealt with during a + // previous pass (this is more than an optimization, the code + // wouldn't work correctly if we kept adjusting for the same item + // over and over again) + if ( majorSizes[n] != wxDefaultCoord ) + continue; + + wxCoord minMajor = GetSizeInMajorDir(item->GetMinSizeWithBorder()); + + // it doesn't make sense for min size to be negative but right now + // it's possible to create e.g. a spacer with (-1, 10) as size and + // people do it in their code apparently (see #11842) so ensure + // that we don't use this -1 as real min size as it conflicts with + // the meaning we use for it here and negative min sizes just don't + // make sense anyhow (which is why it might be a better idea to + // deal with them at wxSizerItem level in the future but for now + // this is the minimal fix for the bug) + if ( minMajor < 0 ) + minMajor = 0; + const int propItem = item->GetProportion(); if ( propItem ) { - const int deltaItem = (delta * propItem) / totalProportion; + // is the desired size of this item big enough? + if ( (remaining*propItem)/totalProportion >= minMajor ) + { + // yes, it is, we'll determine the real size of this + // item later, for now just leave it as wxDefaultCoord + continue; + } + + // the proportion of this item won't count, it has + // effectively become fixed + totalProportion -= propItem; + } + + // we can already allocate space for this item + majorSizes[n] = minMajor; + + // change the amount of the space remaining to the other items, + // as this can result in not being able to satisfy their + // proportions any more we will need to redo another loop + // iteration + remaining -= minMajor; + + nonFixedSpaceChanged = true; + } + + // Similar to the previous loop, but dealing with items whose max size + // is less than what we would allocate to them taking their proportion + // into account. + nonFixedSpaceChanged = false; + for ( i = m_children.begin(), n = 0; ; ++i, ++n ) + { + if ( nonFixedSpaceChanged ) + { + i = m_children.begin(); + n = 0; + nonFixedSpaceChanged = false; + } + + // check for the end of the loop only after the check above as + // otherwise we wouldn't do another pass if the last child resulted + // in non fixed space reduction + if ( i == m_children.end() ) + break; + + wxSizerItem * const item = *i; - majorSize += deltaItem; + if ( !item->IsShown() ) + continue; + + // don't check the item which we had already dealt with during a + // previous pass (this is more than an optimization, the code + // wouldn't work correctly if we kept adjusting for the same item + // over and over again) + if ( majorSizes[n] != wxDefaultCoord ) + continue; + + wxCoord maxMajor = GetSizeInMajorDir(item->GetMaxSizeWithBorder()); + + // must be nonzero, fixed-size items were dealt with in previous loop + const int propItem = item->GetProportion(); + + // is the desired size of this item small enough? + if ( maxMajor < 0 || + (remaining*propItem)/totalProportion <= maxMajor ) + { + // yes, it is, we'll determine the real size of this + // item later, for now just leave it as wxDefaultCoord + continue; + } + + // the proportion of this item won't count, it has + // effectively become fixed + totalProportion -= propItem; + + // we can already allocate space for this item + majorSizes[n] = maxMajor; + + // change the amount of the space remaining to the other items, + // as this can result in not being able to satisfy their + // proportions any more we will need to redo another loop + // iteration + remaining -= maxMajor; + + nonFixedSpaceChanged = true; + } + + // Last by one pass: distribute the remaining space among the non-fixed + // items whose size weren't fixed yet according to their proportions. + for ( i = m_children.begin(), n = 0; i != m_children.end(); ++i, ++n ) + { + wxSizerItem * const item = *i; - delta -= deltaItem; + if ( !item->IsShown() ) + continue; + + if ( majorSizes[n] == wxDefaultCoord ) + { + const int propItem = item->GetProportion(); + majorSizes[n] = (remaining*propItem)/totalProportion; + + remaining -= majorSizes[n]; totalProportion -= propItem; } } + } + + // the position at which we put the next child + wxPoint pt(m_position); + + + // Final pass: finally do position the items correctly using their sizes as + // determined above. + for ( i = m_children.begin(), n = 0; i != m_children.end(); ++i, ++n ) + { + wxSizerItem * const item = *i; + + if ( !item->IsShown() ) + continue; + + const int majorSize = majorSizes[n]; + + const wxSize sizeThis(item->GetMinSizeWithBorder()); // apply the alignment in the minor direction wxPoint posChild(pt); wxCoord minorSize = GetSizeInMinorDir(sizeThis); const int flag = item->GetFlag(); - if ( flag & (wxEXPAND | wxSHAPED) ) + if ( (flag & (wxEXPAND | wxSHAPED)) || (minorSize > totalMinorSize) ) { + // occupy all the available space if wxEXPAND was given and also if + // the item is too big to fit -- in this case we truncate it below + // its minimal size which is bad but better than not showing parts + // of the window at all minorSize = totalMinorSize; + + // do not allow the size in the minor direction to grow beyond the max + // size of the item in the minor direction + const wxCoord maxMinorSize = GetSizeInMinorDir(item->GetMaxSizeWithBorder()); + if ( maxMinorSize >= 0 && minorSize > maxMinorSize ) + minorSize = maxMinorSize; } - else if ( flag & (IsVertical() ? wxALIGN_RIGHT : wxALIGN_BOTTOM) ) + + if ( flag & (IsVertical() ? wxALIGN_RIGHT : wxALIGN_BOTTOM) ) { PosInMinorDir(posChild) += totalMinorSize - minorSize; } // NB: wxCENTRE is used here only for backwards compatibility, // wxALIGN_CENTRE should be used in new code - else if ( flag & (wxCENTER | (IsVertical() ? wxALIGN_CENTRE_HORIZONTAL : wxALIGN_CENTRE_VERTICAL))) + else if ( flag & (wxCENTER | (IsVertical() ? wxALIGN_CENTRE_HORIZONTAL + : wxALIGN_CENTRE_VERTICAL)) ) { PosInMinorDir(posChild) += (totalMinorSize - minorSize) / 2; } @@ -2106,7 +2398,12 @@ wxSize wxBoxSizer::CalcMin() m_totalProportion = 0; m_minSize = wxSize(0, 0); - // calculate the minimal sizes for all items and count sum of proportions + // The minimal size for the sizer should be big enough to allocate its + // element at least its minimal size but also, and this is the non trivial + // part, to respect the children proportion. To satisfy the latter + // condition we must find the greatest min-size-to-proportion ratio for all + // elements with non-zero proportion. + float maxMinSizeToProp = 0.; for ( wxSizerItemList::const_iterator i = m_children.begin(); i != m_children.end(); ++i ) @@ -2117,13 +2414,31 @@ wxSize wxBoxSizer::CalcMin() continue; const wxSize sizeMinThis = item->CalcMin(); - SizeInMajorDir(m_minSize) += GetSizeInMajorDir(sizeMinThis); + if ( const int propThis = item->GetProportion() ) + { + float minSizeToProp = GetSizeInMajorDir(sizeMinThis); + minSizeToProp /= propThis; + + if ( minSizeToProp > maxMinSizeToProp ) + maxMinSizeToProp = minSizeToProp; + + m_totalProportion += item->GetProportion(); + } + else // fixed size item + { + // Just account for its size directly + SizeInMajorDir(m_minSize) += GetSizeInMajorDir(sizeMinThis); + } + + // In the transversal direction we just need to find the maximum. if ( GetSizeInMinorDir(sizeMinThis) > GetSizeInMinorDir(m_minSize) ) SizeInMinorDir(m_minSize) = GetSizeInMinorDir(sizeMinThis); - - m_totalProportion += item->GetProportion(); } + // Using the max ratio ensures that the min size is big enough for all + // items to have their min size and satisfy the proportions among them. + SizeInMajorDir(m_minSize) += (int)(maxMinSizeToProp*m_totalProportion); + return m_minSize; } @@ -2177,8 +2492,12 @@ void wxStaticBoxSizer::RecalcSizes() // in the wxBoxSizer::RecalcSizes() call below using coordinates relative // to the top-left corner of the staticbox: m_position.x = m_position.y = 0; +#elif defined(__WXOSX__) && wxOSX_USE_COCOA + // the distance from the 'inner' content view to the embedded controls + // this is independent of the title, therefore top_border is not relevant + m_position.x = m_position.y = 10; #else - // if the wxStaticBox has childrens, then these windows must be placed + // if the wxStaticBox has children, then these windows must be placed // by the wxBoxSizer::RecalcSizes() call below using coordinates relative // to the top-left corner of the staticbox (but unlike wxGTK, we need // to keep in count the static borders here!): @@ -2226,6 +2545,16 @@ void wxStaticBoxSizer::ShowItems( bool show ) wxBoxSizer::ShowItems( show ); } +bool wxStaticBoxSizer::AreAnyItemsShown() const +{ + // We don't need to check the status of our child items: if the box is + // shown, this sizer should be considered shown even if all its elements + // are hidden (or, more prosaically, there are no elements at all). And, + // conversely, if the box is hidden then all our items, which are its + // children, are hidden too. + return m_staticBox->IsShown(); +} + bool wxStaticBoxSizer::Detach( wxWindow *window ) { // avoid deleting m_staticBox in our dtor if it's being detached from the @@ -2355,30 +2684,38 @@ void wxStdDialogButtonSizer::Realize() // Extra space around and at the right Add(12, 40); #elif defined(__WXGTK20__) - Add(0, 0, 0, wxLEFT, 9); + // http://library.gnome.org/devel/hig-book/stable/windows-alert.html.en + // says that the correct button order is + // + // [Help] [Alternative] [Cancel] [Affirmative] + + // Flags ensuring that margins between the buttons are 6 pixels. + const wxSizerFlags + flagsBtn = wxSizerFlags().Centre().Border(wxLEFT | wxRIGHT, 3); + + // Margin around the entire sizer button should be 12. + AddSpacer(9); + if (m_buttonHelp) - Add((wxWindow*)m_buttonHelp, 0, wxALIGN_CENTRE | wxLEFT | wxRIGHT, 3); + Add(m_buttonHelp, flagsBtn); - // extra whitespace between help and cancel/ok buttons - Add(0, 0, 1, wxEXPAND, 0); + // Align the rest of the buttons to the right. + AddStretchSpacer(); - if (m_buttonNegative){ - Add((wxWindow*)m_buttonNegative, 0, wxALIGN_CENTRE | wxLEFT | wxRIGHT, 3); - } + if (m_buttonNegative) + Add(m_buttonNegative, flagsBtn); - // according to HIG, in explicit apply windows the order is: - // [ Help Apply Cancel OK ] if (m_buttonApply) - Add((wxWindow*)m_buttonApply, 0, wxALIGN_CENTRE | wxLEFT | wxRIGHT, 3); + Add(m_buttonApply, flagsBtn); - if (m_buttonCancel){ - Add((wxWindow*)m_buttonCancel, 0, wxALIGN_CENTRE | wxLEFT | wxRIGHT, 3); - // Cancel or help should be default - // m_buttonCancel->SetDefaultButton(); - } + if (m_buttonCancel) + Add(m_buttonCancel, flagsBtn); if (m_buttonAffirmative) - Add((wxWindow*)m_buttonAffirmative, 0, wxALIGN_CENTRE | wxLEFT, 6); + Add(m_buttonAffirmative, flagsBtn); + + // Ensure that the right margin is 12 as well. + AddSpacer(9); #elif defined(__WXMSW__) // Windows