src/generic/headerctrlg.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/generic/headerctrlg.cpp
   3 // Purpose:     generic wxHeaderCtrl implementation
   4 // Author:      Vadim Zeitlin
   5 // Created:     2008-12-03
   6 // RCS-ID:      $Id$
   7 // Copyright:   (c) 2008 Vadim Zeitlin <vadim@wxwidgets.org>
   8 // Licence:     wxWindows licence
   9 ///////////////////////////////////////////////////////////////////////////////
  10
  11 // ============================================================================
  12 // declarations
  13 // ============================================================================
  14
  15 // ----------------------------------------------------------------------------
  16 // headers
  17 // ----------------------------------------------------------------------------
  18
  19 // for compilers that support precompilation, includes "wx.h".
  20 #include "wx/wxprec.h"
  21
  22 #ifdef __BORLANDC__
  23     #pragma hdrstop
  24 #endif
  25
  26 #ifndef WX_PRECOMP
  27 #endif // WX_PRECOMP
  28
  29 #include "wx/headerctrl.h"
  30
  31 #ifdef wxHAS_GENERIC_HEADERCTRL
  32
  33 #include "wx/dcbuffer.h"
  34 #include "wx/renderer.h"
  35
  36 // ----------------------------------------------------------------------------
  37 // constants
  38 // ----------------------------------------------------------------------------
  39
  40 namespace
  41 {
  42
  43 const unsigned NO_SORT = (unsigned)-1;
  44
  45 const unsigned COL_NONE = (unsigned)-1;
  46
  47 } // anonymous namespace
  48
  49 // ============================================================================
  50 // wxHeaderCtrl implementation
  51 // ============================================================================
  52
  53 // ----------------------------------------------------------------------------
  54 // wxHeaderCtrl creation
  55 // ----------------------------------------------------------------------------
  56
  57 void wxHeaderCtrl::Init()
  58 {
  59     m_numColumns = 0;
  60     m_hover =
  61     m_colBeingResized =
  62     m_colBeingReordered = COL_NONE;
  63     m_dragOffset = 0;
  64     m_scrollOffset = 0;
  65 }
  66
  67 bool wxHeaderCtrl::Create(wxWindow *parent,
  68                           wxWindowID id,
  69                           const wxPoint& pos,
  70                           const wxSize& size,
  71                           long style,
  72                           const wxString& name)
  73 {
  74     if ( !wxHeaderCtrlBase::Create(parent, id, pos, size,
  75                                    style, wxDefaultValidator, name) )
  76         return false;
  77
  78     // tell the system to not paint the background at all to avoid flicker as
  79     // we paint the entire window area in our OnPaint()
  80     SetBackgroundStyle(wxBG_STYLE_CUSTOM);
  81
  82     return true;
  83 }
  84
  85 wxHeaderCtrl::~wxHeaderCtrl()
  86 {
  87 }
  88
  89 // ----------------------------------------------------------------------------
  90 // wxHeaderCtrl columns manipulation
  91 // ----------------------------------------------------------------------------
  92
  93 void wxHeaderCtrl::DoSetCount(unsigned int count)
  94 {
  95     // update the column indices order array before changing m_numColumns
  96     DoResizeColumnIndices(m_colIndices, count);
  97
  98     m_numColumns = count;
  99
 100     InvalidateBestSize();
 101     Refresh();
 102 }
 103
 104 unsigned int wxHeaderCtrl::DoGetCount() const
 105 {
 106     return m_numColumns;
 107 }
 108
 109 void wxHeaderCtrl::DoUpdate(unsigned int idx)
 110 {
 111     InvalidateBestSize();
 112
 113     // we need to refresh not only this column but also the ones after it in
 114     // case it was shown or hidden or its width changed -- it would be nice to
 115     // avoid doing this unnecessary by storing the old column width (TODO)
 116     RefreshColsAfter(idx);
 117 }
 118
 119 // ----------------------------------------------------------------------------
 120 // wxHeaderCtrl scrolling
 121 // ----------------------------------------------------------------------------
 122
 123 void wxHeaderCtrl::DoScrollHorz(int dx)
 124 {
 125     m_scrollOffset += dx;
 126
 127     // don't call our own version which calls this function!
 128     wxControl::ScrollWindow(dx, 0);
 129 }
 130
 131 // ----------------------------------------------------------------------------
 132 // wxHeaderCtrl geometry
 133 // ----------------------------------------------------------------------------
 134
 135 wxSize wxHeaderCtrl::DoGetBestSize() const
 136 {
 137     // the vertical size is rather arbitrary but it looks better if we leave
 138     // some space around the text
 139     const wxSize size(IsEmpty() ? wxHeaderCtrlBase::DoGetBestSize().x
 140                                 : GetColEnd(GetColumnCount() - 1),
 141                       (7*GetCharHeight())/4);
 142     CacheBestSize(size);
 143     return size;
 144 }
 145
 146 int wxHeaderCtrl::GetColStart(unsigned int idx) const
 147 {
 148     wxHeaderCtrl * const self = const_cast<wxHeaderCtrl *>(this);
 149
 150     int pos = m_scrollOffset;
 151     for ( unsigned n = 0; ; n++ )
 152     {
 153         const unsigned i = m_colIndices[n];
 154         if ( i == idx )
 155             break;
 156
 157         const wxHeaderColumn& col = self->GetColumn(i);
 158         if ( col.IsShown() )
 159             pos += col.GetWidth();
 160     }
 161
 162     return pos;
 163 }
 164
 165 int wxHeaderCtrl::GetColEnd(unsigned int idx) const
 166 {
 167     int x = GetColStart(idx);
 168
 169     return x + const_cast<wxHeaderCtrl *>(this)->GetColumn(idx).GetWidth();
 170 }
 171
 172 unsigned int wxHeaderCtrl::FindColumnAtPoint(int x, bool *onSeparator) const
 173 {
 174     wxHeaderCtrl * const self = const_cast<wxHeaderCtrl *>(this);
 175
 176     int pos = 0;
 177     const unsigned count = GetColumnCount();
 178     for ( unsigned n = 0; n < count; n++ )
 179     {
 180         const unsigned idx = m_colIndices[n];
 181         const wxHeaderColumn& col = self->GetColumn(idx);
 182         if ( col.IsHidden() )
 183             continue;
 184
 185         pos += col.GetWidth();
 186
 187         // if the column is resizeable, check if we're approximatively over the
 188         // line separating it from the next column
 189         //
 190         // TODO: don't hardcode sensitivity
 191         if ( col.IsResizeable() && abs(x - pos) < 8 )
 192         {
 193             if ( onSeparator )
 194                 *onSeparator = true;
 195             return idx;
 196         }
 197
 198         // inside this column?
 199         if ( x < pos )
 200         {
 201             if ( onSeparator )
 202                 *onSeparator = false;
 203             return idx;
 204         }
 205     }
 206
 207     return COL_NONE;
 208 }
 209
 210 // ----------------------------------------------------------------------------
 211 // wxHeaderCtrl repainting
 212 // ----------------------------------------------------------------------------
 213
 214 void wxHeaderCtrl::RefreshCol(unsigned int idx)
 215 {
 216     wxRect rect = GetClientRect();
 217     rect.x += GetColStart(idx);
 218     rect.width = GetColumn(idx).GetWidth();
 219
 220     RefreshRect(rect);
 221 }
 222
 223 void wxHeaderCtrl::RefreshColIfNotNone(unsigned int idx)
 224 {
 225     if ( idx != COL_NONE )
 226         RefreshCol(idx);
 227 }
 228
 229 void wxHeaderCtrl::RefreshColsAfter(unsigned int idx)
 230 {
 231     wxRect rect = GetClientRect();
 232     const int ofs = GetColStart(idx);
 233     rect.x += ofs;
 234     rect.width -= ofs;
 235
 236     RefreshRect(rect);
 237 }
 238
 239 // ----------------------------------------------------------------------------
 240 // wxHeaderCtrl dragging/resizing/reordering
 241 // ----------------------------------------------------------------------------
 242
 243 bool wxHeaderCtrl::IsResizing() const
 244 {
 245     return m_colBeingResized != COL_NONE;
 246 }
 247
 248 bool wxHeaderCtrl::IsReordering() const
 249 {
 250     return m_colBeingReordered != COL_NONE;
 251 }
 252
 253 void wxHeaderCtrl::ClearMarkers()
 254 {
 255     wxClientDC dc(this);
 256
 257     wxDCOverlay dcover(m_overlay, &dc);
 258     dcover.Clear();
 259 }
 260
 261 void wxHeaderCtrl::UpdateResizingMarker(int xPhysical)
 262 {
 263     wxClientDC dc(this);
 264
 265     wxDCOverlay dcover(m_overlay, &dc);
 266     dcover.Clear();
 267
 268     // unfortunately drawing the marker over the parent window doesn't work as
 269     // it's usually covered by another window (the main control view) so just
 270     // draw the marker over the header itself, even if it makes it not very
 271     // useful
 272     dc.SetPen(*wxLIGHT_GREY_PEN);
 273     dc.DrawLine(xPhysical, 0, xPhysical, GetClientSize().y);
 274 }
 275
 276 void wxHeaderCtrl::EndDragging()
 277 {
 278     ClearMarkers();
 279
 280     m_overlay.Reset();
 281
 282     // don't use the special dragging cursor any more
 283     SetCursor(wxNullCursor);
 284 }
 285
 286 void wxHeaderCtrl::CancelDragging()
 287 {
 288     wxASSERT_MSG( IsDragging(),
 289                   "shouldn't be called if we're not dragging anything" );
 290
 291     EndDragging();
 292
 293     unsigned int& col = IsResizing() ? m_colBeingResized : m_colBeingReordered;
 294
 295     wxHeaderCtrlEvent event(wxEVT_COMMAND_HEADER_DRAGGING_CANCELLED, GetId());
 296     event.SetEventObject(this);
 297     event.SetColumn(col);
 298
 299     GetEventHandler()->ProcessEvent(event);
 300
 301     col = COL_NONE;
 302 }
 303
 304 int wxHeaderCtrl::ConstrainByMinWidth(unsigned int col, int& xPhysical)
 305 {
 306     const int xStart = GetColStart(col);
 307
 308     // notice that GetMinWidth() returns 0 if there is no minimal width so it
 309     // still makes sense to use it even in this case
 310     const int xMinEnd = xStart + GetColumn(col).GetMinWidth();
 311
 312     if ( xPhysical < xMinEnd )
 313         xPhysical = xMinEnd;
 314
 315     return xPhysical - xStart;
 316 }
 317
 318 void wxHeaderCtrl::StartOrContinueResizing(unsigned int col, int xPhysical)
 319 {
 320     wxHeaderCtrlEvent event(IsResizing() ? wxEVT_COMMAND_HEADER_RESIZING
 321                                          : wxEVT_COMMAND_HEADER_BEGIN_RESIZE,
 322                             GetId());
 323     event.SetEventObject(this);
 324     event.SetColumn(col);
 325
 326     event.SetWidth(ConstrainByMinWidth(col, xPhysical));
 327
 328     if ( GetEventHandler()->ProcessEvent(event) && !event.IsAllowed() )
 329     {
 330         if ( IsResizing() )
 331         {
 332             ReleaseMouse();
 333             CancelDragging();
 334         }
 335         //else: nothing to do -- we just don't start to resize
 336     }
 337     else // go ahead with resizing
 338     {
 339         if ( !IsResizing() )
 340         {
 341             m_colBeingResized = col;
 342             SetCursor(wxCursor(wxCURSOR_SIZEWE));
 343             CaptureMouse();
 344         }
 345         //else: we had already done the above when we started
 346
 347         UpdateResizingMarker(xPhysical);
 348     }
 349 }
 350
 351 void wxHeaderCtrl::EndResizing(int xPhysical)
 352 {
 353     wxASSERT_MSG( IsResizing(), "shouldn't be called if we're not resizing" );
 354
 355     EndDragging();
 356
 357     ReleaseMouse();
 358
 359     wxHeaderCtrlEvent event(wxEVT_COMMAND_HEADER_END_RESIZE, GetId());
 360     event.SetEventObject(this);
 361     event.SetColumn(m_colBeingResized);
 362     event.SetWidth(ConstrainByMinWidth(m_colBeingResized, xPhysical));
 363
 364     GetEventHandler()->ProcessEvent(event);
 365
 366     m_colBeingResized = COL_NONE;
 367 }
 368
 369 void wxHeaderCtrl::UpdateReorderingMarker(int xPhysical)
 370 {
 371     wxClientDC dc(this);
 372
 373     wxDCOverlay dcover(m_overlay, &dc);
 374     dcover.Clear();
 375
 376     dc.SetPen(*wxBLUE);
 377     dc.SetBrush(*wxTRANSPARENT_BRUSH);
 378
 379     // draw the phantom position of the column being dragged
 380     int x = xPhysical - m_dragOffset;
 381     int y = GetClientSize().y;
 382     dc.DrawRectangle(x, 0,
 383                      GetColumn(m_colBeingReordered).GetWidth(), y);
 384
 385     // and also a hint indicating where it is going to be inserted if it's
 386     // dropped now
 387     unsigned int col = FindColumnAtPoint(xPhysical);
 388     if ( col != COL_NONE )
 389     {
 390         static const int DROP_MARKER_WIDTH = 4;
 391
 392         dc.SetBrush(*wxBLUE);
 393         dc.DrawRectangle(GetColEnd(col) - DROP_MARKER_WIDTH/2, 0,
 394                          DROP_MARKER_WIDTH, y);
 395     }
 396 }
 397
 398 void wxHeaderCtrl::StartReordering(unsigned int col, int xPhysical)
 399 {
 400     wxHeaderCtrlEvent event(wxEVT_COMMAND_HEADER_BEGIN_REORDER, GetId());
 401     event.SetEventObject(this);
 402     event.SetColumn(col);
 403
 404     if ( GetEventHandler()->ProcessEvent(event) && !event.IsAllowed() )
 405     {
 406         // don't start dragging it, nothing to do otherwise
 407         return;
 408     }
 409
 410     m_dragOffset = xPhysical - GetColStart(col);
 411
 412     m_colBeingReordered = col;
 413     SetCursor(wxCursor(wxCURSOR_HAND));
 414     CaptureMouse();
 415
 416     // do not call UpdateReorderingMarker() here: we don't want to give
 417     // feedback for reordering until the user starts to really move the mouse
 418     // as he might want to just click on the column and not move it at all
 419 }
 420
 421 bool wxHeaderCtrl::EndReordering(int xPhysical)
 422 {
 423     wxASSERT_MSG( IsReordering(), "shouldn't be called if we're not reordering" );
 424
 425     EndDragging();
 426
 427     ReleaseMouse();
 428
 429     const int colOld = m_colBeingReordered,
 430               colNew = FindColumnAtPoint(xPhysical);
 431
 432     m_colBeingReordered = COL_NONE;
 433
 434     if ( xPhysical - GetColStart(colOld) == m_dragOffset )
 435         return false;
 436
 437     if ( colNew != colOld )
 438     {
 439         wxHeaderCtrlEvent event(wxEVT_COMMAND_HEADER_END_REORDER, GetId());
 440         event.SetEventObject(this);
 441         event.SetColumn(colOld);
 442
 443         const unsigned pos = GetColumnPos(FindColumnAtPoint(xPhysical));
 444         event.SetNewOrder(pos);
 445
 446         if ( !GetEventHandler()->ProcessEvent(event) || event.IsAllowed() )
 447         {
 448             // do reorder the columns
 449             DoMoveCol(colOld, pos);
 450         }
 451     }
 452
 453     // whether we moved the column or not, the user did move the mouse and so
 454     // did try to do it so return true
 455     return true;
 456 }
 457
 458 // ----------------------------------------------------------------------------
 459 // wxHeaderCtrl column reordering
 460 // ----------------------------------------------------------------------------
 461
 462 void wxHeaderCtrl::DoSetColumnsOrder(const wxArrayInt& order)
 463 {
 464     m_colIndices = order;
 465     Refresh();
 466 }
 467
 468 wxArrayInt wxHeaderCtrl::DoGetColumnsOrder() const
 469 {
 470     return m_colIndices;
 471 }
 472
 473 void wxHeaderCtrl::DoMoveCol(unsigned int idx, unsigned int pos)
 474 {
 475     MoveColumnInOrderArray(m_colIndices, idx, pos);
 476
 477     Refresh();
 478 }
 479
 480 // ----------------------------------------------------------------------------
 481 // wxHeaderCtrl event handlers
 482 // ----------------------------------------------------------------------------
 483
 484 BEGIN_EVENT_TABLE(wxHeaderCtrl, wxHeaderCtrlBase)
 485     EVT_PAINT(wxHeaderCtrl::OnPaint)
 486
 487     EVT_MOUSE_EVENTS(wxHeaderCtrl::OnMouse)
 488
 489     EVT_MOUSE_CAPTURE_LOST(wxHeaderCtrl::OnCaptureLost)
 490
 491     EVT_KEY_DOWN(wxHeaderCtrl::OnKeyDown)
 492 END_EVENT_TABLE()
 493
 494 void wxHeaderCtrl::OnPaint(wxPaintEvent& WXUNUSED(event))
 495 {
 496     int w, h;
 497     GetClientSize(&w, &h);
 498
 499     wxAutoBufferedPaintDC dc(this);
 500
 501     dc.SetBackground(GetBackgroundColour());
 502     dc.Clear();
 503
 504     // account for the horizontal scrollbar offset in the parent window
 505     dc.SetDeviceOrigin(m_scrollOffset, 0);
 506
 507     const unsigned int count = m_numColumns;
 508     int xpos = 0;
 509     for ( unsigned int i = 0; i < count; i++ )
 510     {
 511         const unsigned idx = m_colIndices[i];
 512         const wxHeaderColumn& col = GetColumn(idx);
 513         if ( col.IsHidden() )
 514             continue;
 515
 516         const int colWidth = col.GetWidth();
 517
 518         wxHeaderSortIconType sortArrow;
 519         if ( col.IsSortKey() )
 520         {
 521             sortArrow = col.IsSortOrderAscending() ? wxHDR_SORT_ICON_UP
 522                                                    : wxHDR_SORT_ICON_DOWN;
 523         }
 524         else // not sorting by this column
 525         {
 526             sortArrow = wxHDR_SORT_ICON_NONE;
 527         }
 528
 529         int state = 0;
 530         if ( IsEnabled() )
 531         {
 532             if ( idx == m_hover )
 533                 state = wxCONTROL_CURRENT;
 534         }
 535         else // disabled
 536         {
 537             state = wxCONTROL_DISABLED;
 538         }
 539
 540         wxHeaderButtonParams params;
 541         params.m_labelText = col.GetTitle();
 542         params.m_labelBitmap = col.GetBitmap();
 543         params.m_labelAlignment = col.GetAlignment();
 544
 545         wxRendererNative::Get().DrawHeaderButton
 546                                 (
 547                                     this,
 548                                     dc,
 549                                     wxRect(xpos, 0, colWidth, h),
 550                                     state,
 551                                     sortArrow,
 552                                     &params
 553                                 );
 554
 555         xpos += colWidth;
 556     }
 557 }
 558
 559 void wxHeaderCtrl::OnCaptureLost(wxMouseCaptureLostEvent& WXUNUSED(event))
 560 {
 561     if ( IsDragging() )
 562         CancelDragging();
 563 }
 564
 565 void wxHeaderCtrl::OnKeyDown(wxKeyEvent& event)
 566 {
 567     if ( event.GetKeyCode() == WXK_ESCAPE )
 568     {
 569         if ( IsDragging() )
 570         {
 571             ReleaseMouse();
 572             CancelDragging();
 573
 574             return;
 575         }
 576     }
 577
 578     event.Skip();
 579 }
 580
 581 void wxHeaderCtrl::OnMouse(wxMouseEvent& mevent)
 582 {
 583     // do this in advance to allow simply returning if we're not interested,
 584     // we'll undo it if we do handle the event below
 585     mevent.Skip();
 586
 587
 588     // account for the control displacement
 589     const int xPhysical = mevent.GetX();
 590     const int xLogical = xPhysical - m_scrollOffset;
 591
 592     // first deal with the [continuation of any] dragging operations in
 593     // progress
 594     if ( IsResizing() )
 595     {
 596         if ( mevent.LeftUp() )
 597             EndResizing(xPhysical);
 598         else // update the live separator position
 599             StartOrContinueResizing(m_colBeingResized, xPhysical);
 600
 601         return;
 602     }
 603
 604     if ( IsReordering() )
 605     {
 606         if ( !mevent.LeftUp() )
 607         {
 608             // update the column position
 609             UpdateReorderingMarker(xPhysical);
 610
 611             return;
 612         }
 613
 614         // finish reordering and continue to generate a click event below if we
 615         // didn't really reorder anything
 616         if ( EndReordering(xPhysical) )
 617             return;
 618     }
 619
 620
 621     // find if the event is over a column at all
 622     bool onSeparator;
 623     const unsigned col = mevent.Leaving()
 624                             ? (onSeparator = false, COL_NONE)
 625                             : FindColumnAtPoint(xLogical, &onSeparator);
 626
 627
 628     // update the highlighted column if it changed
 629     if ( col != m_hover )
 630     {
 631         const unsigned hoverOld = m_hover;
 632         m_hover = col;
 633
 634         RefreshColIfNotNone(hoverOld);
 635         RefreshColIfNotNone(m_hover);
 636     }
 637
 638     // update mouse cursor as it moves around
 639     if ( mevent.Moving() )
 640     {
 641         SetCursor(onSeparator ? wxCursor(wxCURSOR_SIZEWE) : wxNullCursor);
 642         return;
 643     }
 644
 645     // all the other events only make sense when they happen over a column
 646     if ( col == COL_NONE )
 647         return;
 648
 649
 650     // enter various dragging modes on left mouse press
 651     if ( mevent.LeftDown() )
 652     {
 653         if ( onSeparator )
 654         {
 655             // start resizing the column
 656             wxASSERT_MSG( !IsResizing(), "reentering column resize mode?" );
 657             StartOrContinueResizing(col, xPhysical);
 658         }
 659         else // on column itself
 660         {
 661             // start dragging the column
 662             wxASSERT_MSG( !IsReordering(), "reentering column move mode?" );
 663
 664             StartReordering(col, xPhysical);
 665         }
 666
 667         return;
 668     }
 669
 670     // determine the type of header event corresponding to click events
 671     wxEventType evtType = wxEVT_NULL;
 672     const bool click = mevent.ButtonUp(),
 673                dblclk = mevent.ButtonDClick();
 674     if ( click || dblclk )
 675     {
 676         switch ( mevent.GetButton() )
 677         {
 678             case wxMOUSE_BTN_LEFT:
 679                 // treat left double clicks on separator specially
 680                 if ( onSeparator && dblclk )
 681                 {
 682                     evtType = wxEVT_COMMAND_HEADER_SEPARATOR_DCLICK;
 683                 }
 684                 else // not double click on separator
 685                 {
 686                     evtType = click ? wxEVT_COMMAND_HEADER_CLICK
 687                                     : wxEVT_COMMAND_HEADER_DCLICK;
 688                 }
 689                 break;
 690
 691             case wxMOUSE_BTN_RIGHT:
 692                 evtType = click ? wxEVT_COMMAND_HEADER_RIGHT_CLICK
 693                                 : wxEVT_COMMAND_HEADER_RIGHT_DCLICK;
 694                 break;
 695
 696             case wxMOUSE_BTN_MIDDLE:
 697                 evtType = click ? wxEVT_COMMAND_HEADER_MIDDLE_CLICK
 698                                 : wxEVT_COMMAND_HEADER_MIDDLE_DCLICK;
 699                 break;
 700
 701             default:
 702                 // ignore clicks from other mouse buttons
 703                 ;
 704         }
 705     }
 706
 707     if ( evtType == wxEVT_NULL )
 708         return;
 709
 710     wxHeaderCtrlEvent event(evtType, GetId());
 711     event.SetEventObject(this);
 712     event.SetColumn(col);
 713
 714     if ( GetEventHandler()->ProcessEvent(event) )
 715         mevent.Skip(false);
 716 }
 717
 718 #endif // wxHAS_GENERIC_HEADERCTRL