Fix harmless unused parameter warning in !wxUSE_GRAPHICS_CONTEXT build.

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

diff --git a/src/generic/listbkg.cpp b/src/generic/listbkg.cpp
index 6b5f08b442433d3cefe55a755e91332df48eac1b..ba736367c766f1ae5032f55cd6a66b8c0bacbfc5 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,35 +26,35 @@
 
 #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"

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

-// 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 wxWindows 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_LISTBOOK_PAGE_CHANGING, wxBookCtrlEvent );
+wxDEFINE_EVENT( wxEVT_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()
 
 // ============================================================================


@@ -69,13 +65,6 @@ END_EVENT_TABLE()
 // wxListbook creation
 // ----------------------------------------------------------------------------
 
 // wxListbook creation
 // ----------------------------------------------------------------------------
 

-void wxListbook::Init()
-{
-    m_list = NULL;
-    m_line = NULL;
-    m_selection = wxNOT_FOUND;
-}
-

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


@@ -84,227 +73,188 @@ 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__
     }
 

+    // no border for this control, it doesn't look nice together with
+    // wxListCtrl border
+    style &= ~wxBORDER_MASK;
+    style |= wxBORDER_NONE;
+

     if ( !wxControl::Create(parent, id, pos, size, style,
                             wxDefaultValidator, name) )
         return false;
 
     if ( !wxControl::Create(parent, id, pos, size, style,
                             wxDefaultValidator, name) )
         return false;
 

-    m_list = new wxListView
+    m_bookctrl = new wxListView

                  (
                     this,
                  (
                     this,

-                    wxID_LISTBOOKLISTVIEW,
+                    wxID_ANY,

                     wxDefaultPosition,
                     wxDefaultSize,
                     wxDefaultPosition,
                     wxDefaultSize,

-                    wxBORDER_NONE | wxLC_ICON | wxLC_SINGLE_SEL |
-                        (IsVertical() ? wxLC_ALIGN_LEFT : wxLC_ALIGN_TOP)
-                 );
-
-    m_line = new wxStaticLine
-                 (
-                    this,
-                    -1,
-                    wxDefaultPosition,
-                    wxDefaultSize,
-                    IsVertical() ? wxLI_HORIZONTAL : wxLI_VERTICAL
+                    GetListCtrlFlags()

                  );
 
                  );
 

+    if ( GetListView()->InReportView() )
+        GetListView()->InsertColumn(0, wxS("Pages"));
+
+#ifdef __WXMSW__
+    // 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
+    // need to do this on non-XP windows, but if things are already sized
+    // correctly then nothing changes and so there is no harm.
+    wxSizeEvent evt;
+    GetEventHandler()->AddPendingEvent(evt);
+#endif

     return true;
 }
 
 // ----------------------------------------------------------------------------
     return true;
 }
 
 // ----------------------------------------------------------------------------

-// wxListbook geometry management
+// wxListCtrl flags

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

-wxSize wxListbook::GetListSize() const
+long wxListbook::GetListCtrlFlags() const

 {
 {

-    const wxSize sizeClient = GetClientSize(),
-                 sizeList = m_list->GetViewRect().GetSize();
-
-    wxSize size;
-    if ( IsVertical() )
+    // We'd like to always use wxLC_ICON mode but it doesn't work with the
+    // native wxListCtrl under MSW unless we do have icons for all the items,
+    // so we can't use it if we have no image list. In this case we'd like to
+    // use wxLC_LIST mode because it works correctly for both horizontally and
+    // vertically laid out controls, but MSW native wxListCtrl insists on
+    // creating multiple columns if there are too many items and there doesn't
+    // seem anything to do about it, so we have to use wxLC_REPORT mode in this
+    // case there.
+
+    long flags = IsVertical() ? wxLC_ALIGN_LEFT : wxLC_ALIGN_TOP;
+    if ( GetImageList() )

     {
     {

-        size.x = sizeClient.x;
-        size.y = sizeList.y;
+        flags |= wxLC_ICON;

     }
     }

-    else // left/right aligned
+    else // No images.

     {
     {

-        size.x = sizeList.x;
-        size.y = sizeClient.y;
+#ifdef __WXMSW__
+        if ( !IsVertical() )
+        {
+            // Notice that we intentionally overwrite the alignment flags here
+            // by not using "|=", alignment isn't used for report view.
+            flags = wxLC_REPORT | wxLC_NO_HEADER;
+        }
+        else
+#endif // __WXMSW__
+        {
+            flags |= wxLC_LIST;
+        }

     }
 
     }
 

-    return size;
+    // Use single selection in any case.
+    return flags | wxLC_SINGLE_SEL;

 }
 
 }
 

