Fix HTML help on Mac.

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

diff --git a/src/generic/listctrl.cpp b/src/generic/listctrl.cpp
index 339d5dacd4ceae573c25b811983d3db837f1e8e0..d2f3b996759c4935f5632e7168f236075751a7a0 100644 (file)
--- a/src/generic/listctrl.cpp
+++ b/src/generic/listctrl.cpp
@@ -41,6 +41,10 @@
             ... we have it ourselves ...
         else
             line->GetFoo();
             ... we have it ourselves ...
         else
             line->GetFoo();

+
+   => done
+
+   5. attributes support: we need OnGetItemAttr() as well!

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


@@ -54,7 +58,7 @@
 #ifdef __GNUG__
     #pragma implementation "listctrl.h"
     #pragma implementation "listctrlbase.h"
 #ifdef __GNUG__
     #pragma implementation "listctrl.h"
     #pragma implementation "listctrlbase.h"

-#endif                                                  
+#endif

 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"


@@ -243,7 +247,8 @@ public:
 
     void GetItem( wxListItem &info ) const;
 
 
     void GetItem( wxListItem &info ) const;
 

-    wxListItemAttr *GetAttributes() const { return m_attr; }
+    void SetAttr(wxListItemAttr *attr) { m_attr = attr; }
+    wxListItemAttr *GetAttr() const { return m_attr; }

 
 public:
     // the item image or -1
 
 public:
     // the item image or -1


@@ -380,6 +385,9 @@ public:
     wxString GetText(int index) const;
     void SetText( int index, const wxString s );
 
     wxString GetText(int index) const;
     void SetText( int index, const wxString s );
 

+    wxListItemAttr *GetAttr() const;
+    void SetAttr(wxListItemAttr *attr);
+

     // return true if the highlighting really changed
     bool Highlight( bool on );
 
     // return true if the highlighting really changed
     bool Highlight( bool on );
 


@@ -571,12 +579,17 @@ public:
     void ReverseHighlight( size_t line )
         { HighlightLine(line, !IsHighlighted(line)); RefreshLine(line); }
 
     void ReverseHighlight( size_t line )
         { HighlightLine(line, !IsHighlighted(line)); RefreshLine(line); }
 

+    // return true if the line is highlighted
+    bool IsHighlighted(size_t line) const;
+

     // refresh one or several lines at once
     void RefreshLine( size_t line );
     void RefreshLines( size_t lineFrom, size_t lineTo );
 
     // refresh one or several lines at once
     void RefreshLine( size_t line );
     void RefreshLines( size_t lineFrom, size_t lineTo );
 

-    // return true if the line is highlighted
-    bool IsHighlighted(size_t line) const;
+    // 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)
+    void RefreshAfter( size_t lineFrom );

 
     // the methods which are forwarded to wxListLineData itself in list/icon
     // modes but are here because the lines don't store their positions in the
 
     // the methods which are forwarded to wxListLineData itself in list/icon
     // modes but are here because the lines don't store their positions in the


@@ -1466,6 +1479,24 @@ int wxListLineData::GetImage( int index ) const
     return item->GetImage();
 }
 
     return item->GetImage();
 }
 

