]> git.saurik.com Git - wxWidgets.git/blobdiff - src/generic/headerctrlg.cpp
force doxygen autolink wrt wxLanguage enum
[wxWidgets.git] / src / generic / headerctrlg.cpp
index 6b9c1a399b409890946e72aac47bcf826b5a5983..961c42b5d4e020af13aca5047d407992832097cc 100644 (file)
@@ -58,7 +58,9 @@ void wxHeaderCtrl::Init()
 {
     m_numColumns = 0;
     m_hover =
-    m_colBeingResized = COL_NONE;
+    m_colBeingResized =
+    m_colBeingReordered = COL_NONE;
+    m_dragOffset = 0;
     m_scrollOffset = 0;
 }
 
@@ -90,9 +92,37 @@ wxHeaderCtrl::~wxHeaderCtrl()
 
 void wxHeaderCtrl::DoSetCount(unsigned int count)
 {
+    // update the column indices array if necessary
+    if ( count > m_numColumns )
+    {
+        // all new columns have default positions equal to their indices
+        for ( unsigned n = m_numColumns; n < count; n++ )
+            m_colIndices.push_back(n);
+    }
+    else if ( count < m_numColumns )
+    {
+        // filter out all the positions which are invalid now while keeping the
+        // order of the remaining ones
+        wxArrayInt colIndices;
+        for ( unsigned n = 0; n < m_numColumns; n++ )
+        {
+            const unsigned idx = m_colIndices[n];
+            if ( idx < count )
+                colIndices.push_back(idx);
+        }
+
+        wxASSERT_MSG( colIndices.size() == count, "logic error" );
+
+        m_colIndices = colIndices;
+    }
+    else // count didn't really change
+    {
+        return;
+    }
+
     m_numColumns = count;
-    m_colIndices.resize(count);
 
+    InvalidateBestSize();
     Refresh();
 }
 
@@ -103,6 +133,8 @@ unsigned int wxHeaderCtrl::DoGetCount() const
 
 void wxHeaderCtrl::DoUpdate(unsigned int idx)
 {
+    InvalidateBestSize();
+
     // we need to refresh not only this column but also the ones after it in
     // case it was shown or hidden or its width changed -- it would be nice to
     // avoid doing this unnecessary by storing the old column width (TODO)
@@ -129,7 +161,11 @@ wxSize wxHeaderCtrl::DoGetBestSize() const
 {
     // the vertical size is rather arbitrary but it looks better if we leave
     // some space around the text
-    return wxSize(GetColStart(GetColumnCount()), (7*GetCharHeight())/4);
+    const wxSize size(IsEmpty() ? wxHeaderCtrlBase::DoGetBestSize().x
+                                : GetColEnd(GetColumnCount() - 1),
+                      (7*GetCharHeight())/4);
+    CacheBestSize(size);
+    return size;
 }
 
 int wxHeaderCtrl::GetColStart(unsigned int idx) const
@@ -137,9 +173,13 @@ int wxHeaderCtrl::GetColStart(unsigned int idx) const
     wxHeaderCtrl * const self = const_cast<wxHeaderCtrl *>(this);
 
     int pos = m_scrollOffset;
-    for ( unsigned n = 0; n < idx; n++ )
+    for ( unsigned n = 0; ; n++ )
     {
-        const wxHeaderColumnBase& col = self->GetColumn(n);
+        const unsigned i = m_colIndices[n];
+        if ( i == idx )
+            break;
+
+        const wxHeaderColumn& col = self->GetColumn(i);
         if ( col.IsShown() )
             pos += col.GetWidth();
     }
@@ -147,7 +187,14 @@ int wxHeaderCtrl::GetColStart(unsigned int idx) const
     return pos;
 }
 
