]> git.saurik.com Git - wxWidgets.git/blobdiff - src/generic/listctrl.cpp
removed extra wxSTD
[wxWidgets.git] / src / generic / listctrl.cpp
index ded1c6718d076bc10e83d707f9d7299842776e48..3ca9aa51ac246068d14ce0ea51f89c1c82a66568 100644 (file)
@@ -9,42 +9,10 @@
 /////////////////////////////////////////////////////////////////////////////
 
 /*
-   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
  */
 
 // ============================================================================
@@ -131,6 +99,9 @@ static const int AUTOSIZE_COL_MARGIN = 10;
 static const int WIDTH_COL_DEFAULT = 80;
 static const int WIDTH_COL_MIN = 10;
 
+// the space between the image and the text in the report mode
+static const int IMAGE_MARGIN_IN_REPORT_MODE = 5;
+
 // ============================================================================
 // private classes
 // ============================================================================
@@ -175,7 +146,14 @@ public:
     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;
@@ -587,6 +565,9 @@ public:
     void RefreshLine( size_t line );
     void RefreshLines( size_t lineFrom, size_t lineTo );
 
+    // refresh all selected items
+    void RefreshSelected();
+
     // refresh all lines below the given one: the difference with
     // RefreshLines() is that the index here might not be a valid one (happens
     // when the last line is deleted)
@@ -722,6 +703,12 @@ public:
     // get the y position of the given line (only for report view)
     wxCoord GetLineY(size_t line) const;
 
+    // get the brush to use for the item highlighting
+    wxBrush *GetHighlightBrush() const
+    {
+        return m_hasFocus ? m_highlightBrush : m_highlightUnfocusedBrush;
+    }
+
 //protected:
     // the array of all line objects for a non virtual list control
     wxListLineDataArray  m_lines;
@@ -746,7 +733,6 @@ public:
     // call
     bool                 m_dirty;
 
-    wxBrush             *m_highlightBrush;
     wxColour            *m_highlightColour;
     int                  m_xScroll,
                          m_yScroll;
@@ -845,6 +831,10 @@ private:
     size_t m_lineFrom,
            m_lineTo;
 
+    // the brushes to use for item highlighting when we do/don't have focus
+    wxBrush *m_highlightBrush,
+            *m_highlightUnfocusedBrush;
+
     DECLARE_DYNAMIC_CLASS(wxListMainWindow);
     DECLARE_EVENT_TABLE()
 };
@@ -895,12 +885,19 @@ bool wxSelectionStore::SelectItem(size_t item, bool select)
     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 )
         {
@@ -927,6 +924,9 @@ void wxSelectionStore::SelectRange(size_t itemFrom, size_t itemTo, bool select)
                 if ( selOld.Index(item) == wxNOT_FOUND )
                     m_itemsSel.Add(item);
             }
+
+            // many items (> half) changed state
+            itemsChanged = NULL;
         }
         else // select == m_defaultState
         {
@@ -950,6 +950,17 @@ void wxSelectionStore::SelectRange(size_t itemFrom, size_t itemTo, bool select)
                 // 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);
                 }
             }
@@ -957,12 +968,31 @@ void wxSelectionStore::SelectRange(size_t itemFrom, size_t itemTo, bool select)
     }
     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)
