Change EnsureVisble() to including column parameter, implemented it for wxGTK

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

diff --git a/src/generic/listbkg.cpp b/src/generic/listbkg.cpp
index ea064e2b9b771f703dc70e69ffd35faeb51e4b8d..eae7c13d3ca20aeb952ae650550c3d2911ac8426 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:


@@ -26,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


@@ -51,16 +47,17 @@ 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();

-const int wxID_LISTBOOKLISTVIEW = wxNewId();
+#endif

 
 BEGIN_EVENT_TABLE(wxListbook, wxBookCtrlBase)
     EVT_SIZE(wxListbook::OnSize)
 
 BEGIN_EVENT_TABLE(wxListbook, wxBookCtrlBase)
     EVT_SIZE(wxListbook::OnSize)

-    EVT_LIST_ITEM_SELECTED(wxID_LISTBOOKLISTVIEW, wxListbook::OnListSelected)
+    EVT_LIST_ITEM_SELECTED(wxID_ANY, wxListbook::OnListSelected)

 END_EVENT_TABLE()
 
 // ============================================================================
 END_EVENT_TABLE()
 
 // ============================================================================


@@ -73,10 +70,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;
 }
 


@@ -88,12 +81,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__
     }
 


@@ -106,29 +99,18 @@ wxListbook::Create(wxWindow *parent,
                             wxDefaultValidator, name) )
         return false;
 
                             wxDefaultValidator, name) )
         return false;
 

-    m_list = new wxListView
+    m_bookctrl = new wxListView

                  (
                     this,
                  (
                     this,

-                    wxID_LISTBOOKLISTVIEW,
+                    wxID_ANY,

                     wxDefaultPosition,
                     wxDefaultSize,
                     wxLC_ICON | wxLC_SINGLE_SEL |
                         (IsVertical() ? wxLC_ALIGN_LEFT : wxLC_ALIGN_TOP)
                  );
 
                     wxDefaultPosition,
                     wxDefaultSize,
                     wxLC_ICON | wxLC_SINGLE_SEL |
                         (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
     // (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
     // 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 will be
     // called again after the window is ready to go.  Technically we don't


@@ -144,13 +126,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(),

-                 sizeBorder = m_list->GetSize() - m_list->GetClientSize(),
-                 sizeList = m_list->GetViewRect().GetSize() + sizeBorder;
+                 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;


@@ -165,141 +148,70 @@ wxSize wxListbook::GetListSize() const
     return size;
 }
 
     return size;
 }
 

-wxRect wxListbook::GetPageRect() const
-{
-    const wxSize sizeList = m_list->GetSize();
-
-    wxPoint pt;
-    wxRect rectPage(pt, 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;
-}
-

 void wxListbook::OnSize(wxSizeEvent& event)
 {
 void wxListbook::OnSize(wxSizeEvent& event)
 {

-    event.Skip();
-
-    if ( !m_list )
-    {
-        // we're not fully created yet
-        return;
-    }
-

     // 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)
     // 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)

-    m_list->Arrange();
-
-    // resize the list control and the page area to fit inside our new size
-    const wxSize sizeClient = GetClientSize(),
-                 sizeBorder = m_list->GetSize() - m_list->GetClientSize(),
-                 sizeList = GetListSize();
+    wxListView *list = GetListView();
+    if (list) list->Arrange();
+    wxBookCtrlBase::OnSize(event);
+}

 
 

-    m_list->SetClientSize( sizeList.x - sizeBorder.x, sizeList.y - sizeBorder.y );
+int wxListbook::HitTest(const wxPoint& pt, long *flags) const
+{
+    int pagePos = wxNOT_FOUND;

 
 

-    const wxSize sizeNew = m_list->GetSize();
-    wxPoint posList;
-    switch ( GetWindowStyle() & wxLB_ALIGN_MASK )
-    {
-        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 - sizeNew.y;
-            break;
-
-        case wxLB_RIGHT:
-            posList.x = sizeClient.x - sizeNew.x;
-            break;
-    }
+    if ( flags )
+        *flags = wxBK_HITTEST_NOWHERE;

 
 

-    if ( m_list->GetPosition() != posList )
-        m_list->Move(posList);
+    // convert from listbook control coordinates to list control coordinates
+    const wxListView * const list = GetListView();
+    const wxPoint listPt = list->ScreenToClient(ClientToScreen(pt));

 
 

-#if wxUSE_LINE_IN_LISTBOOK
-    if ( m_line )
+    // is the point inside list control?
+    if ( wxRect(list->GetSize()).Contains(listPt) )

     {
     {

-        wxRect rectLine(sizeClient);
+        int flagsList;
+        pagePos = list->HitTest(listPt, flagsList);

 
 

-        switch ( GetWindowStyle() & wxLB_ALIGN_MASK )
+        if ( flags )

         {
         {

-            case wxLB_TOP:
-                rectLine.y = sizeNew.y + 1;
-                rectLine.height = MARGIN - 2;
-                break;
-
-            case wxLB_BOTTOM:
-                rectLine.height = MARGIN - 2;
-                rectLine.y = sizeClient.y - sizeNew.y - rectLine.height;
-                break;
-
-            case wxLB_LEFT:
-                rectLine.x = sizeNew.x + 1;
-                rectLine.width = MARGIN - 2;
-                break;
-
-            case wxLB_RIGHT:
-                rectLine.width = MARGIN - 2;
-                rectLine.x = sizeClient.x - sizeNew.x - rectLine.width;
-                break;
-        }
+            if ( pagePos != wxNOT_FOUND )
+                *flags = 0;

 
 

-        m_line->SetSize(rectLine);
-    }
-#endif // wxUSE_LINE_IN_LISTBOOK
+            if ( flagsList & (wxLIST_HITTEST_ONITEMICON |
+                              wxLIST_HITTEST_ONITEMSTATEICON ) )
+                *flags |= wxBK_HITTEST_ONICON;

 
 

-    // resize the currently shown page
-    if (m_selection != wxNOT_FOUND )
+            if ( flagsList & wxLIST_HITTEST_ONITEMLABEL )
+                *flags |= wxBK_HITTEST_ONLABEL;
+        }
+    }
+    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().Contains(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;


@@ -312,14 +224,14 @@ 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
 }
 
 int wxListbook::GetPageImage(size_t WXUNUSED(n)) const


@@ -331,7 +243,7 @@ int wxListbook::GetPageImage(size_t WXUNUSED(n)) const
 
 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);

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


@@ -340,7 +252,7 @@ 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);

 
     wxBookCtrlBase::SetImageList(imageList);
 }
 
     wxBookCtrlBase::SetImageList(imageList);
 }