-int wxHeaderCtrl::FindColumnAtPos(int x, bool& onSeparator) const
+int wxHeaderCtrl::GetColEnd(unsigned int idx) const
+{
+    int x = GetColStart(idx);
+
+    return x + const_cast<wxHeaderCtrl *>(this)->GetColumn(idx).GetWidth();
+}
+
+unsigned int wxHeaderCtrl::FindColumnAtPoint(int x, bool *onSeparator) const
 {
     wxHeaderCtrl * const self = const_cast<wxHeaderCtrl *>(this);
 
@@ -155,7 +202,8 @@ int wxHeaderCtrl::FindColumnAtPos(int x, bool& onSeparator) const
     const unsigned count = GetColumnCount();
     for ( unsigned n = 0; n < count; n++ )
     {
-        const wxHeaderColumnBase& col = self->GetColumn(n);
+        const unsigned idx = m_colIndices[n];
+        const wxHeaderColumn& col = self->GetColumn(idx);
         if ( col.IsHidden() )
             continue;
 
@@ -167,15 +215,17 @@ int wxHeaderCtrl::FindColumnAtPos(int x, bool& onSeparator) const
         // TODO: don't hardcode sensitivity
         if ( col.IsResizeable() && abs(x - pos) < 8 )
         {
-            onSeparator = true;
-            return n;
+            if ( onSeparator )
+                *onSeparator = true;
+            return idx;
         }
 
         // inside this column?
         if ( x < pos )
         {
-            onSeparator = false;
-            return n;
+            if ( onSeparator )
+                *onSeparator = false;
+            return idx;
         }
     }
 
@@ -212,7 +262,7 @@ void wxHeaderCtrl::RefreshColsAfter(unsigned int idx)
 }
 
 // ----------------------------------------------------------------------------
-// wxHeaderCtrl dragging
+// wxHeaderCtrl dragging/resizing/reordering
 // ----------------------------------------------------------------------------
 
 bool wxHeaderCtrl::IsResizing() const
@@ -220,27 +270,37 @@ bool wxHeaderCtrl::IsResizing() const
     return m_colBeingResized != COL_NONE;
 }
 
+bool wxHeaderCtrl::IsReordering() const
+{
+    return m_colBeingReordered != COL_NONE;
+}
+
+void wxHeaderCtrl::ClearMarkers()
+{
+    wxClientDC dc(this);
+
+    wxDCOverlay dcover(m_overlay, &dc);
+    dcover.Clear();
+}
+
 void wxHeaderCtrl::UpdateResizingMarker(int xPhysical)
 {
-    // unfortunately drawing the marker over the parent window doesn't work as
-    // it's usually covered by another window (the main control view) so just
-    // draw the marker over the header itself, even if it makes it not very
-    // useful
     wxClientDC dc(this);
 
     wxDCOverlay dcover(m_overlay, &dc);
     dcover.Clear();
 
-    if ( xPhysical != -1 )
-    {
-        dc.SetPen(*wxLIGHT_GREY_PEN);
-        dc.DrawLine(xPhysical, 0, xPhysical, GetClientSize().y);
-    }
+    // unfortunately drawing the marker over the parent window doesn't work as
+    // it's usually covered by another window (the main control view) so just
+    // draw the marker over the header itself, even if it makes it not very
+    // useful
+    dc.SetPen(*wxLIGHT_GREY_PEN);
+    dc.DrawLine(xPhysical, 0, xPhysical, GetClientSize().y);
 }
 
 void wxHeaderCtrl::EndDragging()
 {
-    UpdateResizingMarker(-1);
+    ClearMarkers();
 
     m_overlay.Reset();
 
@@ -248,6 +308,24 @@ void wxHeaderCtrl::EndDragging()
     SetCursor(wxNullCursor);
 }
 
+void wxHeaderCtrl::CancelDragging()
+{
+    wxASSERT_MSG( IsDragging(),
+                  "shouldn't be called if we're not dragging anything" );
+
+    EndDragging();
+
+    unsigned int& col = IsResizing() ? m_colBeingResized : m_colBeingReordered;
+
+    wxHeaderCtrlEvent event(wxEVT_COMMAND_HEADER_DRAGGING_CANCELLED, GetId());
+    event.SetEventObject(this);
+    event.SetColumn(col);
+
+    GetEventHandler()->ProcessEvent(event);
+
+    col = COL_NONE;
+}
+
 int wxHeaderCtrl::ConstrainByMinWidth(unsigned int col, int& xPhysical)
 {
     const int xStart = GetColStart(col);
@@ -277,7 +355,7 @@ void wxHeaderCtrl::StartOrContinueResizing(unsigned int col, int xPhysical)
         if ( IsResizing() )
         {
             ReleaseMouse();
-            EndResizing(-1);
+            CancelDragging();
         }
         //else: nothing to do -- we just don't start to resize
     }
