]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/bookctrl.cpp
fixing overrelease and out-of-bounds write, fixes #13725
[wxWidgets.git] / src / common / bookctrl.cpp
index d1e7bcbe019159228f25cc4b62627632e1312470..9f0e284652550a55169d1529220b9825783bb5ee 100644 (file)
@@ -53,9 +53,8 @@ END_EVENT_TABLE()
 
 void wxBookCtrlBase::Init()
 {
+    m_selection = wxNOT_FOUND;
     m_bookctrl = NULL;
-    m_imageList = NULL;
-    m_ownsImageList = false;
     m_fitToCurrentPage = false;
 
 #if defined(__WXWINCE__)
@@ -88,42 +87,42 @@ wxBookCtrlBase::Create(wxWindow *parent,
                      );
 }
 
-wxBookCtrlBase::~wxBookCtrlBase()
-{
-    if ( m_ownsImageList )
-    {
-        // may be NULL, ok
-        delete m_imageList;
-    }
-}
-
 // ----------------------------------------------------------------------------
-// image list
+// geometry
 // ----------------------------------------------------------------------------
 
-void wxBookCtrlBase::SetImageList(wxImageList *imageList)
+void wxBookCtrlBase::DoInvalidateBestSize()
 {
-    if ( m_ownsImageList )
-    {
-        // may be NULL, ok
-        delete m_imageList;
-
-        m_ownsImageList = false;
-    }
-
-    m_imageList = imageList;
+    // notice that it is not necessary to invalidate our own best size
+    // explicitly if we have m_bookctrl as it will already invalidate the best
+    // size of its parent when its own size is invalidated and its parent is
+    // this control
+    if ( m_bookctrl )
+        m_bookctrl->InvalidateBestSize();
+    else
+        wxControl::InvalidateBestSize();
 }
 
-void wxBookCtrlBase::AssignImageList(wxImageList* imageList)
+wxSize wxBookCtrlBase::CalcSizeFromPage(const wxSize& sizePage) const
 {
-    SetImageList(imageList);
+    // Add the size of the controller and the border between if it's shown.
+    if ( !m_bookctrl || !m_bookctrl->IsShown() )
+        return sizePage;
 
-    m_ownsImageList = true;
-}
+    // Notice that the controller size is its current size while we really want
+    // to have its best size. So we only take into account its size in the
+    // direction in which we should add it but not in the other one, where the
+    // controller size is determined by the size of wxBookCtrl itself.
+    const wxSize sizeController = GetControllerSize();
 
