X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c59da60ade987fd1e54f4aca0fdbc6d95d0d2388..5c87527c5a81eda63e7ccbda2f226ca02716e7da:/src/generic/listbkg.cpp?ds=inline diff --git a/src/generic/listbkg.cpp b/src/generic/listbkg.cpp index 0a616643e2..d7cf2df1db 100644 --- 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: @@ -17,10 +17,6 @@ // 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" @@ -30,33 +26,40 @@ #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/listbook.h" #include "wx/imaglist.h" -#include "wx/settings.h" + +// FIXME: native OS X wxListCtrl hangs if this code is used for it so disable +// it for now +#if !defined(__WXMAC__) + #define CAN_USE_REPORT_VIEW +#endif // ---------------------------------------------------------------------------- -// 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(); -BEGIN_EVENT_TABLE(wxListbook, wxBookCtrl) +BEGIN_EVENT_TABLE(wxListbook, wxBookCtrlBase) EVT_SIZE(wxListbook::OnSize) - EVT_LIST_ITEM_SELECTED(wxID_ANY, wxListbook::OnListSelected) END_EVENT_TABLE() @@ -70,8 +73,6 @@ END_EVENT_TABLE() void wxListbook::Init() { - m_list = NULL; - m_line = NULL; m_selection = wxNOT_FOUND; } @@ -83,233 +84,177 @@ wxListbook::Create(wxWindow *parent, long style, const wxString& name) { - if ( (style & wxLB_ALIGN_MASK) == wxLB_DEFAULT ) + if ( (style & wxBK_ALIGN_MASK) == wxBK_DEFAULT ) { #ifdef __WXMAC__ - style |= wxLB_TOP; + style |= wxBK_TOP; #else // !__WXMAC__ - style |= wxLB_LEFT; + style |= wxBK_LEFT; #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; - m_list = new wxListView - ( - this, - -1, - wxDefaultPosition, - wxDefaultSize, - wxLC_ICON | wxLC_SINGLE_SEL - ); - - m_line = new wxStaticLine + m_bookctrl = new wxListView ( this, - -1, + wxID_ANY, wxDefaultPosition, wxDefaultSize, - IsVertical() ? wxLI_HORIZONTAL : wxLI_VERTICAL + wxLC_SINGLE_SEL | +#ifdef CAN_USE_REPORT_VIEW + GetListCtrlReportViewFlags() +#else // !CAN_USE_REPORT_VIEW + GetListCtrlIconViewFlags() +#endif // CAN_USE_REPORT_VIEW/!CAN_USE_REPORT_VIEW ); +#ifdef CAN_USE_REPORT_VIEW + GetListView()->InsertColumn(0, wxT("Pages")); +#endif // CAN_USE_REPORT_VIEW + +#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; } // ---------------------------------------------------------------------------- -// wxListbook geometry management +// wxListCtrl flags // ---------------------------------------------------------------------------- -wxSize wxListbook::GetListSize() const +long wxListbook::GetListCtrlIconViewFlags() const { - const wxSize sizeClient = GetClientSize(); + return (IsVertical() ? wxLC_ALIGN_LEFT : wxLC_ALIGN_TOP) | wxLC_ICON; +} - // we need to find the longest/tallest label - wxCoord widthMax = 0, - heightMax = 0; - const int count = m_list->GetItemCount(); - if ( count ) - { - for ( int i = 0; i < count; i++ ) - { - wxRect r; - m_list->GetItemRect(i, r); +#ifdef CAN_USE_REPORT_VIEW - wxCoord w = r.x + r.width, - h = r.y + r.height; +long wxListbook::GetListCtrlReportViewFlags() const +{ + return wxLC_REPORT | wxLC_NO_HEADER; +} - if ( w > widthMax ) - widthMax = w; - if ( h > heightMax ) - heightMax = h; - } - } +#endif // CAN_USE_REPORT_VIEW + +// ---------------------------------------------------------------------------- +// wxListbook geometry management +// ---------------------------------------------------------------------------- + +wxSize wxListbook::GetControllerSize() const +{ + const wxSize sizeClient = GetClientSize(), + sizeBorder = m_bookctrl->GetSize() - m_bookctrl->GetClientSize(), + sizeList = GetListView()->GetViewRect().GetSize() + sizeBorder; wxSize size; + if ( IsVertical() ) { size.x = sizeClient.x; - size.y = heightMax; - - if ( widthMax >= sizeClient.x ) - { - // account for the scrollbar - size.y += wxSystemSettings::GetMetric(wxSYS_HSCROLL_Y); - } + size.y = sizeList.y; } else // left/right aligned { - // +10 is due to an apparent bug in wxListCtrl::GetItemRect() but I - // can't fix it there right now so just add a fudge here... - size.x = widthMax + 10; + size.x = sizeList.x; size.y = sizeClient.y; - - if ( heightMax >= sizeClient.y ) - { - // account for the scrollbar - size.x += wxSystemSettings::GetMetric(wxSYS_VSCROLL_X); - } } return size; } -wxRect wxListbook::GetPageRect() const +void wxListbook::OnSize(wxSizeEvent& event) { - const wxSize sizeList = GetListSize(); - - wxRect rectPage(wxPoint(0, 0), GetClientSize()); - switch ( GetWindowStyle() & wxLB_ALIGN_MASK ) - { - default: - wxFAIL_MSG( _T("unexpected wxListbook alignment") ); - // fall through + // 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_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; + 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 { - // 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() ) { - size.y += sizeList.y + MARGIN; + size.y += sizeList.y + GetInternalBorder(); } else // left/right aligned { - size.x += sizeList.x + MARGIN; + size.x += sizeList.x + GetInternalBorder(); } return size; } +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 @@ -317,26 +262,34 @@ wxSize wxListbook::CalcSizeFromPage(const wxSize& sizePage) const 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 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) { - return m_list->SetItemImage(n, imageId, imageId); + return GetListView()->SetItemImage(n, imageId); } // ---------------------------------------------------------------------------- @@ -345,36 +298,85 @@ bool wxListbook::SetPageImage(size_t n, int imageId) void wxListbook::SetImageList(wxImageList *imageList) { - m_list->SetImageList(imageList, wxIMAGE_LIST_NORMAL); + wxListView * const list = GetListView(); + +#ifdef CAN_USE_REPORT_VIEW + // If imageList presence has changed, we update the list control view + if ( (imageList != NULL) != (GetImageList() != NULL) ) + { + wxArrayString labels; + labels.Alloc(GetPageCount()); + + wxArrayInt imageIds; + imageIds.Alloc(GetPageCount()); + + const int oldSel = GetSelection(); + size_t i; + + // Grab snapshot of all list control items before changing the window + // style (which deletes the items) + for ( i = 0; i < GetPageCount(); i++ ) + { + labels.Add(GetPageText(i)); + imageIds.Add(GetPageImage(i)); + } + + // Update the style to use icon view for images, report view otherwise + long style = wxLC_SINGLE_SEL; + if ( imageList ) + { + style |= GetListCtrlIconViewFlags(); + } + else // no image list + { + style |= GetListCtrlReportViewFlags(); + } - wxBookCtrl::SetImageList(imageList); + list->SetWindowStyleFlag(style); + if ( !imageList ) + list->InsertColumn(0, wxT("Pages")); + + // Add back the list control items + for ( i = 0; i < GetPageCount(); i++ ) + { + list->InsertItem(i, labels[i], imageIds[i]); + } + + // Restore selection + if ( oldSel != wxNOT_FOUND ) + SetSelection(oldSel); + } + + list->SetImageList(imageList, wxIMAGE_LIST_NORMAL); +#endif // CAN_USE_REPORT_VIEW + + wxBookCtrlBase::SetImageList(imageList); } // ---------------------------------------------------------------------------- // 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::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_COMMAND_LISTBOOK_PAGE_CHANGING, m_windowId); +} - return selOld; +void wxListbook::MakeChangedEvent(wxBookCtrlEvent &event) +{ + event.SetEventType(wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED); } @@ -389,42 +391,98 @@ wxListbook::InsertPage(size_t n, bool bSelect, int imageId) { - if ( !wxBookCtrl::InsertPage(n, page, text, bSelect, imageId) ) + if ( !wxBookCtrlBase::InsertPage(n, page, text, bSelect, imageId) ) 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 + + // 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(); - } + + if ( selNew != -1 ) + SetSelection(selNew); + + UpdateSize(); return true; } wxWindow *wxListbook::DoRemovePage(size_t page) { - wxWindow *win = wxBookCtrl::DoRemovePage(page); + const size_t page_count = GetPageCount(); + wxWindow *win = wxBookCtrlBase::DoRemovePage(page); + if ( win ) { - m_list->DeleteItem(page); + GetListView()->DeleteItem(page); + + if (m_selection >= (int)page) + { + // force new sel valid if possible + int sel = m_selection - 1; + if (page_count == 1) + sel = wxNOT_FOUND; + else if ((page_count == 2) || (sel == -1)) + sel = 0; + + // force sel invalid if deleting current page - don't try to hide it + m_selection = (m_selection == (int)page) ? wxNOT_FOUND : m_selection - 1; + + if ((sel != wxNOT_FOUND) && (sel != m_selection)) + SetSelection(sel); + } + + GetListView()->Arrange(); + UpdateSize(); } return win; } + +bool wxListbook::DeleteAllPages() +{ + GetListView()->DeleteAllItems(); + if (!wxBookCtrlBase::DeleteAllPages()) + return false; + + m_selection = -1; + + UpdateSize(); + + return true; +} + // ---------------------------------------------------------------------------- // wxListbook events // ---------------------------------------------------------------------------- void wxListbook::OnListSelected(wxListEvent& eventList) { + if ( eventList.GetEventObject() != m_bookctrl ) + { + eventList.Skip(); + return; + } + const int selNew = eventList.GetIndex(); if ( selNew == m_selection ) @@ -435,33 +493,14 @@ void wxListbook::OnListSelected(wxListEvent& eventList) 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 -