@@ -301,26 +379,92 @@ void wxHeaderCtrl::EndResizing(int xPhysical)
 
     EndDragging();
 
-    const bool cancelled = xPhysical == -1;
+    ReleaseMouse();
 
-    // if dragging was cancelled we must have already lost the mouse capture so
-    // don't try to release it
-    if ( !cancelled )
-        ReleaseMouse();
-
-    wxHeaderCtrlEvent event(cancelled ? wxEVT_COMMAND_HEADER_DRAGGING_CANCELLED
-                                      : wxEVT_COMMAND_HEADER_END_RESIZE,
-                            GetId());
+    wxHeaderCtrlEvent event(wxEVT_COMMAND_HEADER_END_RESIZE, GetId());
     event.SetEventObject(this);
     event.SetColumn(m_colBeingResized);
-    if ( !cancelled )
-        event.SetWidth(ConstrainByMinWidth(m_colBeingResized, xPhysical));
+    event.SetWidth(ConstrainByMinWidth(m_colBeingResized, xPhysical));
 
     GetEventHandler()->ProcessEvent(event);
 
     m_colBeingResized = COL_NONE;
 }
 
+void wxHeaderCtrl::UpdateReorderingMarker(int xPhysical)
+{
+    wxClientDC dc(this);
+
+    wxDCOverlay dcover(m_overlay, &dc);
+    dcover.Clear();
+
+    dc.SetPen(*wxBLUE);
+    dc.SetBrush(*wxTRANSPARENT_BRUSH);
+
+    // draw the phantom position of the column being dragged
+    int x = xPhysical - m_dragOffset;
+    int y = GetClientSize().y;
+    dc.DrawRectangle(x, 0,
+                     GetColumn(m_colBeingReordered).GetWidth(), y);
+
+    // and also a hint indicating where it is going to be inserted if it's
+    // dropped now
+    unsigned int col = FindColumnAtPoint(xPhysical);
+    if ( col != COL_NONE )
+    {
+        static const int DROP_MARKER_WIDTH = 4;
+
+        dc.SetBrush(*wxBLUE);
+        dc.DrawRectangle(GetColEnd(col) - DROP_MARKER_WIDTH/2, 0,
+                         DROP_MARKER_WIDTH, y);
+    }
+}
+
+void wxHeaderCtrl::StartReordering(unsigned int col, int xPhysical)
+{
+    wxHeaderCtrlEvent event(wxEVT_COMMAND_HEADER_BEGIN_REORDER, GetId());
+    event.SetEventObject(this);
+    event.SetColumn(col);
+
+    if ( GetEventHandler()->ProcessEvent(event) && !event.IsAllowed() )
+    {
+        // don't start dragging it, nothing to do otherwise
+        return;
+    }
+
+    m_dragOffset = xPhysical - GetColStart(col);
+
+    m_colBeingReordered = col;
+    SetCursor(wxCursor(wxCURSOR_HAND));
+    CaptureMouse();
+
+    UpdateReorderingMarker(xPhysical);
+}
+
+void wxHeaderCtrl::EndReordering(int xPhysical)
+{
+    wxASSERT_MSG( IsReordering(), "shouldn't be called if we're not reordering" );
+
+    EndDragging();
+
+    ReleaseMouse();
+
+    wxHeaderCtrlEvent event(wxEVT_COMMAND_HEADER_END_REORDER, GetId());
+    event.SetEventObject(this);
+    event.SetColumn(m_colBeingReordered);
+
+    const unsigned pos = GetColumnPos(FindColumnAtPoint(xPhysical));
+    event.SetNewOrder(pos);
+
+    if ( !GetEventHandler()->ProcessEvent(event) || event.IsAllowed() )
+    {
+        // do reorder the columns
+        DoMoveCol(m_colBeingReordered, pos);
+    }
+
+    m_colBeingReordered = COL_NONE;
+}
+
 // ----------------------------------------------------------------------------
 // wxHeaderCtrl column reordering
 // ----------------------------------------------------------------------------
