Ensure there is valid context for DrawRectangle

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

diff --git a/src/generic/datavgen.cpp b/src/generic/datavgen.cpp
index 7fef06b83bfdfaaa1c5eb3d1a1d4d5c8105f7d1d..def4fb5877478b7f13170d42e6f05da2070d84ce 100644 (file)
--- a/src/generic/datavgen.cpp
+++ b/src/generic/datavgen.cpp
@@ -80,7 +80,22 @@ static const int EXPANDER_OFFSET = 1;
 // For the generic implementation, both the leaf nodes and the nodes are sorted for
 // fast search when needed
 static wxDataViewModel* g_model;
 // For the generic implementation, both the leaf nodes and the nodes are sorted for
 // fast search when needed
 static wxDataViewModel* g_model;

-static int g_column = -2;
+
+// The column is either the index of the column to be used for sorting or one
+// of the special values in this enum:
+enum
+{
+    // Sort when we're thawed later.
+    SortColumn_OnThaw = -3,
+
+    // Don't sort at all.
+    SortColumn_None = -2,
+
+    // Sort using the model default sort order.
+    SortColumn_Default = -1
+};
+
+static int g_column = SortColumn_None;

 static bool g_asending = true;
 
 // ----------------------------------------------------------------------------
 static bool g_asending = true;
 
 // ----------------------------------------------------------------------------


@@ -347,7 +362,7 @@ public:
     static wxDataViewTreeNode* CreateRootNode()
     {
         wxDataViewTreeNode *n = new wxDataViewTreeNode(NULL, wxDataViewItem());
     static wxDataViewTreeNode* CreateRootNode()
     {
         wxDataViewTreeNode *n = new wxDataViewTreeNode(NULL, wxDataViewItem());

-        n->SetHasChildren(true);
+        n->m_branchData = new BranchNodeData;

         n->m_branchData->open = true;
         return n;
     }
         n->m_branchData->open = true;
         return n;
     }