-// ----------------------------------------------------------------------------
-// geometry
-// ----------------------------------------------------------------------------
+    wxSize size = sizePage;
+    if ( IsVertical() )
+        size.y += sizeController.y + GetInternalBorder();
+    else // left/right aligned
+        size.x += sizeController.x + GetInternalBorder();
+
+    return size;
+}
 
 void wxBookCtrlBase::SetPageSize(const wxSize& size)
 {
@@ -134,26 +133,22 @@ wxSize wxBookCtrlBase::DoGetBestSize() const
 {
     wxSize bestSize;
 
-    // iterate over all pages, get the largest width and height
-    const size_t nCount = m_pages.size();
-    for ( size_t nPage = 0; nPage < nCount; nPage++ )
+    if (m_fitToCurrentPage && GetCurrentPage())
+    {
+        bestSize = GetCurrentPage()->GetBestSize();
+    }
+    else
     {
-        const wxWindow * const pPage = m_pages[nPage];
-        if( pPage )
+        // iterate over all pages, get the largest width and height
+        const size_t nCount = m_pages.size();
+        for ( size_t nPage = 0; nPage < nCount; nPage++ )
         {
-            wxSize childBestSize(pPage->GetBestSize());
-
-            if ( childBestSize.x > bestSize.x )
-                bestSize.x = childBestSize.x;
-
-            if ( childBestSize.y > bestSize.y )
-                bestSize.y = childBestSize.y;
+            const wxWindow * const pPage = m_pages[nPage];
+            if ( pPage )
+                bestSize.IncTo(pPage->GetBestSize());
         }
     }
 
-    if (m_fitToCurrentPage && GetCurrentPage())
-        bestSize = GetCurrentPage()->GetBestSize();
-
     // convert display area to window area, adding the size necessary for the
     // tabs
     wxSize best = CalcSizeFromPage(bestSize);
@@ -161,6 +156,151 @@ wxSize wxBookCtrlBase::DoGetBestSize() const
     return best;
 }
 
+wxRect wxBookCtrlBase::GetPageRect() const
+{
+    const wxSize size = GetControllerSize();
+
+    wxPoint pt;
+    wxRect rectPage(pt, GetClientSize());
+
+    switch ( GetWindowStyle() & wxBK_ALIGN_MASK )
+    {
+        default:
+            wxFAIL_MSG( wxT("unexpected alignment") );
+            // fall through
+
+        case wxBK_TOP:
+            rectPage.y = size.y + GetInternalBorder();
+            // fall through
+
+        case wxBK_BOTTOM:
+            rectPage.height -= size.y + GetInternalBorder();
+            if (rectPage.height < 0)
+                rectPage.height = 0;
+            break;
+
+        case wxBK_LEFT:
+            rectPage.x = size.x + GetInternalBorder();
+            // fall through
+
+        case wxBK_RIGHT:
+            rectPage.width -= size.x + GetInternalBorder();
+            if (rectPage.width < 0)
+                rectPage.width = 0;
+            break;
+    }
+
+    return rectPage;
+}
+
+// Lay out controls
+void wxBookCtrlBase::DoSize()
+{
+    if ( !m_bookctrl )
+    {
+        // we're not fully created yet or OnSize() should be hidden by derived class
+        return;
+    }
+
+    if (GetSizer())
+        Layout();
+    else
+    {
+        // resize controller and the page area to fit inside our new size
+        const wxSize sizeClient( GetClientSize() ),
+                    sizeBorder( m_bookctrl->GetSize() - m_bookctrl->GetClientSize() ),
+                    sizeCtrl( GetControllerSize() );
+
+        m_bookctrl->SetClientSize( sizeCtrl.x - sizeBorder.x, sizeCtrl.y - sizeBorder.y );
+        // if this changes the visibility of the scrollbars the best size changes, relayout in this case
+        wxSize sizeCtrl2 = GetControllerSize();
+        if ( sizeCtrl != sizeCtrl2 )
+        {
+            wxSize sizeBorder2 = m_bookctrl->GetSize() - m_bookctrl->GetClientSize();
+            m_bookctrl->SetClientSize( sizeCtrl2.x - sizeBorder2.x, sizeCtrl2.y - sizeBorder2.y );
+        }
+
+        const wxSize sizeNew = m_bookctrl->GetSize();
+        wxPoint posCtrl;
+        switch ( GetWindowStyle() & wxBK_ALIGN_MASK )
+        {
+            default:
+                wxFAIL_MSG( wxT("unexpected alignment") );
+                // fall through
+
+            case wxBK_TOP:
+            case wxBK_LEFT:
+                // posCtrl is already ok
+                break;
+
+            case wxBK_BOTTOM:
+                posCtrl.y = sizeClient.y - sizeNew.y;
+                break;
+
+            case wxBK_RIGHT:
+                posCtrl.x = sizeClient.x - sizeNew.x;
+                break;
+        }
+
+        if ( m_bookctrl->GetPosition() != posCtrl )
+            m_bookctrl->Move(posCtrl);
+    }
+
+    // resize all pages to fit the new control size
+    const wxRect pageRect = GetPageRect();
+    const unsigned pagesCount = m_pages.GetCount();
+    for ( unsigned int i = 0; i < pagesCount; ++i )
+    {
+        wxWindow * const page = m_pages[i];
+        if ( !page )
+        {
+            wxASSERT_MSG( AllowNullPage(),
+                wxT("Null page in a control that does not allow null pages?") );
+            continue;
+        }
+
+        page->SetSize(pageRect);
+    }
+}
+
+void wxBookCtrlBase::OnSize(wxSizeEvent& event)
+{
+    event.Skip();
+
+    DoSize();
+}
+
+wxSize wxBookCtrlBase::GetControllerSize() const
+{
+    // For at least some book controls (e.g. wxChoicebook) it may make sense to
+    // (temporarily?) hide the controller and we shouldn't leave extra space
+    // for the hidden control in this case.
+    if ( !m_bookctrl || !m_bookctrl->IsShown() )
+        return wxSize(0, 0);
+
+    const wxSize sizeClient = GetClientSize();
+
+    wxSize size;
+
+    // Ask for the best width/height considering the other direction.
+    if ( IsVertical() )
+    {
+        size.x = sizeClient.x;
+        size.y = m_bookctrl->GetBestHeight(sizeClient.x);
+    }
+    else // left/right aligned
+    {
+        size.x = m_bookctrl->GetBestWidth(sizeClient.y);
+        size.y = sizeClient.y;
+    }
+
+    return size;
+}
+
+// ----------------------------------------------------------------------------
+// miscellaneous stuff
+// ----------------------------------------------------------------------------
+
 #if wxUSE_HELP
 
 void wxBookCtrlBase::OnHelp(wxHelpEvent& event)
@@ -172,7 +312,7 @@ void wxBookCtrlBase::OnHelp(wxHelpEvent& event)
     // if the event object == this because the book control can have other
     // subcontrols inside it (e.g. wxSpinButton in case of a notebook in wxUniv)
     wxWindow *source = wxStaticCast(event.GetEventObject(), wxWindow);
-    while ( source && source->GetParent() != this )
+    while ( source && source != this && source->GetParent() != this )
     {
         source = source->GetParent();
     }
@@ -231,15 +371,15 @@ wxBookCtrlBase::InsertPage(size_t nPage,
                            int WXUNUSED(imageId))
 {
     wxCHECK_MSG( page || AllowNullPage(), false,
-                 _T("NULL page in wxBookCtrlBase::InsertPage()") );
+                 wxT("NULL page in wxBookCtrlBase::InsertPage()") );
     wxCHECK_MSG( nPage <= m_pages.size(), false,
-                 _T("invalid page index in wxBookCtrlBase::InsertPage()") );
+                 wxT("invalid page index in wxBookCtrlBase::InsertPage()") );
 
     m_pages.Insert(page, nPage);
     if ( page )
         page->SetSize(GetPageRect());
 
