renamed Number method (should be GetCount)

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

diff --git a/src/generic/listctrl.cpp b/src/generic/listctrl.cpp
index 4a94a65b79e934ed91927e7336e154c666414815..23f67b2520cc17be46a53d9fe52d387851b065da 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"


@@ -96,6 +100,7 @@ DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_CLICK)
 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK)
 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK)
 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_ACTIVATED)
 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK)
 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK)
 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_ACTIVATED)

+DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_CACHE_HINT)

 
 // ----------------------------------------------------------------------------
 // constants
 
 // ----------------------------------------------------------------------------
 // constants


@@ -208,7 +213,7 @@ class WXDLLEXPORT wxListItemData
 {
 public:
     wxListItemData(wxListMainWindow *owner);
 {
 public:
     wxListItemData(wxListMainWindow *owner);

-    ~wxListItemData() { delete m_attr; delete m_rect; }
+    ~wxListItemData();

 
     void SetItem( const wxListItem &info );
     void SetImage( int image ) { m_image = image; }
 
     void SetItem( const wxListItem &info );
     void SetImage( int image ) { m_image = image; }


@@ -243,7 +248,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 +386,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 );
 


@@ -607,12 +616,17 @@ public:
     // return the hit code for the corresponding position (in this line)
     long HitTestLine(size_t line, int x, int y) const;
 
     // 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 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 );
 
     // called to switch the selection from the current item to newCurrent,
     void OnArrowChar( size_t newCurrent, const wxKeyEvent& event );


@@ -653,7 +667,7 @@ public:
     int GetSelectedItemCount();
 
     // set the scrollbars and update the positions of the items
     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();
 
     // refresh the window and the header
     void RefreshAll();


@@ -810,6 +824,9 @@ private:
     // initialize the current item if needed
     void UpdateCurrent();
 
     // 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
     // called when an item is [un]focuded, i.e. becomes [not] current
     //
     // currently unused


@@ -975,6 +992,18 @@ void wxSelectionStore::OnItemDelete(size_t item)
 //  wxListItemData
 //-----------------------------------------------------------------------------
 
 //  wxListItemData
 //-----------------------------------------------------------------------------
 

+wxListItemData::~wxListItemData()
+{
+    // in the virtual list control the attributes are managed by the main
+    // program, so don't delete them
+    if ( !m_owner->IsVirtual() )
+    {
+        delete m_attr;
+    }
+
+    delete m_rect;
+}
+

 void wxListItemData::Init()
 {
     m_image = -1;
 void wxListItemData::Init()
 {
     m_image = -1;


@@ -989,7 +1018,7 @@ wxListItemData::wxListItemData(wxListMainWindow *owner)
 
     m_owner = owner;
 
 
     m_owner = owner;
 

-    if ( owner->HasFlag(wxLC_REPORT) )
+    if ( owner->InReportView() )

     {
         m_rect = NULL;
     }
     {
         m_rect = NULL;
     }


@@ -1471,6 +1500,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,


@@ -1543,11 +1590,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();


@@ -2121,7 +2167,7 @@ wxListMainWindow::wxListMainWindow( wxWindow *parent,
 
 wxListMainWindow::~wxListMainWindow()
 {
 
 wxListMainWindow::~wxListMainWindow()
 {

-    DeleteEverything();
+    DoDeleteAllItems();

 
     delete m_highlightBrush;
 
 
     delete m_highlightBrush;
 


@@ -2141,6 +2187,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


@@ -2361,7 +2408,7 @@ void wxListMainWindow::RefreshLines( size_t lineFrom, size_t lineTo )
         rect.x = 0;
         rect.y = GetLineY(lineFrom);
         rect.width = GetClientSize().x;
         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 );
 
         CalcScrolledPosition( rect.x, rect.y, &rect.x, &rect.y );
         RefreshRect( rect );


@@ -2397,7 +2444,6 @@ void wxListMainWindow::RefreshAfter( size_t lineFrom )
 
         CalcScrolledPosition( rect.x, rect.y, &rect.x, &rect.y );
         RefreshRect( rect );
 
         CalcScrolledPosition( rect.x, rect.y, &rect.x, &rect.y );
         RefreshRect( rect );

-    

     }
     else // !report
     {
     }
     else // !report
     {


@@ -2418,6 +2464,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;


@@ -2433,10 +2485,35 @@ 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);
+
+        // 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++ )
         {
         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) );
         }


@@ -2540,7 +2617,12 @@ void wxListMainWindow::SendNotify( size_t line,
     if ( point != wxDefaultPosition )
         le.m_pointDrag = point;
 
     if ( point != wxDefaultPosition )
         le.m_pointDrag = point;
 

-    GetLine(line)->GetItem( 0, le.m_item );
+    if ( 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 );
 }
 
     GetParent()->GetEventHandler()->ProcessEvent( le );
 }
 


@@ -2799,12 +2881,12 @@ void wxListMainWindow::OnMouse( wxMouseEvent &event )
     }
 }
 
     }
 }
 