+wxListItemAttr *wxListLineData::GetAttr() const
+{
+    wxListItemDataList::Node *node = m_items.GetFirst();
+    wxCHECK_MSG( node, NULL, _T("invalid column index in GetAttr()") );
+
+    wxListItemData *item = node->GetData();
+    return item->GetAttr();
+}
+
+void wxListLineData::SetAttr(wxListItemAttr *attr)
+{
+    wxListItemDataList::Node *node = m_items.GetFirst();
+    wxCHECK_RET( node, _T("invalid column index in SetAttr()") );
+
+    wxListItemData *item = node->GetData();
+    item->SetAttr(attr);
+}
+

 void wxListLineData::SetAttributes(wxDC *dc,
                                    const wxListItemAttr *attr,
                                    const wxColour& colText,
 void wxListLineData::SetAttributes(wxDC *dc,
                                    const wxListItemAttr *attr,
                                    const wxColour& colText,


@@ -1538,11 +1569,10 @@ void wxListLineData::DrawInReportMode( wxDC *dc,
     // default font
     wxFont font = listctrl->GetFont();
 
     // default font
     wxFont font = listctrl->GetFont();
 

-    // VZ: currently we set the colours/fonts only once, but like this (i.e.
-    //     using SetAttributes() inside the loop), it will be trivial to
-    //     customize the subitems (in report mode) too.
-    wxListItemData *item = m_items.GetFirst()->GetData();
-    wxListItemAttr *attr = item->GetAttributes();
+    // 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
+    wxListItemAttr *attr = GetAttr();

     SetAttributes(dc, attr, colText, font, highlighted);
 
     bool hasBgCol = attr && attr->HasBackgroundColour();
     SetAttributes(dc, attr, colText, font, highlighted);
 
     bool hasBgCol = attr && attr->HasBackgroundColour();


@@ -2136,6 +2166,7 @@ void wxListMainWindow::CacheLineData(size_t line)
     }
 
     ld->SetImage(listctrl->OnGetItemImage(line));
     }
 
     ld->SetImage(listctrl->OnGetItemImage(line));

+    ld->SetAttr(listctrl->OnGetItemAttr(line));

 }
 
 wxListLineData *wxListMainWindow::GetDummyLine() const
 }
 
 wxListLineData *wxListMainWindow::GetDummyLine() const


@@ -2340,6 +2371,8 @@ void wxListMainWindow::RefreshLines( size_t lineFrom, size_t lineTo )
     // we suppose that they are ordered by caller
     wxASSERT_MSG( lineFrom <= lineTo, _T("indices in disorder") );
 
     // we suppose that they are ordered by caller
     wxASSERT_MSG( lineFrom <= lineTo, _T("indices in disorder") );
 

+    wxASSERT_MSG( lineTo < GetItemCount(), _T("invalid line range") );
+

     if ( HasFlag(wxLC_REPORT) )
     {
         size_t visibleFrom, visibleTo;
     if ( HasFlag(wxLC_REPORT) )
     {
         size_t visibleFrom, visibleTo;


@@ -2369,6 +2402,35 @@ void wxListMainWindow::RefreshLines( size_t lineFrom, size_t lineTo )
     }
 }
 
     }
 }
 

+void wxListMainWindow::RefreshAfter( size_t lineFrom )
+{
+    if ( HasFlag(wxLC_REPORT) )
+    {
+        size_t visibleFrom;
+        GetVisibleLinesRange(&visibleFrom, NULL);
+
+        if ( lineFrom < visibleFrom )
+            lineFrom = visibleFrom;
+
+        wxRect rect;
+        rect.x = 0;
+        rect.y = GetLineY(lineFrom);
+
+        wxSize size = GetClientSize();
+        rect.width = size.x;
+        // refresh till the bottom of the window
+        rect.height = size.y - rect.y;
+
+        CalcScrolledPosition( rect.x, rect.y, &rect.x, &rect.y );
+        RefreshRect( rect );
+    }
+    else // !report
+    {
+        // TODO: how to do it more efficiently?
+        m_dirty = TRUE;
+    }
+}
+

 void wxListMainWindow::OnPaint( wxPaintEvent &WXUNUSED(event) )
 {
     // Note: a wxPaintDC must be constructed even if no drawing is
 void wxListMainWindow::OnPaint( wxPaintEvent &WXUNUSED(event) )
 {
     // Note: a wxPaintDC must be constructed even if no drawing is


@@ -2381,6 +2443,12 @@ void wxListMainWindow::OnPaint( wxPaintEvent &WXUNUSED(event) )
         return;
     }
 
         return;
     }
 

+    if ( m_dirty )
+    {
+        // delay the repainting until we calculate all the items positions
+        return;
+    }
+

     PrepareDC( dc );
 
     int dev_x, dev_y;
     PrepareDC( dc );
 
     int dev_x, dev_y;


@@ -2396,10 +2464,24 @@ void wxListMainWindow::OnPaint( wxPaintEvent &WXUNUSED(event) )
 
         size_t visibleFrom, visibleTo;
         GetVisibleLinesRange(&visibleFrom, &visibleTo);
 
         size_t visibleFrom, visibleTo;
         GetVisibleLinesRange(&visibleFrom, &visibleTo);