-    InvalidateBestSize();
+    DoInvalidateBestSize();
 
     return true;
 }
@@ -259,11 +399,11 @@ bool wxBookCtrlBase::DeletePage(size_t nPage)
 wxWindow *wxBookCtrlBase::DoRemovePage(size_t nPage)
 {
     wxCHECK_MSG( nPage < m_pages.size(), NULL,
-                 _T("invalid page index in wxBookCtrlBase::DoRemovePage()") );
+                 wxT("invalid page index in wxBookCtrlBase::DoRemovePage()") );
 
     wxWindow *pageRemoved = m_pages[nPage];
     m_pages.RemoveAt(nPage);
-    InvalidateBestSize();
+    DoInvalidateBestSize();
 
     return pageRemoved;
 }
@@ -291,132 +431,66 @@ int wxBookCtrlBase::GetNextPage(bool forward) const
     return nPage;
 }
 
-wxRect wxBookCtrlBase::GetPageRect() const
+bool wxBookCtrlBase::DoSetSelectionAfterInsertion(size_t n, bool bSelect)
 {
-    const wxSize size = GetControllerSize();
-
-    wxPoint pt;
-    wxRect rectPage(pt, GetClientSize());
-
-    switch ( GetWindowStyle() & wxBK_ALIGN_MASK )
-    {
-        default:
-            wxFAIL_MSG( _T("unexpected alignment") );
-            // fall through
-
-        case wxBK_TOP:
-            rectPage.y = size.y + GetInternalBorder();
-            // fall through
-
-        case wxBK_BOTTOM:
-            rectPage.height -= size.y + GetInternalBorder();
-            break;
-
-        case wxBK_LEFT:
-            rectPage.x = size.x + GetInternalBorder();
-            // fall through
-
-        case wxBK_RIGHT:
-            rectPage.width -= size.x + GetInternalBorder();
-            break;
-    }
+    if ( bSelect )
+        SetSelection(n);
+    else if ( m_selection == wxNOT_FOUND )
+        ChangeSelection(0);
+    else // We're not going to select this page.
+        return false;
 
-    return rectPage;
+    // Return true to indicate that we selected this page.
+    return true;
 }
 
