/////////////////////////////////////////////////////////////////////////////
/*
- FIXME for virtual list controls
+ TODO
- +1. clicking on the item with a mouse is awfully slow, what is going on?
- note that selecting with keyboard seems to be much faster
- => fixed HighlightAll() - iterating over 1000000 items *is* slow
-
- 2. background colour is wrong?
- */
-
-/*
- TODO for better virtual list control support:
-
- 1. less dumb line caching, we should cache at least all those visible
- in the control itself and probably twice as many (we might also need to
- cache the first one always for geometry calculations?)
-
- +2. storing selections: we can't use an array to store the selected indices
- like right now as selecting all in a control with 1000000 items is not
- doable like this - instead, store selections as collection of individual
- items and ranges
-
- => wxSelectionStore
-
- 3. we need to implement searching/sorting somehow
-
- 4. the idea of storing the line index in the line itself is really stupid,
- we shouldn't need it - but for this we have to get rid of all calles to
- wxListLineData::GetFoo() and replace them with something like
- if ( IsVirtual()
- ... we have it ourselves ...
- else
- line->GetFoo();
-
- => done
-
- 5. attributes support: we need OnGetItemAttr() as well!
+ 1. we need to implement searching/sorting for virtual controls somehow
+ 2. when changing selection the lines are refreshed twice
*/
// ============================================================================
bool SelectItem(size_t item, bool select = TRUE);
// select the range of items
- void SelectRange(size_t itemFrom, size_t itemTo, bool select = TRUE);
+ //
+ // return true and fill the itemsChanged array with the indices of items
+ // which have changed state if "few" of them did, otherwise return false
+ // (meaning that too many items changed state to bother counting them
+ // individually)
+ bool SelectRange(size_t itemFrom, size_t itemTo,
+ bool select = TRUE,
+ wxArrayInt *itemsChanged = NULL);
// return true if the given item is selected
bool IsSelected(size_t item) const;
// get the mode (i.e. style) of the list control
inline int GetMode() const;
- void SetAttributes(wxDC *dc,
+ // prepare the DC for drawing with these item's attributes, return true if
+ // we need to draw the items background to highlight it, false otherwise
+ bool SetAttributes(wxDC *dc,
const wxListItemAttr *attr,
- const wxColour& colText,
- const wxFont& font,
bool highlight);
// these are only used by GetImage/SetImage above, we don't support images
// return the hit code for the corresponding position (in this line)
long HitTestLine(size_t line, int x, int y) const;
+ // bring the selected item into view, scrolling to it if necessary
+ void MoveToItem(size_t item);
+
+ // bring the current item into view
+ void MoveToFocus() { MoveToItem(m_current); }
+
void EditLabel( long item );
void OnRenameTimer();
void OnRenameAccept();
void OnMouse( wxMouseEvent &event );
- void MoveToFocus();
// called to switch the selection from the current item to newCurrent,
void OnArrowChar( size_t newCurrent, const wxKeyEvent& event );
int GetSelectedItemCount();
// set the scrollbars and update the positions of the items
- void RecalculatePositions();
+ void RecalculatePositions(bool noRefresh = FALSE);
// refresh the window and the header
void RefreshAll();
// initialize the current item if needed
void UpdateCurrent();
+ // delete all items but don't refresh: called from dtor
+ void DoDeleteAllItems();
+
// called when an item is [un]focuded, i.e. becomes [not] current
//
// currently unused
return FALSE;
}
-void wxSelectionStore::SelectRange(size_t itemFrom, size_t itemTo, bool select)
+bool wxSelectionStore::SelectRange(size_t itemFrom, size_t itemTo,
+ bool select,
+ wxArrayInt *itemsChanged)
{
+ // 100 is hardcoded but it shouldn't matter much: the important thing is
+ // that we don't refresh everything when really few (e.g. 1 or 2) items
+ // change state
+ static const size_t MANY_ITEMS = 100;
+
wxASSERT_MSG( itemFrom <= itemTo, _T("should be in order") );
// are we going to have more [un]selected items than the other ones?
- if ( itemTo - itemFrom > m_count / 2 )
+ if ( itemTo - itemFrom > m_count/2 )
{
if ( select != m_defaultState )
{
if ( selOld.Index(item) == wxNOT_FOUND )
m_itemsSel.Add(item);
}
+
+ // many items (> half) changed state
+ itemsChanged = NULL;
}
else // select == m_defaultState
{
// delete all of them (from end to avoid changing indices)
for ( int i = end; i >= (int)start; i-- )
{
+ if ( itemsChanged )
+ {
+ if ( itemsChanged->GetCount() > MANY_ITEMS )
+ {
+ // stop counting (see comment below)
+ itemsChanged = NULL;
+ }
+
+ itemsChanged->Add(m_itemsSel[i]);
+ }
+
m_itemsSel.RemoveAt(i);
}
}
}
else // "few" items change state
{
+ if ( itemsChanged )
+ {
+ itemsChanged->Empty();
+ }
+
// just add the items to the selection
for ( size_t item = itemFrom; item <= itemTo; item++ )
{
- SelectItem(item, select);
+ if ( SelectItem(item, select) && itemsChanged )
+ {
+ itemsChanged->Add(item);
+
+ if ( itemsChanged->GetCount() > MANY_ITEMS )
+ {
+ // stop counting them, we'll just eat gobs of memory
+ // for nothing at all - faster to refresh everything in
+ // this case
+ itemsChanged = NULL;
+ }
+ }
}
}
+
+ // we set it to NULL if there are many items changing state
+ return itemsChanged != NULL;
}
void wxSelectionStore::OnItemDelete(size_t item)
item->SetAttr(attr);
}
-void wxListLineData::SetAttributes(wxDC *dc,
+bool wxListLineData::SetAttributes(wxDC *dc,
const wxListItemAttr *attr,
- const wxColour& colText,
- const wxFont& font,
- bool highlight)
+ bool highlighted)
{
- // don't use foregroud colour for drawing highlighted items - this might
+ wxWindow *listctrl = m_owner->GetParent();
+
+ // fg colour
+
+ // don't use foreground colour for drawing highlighted items - this might
// make them completely invisible (and there is no way to do bit
// arithmetics on wxColour, unfortunately)
- if ( !highlight && attr && attr->HasTextColour() )
+ wxColour colText;
+ if ( highlighted )
{
- dc->SetTextForeground(attr->GetTextColour());
+ colText = wxSystemSettings::GetSystemColour(wxSYS_COLOUR_HIGHLIGHTTEXT);
}
else
{
- dc->SetTextForeground(colText);
+ if ( attr && attr->HasTextColour() )
+ {
+ colText = attr->GetTextColour();
+ }
+ else
+ {
+ colText = listctrl->GetForegroundColour();
+ }
}
+ dc->SetTextForeground(colText);
+
+ // font
+ wxFont font;
if ( attr && attr->HasFont() )
{
- dc->SetFont(attr->GetFont());
+ font = attr->GetFont();
}
else
{
- dc->SetFont(font);
+ font = listctrl->GetFont();
+ }
+
+ dc->SetFont(font);
+
+ // bg colour
+ bool hasBgCol = attr && attr->HasBackgroundColour();
+ if ( highlighted || hasBgCol )
+ {
+ if ( highlighted )
+ {
+ dc->SetBrush( *m_owner->m_highlightBrush );
+ }
+ else
+ {
+ dc->SetBrush(wxBrush(attr->GetBackgroundColour(), wxSOLID));
+ }
+
+ dc->SetPen( *wxTRANSPARENT_PEN );
+
+ return TRUE;
}
+
+ return FALSE;
}
void wxListLineData::Draw( wxDC *dc )
wxListItemDataList::Node *node = m_items.GetFirst();
wxCHECK_RET( node, _T("no subitems at all??") );
+ bool highlighted = IsHighlighted();
+
+ wxListItemAttr *attr = GetAttr();
+
+ if ( SetAttributes(dc, attr, highlighted) )
+ {
+ dc->DrawRectangle( m_gi->m_rectHighlight );
+ }
+
wxListItemData *item = node->GetData();
if (item->HasImage())
{
const wxRect& rectHL,
bool highlighted )
{
- // use our own flag if we maintain it
- if ( !IsVirtual() )
- highlighted = m_highlighted;
-
- // default foreground colour
- wxWindow *listctrl = m_owner->GetParent();
- wxColour colText;
- if ( highlighted )
- {
- colText = wxSystemSettings::GetSystemColour( wxSYS_COLOUR_HIGHLIGHTTEXT );
- }
- else
- {
- colText = listctrl->GetForegroundColour();
- }
-
- // default font
- wxFont font = listctrl->GetFont();
-
// TODO: later we should support setting different attributes for
// different columns - to do it, just add "col" argument to
- // GetAttr() and move this code into the loop below
+ // GetAttr() and move these lines into the loop below
wxListItemAttr *attr = GetAttr();
- SetAttributes(dc, attr, colText, font, highlighted);
-
- bool hasBgCol = attr && attr->HasBackgroundColour();
- if ( highlighted || hasBgCol )
+ if ( SetAttributes(dc, attr, highlighted) )
{
- if ( highlighted )
- {
- dc->SetBrush( *m_owner->m_highlightBrush );
- }
- else
- {
- if ( hasBgCol )
- dc->SetBrush(wxBrush(attr->GetBackgroundColour(), wxSOLID));
- else
- dc->SetBrush( * wxWHITE_BRUSH );
- }
-
- dc->SetPen( * wxTRANSPARENT_PEN );
dc->DrawRectangle( rectHL );
}
wxListMainWindow::~wxListMainWindow()
{
- DeleteEverything();
+ DoDeleteAllItems();
delete m_highlightBrush;
}
}
-void wxListMainWindow::HighlightLines( size_t lineFrom, size_t lineTo, bool highlight )
+void wxListMainWindow::HighlightLines( size_t lineFrom,
+ size_t lineTo,
+ bool highlight )
{
if ( IsVirtual() )
{
- m_selStore.SelectRange(lineFrom, lineTo, highlight);
- RefreshLines(lineFrom, lineTo);
+ wxArrayInt linesChanged;
+ if ( !m_selStore.SelectRange(lineFrom, lineTo, highlight,
+ &linesChanged) )
+ {
+ // meny items changed state, refresh everything
+ RefreshLines(lineFrom, lineTo);
+ }
+ else // only a few items changed state, refresh only them
+ {
+ size_t count = linesChanged.GetCount();
+ for ( size_t n = 0; n < count; n++ )
+ {
+ RefreshLine(linesChanged[n]);
+ }
+ }
}
- else
+ else // iterate over all items in non report view
{
- // do it the dumb way
- bool needsRefresh = FALSE;
for ( size_t line = lineFrom; line <= lineTo; line++ )
{
if ( HighlightLine(line, highlight) )
- needsRefresh = TRUE;
+ {
+ RefreshLine(line);
+ }
}
-
- if ( needsRefresh )
- RefreshLines(lineFrom, lineTo);
}
}
void wxListMainWindow::RefreshLine( size_t line )
{
+ if ( HasFlag(wxLC_REPORT) )
+ {
+ size_t visibleFrom, visibleTo;
+ GetVisibleLinesRange(&visibleFrom, &visibleTo);
+
+ if ( line < visibleFrom || line > visibleTo )
+ return;
+ }
+
wxRect rect = GetLineRect(line);
CalcScrolledPosition( rect.x, rect.y, &rect.x, &rect.y );
rect.x = 0;
rect.y = GetLineY(lineFrom);
rect.width = GetClientSize().x;
- rect.height = GetLineY(lineTo) - rect.y;
+ rect.height = GetLineY(lineTo) - rect.y + GetLineHeight();
CalcScrolledPosition( rect.x, rect.y, &rect.x, &rect.y );
RefreshRect( rect );
wxCoord xOrig, yOrig;
CalcUnscrolledPosition(0, 0, &xOrig, &yOrig);
+ // tell the caller cache to cache the data
+ if ( IsVirtual() )
+ {
+ wxListEvent evCache(wxEVT_COMMAND_LIST_CACHE_HINT,
+ GetParent()->GetId());
+ evCache.SetEventObject( GetParent() );
+ evCache.m_oldItemIndex = visibleFrom;
+ evCache.m_itemIndex = visibleTo;
+ GetParent()->GetEventHandler()->ProcessEvent( evCache );
+ }
+
for ( size_t line = visibleFrom; line <= visibleTo; line++ )
{
rectLine = GetLineRect(line);
GetLine(line)->DrawInReportMode( &dc,
rectLine,
GetLineHighlightRect(line),
- IsHighlighted(line) );
+ m_hasFocus && IsHighlighted(line) );
}
if ( HasFlag(wxLC_HRULES) )
}
}
- if ( HasCurrent() && m_hasFocus )
+ if ( HasCurrent() )
{
+ // don't draw rect outline under Max if we already have the background
+ // color
#ifdef __WXMAC__
- // no rect outline, we already have the background color
-#else
- dc.SetPen( *wxBLACK_PEN );
- dc.SetBrush( *wxTRANSPARENT_BRUSH );
- dc.DrawRectangle( GetLineHighlightRect(m_current) );
-#endif
+ if ( !m_hasFocus )
+#endif // !__WXMAC__
+ {
+ dc.SetPen( *wxBLACK_PEN );
+ dc.SetBrush( *wxTRANSPARENT_BRUSH );
+ dc.DrawRectangle( GetLineHighlightRect(m_current) );
+ }
}
dc.EndDrawing();
if ( point != wxDefaultPosition )
le.m_pointDrag = point;
- GetLine(line)->GetItem( 0, le.m_item );
+ // don't try to get the line info for virtual list controls: the main
+ // program has it anyhow and if we did it would result in accessing all
+ // the lines, even those which are not visible now and this is precisely
+ // what we're trying to avoid
+ if ( !IsVirtual() && (command != wxEVT_COMMAND_LIST_DELETE_ITEM) )
+ {
+ GetLine(line)->GetItem( 0, le.m_item );
+ }
+ //else: there may be no more such item
+
GetParent()->GetEventHandler()->ProcessEvent( le );
}
}
}
-void wxListMainWindow::MoveToFocus()
+void wxListMainWindow::MoveToItem(size_t item)
{
- if ( !HasCurrent() )
+ if ( item == (size_t)-1 )
return;
- wxRect rect = GetLineRect(m_current);
+ wxRect rect = GetLineRect(item);
int client_w, client_h;
GetClientSize( &client_w, &client_h );
le.m_itemIndex = m_current;
GetLine(m_current)->GetItem( 0, le.m_item );
GetParent()->GetEventHandler()->ProcessEvent( le );
+
+ if ( IsHighlighted(m_current) )
+ {
+ // don't unselect the item in single selection mode
+ break;
+ }
+ //else: select it in ReverseHighlight() below if unselected
}
- else
- {
- ReverseHighlight(m_current);
- }
+
+ ReverseHighlight(m_current);
break;
case WXK_RETURN:
_T("invalid list ctrl item index in SetItem") );
size_t oldCurrent = m_current;
- size_t item = (size_t)litem; // sdafe because of the check above
+ size_t item = (size_t)litem; // safe because of the check above
+ // do we need to change the focus?
if ( stateMask & wxLIST_STATE_FOCUSED )
{
if ( state & wxLIST_STATE_FOCUSED )
m_current = item;
OnFocusLine( m_current );
- if ( IsSingleSel() && (oldCurrent != (size_t)-1) )
+ if ( oldCurrent != (size_t)-1 )
{
- HighlightLine(oldCurrent, FALSE);
+ if ( IsSingleSel() )
+ {
+ HighlightLine(oldCurrent, FALSE);
+ }
+
RefreshLine(oldCurrent);
}
{
OnUnfocusLine( m_current );
m_current = (size_t)-1;
+
+ RefreshLine( oldCurrent );
}
}
}
+ // do we need to change the selection state?
if ( stateMask & wxLIST_STATE_SELECTED )
{
bool on = (state & wxLIST_STATE_SELECTED) != 0;
ResetVisibleLinesRange();
- Refresh();
+ // scrollbars must be reset
+ m_dirty = TRUE;
}
int wxListMainWindow::GetSelectedItemCount()
// geometry calculation
// ----------------------------------------------------------------------------
-void wxListMainWindow::RecalculatePositions()
+void wxListMainWindow::RecalculatePositions(bool noRefresh)
{
- if ( IsEmpty() )
- return;
-
wxClientDC dc( this );
dc.SetFont( GetFont() );
SetScrollbars( m_xScroll, m_yScroll, (entireWidth+SCROLL_UNIT_X) / m_xScroll, 0, scroll_pos, 0, TRUE );
}
- // FIXME: why should we call it from here?
- UpdateCurrent();
+ if ( !noRefresh )
+ {
+ // FIXME: why should we call it from here?
+ UpdateCurrent();
- RefreshAll();
+ RefreshAll();
+ }
}
void wxListMainWindow::RefreshAll()
Refresh();
wxListHeaderWindow *headerWin = GetListCtrl()->m_headerWin;
- if ( headerWin )
+ if ( headerWin && headerWin->m_dirty )
{
headerWin->m_dirty = FALSE;
headerWin->Refresh();
size_t index = (size_t)lindex;
- m_dirty = TRUE;
-
- // select the next item when the selected one is deleted
- if ( m_current == index )
+ // we don't need to adjust the index for the previous items
+ if ( HasCurrent() && m_current >= index )
{
- // the last valid index after deleting the item will be count-2
- if ( m_current == count - 1 )
+ // if the current item is being deleted, we want the next one to
+ // become selected - unless there is no next one - so don't adjust
+ // m_current in this case
+ if ( m_current != index || m_current == count - 1 )
{
m_current--;
}
}
- SendNotify( index, wxEVT_COMMAND_LIST_DELETE_ITEM );
-
if ( InReportView() )
{
ResetVisibleLinesRange();
m_lines.RemoveAt( index );
}
+ // we need to refresh the (vert) scrollbar as the number of items changed
m_dirty = TRUE;
+
+ SendNotify( index, wxEVT_COMMAND_LIST_DELETE_ITEM );
+
RefreshAfter(index);
}
m_columns.DeleteNode( node );
}
-void wxListMainWindow::DeleteAllItems()
+void wxListMainWindow::DoDeleteAllItems()
{
if ( IsEmpty() )
{
}
m_lines.Clear();
+}
- // NB: don't just set m_dirty to TRUE here as RecalculatePositions()
- // doesn't do anything if the control is empty and so we won't be
- // refreshed
- Refresh();
+void wxListMainWindow::DeleteAllItems()
+{
+ DoDeleteAllItems();
+
+ RecalculatePositions();
}
void wxListMainWindow::DeleteEverything()
_T("invalid index in EnsureVisible") );
// We have to call this here because the label in question might just have
- // been added and no screen update taken place.
- if (m_dirty)
- wxSafeYield();
+ // been added and its position is not known yet
+ if ( m_dirty )
+ {
+ m_dirty = FALSE;
- size_t oldCurrent = m_current;
- m_current = (size_t)index;
- MoveToFocus();
- m_current = oldCurrent;
+ RecalculatePositions(TRUE /* no refresh */);
+ }
+
+ MoveToItem((size_t)index);
}
long wxListMainWindow::FindItem(long start, const wxString& str, bool WXUNUSED(partial) )
// -------------------------------------------------------------------------------------
IMPLEMENT_DYNAMIC_CLASS(wxListCtrl, wxControl)
+IMPLEMENT_DYNAMIC_CLASS(wxListView, wxListCtrl)
BEGIN_EVENT_TABLE(wxListCtrl,wxControl)
EVT_SIZE(wxListCtrl::OnSize)
{
m_mainWin->DeleteEverything();
- int width = 0;
- int height = 0;
- GetClientSize( &width, &height );
+ // has the header visibility changed?
+ bool hasHeader = HasFlag(wxLC_REPORT) && !HasFlag(wxLC_NO_HEADER),
+ willHaveHeader = (flag & wxLC_REPORT) && !(flag & wxLC_NO_HEADER);
- if (flag & wxLC_REPORT)
+ if ( hasHeader != willHaveHeader )
{
- if (!HasFlag(wxLC_REPORT))
+ // toggle it
+ if ( hasHeader )
+ {
+ if ( m_headerWin )
+ {
+ // don't delete, just hide, as we can reuse it later
+ m_headerWin->Show(FALSE);
+ }
+ //else: nothing to do
+ }
+ else // must show header
{
if (!m_headerWin)
{
CreateHeaderWindow();
-
- if (HasFlag(wxLC_NO_HEADER))
- m_headerWin->Show( FALSE );
}
- else
+ else // already have it, just show
{
- if (flag & wxLC_NO_HEADER)
- m_headerWin->Show( FALSE );
- else
- m_headerWin->Show( TRUE );
+ m_headerWin->Show( TRUE );
}
}
- }
- else // !report
- {
- if ( m_mainWin->HasHeader() )
- {
- m_headerWin->Show( FALSE );
- }
+
+ ResizeReportView(willHaveHeader);
}
}
if ( !m_mainWin )
return;
+ ResizeReportView(m_mainWin->HasHeader());
+
+ m_mainWin->RecalculatePositions();
+}
+
+void wxListCtrl::ResizeReportView(bool showHeader)
+{
int cw, ch;
GetClientSize( &cw, &ch );
- if ( m_mainWin->HasHeader() )
+ if ( showHeader )
{
m_headerWin->SetSize( 0, 0, cw, HEADER_HEIGHT );
m_mainWin->SetSize( 0, HEADER_HEIGHT + 1, cw, ch - HEADER_HEIGHT - 1 );
{
m_mainWin->SetSize( 0, 0, cw, ch );
}
-
- m_mainWin->RecalculatePositions();
}
void wxListCtrl::OnIdle( wxIdleEvent & event )