removed obsolete and incorrect comment

[wxWidgets.git] / src / generic / listbkg.cpp

diff --git a/src/generic/listbkg.cpp b/src/generic/listbkg.cpp
index e3a839128261cc3b5a6b8849bda01745f508886a..67059a7197843378ab5854a0b3f3982008b1905c 100644 (file)
--- a/src/generic/listbkg.cpp
+++ b/src/generic/listbkg.cpp
@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        generic/listbkg.cpp
+// Name:        src/generic/listbkg.cpp

 // Purpose:     generic implementation of wxListbook
 // Author:      Vadim Zeitlin
 // Modified by:
 // Purpose:     generic implementation of wxListbook
 // Author:      Vadim Zeitlin
 // Modified by:


@@ -17,10 +17,6 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma implementation "listbook.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"
 


@@ -30,19 +26,15 @@
 
 #if wxUSE_LISTBOOK
 
 
 #if wxUSE_LISTBOOK
 

-#include "wx/listctrl.h"
-#include "wx/statline.h"

 #include "wx/listbook.h"
 #include "wx/listbook.h"

-#include "wx/imaglist.h"
-#include "wx/settings.h"

 
 

-// ----------------------------------------------------------------------------
-// constants
-// ----------------------------------------------------------------------------
+#ifndef WX_PRECOMP
+    #include "wx/settings.h"
+#endif

 
 

-// margin between the list and the page, should be bigger than wxStaticLine
-// size
-const wxCoord MARGIN = 5;
+#include "wx/listctrl.h"
+#include "wx/statline.h"
+#include "wx/imaglist.h"

 
 // ----------------------------------------------------------------------------
 // various wxWidgets macros
 
 // ----------------------------------------------------------------------------
 // various wxWidgets macros


@@ -55,14 +47,16 @@ const wxCoord MARGIN = 5;
 // event table
 // ----------------------------------------------------------------------------
 
 // event table
 // ----------------------------------------------------------------------------
 

-IMPLEMENT_DYNAMIC_CLASS(wxListbook, wxControl)
+IMPLEMENT_DYNAMIC_CLASS(wxListbook, wxBookCtrlBase)

 IMPLEMENT_DYNAMIC_CLASS(wxListbookEvent, wxNotifyEvent)
 
 IMPLEMENT_DYNAMIC_CLASS(wxListbookEvent, wxNotifyEvent)
 

+#if !WXWIN_COMPATIBILITY_EVENT_TYPES

 const wxEventType wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING = wxNewEventType();
 const wxEventType wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED = wxNewEventType();
 const wxEventType wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING = wxNewEventType();
 const wxEventType wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED = wxNewEventType();

+#endif

 const int wxID_LISTBOOKLISTVIEW = wxNewId();
 
 const int wxID_LISTBOOKLISTVIEW = wxNewId();
 

-BEGIN_EVENT_TABLE(wxListbook, wxBookCtrl)
+BEGIN_EVENT_TABLE(wxListbook, wxBookCtrlBase)

     EVT_SIZE(wxListbook::OnSize)
     EVT_LIST_ITEM_SELECTED(wxID_LISTBOOKLISTVIEW, wxListbook::OnListSelected)
 END_EVENT_TABLE()
     EVT_SIZE(wxListbook::OnSize)
     EVT_LIST_ITEM_SELECTED(wxID_LISTBOOKLISTVIEW, wxListbook::OnListSelected)
 END_EVENT_TABLE()


@@ -77,10 +71,6 @@ END_EVENT_TABLE()
 
 void wxListbook::Init()
 {
 
 void wxListbook::Init()
 {

-    m_list = NULL;
-#if wxUSE_LINE_IN_LISTBOOK
-    m_line = NULL;
-#endif // wxUSE_LINE_IN_LISTBOOK

     m_selection = wxNOT_FOUND;
 }
 
     m_selection = wxNOT_FOUND;
 }
 


