better focus handling (blind fix)

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

diff --git a/src/generic/listctrl.cpp b/src/generic/listctrl.cpp
index d06c5c45b83bf636f3a499990a9b4cca8cf2a0a7..2744044c86fbd12e0dc895a9547b174a2158dd48 100644 (file)
--- a/src/generic/listctrl.cpp
+++ b/src/generic/listctrl.cpp
@@ -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

  */
 
 // ============================================================================
  */
 
 // ============================================================================


@@ -175,7 +143,14 @@ public:
     bool SelectItem(size_t item, bool select = TRUE);
 
     // select the range of items
     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;
 
     // return true if the given item is selected
     bool IsSelected(size_t item) const;


@@ -417,10 +392,10 @@ private:
     // get the mode (i.e. style)  of the list control
     inline int GetMode() 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 wxListItemAttr *attr,

-                       const wxColour& colText,
-                       const wxFont& font,

                        bool highlight);
 
     // these are only used by GetImage/SetImage above, we don't support images
                        bool highlight);
 
     // these are only used by GetImage/SetImage above, we don't support images


@@ -895,12 +870,19 @@ bool wxSelectionStore::SelectItem(size_t item, bool select)
     return FALSE;
 }
 
     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?
     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 ( select != m_defaultState )
         {


@@ -927,6 +909,9 @@ void wxSelectionStore::SelectRange(size_t itemFrom, size_t itemTo, bool select)
                 if ( selOld.Index(item) == wxNOT_FOUND )
                     m_itemsSel.Add(item);
             }
                 if ( selOld.Index(item) == wxNOT_FOUND )
                     m_itemsSel.Add(item);
             }

+
+            // many items (> half) changed state
+            itemsChanged = NULL;

         }
         else // select == m_defaultState
         {
         }
         else // select == m_defaultState
         {


@@ -950,6 +935,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-- )
                 {
                 // 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);
                 }
             }
                     m_itemsSel.RemoveAt(i);
                 }
             }


@@ -957,12 +953,31 @@ void wxSelectionStore::SelectRange(size_t itemFrom, size_t itemTo, bool select)
     }
     else // "few" items change state
     {
     }
     else // "few" items change state
     {

+        if ( itemsChanged )
+        {
+            itemsChanged->Empty();
+        }
+

         // just add the items to the selection
         for ( size_t item = itemFrom; item <= itemTo; item++ )
         {
         // 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)
 }
 
 void wxSelectionStore::OnItemDelete(size_t item)


@@ -1518,32 +1533,68 @@ void wxListLineData::SetAttr(wxListItemAttr *attr)
     item->SetAttr(attr);
 }
 
     item->SetAttr(attr);
 }
 

-void wxListLineData::SetAttributes(wxDC *dc,
+bool wxListLineData::SetAttributes(wxDC *dc,

                                    const wxListItemAttr *attr,
                                    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)
     // 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
     {
     }
     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() )
     {
     if ( attr && attr->HasFont() )
     {

-        dc->SetFont(attr->GetFont());
+        font = attr->GetFont();

     }
     else
     {
     }
     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 )
 }
 
 void wxListLineData::Draw( wxDC *dc )


@@ -1551,6 +1602,15 @@ void wxListLineData::Draw( wxDC *dc )
     wxListItemDataList::Node *node = m_items.GetFirst();
     wxCHECK_RET( node, _T("no subitems at all??") );
 
     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())
     {
     wxListItemData *item = node->GetData();
     if (item->HasImage())
     {


@@ -1571,47 +1631,12 @@ void wxListLineData::DrawInReportMode( wxDC *dc,
                                        const wxRect& rectHL,
                                        bool highlighted )
 {
                                        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
     // 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();
     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 );
     }
 
         dc->DrawRectangle( rectHL );
     }
 


@@ -2332,25 +2357,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() )
     {
 {
     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) )
         for ( size_t line = lineFrom; line <= lineTo; line++ )
         {
             if ( HighlightLine(line, highlight) )

-                needsRefresh = TRUE;
+            {
+                RefreshLine(line);
+            }

         }
         }

-
-        if ( needsRefresh )
-            RefreshLines(lineFrom, lineTo);

     }
 }
 
     }
 }
 