@@ -349,47 +261,29 @@ void wxListbook::SetImageList(wxImageList *imageList)
 // selection
 // ----------------------------------------------------------------------------
 
 // selection
 // ----------------------------------------------------------------------------
 

+void wxListbook::UpdateSelectedPage(size_t newsel)
+{
+    m_selection = newsel;
+    GetListView()->Select(newsel);
+    GetListView()->Focus(newsel);
+}
+

 int wxListbook::GetSelection() const
 {
     return m_selection;
 }
 
 int wxListbook::GetSelection() const
 {
     return m_selection;
 }
 

-int wxListbook::SetSelection(size_t n)
+wxBookCtrlBaseEvent* wxListbook::CreatePageChangingEvent() const

 {
 {

-    wxCHECK_MSG( IS_VALID_PAGE(n), wxNOT_FOUND,
-                 wxT("invalid page index in wxListbook::SetSelection()") );
-
-    const int oldSel = m_selection;
-
-    if ( int(n) != m_selection )
-    {
-        wxListbookEvent event(wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING, m_windowId);
-        event.SetSelection(n);
-        event.SetOldSelection(m_selection);
-        event.SetEventObject(this);
-        if ( !GetEventHandler()->ProcessEvent(event) || event.IsAllowed() )
-        {
-            if ( m_selection != wxNOT_FOUND )
-                m_pages[m_selection]->Hide();
-
-            wxWindow *page = m_pages[n];
-            page->SetSize(GetPageRect());
-            page->Show();
-
-            // change m_selection now to ignore the selection change event
-            m_selection = n;
-            m_list->Select(n);
-            m_list->Focus(n);
-
-            // program allows the page change
-            event.SetEventType(wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED);
-            (void)GetEventHandler()->ProcessEvent(event);
-        }
-    }
+    return new wxListbookEvent(wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING, m_windowId);
+}

 
 

-    return oldSel;
+void wxListbook::MakeChangedEvent(wxBookCtrlBaseEvent &event)
+{
+    event.SetEventType(wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED);

 }
 
 }
 

+

 // ----------------------------------------------------------------------------
 // adding/removing the pages
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // adding/removing the pages
 // ----------------------------------------------------------------------------


@@ -404,7 +298,7 @@ wxListbook::InsertPage(size_t n,
     if ( !wxBookCtrlBase::InsertPage(n, page, text, bSelect, imageId) )
         return false;
 
     if ( !wxBookCtrlBase::InsertPage(n, page, text, bSelect, imageId) )
         return false;
 

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

 
     // if the inserted page is before the selected one, we must update the
     // index of the selected page
 
     // if the inserted page is before the selected one, we must update the
     // index of the selected page


@@ -412,8 +306,8 @@ wxListbook::InsertPage(size_t n,
     {
         // one extra page added
         m_selection++;
     {
         // one extra page added
         m_selection++;

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

     }
 
     // some page should be selected: either this one or the first one if there
     }
 
     // some page should be selected: either this one or the first one if there


@@ -430,8 +324,13 @@ wxListbook::InsertPage(size_t n,
     if ( selNew != -1 )
         SetSelection(selNew);
 
     if ( selNew != -1 )
         SetSelection(selNew);
 

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

     return true;
 }
 
     return true;
 }
 


@@ -442,7 +341,7 @@ wxWindow *wxListbook::DoRemovePage(size_t page)
 
     if ( win )
     {
 
     if ( win )
     {

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

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


@@ -460,7 +359,12 @@ wxWindow *wxListbook::DoRemovePage(size_t page)
                 SetSelection(sel);
         }
 
                 SetSelection(sel);
         }
 

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

     }
 
     return win;
     }
 
     return win;


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

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

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


@@ -479,6 +391,12 @@ bool wxListbook::DeleteAllPages()
 
 void wxListbook::OnListSelected(wxListEvent& eventList)
 {
 
 void wxListbook::OnListSelected(wxListEvent& eventList)
 {

+    if ( eventList.GetEventObject() != m_bookctrl )
+    {
+        eventList.Skip();
+        return;
+    }
+

     const int selNew = eventList.GetIndex();
 
     if ( selNew == m_selection )
     const int selNew = eventList.GetIndex();
 
     if ( selNew == m_selection )


@@ -494,10 +412,9 @@ void wxListbook::OnListSelected(wxListEvent& eventList)
     // change wasn't allowed, return to previous state
     if (m_selection != selNew)
     {
     // change wasn't allowed, return to previous state
     if (m_selection != selNew)
     {

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

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

-