Add a helper wxApp::GetValidTraits() method.

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

diff --git a/src/common/bookctrl.cpp b/src/common/bookctrl.cpp
index b0a8dea974e337974cc2564a21c9435fc86d51fd..8d86c5343e6cf6e5baabfa14e3eceba1653d94bc 100644 (file)
--- a/src/common/bookctrl.cpp
+++ b/src/common/bookctrl.cpp
@@ -42,6 +42,9 @@ IMPLEMENT_ABSTRACT_CLASS(wxBookCtrlBase, wxControl)
 
 BEGIN_EVENT_TABLE(wxBookCtrlBase, wxControl)
     EVT_SIZE(wxBookCtrlBase::OnSize)
 
 BEGIN_EVENT_TABLE(wxBookCtrlBase, wxControl)
     EVT_SIZE(wxBookCtrlBase::OnSize)

+#if wxUSE_HELP
+    EVT_HELP(wxID_ANY, wxBookCtrlBase::OnHelp)
+#endif // wxUSE_HELP

 END_EVENT_TABLE()
 
 // ----------------------------------------------------------------------------
 END_EVENT_TABLE()
 
 // ----------------------------------------------------------------------------


@@ -50,16 +53,18 @@ END_EVENT_TABLE()
 
 void wxBookCtrlBase::Init()
 {
 
 void wxBookCtrlBase::Init()
 {

+    m_selection = wxNOT_FOUND;

     m_bookctrl = NULL;
     m_bookctrl = NULL;

-    m_imageList = NULL;
-    m_ownsImageList = false;
-    m_shrinkToFit = false;
+    m_fitToCurrentPage = false;

 
 #if defined(__WXWINCE__)
     m_internalBorder = 1;
 #else
     m_internalBorder = 5;
 #endif
 
 #if defined(__WXWINCE__)
     m_internalBorder = 1;
 #else
     m_internalBorder = 5;
 #endif

+
+    m_controlMargin = 0;
+    m_controlSizer = NULL;

 }
 
 bool
 }
 
 bool


@@ -82,79 +87,278 @@ wxBookCtrlBase::Create(wxWindow *parent,
                      );
 }
 
                      );
 }
 

-wxBookCtrlBase::~wxBookCtrlBase()
+// ----------------------------------------------------------------------------
+// geometry
+// ----------------------------------------------------------------------------
+
+void wxBookCtrlBase::DoInvalidateBestSize()
+{
+    // 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();
+}
+
+wxSize wxBookCtrlBase::CalcSizeFromPage(const wxSize& sizePage) const

 {
 {

-    if ( m_ownsImageList )
+    // Add the size of the controller and the border between if it's shown.
+    if ( !m_bookctrl || !m_bookctrl->IsShown() )
+        return sizePage;
+
+    // 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();
+
+    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)
+{
+    SetClientSize(CalcSizeFromPage(size));
+}
+
+wxSize wxBookCtrlBase::DoGetBestSize() const
+{
+    wxSize bestSize;
+
+    if (m_fitToCurrentPage && GetCurrentPage())

     {
     {

-        // may be NULL, ok
-        delete m_imageList;
+        bestSize = GetCurrentPage()->GetBestSize();

     }
     }

+    else
+    {
+        // 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++ )
+        {
+            const wxWindow * const pPage = m_pages[nPage];
+            if ( pPage )
+                bestSize.IncTo(pPage->GetBestSize());
+        }
+    }
+
+    // convert display area to window area, adding the size necessary for the
+    // tabs
+    wxSize best = CalcSizeFromPage(bestSize);
+    CacheBestSize(best);
+    return best;

 }
 
 }
 

-// ----------------------------------------------------------------------------
-// image list
-// ----------------------------------------------------------------------------
+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

 
 

-void wxBookCtrlBase::SetImageList(wxImageList *imageList)
+        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_ownsImageList )
+    if ( !m_bookctrl )

     {
     {

-        // may be NULL, ok
-        delete m_imageList;
+        // 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 );
+        }

 
 

-        m_ownsImageList = false;
+        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);

     }
 
     }
 

-    m_imageList = imageList;
+    // 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();

 }
 
 }
 