+
+        wxRect rectLine;
+        wxCoord xOrig, yOrig;
+        CalcUnscrolledPosition(0, 0, &xOrig, &yOrig);
+

         for ( size_t line = visibleFrom; line <= visibleTo; line++ )
         {
         for ( size_t line = visibleFrom; line <= visibleTo; line++ )
         {

+            rectLine = GetLineRect(line);
+
+            if ( !IsExposed(rectLine.x - xOrig, rectLine.y - yOrig,
+                            rectLine.width, rectLine.height) )
+            {
+                // don't redraw unaffected lines to avoid flicker
+                continue;
+            }
+

             GetLine(line)->DrawInReportMode( &dc,
             GetLine(line)->DrawInReportMode( &dc,

-                                             GetLineRect(line),
+                                             rectLine,

                                              GetLineHighlightRect(line),
                                              IsHighlighted(line) );
         }
                                              GetLineHighlightRect(line),
                                              IsHighlighted(line) );
         }


@@ -2612,7 +2694,7 @@ void wxListMainWindow::OnMouse( wxMouseEvent &event )
     int y = event.GetY();
     CalcUnscrolledPosition( x, y, &x, &y );
 
     int y = event.GetY();
     CalcUnscrolledPosition( x, y, &x, &y );
 

-    /* Did we actually hit an item ? */
+    // where did we hit it (if we did)?

     long hitResult = 0;
 
     size_t count = GetItemCount(),
     long hitResult = 0;
 
     size_t count = GetItemCount(),


@@ -2621,15 +2703,18 @@ void wxListMainWindow::OnMouse( wxMouseEvent &event )
     if ( HasFlag(wxLC_REPORT) )
     {
         current = y / GetLineHeight();
     if ( HasFlag(wxLC_REPORT) )
     {
         current = y / GetLineHeight();

-        hitResult = HitTestLine(current, x, y);
+        if ( current < count )
+            hitResult = HitTestLine(current, x, y);

     }
     else // !report
     {
         // TODO: optimize it too! this is less simple than for report view but
         //       enumerating all items is still not a way to do it!!
     }
     else // !report
     {
         // TODO: optimize it too! this is less simple than for report view but
         //       enumerating all items is still not a way to do it!!

-        for ( current = 0; current < count && !hitResult; current++ )
+        for ( current = 0; current < count; current++ )

         {
             hitResult = HitTestLine(current, x, y);
         {
             hitResult = HitTestLine(current, x, y);

+            if ( hitResult )
+                break;

         }
     }
 
         }
     }
 


@@ -3302,19 +3387,21 @@ void wxListMainWindow::SetItem( wxListItem &item )
     wxCHECK_RET( id >= 0 && (size_t)id < GetItemCount(),
                  _T("invalid item index in SetItem") );
 
     wxCHECK_RET( id >= 0 && (size_t)id < GetItemCount(),
                  _T("invalid item index in SetItem") );
 

-    if ( IsVirtual() )
+    if ( !IsVirtual() )
+    {
+        wxListLineData *line = GetLine((size_t)id);
+        line->SetItem( item.m_col, item );
+    }
+
+    if ( InReportView() )

     {
         // just refresh the line to show the new value of the text/image
         RefreshLine((size_t)id);
     }
     {
         // just refresh the line to show the new value of the text/image
         RefreshLine((size_t)id);
     }

-    else // !virtual
+    else // !report

     {
     {

+        // refresh everything (resulting in horrible flicker - FIXME!)

         m_dirty = TRUE;
         m_dirty = TRUE;

-
-        wxListLineData *line = GetLine((size_t)id);
-        if ( HasFlag(wxLC_REPORT) )
-            item.m_width = GetColumnWidth( item.m_col );
-        line->SetItem( item.m_col, item );

     }
 }
 
     }
 }
 


@@ -3702,15 +3789,9 @@ void wxListMainWindow::DeleteItem( long lindex )
 
     if ( InReportView() )
     {
 
     if ( InReportView() )
     {

-        if ( m_lineTo == GetItemCount() - 1 )
-        {
-            m_lineTo--;
-        }
+        ResetVisibleLinesRange();

     }
 
     }
 