@@ -1567,7 +1597,7 @@ bool wxListLineData::SetAttributes(wxDC *dc,
     {
         if ( highlighted )
         {
-            dc->SetBrush( *m_owner->m_highlightBrush );
+            dc->SetBrush( *m_owner->GetHighlightBrush() );
         }
         else
         {
@@ -1607,6 +1637,8 @@ void wxListLineData::Draw( wxDC *dc )
     if (item->HasText())
     {
         wxRect rectLabel = m_gi->m_rectLabel;
+
+        wxDCClipper clipper(*dc, rectLabel);
         dc->DrawText( item->GetText(), rectLabel.x, rectLabel.y );
     }
 }
@@ -1616,10 +1648,6 @@ void wxListLineData::DrawInReportMode( wxDC *dc,
                                        const wxRect& rectHL,
                                        bool highlighted )
 {
-    // use our own flag if we maintain it
-    if ( !IsVirtual() )
-        highlighted = m_highlighted;
-
     // TODO: later we should support setting different attributes for
     //       different columns - to do it, just add "col" argument to
     //       GetAttr() and move these lines into the loop below
@@ -1640,27 +1668,29 @@ void wxListLineData::DrawInReportMode( wxDC *dc,
     {
         wxListItemData *item = node->GetData();
 
+        int width = m_owner->GetColumnWidth(col++);
         int xOld = x;
+        x += width;
 
         if ( item->HasImage() )
         {
             int ix, iy;
-            m_owner->DrawImage( item->GetImage(), dc, x, y );
+            m_owner->DrawImage( item->GetImage(), dc, xOld, y );
             m_owner->GetImageSize( item->GetImage(), ix, iy );
-            x += ix + 5; // FIXME: what is "5"?
-        }
 
-        int width = m_owner->GetColumnWidth(col++);
+            ix += IMAGE_MARGIN_IN_REPORT_MODE;
 
-        wxDCClipper clipper(*dc, x, y, width, rect.height);
+            xOld += ix;
+            width -= ix;
+        }
+
+        wxDCClipper clipper(*dc, xOld, y, width, rect.height);
 
         if ( item->HasText() )
         {
-            dc->DrawText( item->GetText(), x, y );
+            dc->DrawText( item->GetText(), xOld, y );
         }
 
-        x = xOld + width;
-
         node = node->GetNext();
     }
 }
@@ -1834,9 +1864,11 @@ void wxListHeaderWindow::OnPaint( wxPaintEvent &WXUNUSED(event) )
         dc.SetPen( *wxWHITE_PEN );
 
         DoDrawRect( &dc, x, HEADER_OFFSET_Y, cw, h-2 );
-        dc.SetClippingRegion( x, HEADER_OFFSET_Y, cw-5, h-4 );
-        dc.DrawText( item.GetText(), x + EXTRA_WIDTH, HEADER_OFFSET_Y + EXTRA_HEIGHT );
-        dc.DestroyClippingRegion();
+        wxDCClipper clipper(dc, x, HEADER_OFFSET_Y, cw-5, h-4 );
+
+        dc.DrawText( item.GetText(),
+                     x + EXTRA_WIDTH, HEADER_OFFSET_Y + EXTRA_HEIGHT );
+
         x += wCol;
 
         if (xEnd > w+5)
@@ -2152,7 +2184,8 @@ wxListMainWindow::wxListMainWindow()
 {
     Init();
 
-    m_highlightBrush = (wxBrush *) NULL;
+    m_highlightBrush =
+    m_highlightUnfocusedBrush = (wxBrush *) NULL;
 
     m_xScroll =
     m_yScroll = 0;
@@ -2169,7 +2202,24 @@ wxListMainWindow::wxListMainWindow( wxWindow *parent,
 {
     Init();
 
-    m_highlightBrush = new wxBrush( wxSystemSettings::GetSystemColour(wxSYS_COLOUR_HIGHLIGHT), wxSOLID );
+    m_highlightBrush = new wxBrush
+                           (
+                            wxSystemSettings::GetSystemColour
+                            (
+                                wxSYS_COLOUR_HIGHLIGHT
+                            ),
+                            wxSOLID
+                           );
+
+    m_highlightUnfocusedBrush = new wxBrush
+                                    (
+                                       wxSystemSettings::GetSystemColour
+                                       (
+                                           wxSYS_COLOUR_BTNSHADOW
+                                       ),
+                                       wxSOLID
+                                    );
+
     wxSize sz = size;
     sz.y = 25;
 
@@ -2184,6 +2234,7 @@ wxListMainWindow::~wxListMainWindow()
     DoDeleteAllItems();
 
     delete m_highlightBrush;
+    delete m_highlightUnfocusedBrush;
 
     delete m_renameTimer;
 }
@@ -2346,25 +2397,37 @@ bool wxListMainWindow::IsHighlighted(size_t line) const
     }
 }
 
-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);
     }
 }
 
@@ -2379,7 +2442,7 @@ bool wxListMainWindow::HighlightLine( size_t line, bool highlight )
     else // !virtual
     {
         wxListLineData *ld = GetLine(line);
-        wxCHECK_MSG( ld, FALSE, _T("invalid index in IsHighlighted") );
+        wxCHECK_MSG( ld, FALSE, _T("invalid index in HighlightLine") );
 
         changed = ld->Highlight(highlight);
     }
@@ -2395,6 +2458,15 @@ bool wxListMainWindow::HighlightLine( size_t line, bool highlight )
 
 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 );
@@ -2466,6 +2538,37 @@ void wxListMainWindow::RefreshAfter( size_t lineFrom )
     }
 }
 
