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