-wxRect wxListbook::GetPageRect() const
-{
-    const wxSize sizeList = GetListSize();
-
-    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
+// ----------------------------------------------------------------------------
+// wxListbook geometry management
+// ----------------------------------------------------------------------------

 
 

-        case wxLB_RIGHT:
-            rectPage.width -= sizeList.x + MARGIN;
-            break;
-    }
+void wxListbook::OnSize(wxSizeEvent& event)
+{
+    // 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();

 
 

-    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;
-    }
+    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()).Contains(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->SetSize(posList.x, posList.y, sizeList.x, sizeList.y);
+        if ( flags )
+        {
+            if ( pagePos != wxNOT_FOUND )
+                *flags = 0;

 
 

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

     }
     }

-
-    // we should always have some selection if possible
-    if ( m_selection == wxNOT_FOUND && GetPageCount() )
+    else // not over list control at all

     {
     {

-        SetSelection(0);
+        if ( flags && GetPageRect().Contains(pt) )
+            *flags |= wxBK_HITTEST_ONPAGE;

     }
 
     }
 

-    if ( m_selection != wxNOT_FOUND )
-    {
-        wxWindow *page = m_pages[m_selection];
-        wxCHECK_RET( page, _T("NULL page in wxListbook?") );
-
-        page->SetSize(GetPageRect());
-        if ( !page->IsShown() )
-        {
-            page->Show();
-        }
-    }
+    return pagePos;

 }
 
 }
 

-wxSize wxListbook::CalcSizeFromPage(const wxSize& sizePage) const
+void wxListbook::UpdateSize()

 {
 {

-    // 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
-    {
-        size.x += sizeList.x + MARGIN;
-    }
-
-    return size;
+    // 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
 // ----------------------------------------------------------------------------
 
 bool wxListbook::SetPageText(size_t n, const wxString& strText)
 {
 // ----------------------------------------------------------------------------
 // accessing the pages
 // ----------------------------------------------------------------------------
 
 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);

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


@@ -313,36 +263,52 @@ 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);
+    const long flagsOld = GetListCtrlFlags();
+
+    wxBookCtrlBase::SetImageList(imageList);

 
 

-    wxBookCtrl::SetImageList(imageList);
+    const long flagsNew = GetListCtrlFlags();
+
+    wxListView * const list = GetListView();
+
+    // We may need to change the list control mode if the image list presence
+    // has changed.
+    if ( flagsNew != flagsOld )
+    {
+        // Preserve the selection which is lost when changing the mode
+        const int oldSel = GetSelection();
+
+        list->SetWindowStyleFlag(flagsNew);
+        if ( list->InReportView() )
+            list->InsertColumn(0, wxS("Pages"));
+
+        // Restore selection
+        if ( oldSel != wxNOT_FOUND )
+            SetSelection(oldSel);
+    }
+
+    list->SetImageList(imageList, wxIMAGE_LIST_NORMAL);

 }
 
 // ----------------------------------------------------------------------------
 // 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()") );
-
-    int selOld = m_selection;
-
-    if ( (int)n != m_selection )
-    {
-        m_selection = n;
-
-        m_list->Select(m_selection);
-        m_list->Focus(m_selection);
-    }
+    return new wxBookCtrlEvent(wxEVT_LISTBOOK_PAGE_CHANGING, m_windowId);
+}

 
 

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

 }
 
 
 }
 
 


@@ -357,42 +323,70 @@ 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);

 
 

-    if ( bSelect )
+    // if the inserted page is before the selected one, we must update the
+    // index of the selected page
+    if ( int(n) <= m_selection )

     {
     {

-        m_list->Select(n);
-        m_list->Focus(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();

-    }
+
+    UpdateSize();

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

-    wxWindow *win = wxBookCtrl::DoRemovePage(page);
+    wxWindow *win = wxBookCtrlBase::DoRemovePage(page);
+

     if ( win )
     {
     if ( win )
     {

-        m_list->DeleteItem(page);
+        GetListView()->DeleteItem(page);
+
+        DoSetSelectionAfterRemoval(page);
+
+        GetListView()->Arrange();
+        UpdateSize();

     }
 
     return win;
 }
 
     }
 
     return win;
 }
 

+
+bool wxListbook::DeleteAllPages()
+{
+    GetListView()->DeleteAllItems();
+    if (!wxBookCtrlBase::DeleteAllPages())
+        return false;
+
+    UpdateSize();
+
+    return true;
+}
+

 // ----------------------------------------------------------------------------
 // wxListbook events
 // ----------------------------------------------------------------------------
 
 void wxListbook::OnListSelected(wxListEvent& eventList)
 {
 // ----------------------------------------------------------------------------
 // wxListbook events
 // ----------------------------------------------------------------------------
 
 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 )


@@ -403,33 +397,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(m_selection);
-    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
-    if ( m_selection != wxNOT_FOUND )
-        m_pages[m_selection]->Hide();
-    wxWindow *page = m_pages[m_selection = selNew];
-    page->SetSize(GetPageRect());
-    page->Show();
-
-    wxListbookEvent eventEd(wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED, GetId());
-
-    eventEd.SetEventObject(this);
-    eventEd.SetSelection(selNew);
-    eventEd.SetOldSelection(m_selection);
-
-    (void)GetEventHandler()->ProcessEvent(eventEd);

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

-