-// Lay out controls
-void wxBookCtrlBase::DoSize()
+int wxBookCtrlBase::DoSetSelection(size_t n, int flags)
 {
-    if ( !m_bookctrl )
-    {
-        // we're not fully created yet or OnSize() should be hidden by derived class
-        return;
-    }
+    wxCHECK_MSG( n < GetPageCount(), wxNOT_FOUND,
+                 wxT("invalid page index in wxBookCtrlBase::DoSetSelection()") );
 
-    if (GetSizer())
-        Layout();
-    else
-    {
-        // resize controller and the page area to fit inside our new size
-        const wxSize sizeClient( GetClientSize() ),
-                    sizeBorder( m_bookctrl->GetSize() - m_bookctrl->GetClientSize() ),
-                    sizeCtrl( GetControllerSize() );
+    const int oldSel = GetSelection();
 
-        m_bookctrl->SetClientSize( sizeCtrl.x - sizeBorder.x, sizeCtrl.y - sizeBorder.y );
+    if ( n != (size_t)oldSel )
+    {
+        wxBookCtrlEvent *event = CreatePageChangingEvent();
+        bool allowed = false;
 
-        const wxSize sizeNew = m_bookctrl->GetSize();
-        wxPoint posCtrl;
-        switch ( GetWindowStyle() & wxBK_ALIGN_MASK )
+        if ( flags & SetSelection_SendEvent )
         {
-            default:
-                wxFAIL_MSG( _T("unexpected alignment") );
-                // fall through
-
-            case wxBK_TOP:
-            case wxBK_LEFT:
-                // posCtrl is already ok
-                break;
-
-            case wxBK_BOTTOM:
-                posCtrl.y = sizeClient.y - sizeNew.y;
-                break;
+            event->SetSelection(n);
+            event->SetOldSelection(oldSel);
+            event->SetEventObject(this);
 
-            case wxBK_RIGHT:
-                posCtrl.x = sizeClient.x - sizeNew.x;
-                break;
+            allowed = !GetEventHandler()->ProcessEvent(*event) || event->IsAllowed();
         }
 
-        if ( m_bookctrl->GetPosition() != posCtrl )
-            m_bookctrl->Move(posCtrl);
-    }
-
-    // resize all pages to fit the new control size
-    const wxRect pageRect = GetPageRect();
-    const unsigned pagesCount = m_pages.Count();
-    for ( unsigned int i = 0; i < pagesCount; ++i )
-    {
-        wxWindow * const page = m_pages[i];
-        if ( !page )
+        if ( !(flags & SetSelection_SendEvent) || allowed)
         {
-            wxASSERT_MSG( AllowNullPage(),
-                _T("Null page in a control that does not allow null pages?") );
-            continue;
-        }
-
-        page->SetSize(pageRect);
-    }
-}
+            if ( oldSel != wxNOT_FOUND )
+                DoShowPage(m_pages[oldSel], false);
 
-void wxBookCtrlBase::OnSize(wxSizeEvent& event)
-{
-    event.Skip();
+            wxWindow *page = m_pages[n];
+            page->SetSize(GetPageRect());
+            DoShowPage(page, true);
 
-    DoSize();
-}
+            // change selection now to ignore the selection change event
+            UpdateSelectedPage(n);
 
-wxSize wxBookCtrlBase::GetControllerSize() const
-{
-    if(!m_bookctrl)
-        return wxSize(0,0);
-
-    const wxSize sizeClient = GetClientSize(),
-                 sizeBorder = m_bookctrl->GetSize() - m_bookctrl->GetClientSize(),
-                 sizeCtrl = m_bookctrl->GetBestSize() + sizeBorder;
-
-    wxSize size;
+            if ( flags & SetSelection_SendEvent )
+            {
+                // program allows the page change
+                MakeChangedEvent(*event);
+                (void)GetEventHandler()->ProcessEvent(*event);
+            }
+        }
 
-    if ( IsVertical() )
-    {
-        size.x = sizeClient.x;
-        size.y = sizeCtrl.y;
-    }
-    else // left/right aligned
-    {
-        size.x = sizeCtrl.x;
-        size.y = sizeClient.y;
+        delete event;
     }
 
-    return size;
+    return oldSel;
 }
 
+IMPLEMENT_DYNAMIC_CLASS(wxBookCtrlEvent, wxNotifyEvent)
+
 #endif // wxUSE_BOOKCTRL