4e467d818b
wxListbook::GetPageImage() always returned -1. Fix this by defining the mask properly before calling wxListCtrl::GetItem(). Closes #17858.
408 lines
11 KiB
C++
408 lines
11 KiB
C++
///////////////////////////////////////////////////////////////////////////////
|
|
// Name: src/generic/listbkg.cpp
|
|
// Purpose: generic implementation of wxListbook
|
|
// Author: Vadim Zeitlin
|
|
// Modified by:
|
|
// Created: 19.08.03
|
|
// Copyright: (c) 2003 Vadim Zeitlin <vadim@wxwindows.org>
|
|
// Licence: wxWindows licence
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
|
|
// ============================================================================
|
|
// declarations
|
|
// ============================================================================
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// headers
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// For compilers that support precompilation, includes "wx.h".
|
|
#include "wx/wxprec.h"
|
|
|
|
#ifdef __BORLANDC__
|
|
#pragma hdrstop
|
|
#endif
|
|
|
|
#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/imaglist.h"
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// event table
|
|
// ----------------------------------------------------------------------------
|
|
|
|
wxIMPLEMENT_DYNAMIC_CLASS(wxListbook, wxBookCtrlBase);
|
|
|
|
wxDEFINE_EVENT( wxEVT_LISTBOOK_PAGE_CHANGING, wxBookCtrlEvent );
|
|
wxDEFINE_EVENT( wxEVT_LISTBOOK_PAGE_CHANGED, wxBookCtrlEvent );
|
|
|
|
wxBEGIN_EVENT_TABLE(wxListbook, wxBookCtrlBase)
|
|
EVT_SIZE(wxListbook::OnSize)
|
|
EVT_LIST_ITEM_SELECTED(wxID_ANY, wxListbook::OnListSelected)
|
|
wxEND_EVENT_TABLE()
|
|
|
|
// ============================================================================
|
|
// wxListbook implementation
|
|
// ============================================================================
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// wxListbook creation
|
|
// ----------------------------------------------------------------------------
|
|
|
|
bool
|
|
wxListbook::Create(wxWindow *parent,
|
|
wxWindowID id,
|
|
const wxPoint& pos,
|
|
const wxSize& size,
|
|
long style,
|
|
const wxString& name)
|
|
{
|
|
if ( (style & wxBK_ALIGN_MASK) == wxBK_DEFAULT )
|
|
{
|
|
#ifdef __WXMAC__
|
|
style |= wxBK_TOP;
|
|
#else // !__WXMAC__
|
|
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_bookctrl = new wxListView
|
|
(
|
|
this,
|
|
wxID_ANY,
|
|
wxDefaultPosition,
|
|
wxDefaultSize,
|
|
GetListCtrlFlags()
|
|
);
|
|
|
|
if ( GetListView()->InReportView() )
|
|
GetListView()->InsertColumn(0, wxS("Pages"));
|
|
|
|
// Ensure that we rearrange the items in our list view after all the pages
|
|
// are added.
|
|
PostSizeEvent();
|
|
|
|
return true;
|
|
}
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// wxListCtrl flags
|
|
// ----------------------------------------------------------------------------
|
|
|
|
long wxListbook::GetListCtrlFlags() const
|
|
{
|
|
// 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() )
|
|
{
|
|
flags |= wxLC_ICON;
|
|
}
|
|
else // No images.
|
|
{
|
|
#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;
|
|
}
|
|
|
|
#ifdef __WXQT__
|
|
flags |= wxLC_NO_HEADER;
|
|
#endif
|
|
}
|
|
|
|
// Use single selection in any case.
|
|
return flags | wxLC_SINGLE_SEL;
|
|
}
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// wxListbook geometry management
|
|
// ----------------------------------------------------------------------------
|
|
|
|
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();
|
|
|
|
const int sel = GetSelection();
|
|
if ( sel != wxNOT_FOUND )
|
|
list->EnsureVisible(sel);
|
|
}
|
|
|
|
event.Skip();
|
|
}
|
|
|
|
int wxListbook::HitTest(const wxPoint& pt, long *flags) const
|
|
{
|
|
int pagePos = wxNOT_FOUND;
|
|
|
|
if ( flags )
|
|
*flags = wxBK_HITTEST_NOWHERE;
|
|
|
|
// convert from listbook control coordinates to list control coordinates
|
|
const wxListView * const list = GetListView();
|
|
const wxPoint listPt = list->ScreenToClient(ClientToScreen(pt));
|
|
|
|
// is the point inside list control?
|
|
if ( wxRect(list->GetSize()).Contains(listPt) )
|
|
{
|
|
int flagsList;
|
|
pagePos = list->HitTest(listPt, flagsList);
|
|
|
|
if ( flags )
|
|
{
|
|
if ( pagePos != wxNOT_FOUND )
|
|
*flags = 0;
|
|
|
|
if ( flagsList & (wxLIST_HITTEST_ONITEMICON |
|
|
wxLIST_HITTEST_ONITEMSTATEICON ) )
|
|
*flags |= wxBK_HITTEST_ONICON;
|
|
|
|
if ( flagsList & wxLIST_HITTEST_ONITEMLABEL )
|
|
*flags |= wxBK_HITTEST_ONLABEL;
|
|
}
|
|
}
|
|
else // not over list control at all
|
|
{
|
|
if ( flags && GetPageRect().Contains(pt) )
|
|
*flags |= wxBK_HITTEST_ONPAGE;
|
|
}
|
|
|
|
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
|
|
// ----------------------------------------------------------------------------
|
|
|
|
bool wxListbook::SetPageText(size_t n, const wxString& strText)
|
|
{
|
|
GetListView()->SetItemText(n, strText);
|
|
|
|
return true;
|
|
}
|
|
|
|
wxString wxListbook::GetPageText(size_t n) const
|
|
{
|
|
return GetListView()->GetItemText(n);
|
|
}
|
|
|
|
int wxListbook::GetPageImage(size_t n) const
|
|
{
|
|
wxListItem item;
|
|
item.SetId(n);
|
|
item.SetMask(wxLIST_MASK_IMAGE);
|
|
|
|
if (GetListView()->GetItem(item))
|
|
{
|
|
return item.GetImage();
|
|
}
|
|
else
|
|
{
|
|
return wxNOT_FOUND;
|
|
}
|
|
}
|
|
|
|
bool wxListbook::SetPageImage(size_t n, int imageId)
|
|
{
|
|
return GetListView()->SetItemImage(n, imageId);
|
|
}
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// image list stuff
|
|
// ----------------------------------------------------------------------------
|
|
|
|
void wxListbook::SetImageList(wxImageList *imageList)
|
|
{
|
|
const long flagsOld = GetListCtrlFlags();
|
|
|
|
wxBookCtrlBase::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
|
|
// ----------------------------------------------------------------------------
|
|
|
|
void wxListbook::UpdateSelectedPage(size_t newsel)
|
|
{
|
|
m_selection = newsel;
|
|
GetListView()->Select(newsel);
|
|
GetListView()->Focus(newsel);
|
|
}
|
|
|
|
wxBookCtrlEvent* wxListbook::CreatePageChangingEvent() const
|
|
{
|
|
return new wxBookCtrlEvent(wxEVT_LISTBOOK_PAGE_CHANGING, m_windowId);
|
|
}
|
|
|
|
void wxListbook::MakeChangedEvent(wxBookCtrlEvent &event)
|
|
{
|
|
event.SetEventType(wxEVT_LISTBOOK_PAGE_CHANGED);
|
|
}
|
|
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// adding/removing the pages
|
|
// ----------------------------------------------------------------------------
|
|
|
|
bool
|
|
wxListbook::InsertPage(size_t n,
|
|
wxWindow *page,
|
|
const wxString& text,
|
|
bool bSelect,
|
|
int imageId)
|
|
{
|
|
if ( !wxBookCtrlBase::InsertPage(n, page, text, bSelect, imageId) )
|
|
return false;
|
|
|
|
GetListView()->InsertItem(n, text, imageId);
|
|
|
|
// if the inserted page is before the selected one, we must update the
|
|
// index of the selected page
|
|
if ( int(n) <= m_selection )
|
|
{
|
|
// one extra page added
|
|
m_selection++;
|
|
GetListView()->Select(m_selection);
|
|
GetListView()->Focus(m_selection);
|
|
}
|
|
|
|
if ( !DoSetSelectionAfterInsertion(n, bSelect) )
|
|
page->Hide();
|
|
|
|
UpdateSize();
|
|
|
|
return true;
|
|
}
|
|
|
|
wxWindow *wxListbook::DoRemovePage(size_t page)
|
|
{
|
|
wxWindow *win = wxBookCtrlBase::DoRemovePage(page);
|
|
|
|
if ( win )
|
|
{
|
|
GetListView()->DeleteItem(page);
|
|
|
|
DoSetSelectionAfterRemoval(page);
|
|
|
|
GetListView()->Arrange();
|
|
UpdateSize();
|
|
}
|
|
|
|
return win;
|
|
}
|
|
|
|
|
|
bool wxListbook::DeleteAllPages()
|
|
{
|
|
GetListView()->DeleteAllItems();
|
|
if (!wxBookCtrlBase::DeleteAllPages())
|
|
return false;
|
|
|
|
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 )
|
|
{
|
|
// this event can only come from our own Select(m_selection) below
|
|
// which we call when the page change is vetoed, so we should simply
|
|
// ignore it
|
|
return;
|
|
}
|
|
|
|
SetSelection(selNew);
|
|
|
|
// change wasn't allowed, return to previous state
|
|
if (m_selection != selNew)
|
|
{
|
|
GetListView()->Select(m_selection);
|
|
GetListView()->Focus(m_selection);
|
|
}
|
|
}
|
|
|
|
#endif // wxUSE_LISTBOOK
|