@@ -336,6 +480,13 @@ wxArrayInt wxHeaderCtrl::DoGetColumnsOrder() const
     return m_colIndices;
 }
 
+void wxHeaderCtrl::DoMoveCol(unsigned int idx, unsigned int pos)
+{
+    MoveColumnInOrderArray(m_colIndices, idx, pos);
+
+    Refresh();
+}
+
 // ----------------------------------------------------------------------------
 // wxHeaderCtrl event handlers
 // ----------------------------------------------------------------------------
@@ -367,7 +518,8 @@ void wxHeaderCtrl::OnPaint(wxPaintEvent& WXUNUSED(event))
     int xpos = 0;
     for ( unsigned int i = 0; i < count; i++ )
     {
-        const wxHeaderColumnBase& col = GetColumn(i);
+        const unsigned idx = m_colIndices[i];
+        const wxHeaderColumn& col = GetColumn(idx);
         if ( col.IsHidden() )
             continue;
 
@@ -387,7 +539,7 @@ void wxHeaderCtrl::OnPaint(wxPaintEvent& WXUNUSED(event))
         int state = 0;
         if ( IsEnabled() )
         {
-            if ( i == m_hover )
+            if ( idx == m_hover )
                 state = wxCONTROL_CURRENT;
         }
         else // disabled
@@ -416,21 +568,24 @@ void wxHeaderCtrl::OnPaint(wxPaintEvent& WXUNUSED(event))
 
 void wxHeaderCtrl::OnCaptureLost(wxMouseCaptureLostEvent& WXUNUSED(event))
 {
-    if ( IsResizing() )
-        EndResizing(-1);
+    if ( IsDragging() )
+        CancelDragging();
 }
 
 void wxHeaderCtrl::OnKeyDown(wxKeyEvent& event)
 {
-    if ( IsResizing() && event.GetKeyCode() == WXK_ESCAPE )
+    if ( event.GetKeyCode() == WXK_ESCAPE )
     {
-        ReleaseMouse();
-        EndResizing(-1);
-    }
-    else
-    {
-        event.Skip();
+        if ( IsDragging() )
+        {
+            ReleaseMouse();
+            CancelDragging();
+
+            return;
+        }
     }
+
+    event.Skip();
 }
 
 void wxHeaderCtrl::OnMouse(wxMouseEvent& mevent)
@@ -456,12 +611,22 @@ void wxHeaderCtrl::OnMouse(wxMouseEvent& mevent)
         return;
     }
 
+    if ( IsReordering() )
+    {
+        if ( mevent.LeftUp() )
+            EndReordering(xPhysical);
+        else // update the column position
+            UpdateReorderingMarker(xPhysical);
+
+        return;
+    }
+
 
     // find if the event is over a column at all
     bool onSeparator;
     const unsigned col = mevent.Leaving()
                             ? (onSeparator = false, COL_NONE)
-                            : FindColumnAtPos(xLogical, onSeparator);
+                            : FindColumnAtPoint(xLogical, &onSeparator);
 
 
     // update the highlighted column if it changed
@@ -492,13 +657,15 @@ void wxHeaderCtrl::OnMouse(wxMouseEvent& mevent)
         if ( onSeparator )
         {
             // start resizing the column
-            wxASSERT_MSG( !IsResizing(), "reentering resize mode?" );
+            wxASSERT_MSG( !IsResizing(), "reentering column resize mode?" );
             StartOrContinueResizing(col, xPhysical);
         }
         else // on column itself
         {
-            // TODO: drag column
-            ;
+            // start dragging the column
+            wxASSERT_MSG( !IsReordering(), "reentering column move mode?" );
+
+            StartReordering(col, xPhysical);
         }
 
         return;