-void wxListMainWindow::MoveToFocus()
+void wxListMainWindow::MoveToItem(size_t item)

 {
 {

-    if ( !HasCurrent() )
+    if ( item == (size_t)-1 )

         return;
 
         return;
 

-    wxRect rect = GetLineRect(m_current);
+    wxRect rect = GetLineRect(item);

 
     int client_w, client_h;
     GetClientSize( &client_w, &client_h );
 
     int client_w, client_h;
     GetClientSize( &client_w, &client_h );


@@ -3342,19 +3424,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 );

     }
 }
 
     }
 }
 


@@ -3480,7 +3564,10 @@ void wxListMainWindow::SetItemCount(long count)
     m_selStore.SetItemCount(count);
     m_countVirt = count;
 
     m_selStore.SetItemCount(count);
     m_countVirt = count;
 

-    Refresh();
+    ResetVisibleLinesRange();
+
+    // scrollbars must be reset
+    m_dirty = TRUE;

 }
 
 int wxListMainWindow::GetSelectedItemCount()
 }
 
 int wxListMainWindow::GetSelectedItemCount()


@@ -3537,11 +3624,8 @@ bool wxListMainWindow::GetItemPosition(long item, wxPoint& pos)
 // geometry calculation
 // ----------------------------------------------------------------------------
 
 // geometry calculation
 // ----------------------------------------------------------------------------
 

-void wxListMainWindow::RecalculatePositions()
+void wxListMainWindow::RecalculatePositions(bool noRefresh)

 {
 {

-    if ( IsEmpty() )
-        return;
-

     wxClientDC dc( this );
     dc.SetFont( GetFont() );
 
     wxClientDC dc( this );
     dc.SetFont( GetFont() );
 


@@ -3642,10 +3726,13 @@ void wxListMainWindow::RecalculatePositions()
         SetScrollbars( m_xScroll, m_yScroll, (entireWidth+SCROLL_UNIT_X) / m_xScroll, 0, scroll_pos, 0, TRUE );
     }
 
         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()
 }
 
 void wxListMainWindow::RefreshAll()


@@ -3726,20 +3813,12 @@ void wxListMainWindow::DeleteItem( long lindex )
 
     size_t index = (size_t)lindex;
 
 
     size_t index = (size_t)lindex;
 

-    m_dirty = TRUE;
-

     // select the next item when the selected one is deleted
     // select the next item when the selected one is deleted

-    if ( m_current == index )
+    if ( m_current >= index )

     {
     {

-        // the last valid index after deleting the item will be count-2
-        if ( m_current == count - 1 )
-        {
-            m_current--;
-        }
+        m_current--;

     }
 
     }
 

-    SendNotify( index, wxEVT_COMMAND_LIST_DELETE_ITEM );
-

     if ( InReportView() )
     {
         ResetVisibleLinesRange();
     if ( InReportView() )
     {
         ResetVisibleLinesRange();


@@ -3756,6 +3835,10 @@ void wxListMainWindow::DeleteItem( long lindex )
         m_lines.RemoveAt( index );
     }
 
         m_lines.RemoveAt( index );
     }
 

+    m_dirty = TRUE;
+
+    SendNotify( index, wxEVT_COMMAND_LIST_DELETE_ITEM );
+

     RefreshAfter(index);
 }
 
     RefreshAfter(index);
 }
 


@@ -3769,7 +3852,7 @@ void wxListMainWindow::DeleteColumn( int col )
     m_columns.DeleteNode( node );
 }
 
     m_columns.DeleteNode( node );
 }
 

-void wxListMainWindow::DeleteAllItems()
+void wxListMainWindow::DoDeleteAllItems()

 {
     if ( IsEmpty() )
     {
 {
     if ( IsEmpty() )
     {


@@ -3777,8 +3860,6 @@ void wxListMainWindow::DeleteAllItems()
         return;
     }
 
         return;
     }
 

-    m_dirty = TRUE;
-

     ResetCurrent();
 
     // to make the deletion of all items faster, we don't send the
     ResetCurrent();
 
     // to make the deletion of all items faster, we don't send the


@@ -3794,7 +3875,7 @@ void wxListMainWindow::DeleteAllItems()
     {
         m_countVirt = 0;
 
     {
         m_countVirt = 0;
 

-        ResetVisibleLinesRange();
+        m_selStore.Clear();

     }
 
     if ( InReportView() )
     }
 
     if ( InReportView() )


@@ -3803,8 +3884,13 @@ void wxListMainWindow::DeleteAllItems()
     }
 
     m_lines.Clear();
     }
 
     m_lines.Clear();

+}

 
 

-    m_selStore.Clear();
+void wxListMainWindow::DeleteAllItems()
+{
+    DoDeleteAllItems();
+
+    RecalculatePositions();

 }
 
 void wxListMainWindow::DeleteEverything()
 }
 
 void wxListMainWindow::DeleteEverything()


@@ -3824,14 +3910,15 @@ void wxListMainWindow::EnsureVisible( long index )
                  _T("invalid index in EnsureVisible") );
 
     // We have to call this here because the label in question might just have
                  _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) )
 }
 
 long wxListMainWindow::FindItem(long start, const wxString& str, bool WXUNUSED(partial) )


@@ -3934,6 +4021,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);
 }
 


@@ -4855,6 +4943,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") );


@@ -4862,4 +4959,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