-void wxBookCtrlBase::AssignImageList(wxImageList* imageList)
+wxSize wxBookCtrlBase::GetControllerSize() const

 {
 {

-    SetImageList(imageList);
+    // 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;
+    }

 
 

-    m_ownsImageList = true;
+    return size;

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------

-// geometry
+// miscellaneous stuff

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

-void wxBookCtrlBase::SetPageSize(const wxSize& size)
-{
-    SetClientSize(CalcSizeFromPage(size));
-}
+#if wxUSE_HELP

 
 

-wxSize wxBookCtrlBase::DoGetBestSize() const
+void wxBookCtrlBase::OnHelp(wxHelpEvent& event)

 {
 {

-    wxSize bestSize;
+    // determine where does this even originate from to avoid redirecting it
+    // back to the page which generated it (resulting in an infinite loop)
+
+    // notice that we have to check in the hard(er) way instead of just testing
+    // 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 != this && source->GetParent() != this )
+    {
+        source = source->GetParent();
+    }

 
 

-    // 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 ( source && m_pages.Index(source) == wxNOT_FOUND )

     {
     {

-        const wxWindow * const pPage = m_pages[nPage];
-        if( pPage )
+        // this event is for the book control itself, redirect it to the
+        // corresponding page
+        wxWindow *page = NULL;
+
+        if ( event.GetOrigin() == wxHelpEvent::Origin_HelpButton )

         {
         {

-            wxSize childBestSize(pPage->GetBestSize());
+            // show help for the page under the mouse
+            const int pagePos = HitTest(ScreenToClient(event.GetPosition()));

 
 

-            if ( childBestSize.x > bestSize.x )
-                bestSize.x = childBestSize.x;
+            if ( pagePos != wxNOT_FOUND)
+            {
+                page = GetPage((size_t)pagePos);
+            }
+        }
+        else // event from keyboard or unknown source
+        {
+            // otherwise show the current page help
+            page = GetCurrentPage();
+        }

 
 

-            if ( childBestSize.y > bestSize.y )
-                bestSize.y = childBestSize.y;
+        if ( page )
+        {
+            // change event object to the page to avoid infinite recursion if
+            // we get this event ourselves if the page doesn't handle it
+            event.SetEventObject(page);
+
+            if ( page->GetEventHandler()->ProcessEvent(event) )
+            {
+                // don't call event.Skip()
+                return;
+            }

         }
     }
         }
     }

-    
-    if (m_shrinkToFit && GetCurrentPage())
-        bestSize = GetCurrentPage()->GetBestSize();
+    //else: event coming from one of our pages already

 
 

-    // convert display area to window area, adding the size necessary for the
-    // tabs
-    wxSize best = CalcSizeFromPage(bestSize);
-    CacheBestSize(best);
-    return best;
+    event.Skip();

 }
 
 }
 

+#endif // wxUSE_HELP
+

 // ----------------------------------------------------------------------------
 // pages management
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // pages management
 // ----------------------------------------------------------------------------


@@ -167,12 +371,15 @@ wxBookCtrlBase::InsertPage(size_t nPage,
                            int WXUNUSED(imageId))
 {
     wxCHECK_MSG( page || AllowNullPage(), false,
                            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,
     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);
 
     m_pages.Insert(page, nPage);

-    InvalidateBestSize();
+    if ( page )
+        page->SetSize(GetPageRect());
+
+    DoInvalidateBestSize();

 
     return true;
 }
 
     return true;
 }


@@ -192,11 +399,11 @@ bool wxBookCtrlBase::DeletePage(size_t nPage)
 wxWindow *wxBookCtrlBase::DoRemovePage(size_t nPage)
 {
     wxCHECK_MSG( nPage < m_pages.size(), NULL,
 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);
 
     wxWindow *pageRemoved = m_pages[nPage];
     m_pages.RemoveAt(nPage);

-    InvalidateBestSize();
+    DoInvalidateBestSize();

 
     return pageRemoved;
 }
 
     return pageRemoved;
 }


@@ -224,118 +431,98 @@ int wxBookCtrlBase::GetNextPage(bool forward) const
     return nPage;
 }
 
     return nPage;
 }
 

