new file added

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

diff --git a/src/generic/listbkg.cpp b/src/generic/listbkg.cpp
index 928f9b102643678f9154a6db40bb1ca6e095173c..88a3c4a7ffd464fc9286be8533025d914b1c0c4c 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,34 +26,37 @@
 
 #if wxUSE_LISTBOOK
 
 
 #if wxUSE_LISTBOOK
 

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

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

-#include "wx/listbook.h"

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

-#include "wx/settings.h"
+
+#include "wx/sysopt.h"

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

-// constants
+// various wxWidgets macros

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

-// margin between the list and the page, should be bigger than wxStaticLine
-// size
-const wxCoord MARGIN = 5;
+// check that the page index is valid
+#define IS_VALID_PAGE(nPage) ((nPage) < GetPageCount())

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

-// various wxWidgets macros
+// event table

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

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

 
 

-const wxEventType wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING = wxNewEventType();
-const wxEventType wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED = wxNewEventType();
-const int wxID_LISTBOOKLISTVIEW = wxNewId();
+wxDEFINE_EVENT( wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING, wxBookCtrlEvent );
+wxDEFINE_EVENT( wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED,  wxBookCtrlEvent );

 
 

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

     EVT_SIZE(wxListbook::OnSize)
     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()
 
 // ============================================================================


@@ -68,15 +67,6 @@ END_EVENT_TABLE()
 // wxListbook creation
 // ----------------------------------------------------------------------------
 
 // wxListbook creation
 // ----------------------------------------------------------------------------
 

-void wxListbook::Init()
-{
-    m_list = NULL;
-#if wxUSE_LINE_IN_LISTBOOK
-    m_line = NULL;
-#endif // wxUSE_LINE_IN_LISTBOOK
-    m_selection = wxNOT_FOUND;
-}
-

 bool
 wxListbook::Create(wxWindow *parent,
                    wxWindowID id,
 bool
 wxListbook::Create(wxWindow *parent,
                    wxWindowID id,


@@ -85,12 +75,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__
     }
 


@@ -103,31 +93,21 @@ wxListbook::Create(wxWindow *parent,
                             wxDefaultValidator, name) )
         return false;
 
                             wxDefaultValidator, name) )
         return false;
 

-    m_list = new wxListView
-                 (
-                    this,
-                    wxID_LISTBOOKLISTVIEW,
-                    wxDefaultPosition,
-                    wxDefaultSize,
-                    wxLC_ICON | wxLC_SINGLE_SEL |
-                        (IsVertical() ? wxLC_ALIGN_LEFT : wxLC_ALIGN_TOP)
-                 );
-
-#if wxUSE_LINE_IN_LISTBOOK
-    m_line = new wxStaticLine
+    m_bookctrl = new wxListView

                  (
                     this,
                     wxID_ANY,
                     wxDefaultPosition,
                     wxDefaultSize,
                  (
                     this,
                     wxID_ANY,
                     wxDefaultPosition,
                     wxDefaultSize,

-                    IsVertical() ? wxLI_HORIZONTAL : wxLI_VERTICAL
+                    wxLC_SINGLE_SEL |
+                    (IsVertical() ? wxLC_ALIGN_LEFT : wxLC_ALIGN_TOP) |
+                    wxLC_LIST

                  );
                  );

-#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.


@@ -141,154 +121,66 @@ wxListbook::Create(wxWindow *parent,
 // wxListbook geometry management
 // ----------------------------------------------------------------------------
 
 // wxListbook geometry management
 // ----------------------------------------------------------------------------
 

-wxSize wxListbook::GetListSize() const
-{
-    const wxSize sizeClient = GetClientSize(),
-                 sizeList = m_list->GetViewRect().GetSize();
-
-    wxSize size;
-    if ( IsVertical() )
-    {
-        size.x = sizeClient.x;
-        size.y = sizeList.y;
-    }
-    else // left/right aligned
-    {
-        size.x = sizeList.x;
-        size.y = sizeClient.y;
-    }
-
-    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;
+    // 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 * const list = GetListView();
+    if ( list )
+        list->Arrange();

 
 

-        case wxLB_LEFT:
-            rectPage.x = sizeList.x + MARGIN;
-            // fall through
-
-        case wxLB_RIGHT:
-            rectPage.width -= sizeList.x + MARGIN;
-            break;
-    }
-
-    return rectPage;
+    event.Skip();

 }
 
 }
 

-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;
-    }
-
-    // resize the list control and the page area to fit inside our new size
-    const wxSize sizeClient = GetClientSize(),
-                 sizeList = GetListSize();
-
-    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 - sizeList.y;
-            break;
-
-        case wxLB_RIGHT:
-            posList.x = sizeClient.x - sizeList.x;
-            break;
-    }
+    if ( flags )
+        *flags = wxBK_HITTEST_NOWHERE;

 
 