@@ -2381,6 +2418,15 @@ bool wxListMainWindow::HighlightLine( size_t line, bool highlight )
 
 void wxListMainWindow::RefreshLine( size_t line )
 {
 
 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 );
     wxRect rect = GetLineRect(line);
 
     CalcScrolledPosition( rect.x, rect.y, &rect.x, &rect.y );


@@ -2515,7 +2561,7 @@ void wxListMainWindow::OnPaint( wxPaintEvent &WXUNUSED(event) )
             GetLine(line)->DrawInReportMode( &dc,
                                              rectLine,
                                              GetLineHighlightRect(line),
             GetLine(line)->DrawInReportMode( &dc,
                                              rectLine,
                                              GetLineHighlightRect(line),

-                                             IsHighlighted(line) );
+                                             m_hasFocus && IsHighlighted(line) );

         }
 
         if ( HasFlag(wxLC_HRULES) )
         }
 
         if ( HasFlag(wxLC_HRULES) )


@@ -2572,15 +2618,18 @@ 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

 #ifdef __WXMAC__
 #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();
     }
 
     dc.EndDrawing();


@@ -2617,7 +2666,11 @@ void wxListMainWindow::SendNotify( size_t line,
     if ( point != wxDefaultPosition )
         le.m_pointDrag = point;
 
     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 );
     }
     {
         GetLine(line)->GetItem( 0, le.m_item );
     }


@@ -3123,11 +3176,16 @@ void wxListMainWindow::OnChar( wxKeyEvent &event )
                 le.m_itemIndex = m_current;
                 GetLine(m_current)->GetItem( 0, le.m_item );
                 GetParent()->GetEventHandler()->ProcessEvent( le );
                 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:
             break;
 
         case WXK_RETURN:


@@ -3448,8 +3506,9 @@ void wxListMainWindow::SetItemState( long litem, long state, long stateMask )
                   _T("invalid list ctrl item index in SetItem") );
 
     size_t oldCurrent = m_current;
                   _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 )
     if ( stateMask & wxLIST_STATE_FOCUSED )
     {
         if ( state & wxLIST_STATE_FOCUSED )


@@ -3461,9 +3520,13 @@ void wxListMainWindow::SetItemState( long litem, long state, long stateMask )
                 m_current = item;
                 OnFocusLine( m_current );
 
                 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);
                 }
 
                     RefreshLine(oldCurrent);
                 }
 


@@ -3477,10 +3540,13 @@ void wxListMainWindow::SetItemState( long litem, long state, long stateMask )
             {
                 OnUnfocusLine( m_current );
                 m_current = (size_t)-1;
             {
                 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;
     if ( stateMask & wxLIST_STATE_SELECTED )
     {
         bool on = (state & wxLIST_STATE_SELECTED) != 0;


@@ -3741,7 +3807,7 @@ void wxListMainWindow::RefreshAll()
     Refresh();
 
     wxListHeaderWindow *headerWin = GetListCtrl()->m_headerWin;
     Refresh();
 
     wxListHeaderWindow *headerWin = GetListCtrl()->m_headerWin;

-    if ( headerWin )
+    if ( headerWin && headerWin->m_dirty )

     {
         headerWin->m_dirty = FALSE;
         headerWin->Refresh();
     {
         headerWin->m_dirty = FALSE;
         headerWin->Refresh();


@@ -3841,6 +3907,7 @@ void wxListMainWindow::DeleteItem( long lindex )
         m_lines.RemoveAt( index );
     }
 
         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 );
     m_dirty = TRUE;
 
     SendNotify( index, wxEVT_COMMAND_LIST_DELETE_ITEM );


@@ -4254,6 +4321,7 @@ void wxListEvent::CopyObject(wxObject& object_dest) const
 // -------------------------------------------------------------------------------------
 
 IMPLEMENT_DYNAMIC_CLASS(wxListCtrl, wxControl)
 // -------------------------------------------------------------------------------------
 
 IMPLEMENT_DYNAMIC_CLASS(wxListCtrl, wxControl)

+IMPLEMENT_DYNAMIC_CLASS(wxListView, wxListCtrl)

 
 BEGIN_EVENT_TABLE(wxListCtrl,wxControl)
   EVT_SIZE(wxListCtrl::OnSize)
 
 BEGIN_EVENT_TABLE(wxListCtrl,wxControl)
   EVT_SIZE(wxListCtrl::OnSize)