@@ -416,6 +431,11 @@ public:
 
     void ToggleOpen()
     {
 
     void ToggleOpen()
     {

+        // We do not allow the (invisible) root node to be collapsed because
+        // there is no way to expand it again.
+        if ( !m_parent )
+            return;
+

         wxCHECK_RET( m_branchData != NULL, "can't open leaf node" );
 
         int sum = 0;
         wxCHECK_RET( m_branchData != NULL, "can't open leaf node" );
 
         int sum = 0;


@@ -446,6 +466,11 @@ public:
 
     void SetHasChildren(bool has)
     {
 
     void SetHasChildren(bool has)
     {

+        // The invisible root item always has children, so ignore any attempts
+        // to change this.
+        if ( !m_parent )
+            return;
+

         if ( !has )
         {
             wxDELETE(m_branchData);
         if ( !has )
         {
             wxDELETE(m_branchData);


@@ -571,16 +596,39 @@ public:
         UpdateDisplay();
     }
 
         UpdateDisplay();
     }
 

+    // Override the base class method to resort if needed, i.e. if
+    // SortPrepare() was called -- and ignored -- while we were frozen.
+    virtual void DoThaw()
+    {
+        if ( g_column == SortColumn_OnThaw )
+        {
+            Resort();
+            g_column = SortColumn_None;
+        }
+
+        wxWindow::DoThaw();
+    }
+

     void SortPrepare()
     {
         g_model = GetModel();
     void SortPrepare()
     {
         g_model = GetModel();

+
+        // Avoid sorting while the window is frozen, this allows to quickly add
+        // many items without resorting after each addition and only resort
+        // them all at once when the window is finally thawed, see above.
+        if ( IsFrozen() )
+        {
+            g_column = SortColumn_OnThaw;
+            return;
+        }
+

         wxDataViewColumn* col = GetOwner()->GetSortingColumn();
         if( !col )
         {
             if (g_model->HasDefaultCompare())
         wxDataViewColumn* col = GetOwner()->GetSortingColumn();
         if( !col )
         {
             if (g_model->HasDefaultCompare())

-                g_column = -1;
+                g_column = SortColumn_Default;

             else
             else

-                g_column = -2;
+                g_column = SortColumn_None;

 
             g_asending = true;
             return;
 
             g_asending = true;
             return;


@@ -602,7 +650,7 @@ public:
     void OnPaint( wxPaintEvent &event );
     void OnCharHook( wxKeyEvent &event );
     void OnChar( wxKeyEvent &event );
     void OnPaint( wxPaintEvent &event );
     void OnCharHook( wxKeyEvent &event );
     void OnChar( wxKeyEvent &event );

-    void OnVerticalNavigation(unsigned int newCurrent, const wxKeyEvent& event);
+    void OnVerticalNavigation(int delta, const wxKeyEvent& event);

     void OnLeftKey();
     void OnRightKey();
     void OnMouse( wxMouseEvent &event );
     void OnLeftKey();
     void OnRightKey();
     void OnMouse( wxMouseEvent &event );


@@ -668,6 +716,7 @@ public:
 
     void SetRowHeight( int lineHeight ) { m_lineHeight = lineHeight; }
     int GetRowHeight() const { return m_lineHeight; }
 
     void SetRowHeight( int lineHeight ) { m_lineHeight = lineHeight; }
     int GetRowHeight() const { return m_lineHeight; }

+    int GetDefaultRowHeight() const;

 
     // Some useful functions for row and item mapping
     wxDataViewItem GetItemByRow( unsigned int row ) const;
 
     // Some useful functions for row and item mapping
     wxDataViewItem GetItemByRow( unsigned int row ) const;


@@ -1387,16 +1436,8 @@ wxDataViewMainWindow::wxDataViewMainWindow( wxDataViewCtrl *parent, wxWindowID i
     m_currentCol = NULL;
     m_currentColSetByKeyboard = false;
     m_useCellFocus = false;
     m_currentCol = NULL;
     m_currentColSetByKeyboard = false;
     m_useCellFocus = false;

-    m_currentRow = 0;
-
-#ifdef __WXMSW__
-    // We would like to use the same line height that Explorer uses. This is
-    // different from standard ListView control since Vista.
-    if ( wxGetWinVersion() >= wxWinVersion_Vista )
-        m_lineHeight = wxMax(16, GetCharHeight()) + 6; // 16 = mini icon height
-    else
-#endif // __WXMSW__
-        m_lineHeight = wxMax(16, GetCharHeight()) + 1; // 16 = mini icon height
+    m_currentRow = (unsigned)-1;
+    m_lineHeight = GetDefaultRowHeight();

 
 #if wxUSE_DRAG_AND_DROP
     m_dragCount = 0;
 
 #if wxUSE_DRAG_AND_DROP
     m_dragCount = 0;


@@ -1439,6 +1480,20 @@ wxDataViewMainWindow::~wxDataViewMainWindow()
 }
 
 
 }
 
 

+int wxDataViewMainWindow::GetDefaultRowHeight() const
+{
+#ifdef __WXMSW__
+    // We would like to use the same line height that Explorer uses. This is
+    // different from standard ListView control since Vista.
+    if ( wxGetWinVersion() >= wxWinVersion_Vista )
+        return wxMax(16, GetCharHeight()) + 6; // 16 = mini icon height
+    else
+#endif // __WXMSW__
+        return wxMax(16, GetCharHeight()) + 1; // 16 = mini icon height
+}
+
+
+

 #if wxUSE_DRAG_AND_DROP
 bool wxDataViewMainWindow::EnableDragSource( const wxDataFormat &format )
 {
 #if wxUSE_DRAG_AND_DROP
 bool wxDataViewMainWindow::EnableDragSource( const wxDataFormat &format )
 {


@@ -1695,11 +1750,9 @@ void wxDataViewMainWindow::OnPaint( wxPaintEvent &WXUNUSED(event) )
     wxDataViewModel *model = GetModel();
     wxAutoBufferedPaintDC dc( this );
 
     wxDataViewModel *model = GetModel();
     wxAutoBufferedPaintDC dc( this );
 

-#ifdef __WXMSW__

     dc.SetBrush(GetOwner()->GetBackgroundColour());
     dc.SetPen( *wxTRANSPARENT_PEN );
     dc.DrawRectangle(GetClientSize());
     dc.SetBrush(GetOwner()->GetBackgroundColour());
     dc.SetPen( *wxTRANSPARENT_PEN );
     dc.DrawRectangle(GetClientSize());

-#endif

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


@@ -2390,7 +2443,7 @@ bool wxDataViewMainWindow::ItemDeleted(const wxDataViewItem& parent,
     }
 
     // Change the current row to the last row if the current exceed the max row number
     }
 
     // Change the current row to the last row if the current exceed the max row number

-    if( m_currentRow > GetRowCount() )
+    if ( m_currentRow >= GetRowCount() )

         ChangeCurrentRow(m_count - 1);
 
     GetOwner()->InvalidateColBestWidths();
         ChangeCurrentRow(m_count - 1);
 
     GetOwner()->InvalidateColBestWidths();


@@ -2464,9 +2517,17 @@ bool wxDataViewMainWindow::Cleared()
 {
     DestroyTree();
     m_selection.Clear();
 {
     DestroyTree();
     m_selection.Clear();

+    m_currentRow = (unsigned)-1;

 
 

-    SortPrepare();
-    BuildTree( GetModel() );
+    if (GetModel())
+    {
+        SortPrepare();
+        BuildTree( GetModel() );
+    }
+    else
+    {
+        m_count = 0;
+    }

 
     GetOwner()->InvalidateColBestWidths();
     UpdateDisplay();
 
     GetOwner()->InvalidateColBestWidths();
     UpdateDisplay();


@@ -2987,6 +3048,9 @@ wxDataViewTreeNode * wxDataViewMainWindow::GetTreeNodeByRow(unsigned int row) co
 {
     wxASSERT( !IsVirtualList() );
 
 {
     wxASSERT( !IsVirtualList() );
 

+    if ( row == (unsigned)-1 )
+        return NULL;
+

     RowToTreeNodeJob job( row , -2, m_root );
     Walker( m_root , job );
     return job.GetResult();
     RowToTreeNodeJob job( row , -2, m_root );
     Walker( m_root , job );
     return job.GetResult();


@@ -3066,44 +3130,44 @@ void wxDataViewMainWindow::Expand( unsigned int row )
     if (!node->HasChildren())
         return;
 
     if (!node->HasChildren())
         return;
 

-            if (!node->IsOpen())
-            {
-                if ( !SendExpanderEvent(wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDING, node->GetItem()) )
-                {
-                    // Vetoed by the event handler.
-                    return;
-                }
+    if (!node->IsOpen())
+    {
+        if ( !SendExpanderEvent(wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDING, node->GetItem()) )
+        {
+            // Vetoed by the event handler.
+            return;
+        }

 
 

-                node->ToggleOpen();
+        node->ToggleOpen();

 
 

-                // build the children of current node
-                if( node->GetChildNodes().empty() )
-                {
-                    SortPrepare();
-                    ::BuildTreeHelper(GetModel(), node->GetItem(), node);
-                }
+        // build the children of current node
+        if( node->GetChildNodes().empty() )
+        {
+            SortPrepare();
+            ::BuildTreeHelper(GetModel(), node->GetItem(), node);
+        }

 
 

-                // By expanding the node all row indices that are currently in the selection list
-                // and are greater than our node have become invalid. So we have to correct that now.
-                const unsigned rowAdjustment = node->GetSubTreeCount();
-                for(unsigned i=0; i<m_selection.size(); ++i)
-                {
-                    const unsigned testRow = m_selection[i];
-                    // all rows above us are not affected, so skip them
-                    if(testRow <= row)
-                        continue;
+        // By expanding the node all row indices that are currently in the selection list
+        // and are greater than our node have become invalid. So we have to correct that now.
+        const unsigned rowAdjustment = node->GetSubTreeCount();
+        for(unsigned i=0; i<m_selection.size(); ++i)
+        {
+            const unsigned testRow = m_selection[i];
+            // all rows above us are not affected, so skip them
+            if(testRow <= row)
+                continue;

 
 

-                    m_selection[i] += rowAdjustment;
-                }
+            m_selection[i] += rowAdjustment;
+        }

 
 

-                if(m_currentRow > row)
-                    ChangeCurrentRow(m_currentRow + rowAdjustment);
+        if(m_currentRow > row)
+            ChangeCurrentRow(m_currentRow + rowAdjustment);

 
 

-                m_count = -1;
-                UpdateDisplay();
-                // Send the expanded event
-                SendExpanderEvent(wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDED,node->GetItem());
-            }
+        m_count = -1;
+        UpdateDisplay();
+        // Send the expanded event
+        SendExpanderEvent(wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDED,node->GetItem());
+    }

 }
 
 void wxDataViewMainWindow::Collapse(unsigned int row)
 }
 
 void wxDataViewMainWindow::Collapse(unsigned int row)


@@ -3689,13 +3753,11 @@ void wxDataViewMainWindow::OnChar( wxKeyEvent &event )
             break;
 
         case WXK_UP:
             break;
 
         case WXK_UP:

-            if ( m_currentRow > 0 )
-                OnVerticalNavigation( m_currentRow - 1, event );
+            OnVerticalNavigation( -1, event );

             break;
 
         case WXK_DOWN:
             break;
 
         case WXK_DOWN:

-            if ( m_currentRow + 1 < GetRowCount() )
-                OnVerticalNavigation( m_currentRow + 1, event );
+            OnVerticalNavigation( +1, event );

             break;
         // Add the process for tree expanding/collapsing
         case WXK_LEFT:
             break;
         // Add the process for tree expanding/collapsing
         case WXK_LEFT:


@@ -3707,37 +3769,19 @@ void wxDataViewMainWindow::OnChar( wxKeyEvent &event )
             break;
 
         case WXK_END:
             break;
 
         case WXK_END:

-        {
-            if (!IsEmpty())
-                OnVerticalNavigation( GetRowCount() - 1, event );
+            OnVerticalNavigation( +(int)GetRowCount(), event );

             break;
             break;

-        }
+

         case WXK_HOME:
         case WXK_HOME:

-            if (!IsEmpty())
-                OnVerticalNavigation( 0, event );
+            OnVerticalNavigation( -(int)GetRowCount(), event );

             break;
 
         case WXK_PAGEUP:
             break;
 
         case WXK_PAGEUP:

-            {
-                int steps = pageSize - 1;
-                int index = m_currentRow - steps;
-                if (index < 0)
-                    index = 0;
-
-                OnVerticalNavigation( index, event );
-            }
+            OnVerticalNavigation( -(pageSize - 1), event );

             break;
 
         case WXK_PAGEDOWN:
             break;
 
         case WXK_PAGEDOWN:

-            {
-                int steps = pageSize - 1;
-                unsigned int index = m_currentRow + steps;
-                unsigned int count = GetRowCount();
-                if ( index >= count )
-                    index = count - 1;
-
-                OnVerticalNavigation( index, event );
-            }
+            OnVerticalNavigation( +(pageSize - 1), event );

             break;
 
         default:
             break;
 
         default:


@@ -3745,16 +3789,24 @@ void wxDataViewMainWindow::OnChar( wxKeyEvent &event )
     }
 }
 
     }
 }
 

-void wxDataViewMainWindow::OnVerticalNavigation(unsigned int newCurrent, const wxKeyEvent& event)
+void wxDataViewMainWindow::OnVerticalNavigation(int delta, const wxKeyEvent& event)

 {
 {

-    wxCHECK_RET( newCurrent < GetRowCount(),
-                wxT("invalid item index in OnVerticalNavigation()") );
-

     // if there is no selection, we cannot move it anywhere
     // if there is no selection, we cannot move it anywhere

-    if (!HasCurrentRow())
+    if (!HasCurrentRow() || IsEmpty())

         return;
 
         return;
 

+    int newRow = (int)m_currentRow + delta;
+
+    // let's keep the new row inside the allowed range
+    if ( newRow < 0 )
+        newRow = 0;
+
+    const int rowCount = (int)GetRowCount();
+    if ( newRow >= rowCount )
+        newRow = rowCount - 1;
+

     unsigned int oldCurrent = m_currentRow;
     unsigned int oldCurrent = m_currentRow;

+    unsigned int newCurrent = (unsigned int)newRow;

 
     // in single selection we just ignore Shift as we can't select several
     // items anyhow
 
     // in single selection we just ignore Shift as we can't select several
     // items anyhow


@@ -3806,6 +3858,8 @@ void wxDataViewMainWindow::OnLeftKey()
     else
     {
         wxDataViewTreeNode* node = GetTreeNodeByRow(m_currentRow);
     else
     {
         wxDataViewTreeNode* node = GetTreeNodeByRow(m_currentRow);

+        if ( !node )
+            return;

 
         if ( TryAdvanceCurrentColumn(node, /*forward=*/false) )
             return;
 
         if ( TryAdvanceCurrentColumn(node, /*forward=*/false) )
             return;


@@ -3848,6 +3902,8 @@ void wxDataViewMainWindow::OnRightKey()
     else
     {
         wxDataViewTreeNode* node = GetTreeNodeByRow(m_currentRow);
     else
     {
         wxDataViewTreeNode* node = GetTreeNodeByRow(m_currentRow);

+        if ( !node )
+            return;

 
         if ( node->HasChildren() )
         {
 
         if ( node->HasChildren() )
         {


@@ -3932,9 +3988,13 @@ void wxDataViewMainWindow::OnMouse( wxMouseEvent &event )
         return;
     }
 
         return;
     }
 

-    // set the focus to ourself if any of the mouse buttons are pressed
-    if(event.ButtonDown() && !HasFocus())
-        SetFocus();
+    if(event.ButtonDown())
+    {
+        // Not skipping button down events would prevent the system from
+        // setting focus to this window as most (all?) of them do by default,
+        // so skip it to enable default handling.
+        event.Skip();
+    }

 
     int x = event.GetX();
     int y = event.GetY();
 
     int x = event.GetX();
     int y = event.GetY();


@@ -3978,30 +4038,30 @@ void wxDataViewMainWindow::OnMouse( wxMouseEvent &event )
             le.SetItem( item );
             le.SetColumn( col->GetModelColumn() );
             le.SetDataViewColumn( col );
             le.SetItem( item );
             le.SetColumn( col->GetModelColumn() );
             le.SetDataViewColumn( col );

-
-            wxVariant value;
-            model->GetValue( value, item, col->GetModelColumn() );
-            le.SetValue(value);

         }
 
         parent->ProcessWindowEvent(le);
         return;
     }
 
         }
 
         parent->ProcessWindowEvent(le);
         return;
     }
 

-    if (!col)
+    // Check if we clicked outside the item area.
+    if ((current >= GetRowCount()) || !col)

     {
     {

+        // Follow Windows convention here: clicking either left or right (but
+        // not middle) button clears the existing selection.
+        if (m_owner && (event.LeftDown() || event.RightDown()))
+        {
+            if (!GetSelections().empty())
+            {
+                m_owner->UnselectAll();
+                SendSelectionChangedEvent(wxDataViewItem());
+            }
+        }

         event.Skip();
         return;
     }
 
     wxDataViewRenderer *cell = col->GetRenderer();
         event.Skip();
         return;
     }
 
     wxDataViewRenderer *cell = col->GetRenderer();

-    if ((current >= GetRowCount()) || (x > GetEndOfLastCol()))
-    {
-        // Unselect all if below the last row ?
-        event.Skip();
-        return;
-    }
-

     wxDataViewColumn* const
         expander = GetExpanderColumnOrFirstOne(GetOwner());
 
     wxDataViewColumn* const
         expander = GetExpanderColumnOrFirstOne(GetOwner());
 


@@ -4279,8 +4339,15 @@ void wxDataViewMainWindow::OnMouse( wxMouseEvent &event )
         m_currentCol = col;
         m_currentColSetByKeyboard = false;
 
         m_currentCol = col;
         m_currentColSetByKeyboard = false;
 

+        // This flag is used to decide whether we should start editing the item
+        // label. We do it if the user clicks twice (but not double clicks,
+        // i.e. simulateClick is false) on the same item but not if the click
+        // was used for something else already, e.g. selecting the item (so it
+        // must have been already selected) or giving the focus to the control
+        // (so it must have had focus already).

         m_lastOnSame = !simulateClick && ((col == oldCurrentCol) &&
         m_lastOnSame = !simulateClick && ((col == oldCurrentCol) &&

-                        (current == oldCurrentRow)) && oldWasSelected;
+                        (current == oldCurrentRow)) && oldWasSelected &&
+                        HasFocus();

 
         // Call ActivateCell() after everything else as under GTK+
         if ( IsCellEditableInMode(item, col, wxDATAVIEW_CELL_ACTIVATABLE) )
 
         // Call ActivateCell() after everything else as under GTK+
         if ( IsCellEditableInMode(item, col, wxDATAVIEW_CELL_ACTIVATABLE) )


@@ -4408,6 +4475,7 @@ void wxDataViewCtrl::Init()
     m_sortingColumnIdx = wxNOT_FOUND;
 
     m_headerArea = NULL;
     m_sortingColumnIdx = wxNOT_FOUND;
 
     m_headerArea = NULL;

+    m_clientArea = NULL;

 
     m_colsDirty = false;
 }
 
     m_colsDirty = false;
 }


@@ -4521,18 +4589,53 @@ void wxDataViewCtrl::SetFocus()
         m_clientArea->SetFocus();
 }
 
         m_clientArea->SetFocus();
 }
 

+bool wxDataViewCtrl::SetFont(const wxFont & font)
+{
+    if (!wxControl::SetFont(font))
+        return false;
+
+    if (m_headerArea)
+        m_headerArea->SetFont(font);
+
+    if (m_clientArea)
+    {
+        m_clientArea->SetFont(font);
+        m_clientArea->SetRowHeight(m_clientArea->GetDefaultRowHeight());
+    }
+
+    if (m_headerArea || m_clientArea)
+    {
+        InvalidateColBestWidths();
+        Layout();
+    }
+
+    return true;
+}
+
+
+

 bool wxDataViewCtrl::AssociateModel( wxDataViewModel *model )
 {
     if (!wxDataViewCtrlBase::AssociateModel( model ))
         return false;
 
 bool wxDataViewCtrl::AssociateModel( wxDataViewModel *model )
 {
     if (!wxDataViewCtrlBase::AssociateModel( model ))
         return false;
 

-    m_notifier = new wxGenericDataViewModelNotifier( m_clientArea );
-
-    model->AddNotifier( m_notifier );
+    if (model)
+    {
+        m_notifier = new wxGenericDataViewModelNotifier( m_clientArea );
+        model->AddNotifier( m_notifier );
+    }
+    else if (m_notifier)
+    {
+        m_notifier->Cleared();
+        m_notifier = NULL;
+    }

 
     m_clientArea->DestroyTree();
 
 
     m_clientArea->DestroyTree();
 

-    m_clientArea->BuildTree(model);
+    if (model)
+    {
+        m_clientArea->BuildTree(model);
+    }

 
     m_clientArea->UpdateDisplay();
 
 
     m_clientArea->UpdateDisplay();