+void wxListMainWindow::RefreshSelected()
+{
+    if ( IsEmpty() )
+        return;
+
+    size_t from, to;
+    if ( InReportView() )
+    {
+        GetVisibleLinesRange(&from, &to);
+    }
+    else // !virtual
+    {
+        from = 0;
+        to = GetItemCount() - 1;
+    }
+
+    if ( HasCurrent() && m_current > from && m_current <= to )
+    {
+        RefreshLine(m_current);
+    }
+
+    for ( size_t line = from; line <= to; line++ )
+    {
+        // NB: the test works as expected even if m_current == -1
+        if ( line != m_current && IsHighlighted(line) )
+        {
+            RefreshLine(line);
+        }
+    }
+}
+
 void wxListMainWindow::OnPaint( wxPaintEvent &WXUNUSED(event) )
 {
     // Note: a wxPaintDC must be constructed even if no drawing is
@@ -2586,15 +2689,21 @@ void wxListMainWindow::OnPaint( wxPaintEvent &WXUNUSED(event) )
         }
     }
 
-    if ( HasCurrent() && m_hasFocus )
+    if ( HasCurrent() )
     {
+        // don't draw rect outline under Max if we already have the background
+        // color but under other platforms only draw it if we do: it is a bit
+        // silly to draw "focus rect" if we don't have focus!
 #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 )
+#else // !__WXMAC__
+        if ( m_hasFocus )
+#endif // __WXMAC__/!__WXMAC__
+        {
+            dc.SetPen( *wxBLACK_PEN );
+            dc.SetBrush( *wxTRANSPARENT_BRUSH );
+            dc.DrawRectangle( GetLineHighlightRect(m_current) );
+        }
     }
 
     dc.EndDrawing();
@@ -2631,7 +2740,11 @@ void wxListMainWindow::SendNotify( size_t line,
     if ( point != wxDefaultPosition )
         le.m_pointDrag = point;
 
-    if ( command != wxEVT_COMMAND_LIST_DELETE_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 );
     }
@@ -3137,11 +3250,16 @@ void wxListMainWindow::OnChar( wxKeyEvent &event )
                 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:
@@ -3173,12 +3291,11 @@ void wxListMainWindow::OnSetFocus( wxFocusEvent &WXUNUSED(event) )
 {
     m_hasFocus = TRUE;
 
-    if ( HasCurrent() )
-        RefreshLine( m_current );
-
     if (!GetParent())
         return;
 
+    RefreshSelected();
+
 #ifdef __WXGTK__
     g_focusWindow = GetParent();
 #endif
@@ -3192,8 +3309,7 @@ void wxListMainWindow::OnKillFocus( wxFocusEvent &WXUNUSED(event) )
 {
     m_hasFocus = FALSE;
 
-    if ( HasCurrent() )
-        RefreshLine( m_current );
+    RefreshSelected();
 }
 
 void wxListMainWindow::DrawImage( int index, wxDC *dc, int x, int y )
@@ -3462,8 +3578,9 @@ void wxListMainWindow::SetItemState( long litem, long state, long stateMask )
                   _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 )
@@ -3475,9 +3592,13 @@ void wxListMainWindow::SetItemState( long litem, long state, long stateMask )
                 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);
                 }
 
@@ -3491,10 +3612,13 @@ void wxListMainWindow::SetItemState( long litem, long state, long stateMask )
             {
                 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;
@@ -3755,7 +3879,7 @@ void wxListMainWindow::RefreshAll()
     Refresh();
 
     wxListHeaderWindow *headerWin = GetListCtrl()->m_headerWin;
-    if ( headerWin )
+    if ( headerWin && headerWin->m_dirty )
     {
         headerWin->m_dirty = FALSE;
         headerWin->Refresh();
@@ -3855,6 +3979,7 @@ void wxListMainWindow::DeleteItem( long lindex )
         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 );
@@ -3933,8 +4058,6 @@ void wxListMainWindow::EnsureVisible( long index )
     // been added and its position is not known yet
     if ( m_dirty )
     {
-        m_dirty = FALSE;
-
         RecalculatePositions(TRUE /* no refresh */);
     }
 
@@ -4268,6 +4391,7 @@ void wxListEvent::CopyObject(wxObject& object_dest) const
 // -------------------------------------------------------------------------------------
 
 IMPLEMENT_DYNAMIC_CLASS(wxListCtrl, wxControl)
+IMPLEMENT_DYNAMIC_CLASS(wxListView, wxListCtrl)
 
 BEGIN_EVENT_TABLE(wxListCtrl,wxControl)
   EVT_SIZE(wxListCtrl::OnSize)