@@ -92,12 +82,12 @@ wxListbook::Create(wxWindow *parent,
                    long style,
                    const wxString& name)
 {
                    long style,
                    const wxString& name)
 {

-    if ( (style & wxLB_ALIGN_MASK) == wxLB_DEFAULT )
+    if ( (style & wxBK_ALIGN_MASK) == wxBK_DEFAULT )

     {
 #ifdef __WXMAC__
     {
 #ifdef __WXMAC__

-        style |= wxLB_TOP;
+        style |= wxBK_TOP;

 #else // !__WXMAC__
 #else // !__WXMAC__

-        style |= wxLB_LEFT;
+        style |= wxBK_LEFT;

 #endif // __WXMAC__/!__WXMAC__
     }
 
 #endif // __WXMAC__/!__WXMAC__
     }
 


@@ -110,7 +100,7 @@ wxListbook::Create(wxWindow *parent,
                             wxDefaultValidator, name) )
         return false;
 
                             wxDefaultValidator, name) )
         return false;
 

-    m_list = new wxListView
+    m_bookctrl = new wxListView

                  (
                     this,
                     wxID_LISTBOOKLISTVIEW,
                  (
                     this,
                     wxID_LISTBOOKLISTVIEW,


@@ -120,21 +110,10 @@ wxListbook::Create(wxWindow *parent,
                         (IsVertical() ? wxLC_ALIGN_LEFT : wxLC_ALIGN_TOP)
                  );
 
                         (IsVertical() ? wxLC_ALIGN_LEFT : wxLC_ALIGN_TOP)
                  );
 

-#if wxUSE_LINE_IN_LISTBOOK
-    m_line = new wxStaticLine
-                 (
-                    this,
-                    wxID_ANY,
-                    wxDefaultPosition,
-                    wxDefaultSize,
-                    IsVertical() ? wxLI_HORIZONTAL : wxLI_VERTICAL
-                 );
-#endif // wxUSE_LINE_IN_LISTBOOK
-

 #ifdef __WXMSW__
 #ifdef __WXMSW__

-    // On XP with themes enabled the GetViewRect used in GetListSize to
+    // On XP with themes enabled the GetViewRect used in GetControllerSize() to

     // determine the space needed for the list view will incorrectly return
     // determine the space needed for the list view will incorrectly return

-    // (0,0,0,0) the first time.  So send a pending event so OnSize wiull be
+    // (0,0,0,0) the first time.  So send a pending event so OnSize will be

     // called again after the window is ready to go.  Technically we don't
     // need to do this on non-XP windows, but if things are already sized
     // correctly then nothing changes and so there is no harm.
     // called again after the window is ready to go.  Technically we don't
     // need to do this on non-XP windows, but if things are already sized
     // correctly then nothing changes and so there is no harm.


@@ -148,12 +127,14 @@ wxListbook::Create(wxWindow *parent,
 // wxListbook geometry management
 // ----------------------------------------------------------------------------
 
 // wxListbook geometry management
 // ----------------------------------------------------------------------------
 

-wxSize wxListbook::GetListSize() const
+wxSize wxListbook::GetControllerSize() const

 {
     const wxSize sizeClient = GetClientSize(),
 {
     const wxSize sizeClient = GetClientSize(),

-                 sizeList = m_list->GetViewRect().GetSize();
+                 sizeBorder = m_bookctrl->GetSize() - m_bookctrl->GetClientSize(),
+                 sizeList = GetListView()->GetViewRect().GetSize() + sizeBorder;

 
     wxSize size;
 
     wxSize size;

+

     if ( IsVertical() )
     {
         size.x = sizeClient.x;
     if ( IsVertical() )
     {
         size.x = sizeClient.x;


@@ -168,129 +149,70 @@ wxSize wxListbook::GetListSize() const
     return size;
 }
 
     return size;
 }
 

-wxRect wxListbook::GetPageRect() const
+void wxListbook::OnSize(wxSizeEvent& event)

 {
 {

-    const wxSize sizeList = m_list->GetSize();
-
-    wxRect rectPage(wxPoint(0, 0), GetClientSize());
-    switch ( GetWindowStyle() & wxLB_ALIGN_MASK )
-    {
-        default:
-            wxFAIL_MSG( _T("unexpected wxListbook alignment") );
-            // fall through
-
-        case wxLB_TOP:
-            rectPage.y = sizeList.y + MARGIN;
-            // fall through
-
-        case wxLB_BOTTOM:
-            rectPage.height -= sizeList.y + MARGIN;
-            break;
-
-        case wxLB_LEFT:
-            rectPage.x = sizeList.x + MARGIN;
-            // fall through
-
-        case wxLB_RIGHT:
-            rectPage.width -= sizeList.x + MARGIN;
-            break;
-    }
-
-    return rectPage;
+    // arrange the icons before calling SetClientSize(), otherwise it wouldn't
+    // account for the scrollbars the list control might need and, at least
+    // under MSW, we'd finish with an ugly looking list control with both
+    // vertical and horizontal scrollbar (with one of them being added because
+    // the other one is not accounted for in client size computations)
+    wxListView *list = GetListView();
+    if (list) list->Arrange();
+    wxBookCtrlBase::OnSize(event);

 }
 
 }
 

-void wxListbook::OnSize(wxSizeEvent& event)
+int wxListbook::HitTest(const wxPoint& pt, long *flags) const

 {
 {

-    event.Skip();
+    int pagePos = wxNOT_FOUND;

 
 

-    if ( !m_list )
-    {
-        // we're not fully created yet
-        return;
-    }
+    if ( flags )
+        *flags = wxBK_HITTEST_NOWHERE;

 
 

-    // resize the list control and the page area to fit inside our new size
-    const wxSize sizeClient = GetClientSize(),
-                 sizeList = GetListSize();
+    // convert from listbook control coordinates to list control coordinates
+    const wxListView * const list = GetListView();
+    const wxPoint listPt = list->ScreenToClient(ClientToScreen(pt));

 
 

-    wxPoint posList;
-    switch ( GetWindowStyle() & wxLB_ALIGN_MASK )
+    // is the point inside list control?
+    if ( wxRect(list->GetSize()).Inside(listPt) )

     {
     {

-        default:
-            wxFAIL_MSG( _T("unexpected wxListbook alignment") );
-            // fall through
-
-        case wxLB_TOP:
-        case wxLB_LEFT:
-            // posList is already ok
-            break;
-
-        case wxLB_BOTTOM:
-            posList.y = sizeClient.y - sizeList.y;
-            break;
-
-        case wxLB_RIGHT:
-            posList.x = sizeClient.x - sizeList.x;
-            break;
-    }
+        int flagsList;
+        pagePos = list->HitTest(listPt, flagsList);

 
 

-    m_list->Move(posList.x, posList.y);
-    m_list->SetClientSize(sizeList.x, sizeList.y);
+        if ( flags )
+        {
+            if ( pagePos != wxNOT_FOUND )
+                *flags = 0;

 
 

-#if wxUSE_LINE_IN_LISTBOOK
-    if ( m_line )
-    {
-        wxRect rectLine(wxPoint(0, 0), sizeClient);
+            if ( flagsList & (wxLIST_HITTEST_ONITEMICON |
+                              wxLIST_HITTEST_ONITEMSTATEICON ) )
+                *flags |= wxBK_HITTEST_ONICON;

 
 

-        switch ( GetWindowStyle() & wxLB_ALIGN_MASK )
-        {
-            case wxLB_TOP:
-                rectLine.y = sizeList.y + 1;
-                rectLine.height = MARGIN - 2;
-                break;
-
-            case wxLB_BOTTOM:
-                rectLine.height = MARGIN - 2;
-                rectLine.y = sizeClient.y - sizeList.y - rectLine.height;
-                break;
-
-            case wxLB_LEFT:
-                rectLine.x = sizeList.x + 1;
-                rectLine.width = MARGIN - 2;
-                break;
-
-            case wxLB_RIGHT:
-                rectLine.width = MARGIN - 2;
-                rectLine.x = sizeClient.x - sizeList.x - rectLine.width;
-                break;
+            if ( flagsList & wxLIST_HITTEST_ONITEMLABEL )
+                *flags |= wxBK_HITTEST_ONLABEL;

         }
         }

-
-        m_line->SetSize(rectLine);

     }
     }

-#endif // wxUSE_LINE_IN_LISTBOOK
-
-    // resize the currently shown page
-    if (m_selection != wxNOT_FOUND )
+    else // not over list control at all

     {
     {

-        wxWindow *page = m_pages[m_selection];
-        wxCHECK_RET( page, _T("NULL page in wxListbook?") );
-        page->SetSize(GetPageRect());
-        }
+        if ( flags && GetPageRect().Inside(pt) )
+            *flags |= wxBK_HITTEST_ONPAGE;
+    }
+
+    return pagePos;

 }
 
 wxSize wxListbook::CalcSizeFromPage(const wxSize& sizePage) const
 {
 }
 
 wxSize wxListbook::CalcSizeFromPage(const wxSize& sizePage) const
 {

-    // we need to add the size of the list control and the margin
-    const wxSize sizeList = GetListSize();
+    // we need to add the size of the list control and the border between
+    const wxSize sizeList = GetControllerSize();

 
     wxSize size = sizePage;
     if ( IsVertical() )
     {
 
     wxSize size = sizePage;
     if ( IsVertical() )
     {

-        size.y += sizeList.y + MARGIN;
+        size.y += sizeList.y + GetInternalBorder();

     }
     else // left/right aligned
     {
     }
     else // left/right aligned
     {

-        size.x += sizeList.x + MARGIN;
+        size.x += sizeList.x + GetInternalBorder();

     }
 
     return size;
     }
 
     return size;


@@ -303,26 +225,26 @@ wxSize wxListbook::CalcSizeFromPage(const wxSize& sizePage) const
 
 bool wxListbook::SetPageText(size_t n, const wxString& strText)
 {
 
 bool wxListbook::SetPageText(size_t n, const wxString& strText)
 {

-    m_list->SetItemText(n, strText);
+    GetListView()->SetItemText(n, strText);

 
     return true;
 }
 
 wxString wxListbook::GetPageText(size_t n) const
 {
 
     return true;
 }
 
 wxString wxListbook::GetPageText(size_t n) const
 {

-    return m_list->GetItemText(n);
+    return GetListView()->GetItemText(n);

 }
 
 int wxListbook::GetPageImage(size_t WXUNUSED(n)) const
 {
     wxFAIL_MSG( _T("wxListbook::GetPageImage() not implemented") );
 
 }
 
 int wxListbook::GetPageImage(size_t WXUNUSED(n)) const
 {
     wxFAIL_MSG( _T("wxListbook::GetPageImage() not implemented") );
 

-    return -1;
+    return wxNOT_FOUND;

 }
 
 bool wxListbook::SetPageImage(size_t n, int imageId)
 {
 }
 
 bool wxListbook::SetPageImage(size_t n, int imageId)
 {

-    return m_list->SetItemImage(n, imageId);
+    return GetListView()->SetItemImage(n, imageId);

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


@@ -331,9 +253,9 @@ bool wxListbook::SetPageImage(size_t n, int imageId)
 
 void wxListbook::SetImageList(wxImageList *imageList)
 {
 
 void wxListbook::SetImageList(wxImageList *imageList)
 {

-    m_list->SetImageList(imageList, wxIMAGE_LIST_NORMAL);
+    GetListView()->SetImageList(imageList, wxIMAGE_LIST_NORMAL);

 
 

-    wxBookCtrl::SetImageList(imageList);
+    wxBookCtrlBase::SetImageList(imageList);

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


@@ -367,9 +289,10 @@ int wxListbook::SetSelection(size_t n)
             page->SetSize(GetPageRect());
             page->Show();
 
             page->SetSize(GetPageRect());
             page->Show();
 

+            // change m_selection now to ignore the selection change event

             m_selection = n;
             m_selection = n;

-            m_list->Select(n);
-            m_list->Focus(n);
+            GetListView()->Select(n);
+            GetListView()->Focus(n);

 
             // program allows the page change
             event.SetEventType(wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED);
 
             // program allows the page change
             event.SetEventType(wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED);


@@ -391,34 +314,55 @@ wxListbook::InsertPage(size_t n,
                        bool bSelect,
                        int imageId)
 {
                        bool bSelect,
                        int imageId)
 {

-    if ( !wxBookCtrl::InsertPage(n, page, text, bSelect, imageId) )
+    if ( !wxBookCtrlBase::InsertPage(n, page, text, bSelect, imageId) )

         return false;
 
         return false;
 

-    m_list->InsertItem(n, text, imageId);
+    GetListView()->InsertItem(n, text, imageId);

 
 

-    // we should always have some selection if possible
-    if ( bSelect || (m_selection == wxNOT_FOUND) )
+    // if the inserted page is before the selected one, we must update the
+    // index of the selected page
+    if ( int(n) <= m_selection )

     {
     {

-        SetSelection(n);
+        // one extra page added
+        m_selection++;
+        GetListView()->Select(m_selection);
+        GetListView()->Focus(m_selection);

     }
     }

-    else // don't select this page
-    {
-        // it will be shown only when selected
+
+    // some page should be selected: either this one or the first one if there
+    // is still no selection
+    int selNew = -1;
+    if ( bSelect )
+        selNew = n;
+    else if ( m_selection == -1 )
+        selNew = 0;
+
+    if ( selNew != m_selection )

         page->Hide();
         page->Hide();

-    }
+
+    if ( selNew != -1 )
+        SetSelection(selNew);

 
     InvalidateBestSize();
 
     InvalidateBestSize();

+    // GetListView()->InvalidateBestSize();
+    GetListView()->Arrange();
+
+    if (GetPageCount() == 1)
+    {
+        wxSizeEvent sz(GetSize(), GetId());
+        ProcessEvent(sz);
+    }

     return true;
 }
 
 wxWindow *wxListbook::DoRemovePage(size_t page)
 {
     return true;
 }
 
 wxWindow *wxListbook::DoRemovePage(size_t page)
 {

-    const int page_count = GetPageCount();
-    wxWindow *win = wxBookCtrl::DoRemovePage(page);
+    const size_t page_count = GetPageCount();
+    wxWindow *win = wxBookCtrlBase::DoRemovePage(page);

 
     if ( win )
     {
 
     if ( win )
     {

-        m_list->DeleteItem(page);
+        GetListView()->DeleteItem(page);

 
         if (m_selection >= (int)page)
         {
 
         if (m_selection >= (int)page)
         {


@@ -435,6 +379,13 @@ wxWindow *wxListbook::DoRemovePage(size_t page)
             if ((sel != wxNOT_FOUND) && (sel != m_selection))
                 SetSelection(sel);
         }
             if ((sel != wxNOT_FOUND) && (sel != m_selection))
                 SetSelection(sel);
         }

+
+        GetListView()->Arrange();
+        if (GetPageCount() == 0)
+        {
+            wxSizeEvent sz(GetSize(), GetId());
+            ProcessEvent(sz);
+        }

     }
 
     return win;
     }
 
     return win;


@@ -443,8 +394,16 @@ wxWindow *wxListbook::DoRemovePage(size_t page)
 
 bool wxListbook::DeleteAllPages()
 {
 
 bool wxListbook::DeleteAllPages()
 {

-    m_list->DeleteAllItems();
-    return wxBookCtrl::DeleteAllPages();
+    GetListView()->DeleteAllItems();
+    if (!wxBookCtrlBase::DeleteAllPages())
+        return false;
+
+    m_selection = -1;
+
+    wxSizeEvent sz(GetSize(), GetId());
+    ProcessEvent(sz);
+
+    return true;

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


@@ -454,7 +413,6 @@ bool wxListbook::DeleteAllPages()
 void wxListbook::OnListSelected(wxListEvent& eventList)
 {
     const int selNew = eventList.GetIndex();
 void wxListbook::OnListSelected(wxListEvent& eventList)
 {
     const int selNew = eventList.GetIndex();

-    const int selOld = m_selection;

 
     if ( selNew == m_selection )
     {
 
     if ( selNew == m_selection )
     {


@@ -464,29 +422,14 @@ void wxListbook::OnListSelected(wxListEvent& eventList)
         return;
     }
 
         return;
     }
 

-    // first send "change in progress" event which may be vetoed by user
-    wxListbookEvent eventIng(wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING, GetId());
+    SetSelection(selNew);

 
 

-    eventIng.SetEventObject(this);
-    eventIng.SetSelection(selNew);
-    eventIng.SetOldSelection(selOld);
-    if ( GetEventHandler()->ProcessEvent(eventIng) && !eventIng.IsAllowed() )
+    // change wasn't allowed, return to previous state
+    if (m_selection != selNew)

     {
     {

-        m_list->Select(m_selection);
-        return;
+        GetListView()->Select(m_selection);
+        GetListView()->Focus(m_selection);

     }
     }

-
-    // change allowed: do change the page and notify the user about it
-    SetSelection(selNew);
-
-    wxListbookEvent eventEd(wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED, GetId());
-
-    eventEd.SetEventObject(this);
-    eventEd.SetSelection(selNew);
-    eventEd.SetOldSelection(selOld);
-
-    (void)GetEventHandler()->ProcessEvent(eventEd);

 }
 
 #endif // wxUSE_LISTBOOK
 }
 
 #endif // wxUSE_LISTBOOK

-