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 = COL_NONE;
  62     m_scrollOffset = 0;
  63 }
  64
  65 bool wxHeaderCtrl::Create(wxWindow *parent,
  66                           wxWindowID id,
  67                           const wxPoint& pos,
  68                           const wxSize& size,
  69                           long style,
  70                           const wxString& name)
  71 {
  72     if ( !wxHeaderCtrlBase::Create(parent, id, pos, size,
  73                                    style, wxDefaultValidator, name) )
  74         return false;
  75
  76     // tell the system to not paint the background at all to avoid flicker as
  77     // we paint the entire window area in our OnPaint()
  78     SetBackgroundStyle(wxBG_STYLE_CUSTOM);
  79
  80     return true;
  81 }
  82
  83 wxHeaderCtrl::~wxHeaderCtrl()
  84 {
  85 }
  86
  87 // ----------------------------------------------------------------------------
  88 // wxHeaderCtrl columns manipulation
  89 // ----------------------------------------------------------------------------
  90
  91 void wxHeaderCtrl::DoSetCount(unsigned int count)
  92 {
  93     m_numColumns = count;
  94
  95     Refresh();
  96 }
  97
  98 unsigned int wxHeaderCtrl::DoGetCount() const
  99 {
 100     return m_numColumns;
 101 }
 102
 103 void wxHeaderCtrl::DoUpdate(unsigned int idx)
 104 {
 105     // we need to refresh not only this column but also the ones after it in
 106     // case it was shown or hidden or its width changed -- it would be nice to
 107     // avoid doing this unnecessary by storing the old column width (TODO)
 108     RefreshColsAfter(idx);
 109 }
 110
 111 // ----------------------------------------------------------------------------
 112 // wxHeaderCtrl scrolling
 113 // ----------------------------------------------------------------------------
 114
 115 void wxHeaderCtrl::DoScrollHorz(int dx)
 116 {
 117     m_scrollOffset += dx;
 118
 119     // don't call our own version which calls this function!
 120     wxControl::ScrollWindow(dx, 0);
 121 }
 122
 123 // ----------------------------------------------------------------------------
 124 // wxHeaderCtrl geometry
 125 // ----------------------------------------------------------------------------
 126
 127 wxSize wxHeaderCtrl::DoGetBestSize() const
 128 {
 129     // the vertical size is rather arbitrary but it looks better if we leave
 130     // some space around the text
 131     return wxSize(GetColStart(GetColumnCount()), (7*GetCharHeight())/4);
 132 }
 133
 134 int wxHeaderCtrl::GetColStart(unsigned int idx) const
 135 {
 136     wxHeaderCtrl * const self = const_cast<wxHeaderCtrl *>(this);
 137
 138     int pos = m_scrollOffset;
 139     for ( unsigned n = 0; n < idx; n++ )
 140     {
 141         const wxHeaderColumnBase& col = self->GetColumn(n);
 142         if ( col.IsShown() )
 143             pos += col.GetWidth();
 144     }
 145
 146     return pos;
 147 }
 148
 149 int wxHeaderCtrl::FindColumnAtPos(int x, bool& onSeparator) const
 150 {
 151     wxHeaderCtrl * const self = const_cast<wxHeaderCtrl *>(this);
 152
 153     int pos = 0;
 154     const unsigned count = GetColumnCount();
 155     for ( unsigned n = 0; n < count; n++ )
 156     {
 157         const wxHeaderColumnBase& col = self->GetColumn(n);
 158         if ( col.IsHidden() )
 159             continue;
 160
 161         pos += col.GetWidth();
 162
 163         // if the column is resizeable, check if we're approximatively over the
 164         // line separating it from the next column
 165         //
 166         // TODO: don't hardcode sensitivity
 167         if ( col.IsResizeable() && abs(x - pos) < 8 )
 168         {
 169             onSeparator = true;
 170             return n;
 171         }
 172
 173         // inside this column?
 174         if ( x < pos )
 175         {
 176             onSeparator = false;
 177             return n;
 178         }
 179     }
 180
 181     return COL_NONE;
 182 }
 183
 184 // ----------------------------------------------------------------------------
 185 // wxHeaderCtrl repainting
 186 // ----------------------------------------------------------------------------
 187
 188 void wxHeaderCtrl::RefreshCol(unsigned int idx)
 189 {
 190     wxRect rect = GetClientRect();
 191     rect.x += GetColStart(idx);
 192     rect.width = GetColumn(idx).GetWidth();
 193
 194     RefreshRect(rect);
 195 }
 196
 197 void wxHeaderCtrl::RefreshColIfNotNone(unsigned int idx)
 198 {
 199     if ( idx != COL_NONE )
 200         RefreshCol(idx);
 201 }
 202
 203 void wxHeaderCtrl::RefreshColsAfter(unsigned int idx)
 204 {
 205     wxRect rect = GetClientRect();
 206     const int ofs = GetColStart(idx);
 207     rect.x += ofs;
 208     rect.width -= ofs;
 209
 210     RefreshRect(rect);
 211 }
 212
 213 // ----------------------------------------------------------------------------
 214 // wxHeaderCtrl dragging
 215 // ----------------------------------------------------------------------------
 216
 217 void wxHeaderCtrl::UpdateResizingMarker(int xPhysical)
 218 {
 219     // unfortunately drawing the marker over the parent window doesn't work as
 220     // it's usually covered by another window (the main control view) so just
 221     // draw the marker over the header itself, even if it makes it not very
 222     // useful
 223     wxClientDC dc(this);
 224
 225     wxDCOverlay dcover(m_overlay, &dc);
 226     dcover.Clear();
 227
 228     if ( xPhysical != -1 )
 229     {
 230         dc.SetPen(*wxLIGHT_GREY_PEN);
 231         dc.DrawLine(xPhysical, 0, xPhysical, GetClientSize().y);
 232     }
 233 }
 234
 235 void wxHeaderCtrl::EndDragging()
 236 {
 237     UpdateResizingMarker(-1);
 238
 239     m_overlay.Reset();
 240
 241     // don't use the special dragging cursor any more
 242     SetCursor(wxNullCursor);
 243 }
 244
 245 void wxHeaderCtrl::EndResizing(int width)
 246 {
 247     wxASSERT_MSG( m_colBeingResized != COL_NONE,
 248                   "shouldn't be called if we're not resizing" );
 249
 250     EndDragging();
 251
 252     // if dragging was cancelled we must have already lost the mouse capture so
 253     // don't try to release it
 254     if ( width != -1 )
 255         ReleaseMouse();
 256
 257     wxHeaderCtrlEvent event(wxEVT_COMMAND_HEADER_END_DRAG, GetId());
 258     event.SetEventObject(this);
 259     event.SetColumn(m_colBeingResized);
 260     if ( width == -1 )
 261         event.SetCancelled();
 262     else
 263         event.SetWidth(width);
 264
 265     GetEventHandler()->ProcessEvent(event);
 266
 267     m_colBeingResized = COL_NONE;
 268 }
 269
 270 // ----------------------------------------------------------------------------
 271 // wxHeaderCtrl event handlers
 272 // ----------------------------------------------------------------------------
 273
 274 BEGIN_EVENT_TABLE(wxHeaderCtrl, wxHeaderCtrlBase)
 275     EVT_PAINT(wxHeaderCtrl::OnPaint)
 276
 277     EVT_MOUSE_EVENTS(wxHeaderCtrl::OnMouse)
 278
 279     EVT_MOUSE_CAPTURE_LOST(wxHeaderCtrl::OnCaptureLost)
 280 END_EVENT_TABLE()
 281
 282 void wxHeaderCtrl::OnPaint(wxPaintEvent& WXUNUSED(event))
 283 {
 284     int w, h;
 285     GetClientSize(&w, &h);
 286
 287     wxAutoBufferedPaintDC dc(this);
 288
 289     dc.SetBackground(GetBackgroundColour());
 290     dc.Clear();
 291
 292     // account for the horizontal scrollbar offset in the parent window
 293     dc.SetDeviceOrigin(m_scrollOffset, 0);
 294
 295     const unsigned int count = m_numColumns;
 296     int xpos = 0;
 297     for ( unsigned int i = 0; i < count; i++ )
 298     {
 299         const wxHeaderColumnBase& col = GetColumn(i);
 300         if ( col.IsHidden() )
 301             continue;
 302
 303         const int colWidth = col.GetWidth();
 304
 305         wxHeaderSortIconType sortArrow;
 306         if ( col.IsSortKey() )
 307         {
 308             sortArrow = col.IsSortOrderAscending() ? wxHDR_SORT_ICON_UP
 309                                                    : wxHDR_SORT_ICON_DOWN;
 310         }
 311         else // not sorting by this column
 312         {
 313             sortArrow = wxHDR_SORT_ICON_NONE;
 314         }
 315
 316         int state = 0;
 317         if ( IsEnabled() )
 318         {
 319             if ( i == m_hover )
 320                 state = wxCONTROL_CURRENT;
 321         }
 322         else // disabled
 323         {
 324             state = wxCONTROL_DISABLED;
 325         }
 326
 327         wxHeaderButtonParams params;
 328         params.m_labelText = col.GetTitle();
 329         params.m_labelBitmap = col.GetBitmap();
 330         params.m_labelAlignment = col.GetAlignment();
 331
 332         wxRendererNative::Get().DrawHeaderButton
 333                                 (
 334                                     this,
 335                                     dc,
 336                                     wxRect(xpos, 0, colWidth, h),
 337                                     state,
 338                                     sortArrow,
 339                                     &params
 340                                 );
 341
 342         xpos += colWidth;
 343     }
 344 }
 345
 346 void wxHeaderCtrl::OnCaptureLost(wxMouseCaptureLostEvent& WXUNUSED(event))
 347 {
 348     if ( m_colBeingResized != COL_NONE )
 349         EndResizing(-1);
 350 }
 351
 352 void wxHeaderCtrl::OnMouse(wxMouseEvent& mevent)
 353 {
 354     // do this in advance to allow simply returning if we're not interested,
 355     // we'll undo it if we do handle the event below
 356     mevent.Skip();
 357
 358
 359     // account for the control displacement
 360     const int xPhysical = mevent.GetX();
 361     const int xLogical = xPhysical - m_scrollOffset;
 362
 363     // first deal with the [continuation of any] dragging operations in
 364     // progress
 365     if ( m_colBeingResized != COL_NONE )
 366     {
 367         if ( mevent.LeftUp() )
 368             EndResizing(xPhysical - GetColStart(m_colBeingResized));
 369         else // update the live separator position
 370             UpdateResizingMarker(xPhysical);
 371
 372         return;
 373     }
 374
 375
 376     // find if the event is over a column at all
 377     bool onSeparator;
 378     const unsigned col = mevent.Leaving()
 379                             ? (onSeparator = false, COL_NONE)
 380                             : FindColumnAtPos(xLogical, onSeparator);
 381
 382
 383     // update the highlighted column if it changed
 384     if ( col != m_hover )
 385     {
 386         const unsigned hoverOld = m_hover;
 387         m_hover = col;
 388
 389         RefreshColIfNotNone(hoverOld);
 390         RefreshColIfNotNone(m_hover);
 391     }
 392
 393     // update mouse cursor as it moves around
 394     if ( mevent.Moving() )
 395     {
 396         SetCursor(onSeparator ? wxCursor(wxCURSOR_SIZEWE) : wxNullCursor);
 397         return;
 398     }
 399
 400     // all the other events only make sense when they happen over a column
 401     if ( col == COL_NONE )
 402         return;
 403
 404
 405     // enter various dragging modes on left mouse press
 406     if ( mevent.LeftDown() )
 407     {
 408         if ( onSeparator )
 409         {
 410             // start resizing the column
 411             m_colBeingResized = col;
 412             SetCursor(wxCursor(wxCURSOR_SIZEWE));
 413             CaptureMouse();
 414             UpdateResizingMarker(xPhysical);
 415         }
 416         else // on column itself
 417         {
 418             // TODO: drag column
 419             ;
 420         }
 421
 422         return;
 423     }
 424
 425     // determine the type of header event corresponding to click events
 426     wxEventType evtType = wxEVT_NULL;
 427     const bool click = mevent.ButtonUp(),
 428                dblclk = mevent.ButtonDClick();
 429     if ( click || dblclk )
 430     {
 431         switch ( mevent.GetButton() )
 432         {
 433             case wxMOUSE_BTN_LEFT:
 434                 // treat left double clicks on separator specially
 435                 if ( onSeparator && dblclk )
 436                 {
 437                     evtType = wxEVT_COMMAND_HEADER_SEPARATOR_DCLICK;
 438                 }
 439                 else // not double click on separator
 440                 {
 441                     evtType = click ? wxEVT_COMMAND_HEADER_CLICK
 442                                     : wxEVT_COMMAND_HEADER_DCLICK;
 443                 }
 444                 break;
 445
 446             case wxMOUSE_BTN_RIGHT:
 447                 evtType = click ? wxEVT_COMMAND_HEADER_RIGHT_CLICK
 448                                 : wxEVT_COMMAND_HEADER_RIGHT_DCLICK;
 449                 break;
 450
 451             case wxMOUSE_BTN_MIDDLE:
 452                 evtType = click ? wxEVT_COMMAND_HEADER_MIDDLE_CLICK
 453                                 : wxEVT_COMMAND_HEADER_MIDDLE_DCLICK;
 454                 break;
 455
 456             default:
 457                 // ignore clicks from other mouse buttons
 458                 ;
 459         }
 460     }
 461
 462     if ( evtType == wxEVT_NULL )
 463         return;
 464
 465     wxHeaderCtrlEvent event(evtType, GetId());
 466     event.SetEventObject(this);
 467     event.SetColumn(col);
 468
 469     if ( GetEventHandler()->ProcessEvent(event) )
 470         mevent.Skip(false);
 471 }
 472
 473 #endif // wxHAS_GENERIC_HEADERCTRL