-wxRect wxBookCtrlBase::GetPageRect() const
+int wxBookCtrlBase::FindPage(const wxWindow* page) const

 {
 {

-    const wxSize size = GetControllerSize();
-
-    wxPoint pt;
-    wxRect rectPage(pt, GetClientSize());
-    switch ( GetWindowStyle() & wxBK_ALIGN_MASK )
+    const size_t nCount = m_pages.size();
+    for ( size_t nPage = 0; nPage < nCount; nPage++ )

     {
     {

-        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;
+        if ( m_pages[nPage] == page )
+            return (int)nPage;
+    }

 
 

-        case wxBK_LEFT:
-            rectPage.x = size.x + GetInternalBorder();
-            // fall through
+    return wxNOT_FOUND;
+}

 
 

-        case wxBK_RIGHT:
-            rectPage.width -= size.x + GetInternalBorder();
-            break;
-    }
+bool wxBookCtrlBase::DoSetSelectionAfterInsertion(size_t n, bool bSelect)
+{
+    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()
+void wxBookCtrlBase::DoSetSelectionAfterRemoval(size_t n)

 {
 {

-    if ( !m_bookctrl )
+    if ( m_selection >= (int)n )

     {
     {

-        // we're not fully created yet or OnSize() should be hidden by derived class
-        return;
+        // ensure that the selection is valid
+        int sel;
+        if ( GetPageCount() == 0 )
+            sel = wxNOT_FOUND;
+        else
+            sel = m_selection ? m_selection - 1 : 0;
+
+        // if deleting current page we shouldn't try to hide it
+        m_selection = m_selection == (int)n ? wxNOT_FOUND
+                                            : m_selection - 1;
+
+        if ( sel != wxNOT_FOUND && sel != m_selection )
+            SetSelection(sel);

     }
     }

+}

 
 

-    // 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() );
+int wxBookCtrlBase::DoSetSelection(size_t n, int flags)
+{
+    wxCHECK_MSG( n < GetPageCount(), wxNOT_FOUND,
+                 wxT("invalid page index in wxBookCtrlBase::DoSetSelection()") );

 
 

-    m_bookctrl->SetClientSize( sizeCtrl.x - sizeBorder.x, sizeCtrl.y - sizeBorder.y );
+    const int oldSel = GetSelection();

 
 

-    const wxSize sizeNew = m_bookctrl->GetSize();
-    wxPoint posCtrl;
-    switch ( GetWindowStyle() & wxBK_ALIGN_MASK )
+    if ( n != (size_t)oldSel )

     {
     {

-        default:
-            wxFAIL_MSG( _T("unexpected alignment") );
-            // fall through
+        wxBookCtrlEvent *event = CreatePageChangingEvent();
+        bool allowed = false;

 
 

-        case wxBK_TOP:
-        case wxBK_LEFT:
-            // posCtrl is already ok
-            break;
-
-        case wxBK_BOTTOM:
-            posCtrl.y = sizeClient.y - sizeNew.y;
-            break;
+        if ( flags & SetSelection_SendEvent )
+        {
+            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);
+        if ( !(flags & SetSelection_SendEvent) || allowed)
+        {
+            if ( oldSel != wxNOT_FOUND )
+                DoShowPage(m_pages[oldSel], false);
+
+            wxWindow *page = m_pages[n];
+            page->SetSize(GetPageRect());
+            DoShowPage(page, true);
+
+            // change selection now to ignore the selection change event
+            UpdateSelectedPage(n);
+
+            if ( flags & SetSelection_SendEvent )
+            {
+                // program allows the page change
+                MakeChangedEvent(*event);
+                (void)GetEventHandler()->ProcessEvent(*event);
+            }
+        }

 
 

-    // resize the currently shown page
-    if (GetSelection() != wxNOT_FOUND )
-    {
-        wxWindow *page = m_pages[GetSelection()];
-        wxCHECK_RET( page, _T("NULL page?") );
-        page->SetSize(GetPageRect());
+        delete event;

     }
     }

-}

 
 

-void wxBookCtrlBase::OnSize(wxSizeEvent& event)
-{
-    event.Skip();
-    
-    DoSize();
+    return oldSel;

 }
 
 }
 

-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 ( IsVertical() )
-    {
-        size.x = sizeClient.x;
-        size.y = sizeCtrl.y;
-    }
-    else // left/right aligned
-    {
-        size.x = sizeCtrl.x;
-        size.y = sizeClient.y;
-    }
-
-    return size;
-}
+IMPLEMENT_DYNAMIC_CLASS(wxBookCtrlEvent, wxNotifyEvent)

 
 #endif // wxUSE_BOOKCTRL
 
 #endif // wxUSE_BOOKCTRL