-    // refresh before removing the line
-    RefreshLines(index, GetItemCount() - 1);
-

     if ( IsVirtual() )
     {
         m_countVirt--;
     if ( IsVirtual() )
     {
         m_countVirt--;


@@ -3721,6 +3802,9 @@ void wxListMainWindow::DeleteItem( long lindex )
     {
         m_lines.RemoveAt( index );
     }
     {
         m_lines.RemoveAt( index );
     }

+
+    m_dirty = TRUE;
+    RefreshAfter(index);

 }
 
 void wxListMainWindow::DeleteColumn( int col )
 }
 
 void wxListMainWindow::DeleteColumn( int col )


@@ -3761,6 +3845,11 @@ void wxListMainWindow::DeleteAllItems()
         ResetVisibleLinesRange();
     }
 
         ResetVisibleLinesRange();
     }
 

+    if ( InReportView() )
+    {
+        ResetVisibleLinesRange();
+    }
+

     m_lines.Clear();
 
     m_selStore.Clear();
     m_lines.Clear();
 
     m_selStore.Clear();


@@ -3893,6 +3982,7 @@ void wxListMainWindow::InsertItem( wxListItem &item )
 
     m_lines.Insert( line, id );
 
 
     m_lines.Insert( line, id );
 

+    m_dirty = TRUE;

     RefreshLines(id, GetItemCount() - 1);
 }
 
     RefreshLines(id, GetItemCount() - 1);
 }
 


@@ -3989,19 +4079,32 @@ void wxListMainWindow::GetVisibleLinesRange(size_t *from, size_t *to)
 
     if ( m_lineFrom == (size_t)-1 )
     {
 
     if ( m_lineFrom == (size_t)-1 )
     {

-        m_lineFrom = GetScrollPos(wxVERTICAL);
-

         size_t count = GetItemCount();
         size_t count = GetItemCount();

+        if ( count )
+        {
+            m_lineFrom = GetScrollPos(wxVERTICAL);

 
 

-        wxASSERT_MSG( m_lineFrom < count, _T("invalid scroll position?") );
+            // this may happen if SetScrollbars() hadn't been called yet
+            if ( m_lineFrom >= count )
+                m_lineFrom = count - 1;

 
 

-        // we redraw one extra line but this is needed to make the redrawing
-        // logic work when there is a fractional number of lines on screen
-        m_lineTo = m_lineFrom + m_linesPerPage;
-        if ( m_lineTo >= count )
-            m_lineTo = count - 1;
+            // we redraw one extra line but this is needed to make the redrawing
+            // logic work when there is a fractional number of lines on screen
+            m_lineTo = m_lineFrom + m_linesPerPage;
+            if ( m_lineTo >= count )
+                m_lineTo = count - 1;
+        }
+        else // empty control
+        {
+            m_lineFrom = 0;
+            m_lineTo = (size_t)-1;
+        }

     }
 
     }
 

+    wxASSERT_MSG( IsEmpty() ||
+                  (m_lineFrom <= m_lineTo && m_lineTo < GetItemCount()),
+                  _T("GetVisibleLinesRange() returns incorrect result") );
+

     if ( from )
         *from = m_lineFrom;
     if ( to )
     if ( from )
         *from = m_lineFrom;
     if ( to )


@@ -4801,6 +4904,15 @@ int wxListCtrl::OnGetItemImage(long item) const
     return -1;
 }
 
     return -1;
 }
 

+wxListItemAttr *wxListCtrl::OnGetItemAttr(long item) const
+{
+    wxASSERT_MSG( item >= 0 && item < GetItemCount(),
+                  _T("invalid item index in OnGetItemAttr()") );
+
+    // no attributes by default
+    return NULL;
+}
+

 void wxListCtrl::SetItemCount(long count)
 {
     wxASSERT_MSG( IsVirtual(), _T("this is for virtual controls only") );
 void wxListCtrl::SetItemCount(long count)
 {
     wxASSERT_MSG( IsVirtual(), _T("this is for virtual controls only") );


@@ -4808,4 +4920,14 @@ void wxListCtrl::SetItemCount(long count)
     m_mainWin->SetItemCount(count);
 }
 
     m_mainWin->SetItemCount(count);
 }
 

+void wxListCtrl::RefreshItem(long item)
+{
+    m_mainWin->RefreshLine(item);
+}
+
+void wxListCtrl::RefreshItems(long itemFrom, long itemTo)
+{
+    m_mainWin->RefreshLines(itemFrom, itemTo);
+}
+

 #endif // wxUSE_LISTCTRL
 #endif // wxUSE_LISTCTRL