src/msw/statusbar.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/msw/statusbar.cpp
   3 // Purpose:     native implementation of wxStatusBar
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     04.04.98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 // for compilers that support precompilation, includes "wx.h".
  21 #include "wx/wxprec.h"
  22
  23 #ifdef __BORLANDC__
  24   #pragma hdrstop
  25 #endif
  26
  27 #if wxUSE_STATUSBAR && wxUSE_NATIVE_STATUSBAR
  28
  29 #include "wx/statusbr.h"
  30
  31 #ifndef WX_PRECOMP
  32     #include "wx/msw/wrapcctl.h" // include <commctrl.h> "properly"
  33     #include "wx/frame.h"
  34     #include "wx/settings.h"
  35     #include "wx/dcclient.h"
  36     #include "wx/intl.h"
  37     #include "wx/log.h"
  38     #include "wx/control.h"
  39 #endif
  40
  41 #include "wx/msw/private.h"
  42 #include "wx/tooltip.h"
  43 #include <windowsx.h>
  44
  45 #if wxUSE_UXTHEME
  46     #include "wx/msw/uxtheme.h"
  47 #endif
  48
  49 // ----------------------------------------------------------------------------
  50 // constants
  51 // ----------------------------------------------------------------------------
  52
  53 namespace
  54 {
  55
  56 // no idea for a default width, just choose something
  57 static const int DEFAULT_FIELD_WIDTH = 25;
  58
  59 } // anonymous namespace
  60
  61 // ----------------------------------------------------------------------------
  62 // macros
  63 // ----------------------------------------------------------------------------
  64
  65 // windowsx.h and commctrl.h don't define those, so we do it here
  66 #define StatusBar_SetParts(h, n, w) SendMessage(h, SB_SETPARTS, (WPARAM)n, (LPARAM)w)
  67 #define StatusBar_SetText(h, n, t)  SendMessage(h, SB_SETTEXT, (WPARAM)n, (LPARAM)(LPCTSTR)t)
  68 #define StatusBar_GetTextLen(h, n)  LOWORD(SendMessage(h, SB_GETTEXTLENGTH, (WPARAM)n, 0))
  69 #define StatusBar_GetText(h, n, s)  LOWORD(SendMessage(h, SB_GETTEXT, (WPARAM)n, (LPARAM)(LPTSTR)s))
  70
  71 // ============================================================================
  72 // implementation
  73 // ============================================================================
  74
  75 // ----------------------------------------------------------------------------
  76 // wxStatusBar class
  77 // ----------------------------------------------------------------------------
  78
  79 wxStatusBar::wxStatusBar()
  80 {
  81     SetParent(NULL);
  82     m_hWnd = 0;
  83     m_windowId = 0;
  84     m_pDC = NULL;
  85 }
  86
  87 WXDWORD wxStatusBar::MSWGetStyle(long style, WXDWORD *exstyle) const
  88 {
  89     WXDWORD msStyle = wxStatusBarBase::MSWGetStyle(style, exstyle);
  90
  91     // wxSTB_SIZEGRIP is part of our default style but it doesn't make sense to
  92     // show size grip if this is the status bar of a non-resizable TLW so turn
  93     // it off in such case
  94     wxWindow * const parent = GetParent();
  95     wxCHECK_MSG( parent, msStyle, wxS("Status bar must have a parent") );
  96     if ( parent->IsTopLevel() && !parent->HasFlag(wxRESIZE_BORDER) )
  97         style &= ~wxSTB_SIZEGRIP;
  98
  99     // setting SBARS_SIZEGRIP is perfectly useless: it's always on by default
 100     // (at least in the version of comctl32.dll I'm using), and the only way to
 101     // turn it off is to use CCS_TOP style - as we position the status bar
 102     // manually anyhow (see DoMoveWindow), use CCS_TOP style if wxSTB_SIZEGRIP
 103     // is not given
 104     if ( !(style & wxSTB_SIZEGRIP) )
 105     {
 106         msStyle |= CCS_TOP;
 107     }
 108     else
 109     {
 110 #ifndef __WXWINCE__
 111         // may be some versions of comctl32.dll do need it - anyhow, it won't
 112         // do any harm
 113        msStyle |= SBARS_SIZEGRIP;
 114 #endif
 115     }
 116
 117     return msStyle;
 118 }
 119
 120 bool wxStatusBar::Create(wxWindow *parent,
 121                          wxWindowID id,
 122                          long style,
 123                          const wxString& name)
 124 {
 125     if ( !CreateControl(parent, id, wxDefaultPosition, wxDefaultSize,
 126                         style, wxDefaultValidator, name) )
 127         return false;
 128
 129     if ( !MSWCreateControl(STATUSCLASSNAME, wxString(),
 130                            wxDefaultPosition, wxDefaultSize) )
 131         return false;
 132
 133     SetFieldsCount(1);
 134
 135     // cache the DC instance used by DoUpdateStatusText:
 136     m_pDC = new wxClientDC(this);
 137
 138     // we must refresh the frame size when the statusbar is created, because
 139     // its client area might change
 140     //
 141     // notice that we must post the event, not send it, as the frame doesn't
 142     // know that we're its status bar yet so laying it out right now wouldn't
 143     // work correctly, we need to wait until we return to the main loop
 144     PostSizeEventToParent();
 145
 146     return true;
 147 }
 148
 149 wxStatusBar::~wxStatusBar()
 150 {
 151     // we must refresh the frame size when the statusbar is deleted but the
 152     // frame is not - otherwise statusbar leaves a hole in the place it used to
 153     // occupy
 154     PostSizeEventToParent();
 155
 156     // delete existing tooltips
 157     for (size_t i=0; i<m_tooltips.size(); i++)
 158     {
 159         wxDELETE(m_tooltips[i]);
 160     }
 161
 162     wxDELETE(m_pDC);
 163 }
 164
 165 bool wxStatusBar::SetFont(const wxFont& font)
 166 {
 167     if (!wxWindow::SetFont(font))
 168         return false;
 169
 170     if (m_pDC) m_pDC->SetFont(font);
 171     return true;
 172 }
 173
 174 void wxStatusBar::SetFieldsCount(int nFields, const int *widths)
 175 {
 176     // this is a Windows limitation
 177     wxASSERT_MSG( (nFields > 0) && (nFields < 255), "too many fields" );
 178
 179     wxStatusBarBase::SetFieldsCount(nFields, widths);
 180
 181     MSWUpdateFieldsWidths();
 182
 183     // keep in synch also our m_tooltips array
 184
 185     // reset all current tooltips
 186     for (size_t i=0; i<m_tooltips.size(); i++)
 187     {
 188         wxDELETE(m_tooltips[i]);
 189     }
 190
 191     // shrink/expand the array:
 192     m_tooltips.resize(m_panes.GetCount(), NULL);
 193 }
 194
 195 void wxStatusBar::SetStatusWidths(int n, const int widths[])
 196 {
 197     wxStatusBarBase::SetStatusWidths(n, widths);
 198
 199     MSWUpdateFieldsWidths();
 200 }
 201
 202 void wxStatusBar::MSWUpdateFieldsWidths()
 203 {
 204     if ( m_panes.IsEmpty() )
 205         return;
 206
 207     const int count = m_panes.GetCount();
 208
 209     const int extraWidth = MSWGetBorderWidth() + MSWGetMetrics().textMargin;
 210
 211     // compute the effectively available amount of space:
 212     int widthAvailable = GetClientSize().x;     // start with the entire width
 213     widthAvailable -= extraWidth*(count - 1);   // extra space between fields
 214     widthAvailable -= MSWGetMetrics().textMargin;   // and for the last field
 215
 216     // Deal with the grip: we shouldn't overflow onto the space occupied by it
 217     // so the effectively available space is smaller.
 218     const int gripWidth = HasFlag(wxSTB_SIZEGRIP) ? MSWGetMetrics().gripWidth
 219                                                   : 0;
 220     widthAvailable -= gripWidth;
 221
 222     // distribute the available space (client width) among the various fields:
 223
 224     wxArrayInt widthsAbs = CalculateAbsWidths(widthAvailable);
 225
 226
 227     // update the field widths in the native control:
 228
 229     int *pWidths = new int[count];
 230
 231     int nCurPos = 0;
 232     for ( int i = 0; i < count; i++ )
 233     {
 234         nCurPos += widthsAbs[i] + extraWidth;
 235         pWidths[i] = nCurPos;
 236     }
 237
 238     // The total width of the panes passed to Windows must be equal to the
 239     // total width available, including the grip. Otherwise we get an extra
 240     // separator line just before it.
 241     pWidths[count - 1] += gripWidth;
 242
 243     if ( !StatusBar_SetParts(GetHwnd(), count, pWidths) )
 244     {
 245         wxLogLastError("StatusBar_SetParts");
 246     }
 247
 248     delete [] pWidths;
 249
 250
 251     // FIXME: we may want to call DoUpdateStatusText() here since we may need to (de)ellipsize status texts
 252 }
 253
 254 void wxStatusBar::DoUpdateStatusText(int nField)
 255 {
 256     if (!m_pDC)
 257         return;
 258
 259     // Get field style, if any
 260     int style;
 261     switch(m_panes[nField].GetStyle())
 262     {
 263     case wxSB_RAISED:
 264         style = SBT_POPOUT;
 265         break;
 266     case wxSB_FLAT:
 267         style = SBT_NOBORDERS;
 268         break;
 269
 270     case wxSB_NORMAL:
 271     default:
 272         style = 0;
 273         break;
 274     }
 275
 276     wxRect rc;
 277     GetFieldRect(nField, rc);
 278
 279     const int maxWidth = rc.GetWidth() - MSWGetMetrics().textMargin;
 280
 281     wxString text = GetStatusText(nField);
 282
 283     // do we need to ellipsize this string?
 284     wxEllipsizeMode ellmode = (wxEllipsizeMode)-1;
 285     if (HasFlag(wxSTB_ELLIPSIZE_START)) ellmode = wxELLIPSIZE_START;
 286     else if (HasFlag(wxSTB_ELLIPSIZE_MIDDLE)) ellmode = wxELLIPSIZE_MIDDLE;
 287     else if (HasFlag(wxSTB_ELLIPSIZE_END)) ellmode = wxELLIPSIZE_END;
 288
 289     if (ellmode == (wxEllipsizeMode)-1)
 290     {
 291         // if we have the wxSTB_SHOW_TIPS we must set the ellipsized flag even if
 292         // we don't ellipsize the text but just truncate it
 293         if (HasFlag(wxSTB_SHOW_TIPS))
 294             SetEllipsizedFlag(nField, m_pDC->GetTextExtent(text).GetWidth() > maxWidth);
 295     }
 296     else
 297     {
 298         text = wxControl::Ellipsize(text,
 299                                      *m_pDC,
 300                                      ellmode,
 301                                      maxWidth,
 302                                      wxELLIPSIZE_FLAGS_EXPAND_TABS);
 303
 304         // update the ellipsization status for this pane; this is used later to
 305         // decide whether a tooltip should be shown or not for this pane
 306         // (if we have wxSTB_SHOW_TIPS)
 307         SetEllipsizedFlag(nField, text != GetStatusText(nField));
 308     }
 309
 310     // Set the status text in the native control passing both field number and style.
 311     // NOTE: MSDN library doesn't mention that nField and style have to be 'ORed'
 312     if ( !StatusBar_SetText(GetHwnd(), nField | style, text.wx_str()) )
 313     {
 314         wxLogLastError("StatusBar_SetText");
 315     }
 316
 317     if (HasFlag(wxSTB_SHOW_TIPS))
 318     {
 319         wxASSERT(m_tooltips.size() == m_panes.GetCount());
 320
 321         if (m_tooltips[nField])
 322         {
 323             if (GetField(nField).IsEllipsized())
 324             {
 325                 // update the rect of this tooltip:
 326                 m_tooltips[nField]->SetRect(rc);
 327
 328                 // update also the text:
 329                 m_tooltips[nField]->SetTip(GetStatusText(nField));
 330             }
 331             else
 332             {
 333                 // delete the tooltip associated with this pane; it's not needed anymore
 334                 wxDELETE(m_tooltips[nField]);
 335             }
 336         }
 337         else
 338         {
 339             // create a new tooltip for this pane if needed
 340             if (GetField(nField).IsEllipsized())
 341                 m_tooltips[nField] = new wxToolTip(this, nField, GetStatusText(nField), rc);
 342             //else: leave m_tooltips[nField]==NULL
 343         }
 344     }
 345 }
 346
 347 wxStatusBar::MSWBorders wxStatusBar::MSWGetBorders() const
 348 {
 349     int aBorders[3];
 350     SendMessage(GetHwnd(), SB_GETBORDERS, 0, (LPARAM)aBorders);
 351
 352     MSWBorders borders;
 353     borders.horz = aBorders[0];
 354     borders.vert = aBorders[1];
 355     borders.between = aBorders[2];
 356     return borders;
 357 }
 358
 359 int wxStatusBar::GetBorderX() const
 360 {
 361     return MSWGetBorders().horz;
 362 }
 363
 364 int wxStatusBar::GetBorderY() const
 365 {
 366     return MSWGetBorders().vert;
 367 }
 368
 369 int wxStatusBar::MSWGetBorderWidth() const
 370 {
 371     return MSWGetBorders().between;
 372 }
 373
 374 /* static */
 375 const wxStatusBar::MSWMetrics& wxStatusBar::MSWGetMetrics()
 376 {
 377     static MSWMetrics s_metrics = { 0 };
 378     if ( !s_metrics.textMargin )
 379     {
 380         // Grip size should be self explanatory (the only problem with it is
 381         // that it's hard coded as we don't know how to find its size using
 382         // API) but the margin might merit an explanation: Windows offsets the
 383         // text drawn in status bar panes so we need to take this extra margin
 384         // into account to make sure the text drawn by user fits inside the
 385         // pane. Notice that it's not the value returned by SB_GETBORDERS
 386         // which, at least on this Windows 2003 system, returns {0, 2, 2}
 387         if ( wxUxThemeEngine::GetIfActive() )
 388         {
 389             s_metrics.gripWidth = 20;
 390             s_metrics.textMargin = 8;
 391         }
 392         else // classic/unthemed look
 393         {
 394             s_metrics.gripWidth = 18;
 395             s_metrics.textMargin = 4;
 396         }
 397     }
 398
 399     return s_metrics;
 400 }
 401
 402 void wxStatusBar::SetMinHeight(int height)
 403 {
 404     SendMessage(GetHwnd(), SB_SETMINHEIGHT, height + 2*GetBorderY(), 0);
 405
 406     // we have to send a (dummy) WM_SIZE to redraw it now
 407     SendMessage(GetHwnd(), WM_SIZE, 0, 0);
 408 }
 409
 410 bool wxStatusBar::GetFieldRect(int i, wxRect& rect) const
 411 {
 412     wxCHECK_MSG( (i >= 0) && ((size_t)i < m_panes.GetCount()), false,
 413                  "invalid statusbar field index" );
 414
 415     RECT r;
 416     if ( !::SendMessage(GetHwnd(), SB_GETRECT, i, (LPARAM)&r) )
 417     {
 418         wxLogLastError("SendMessage(SB_GETRECT)");
 419     }
 420
 421 #if wxUSE_UXTHEME
 422     wxUxThemeHandle theme(const_cast<wxStatusBar*>(this), L"Status");
 423     if ( theme )
 424     {
 425         // by default Windows has a 2 pixel border to the right of the left
 426         // divider (or it could be a bug) but it looks wrong so remove it
 427         if ( i != 0 )
 428         {
 429             r.left -= 2;
 430         }
 431
 432         wxUxThemeEngine::Get()->GetThemeBackgroundContentRect(theme, NULL,
 433                                                               1 /* SP_PANE */, 0,
 434                                                               &r, &r);
 435     }
 436 #endif
 437
 438     wxCopyRECTToRect(r, rect);
 439
 440     return true;
 441 }
 442
 443 wxSize wxStatusBar::DoGetBestSize() const
 444 {
 445     const MSWBorders borders = MSWGetBorders();
 446
 447     // calculate width
 448     int width = 0;
 449     for ( size_t i = 0; i < m_panes.GetCount(); ++i )
 450     {
 451         int widthField =
 452             m_bSameWidthForAllPanes ? DEFAULT_FIELD_WIDTH : m_panes[i].GetWidth();
 453         if ( widthField >= 0 )
 454         {
 455             width += widthField;
 456         }
 457         else
 458         {
 459             // variable width field, its width is really a proportion
 460             // related to the other fields
 461             width += -widthField*DEFAULT_FIELD_WIDTH;
 462         }
 463
 464         // add the space between fields
 465         width += borders.between;
 466     }
 467
 468     if ( !width )
 469     {
 470         // still need something even for an empty status bar
 471         width = 2*DEFAULT_FIELD_WIDTH;
 472     }
 473
 474     // calculate height
 475     int height;
 476     wxGetCharSize(GetHWND(), NULL, &height, GetFont());
 477     height = EDIT_HEIGHT_FROM_CHAR_HEIGHT(height);
 478     height += borders.vert;
 479
 480     wxSize best(width, height);
 481     CacheBestSize(best);
 482     return best;
 483 }
 484
 485 void wxStatusBar::DoMoveWindow(int x, int y, int width, int height)
 486 {
 487     if ( GetParent()->IsSizeDeferred() )
 488     {
 489         wxWindowMSW::DoMoveWindow(x, y, width, height);
 490     }
 491     else
 492     {
 493         // parent pos/size isn't deferred so do it now but don't send
 494         // WM_WINDOWPOSCHANGING since we don't want to change pos/size later
 495         // we must use SWP_NOCOPYBITS here otherwise it paints incorrectly
 496         // if other windows are size deferred
 497         ::SetWindowPos(GetHwnd(), NULL, x, y, width, height,
 498                        SWP_NOZORDER | SWP_NOOWNERZORDER | SWP_NOACTIVATE
 499 #ifndef __WXWINCE__
 500                        | SWP_NOCOPYBITS | SWP_NOSENDCHANGING
 501 #endif
 502                        );
 503     }
 504
 505     // adjust fields widths to the new size
 506     MSWUpdateFieldsWidths();
 507
 508     // we have to trigger wxSizeEvent if there are children window in status
 509     // bar because GetFieldRect returned incorrect (not updated) values up to
 510     // here, which almost certainly resulted in incorrectly redrawn statusbar
 511     if ( m_children.GetCount() > 0 )
 512     {
 513         wxSizeEvent event(GetClientSize(), m_windowId);
 514         event.SetEventObject(this);
 515         HandleWindowEvent(event);
 516     }
 517 }
 518
 519 void wxStatusBar::SetStatusStyles(int n, const int styles[])
 520 {
 521     wxStatusBarBase::SetStatusStyles(n, styles);
 522
 523     if (n != (int)m_panes.GetCount())
 524         return;
 525
 526     for (int i = 0; i < n; i++)
 527     {
 528         int style;
 529         switch(styles[i])
 530         {
 531         case wxSB_RAISED:
 532             style = SBT_POPOUT;
 533             break;
 534         case wxSB_FLAT:
 535             style = SBT_NOBORDERS;
 536             break;
 537         case wxSB_NORMAL:
 538         default:
 539             style = 0;
 540             break;
 541         }
 542
 543         // The SB_SETTEXT message is both used to set the field's text as well as
 544         // the fields' styles.
 545         // NOTE: MSDN library doesn't mention that nField and style have to be 'ORed'
 546         wxString text = GetStatusText(i);
 547         if (!StatusBar_SetText(GetHwnd(), style | i, text.wx_str()))
 548         {
 549             wxLogLastError("StatusBar_SetText");
 550         }
 551     }
 552 }
 553
 554 WXLRESULT
 555 wxStatusBar::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
 556 {
 557 #ifndef __WXWINCE__
 558     if ( nMsg == WM_WINDOWPOSCHANGING )
 559     {
 560         WINDOWPOS *lpPos = (WINDOWPOS *)lParam;
 561         int x, y, w, h;
 562         GetPosition(&x, &y);
 563         GetSize(&w, &h);
 564
 565         // we need real window coords and not wx client coords
 566         AdjustForParentClientOrigin(x, y);
 567
 568         lpPos->x  = x;
 569         lpPos->y  = y;
 570         lpPos->cx = w;
 571         lpPos->cy = h;
 572
 573         return 0;
 574     }
 575
 576     if ( nMsg == WM_NCLBUTTONDOWN )
 577     {
 578         // if hit-test is on gripper then send message to TLW to begin
 579         // resizing. It is possible to send this message to any window.
 580         if ( wParam == HTBOTTOMRIGHT )
 581         {
 582             wxWindow *win;
 583
 584             for ( win = GetParent(); win; win = win->GetParent() )
 585             {
 586                 if ( win->IsTopLevel() )
 587                 {
 588                     SendMessage(GetHwndOf(win), WM_NCLBUTTONDOWN,
 589                                 wParam, lParam);
 590
 591                     return 0;
 592                 }
 593             }
 594         }
 595     }
 596 #endif
 597
 598     bool needsEllipsization = HasFlag(wxSTB_ELLIPSIZE_START) ||
 599                               HasFlag(wxSTB_ELLIPSIZE_MIDDLE) ||
 600                               HasFlag(wxSTB_ELLIPSIZE_END);
 601     if ( nMsg == WM_SIZE && needsEllipsization )
 602     {
 603         for (int i=0; i<GetFieldsCount(); i++)
 604             DoUpdateStatusText(i);
 605             // re-set the field text, in case we need to ellipsize
 606             // (or de-ellipsize) some parts of it
 607     }
 608
 609     return wxStatusBarBase::MSWWindowProc(nMsg, wParam, lParam);
 610 }
 611
 612 #if wxUSE_TOOLTIPS
 613 bool wxStatusBar::MSWProcessMessage(WXMSG* pMsg)
 614 {
 615     if ( HasFlag(wxSTB_SHOW_TIPS) )
 616     {
 617         // for a tooltip to be shown, we need to relay mouse events to it;
 618         // this is typically done by wxWindowMSW::MSWProcessMessage but only
 619         // if wxWindow::m_tooltip pointer is non-NULL.
 620         // Since wxStatusBar has multiple tooltips for a single HWND, it keeps
 621         // wxWindow::m_tooltip == NULL and then relays mouse events here:
 622         MSG *msg = (MSG *)pMsg;
 623         if ( msg->message == WM_MOUSEMOVE )
 624             wxToolTip::RelayEvent(pMsg);
 625     }
 626
 627     return wxWindow::MSWProcessMessage(pMsg);
 628 }
 629
 630 bool wxStatusBar::MSWOnNotify(int WXUNUSED(idCtrl), WXLPARAM lParam, WXLPARAM* WXUNUSED(result))
 631 {
 632     if ( HasFlag(wxSTB_SHOW_TIPS) )
 633     {
 634         // see comment in wxStatusBar::MSWProcessMessage for more info;
 635         // basically we need to override wxWindow::MSWOnNotify because
 636         // we have wxWindow::m_tooltip always NULL but we still use tooltips...
 637
 638         NMHDR* hdr = (NMHDR *)lParam;
 639
 640         wxString str;
 641         if (hdr->idFrom < m_tooltips.size() && m_tooltips[hdr->idFrom])
 642             str = m_tooltips[hdr->idFrom]->GetTip();
 643
 644         if ( HandleTooltipNotify(hdr->code, lParam, str))
 645         {
 646             // processed
 647             return true;
 648         }
 649     }
 650
 651     return false;
 652 }
 653 #endif // wxUSE_TOOLTIPS
 654
 655 #endif // wxUSE_STATUSBAR && wxUSE_NATIVE_STATUSBAR