-    m_list->Move(posList.x, posList.y);
-    m_list->SetClientSize(sizeList.x, sizeList.y);
+    // 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(wxPoint(0, 0), sizeClient);
+        int flagsList;
+        pagePos = list->HitTest(listPt, flagsList);

 
 

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

         {
         {

-            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 ( 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 )
-    {
-        wxWindow *page = m_pages[m_selection];
-        wxCHECK_RET( page, _T("NULL page in wxListbook?") );
-        page->SetSize(GetPageRect());
+            if ( flagsList & wxLIST_HITTEST_ONITEMLABEL )
+                *flags |= wxBK_HITTEST_ONLABEL;

         }
         }

-}
-
-wxSize wxListbook::CalcSizeFromPage(const wxSize& sizePage) const
-{
-    // we need to add the size of the list control and the margin
-    const wxSize sizeList = GetListSize();
-
-    wxSize size = sizePage;
-    if ( IsVertical() )
-    {
-        size.y += sizeList.y + MARGIN;

     }
     }

-    else // left/right aligned
+    else // not over list control at all

     {
     {

-        size.x += sizeList.x + MARGIN;
+        if ( flags && GetPageRect().Contains(pt) )
+            *flags |= wxBK_HITTEST_ONPAGE;

     }
 
     }
 

-    return size;
+    return pagePos;

 }
 
 }
 

+void wxListbook::UpdateSize()
+{
+    // we should find a more elegant way to force a layout than generating this
+    // dummy event
+    wxSizeEvent sz(GetSize(), GetId());
+    GetEventHandler()->ProcessEvent(sz);
+}

 
 // ----------------------------------------------------------------------------
 // accessing the pages
 
 // ----------------------------------------------------------------------------
 // accessing the pages


@@ -296,26 +188,34 @@ 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 n) const

 {
 {

-    wxFAIL_MSG( _T("wxListbook::GetPageImage() not implemented") );
+    wxListItem item;
+    item.SetId(n);

 
 

-    return -1;
+    if (GetListView()->GetItem(item))
+    {
+       return item.GetImage();
+    }
+    else
+    {
+       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, imageId);
+    return GetListView()->SetItemImage(n, imageId);

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


@@ -324,45 +224,59 @@ 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);
+    wxListView * const list = GetListView();
+
+    // If imageList presence has changed, we update the list control style
+    if ( (imageList != NULL) != (GetImageList() != NULL) )
+    {
+        // Preserve the selection which is lost when changing the mode
+        const int oldSel = GetSelection();

 
 

-    wxBookCtrl::SetImageList(imageList);
+        // Update the style to use icon view for images, list view otherwise
+        long style = list->GetWindowStyle() & ~wxLC_MASK_TYPE;
+        if ( imageList )
+        {
+            style |= wxLC_ICON;
+        }
+        else // no image list
+        {
+            style |= wxLC_LIST;
+        }
+
+        list->SetWindowStyleFlag(style);
+
+        // Restore selection
+        if ( oldSel != wxNOT_FOUND )
+            SetSelection(oldSel);
+    }
+
+    list->SetImageList(imageList, wxIMAGE_LIST_NORMAL);
+
+    wxBookCtrlBase::SetImageList(imageList);

 }
 
 // ----------------------------------------------------------------------------
 // selection
 // ----------------------------------------------------------------------------
 
 }
 
 // ----------------------------------------------------------------------------
 // selection
 // ----------------------------------------------------------------------------
 

-int wxListbook::GetSelection() const
+void wxListbook::UpdateSelectedPage(size_t newsel)

 {
 {

-    return m_selection;
+    m_selection = newsel;
+    GetListView()->Select(newsel);
+    GetListView()->Focus(newsel);

 }
 
 }
 

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

 {
 {

-    wxCHECK_MSG( n < GetPageCount(), wxNOT_FOUND,
-                 _T("invalid page index in wxListbook::SetSelection()") );
-
-    const int selOld = m_selection;
-
-    if ( (int)n != m_selection )
-    {
-        if ( m_selection != wxNOT_FOUND )
-            m_pages[m_selection]->Hide();
-        wxWindow *page = m_pages[n];
-        page->SetSize(GetPageRect());
-        page->Show();
-
-        // change m_selection only now to ignore the selection change event
-        m_selection = n;
-
-        m_list->Select(n);
-        m_list->Focus(n);
-    }
+    return new wxBookCtrlEvent(wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING, m_windowId);
+}

 
 

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

 }
 
 }
 

+

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


@@ -374,34 +288,37 @@ 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
+
+    if ( !DoSetSelectionAfterInsertion(n, bSelect) )

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

-    }

 
 

-    InvalidateBestSize();
+    UpdateSize();
+

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


@@ -409,7 +326,7 @@ wxWindow *wxListbook::DoRemovePage(size_t page)
             int sel = m_selection - 1;
             if (page_count == 1)
                 sel = wxNOT_FOUND;
             int sel = m_selection - 1;
             if (page_count == 1)
                 sel = wxNOT_FOUND;

-            else if ((page_count == 2) || (sel == -1))
+            else if ((page_count == 2) || (sel == wxNOT_FOUND))

                 sel = 0;
 
             // force sel invalid if deleting current page - don't try to hide it
                 sel = 0;
 
             // force sel invalid if deleting current page - don't try to hide it


@@ -418,6 +335,9 @@ 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();
+        UpdateSize();

     }
 
     return win;
     }
 
     return win;


@@ -426,8 +346,13 @@ 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;
+
+    UpdateSize();
+
+    return true;

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


@@ -436,8 +361,13 @@ 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();
     const int selNew = eventList.GetIndex();

-    const int selOld = m_selection;

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


@@ -447,29 +377,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

-