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     // keep in synch also our m_tooltips array
 180
 181     // reset all current tooltips
 182     for (size_t i=0; i<m_tooltips.size(); i++)
 183     {
 184         wxDELETE(m_tooltips[i]);
 185     }
 186
 187     // shrink/expand the array:
 188     m_tooltips.resize(nFields, NULL);
 189
 190     wxStatusBarBase::SetFieldsCount(nFields, widths);
 191
 192     MSWUpdateFieldsWidths();
 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         DoUpdateStatusText(i);
 238     }
 239
 240     // The total width of the panes passed to Windows must be equal to the
 241     // total width available, including the grip. Otherwise we get an extra
 242     // separator line just before it.
 243     pWidths[count - 1] += gripWidth;
 244
 245     if ( !StatusBar_SetParts(GetHwnd(), count, pWidths) )
 246     {
 247         wxLogLastError("StatusBar_SetParts");
 248     }
 249
 250     delete [] pWidths;
 251 }
 252
 253 void wxStatusBar::DoUpdateStatusText(int nField)
 254 {
 255     if (!m_pDC)
 256         return;
 257
 258     // Get field style, if any
 259     int style;
 260     switch(m_panes[nField].GetStyle())
 261     {
 262     case wxSB_RAISED:
 263         style = SBT_POPOUT;
 264         break;
 265     case wxSB_FLAT:
 266         style = SBT_NOBORDERS;
 267         break;
 268
 269     case wxSB_NORMAL:
 270     default:
 271         style = 0;
 272         break;
 273     }
 274
 275     wxRect rc;
 276     GetFieldRect(nField, rc);
 277
 278     const int maxWidth = rc.GetWidth() - MSWGetMetrics().textMargin;
 279
 280     wxString text = GetStatusText(nField);
 281
 282     // do we need to ellipsize this string?
 283     wxEllipsizeMode ellmode = (wxEllipsizeMode)-1;
 284     if (HasFlag(wxSTB_ELLIPSIZE_START)) ellmode = wxELLIPSIZE_START;
 285     else if (HasFlag(wxSTB_ELLIPSIZE_MIDDLE)) ellmode = wxELLIPSIZE_MIDDLE;
 286     else if (HasFlag(wxSTB_ELLIPSIZE_END)) ellmode = wxELLIPSIZE_END;
 287
 288     if (ellmode == (wxEllipsizeMode)-1)
 289     {
 290         // if we have the wxSTB_SHOW_TIPS we must set the ellipsized flag even if
 291         // we don't ellipsize the text but just truncate it
 292         if (HasFlag(wxSTB_SHOW_TIPS))
 293             SetEllipsizedFlag(nField, m_pDC->GetTextExtent(text).GetWidth() > maxWidth);
 294     }
 295     else
 296     {
 297         text = wxControl::Ellipsize(text,
 298                                      *m_pDC,
 299                                      ellmode,
 300                                      maxWidth,
 301                                      wxELLIPSIZE_FLAGS_EXPAND_TABS);
 302
 303         // update the ellipsization status for this pane; this is used later to
 304         // decide whether a tooltip should be shown or not for this pane
 305         // (if we have wxSTB_SHOW_TIPS)
 306         SetEllipsizedFlag(nField, text != GetStatusText(nField));
 307     }
 308
 309     // Set the status text in the native control passing both field number and style.
 310     // NOTE: MSDN library doesn't mention that nField and style have to be 'ORed'
 311     if ( !StatusBar_SetText(GetHwnd(), nField | style, text.wx_str()) )
 312     {
 313         wxLogLastError("StatusBar_SetText");
 314     }
 315
 316     if (HasFlag(wxSTB_SHOW_TIPS))
 317     {
 318         wxASSERT(m_tooltips.size() == m_panes.GetCount());
 319
 320         if (m_tooltips[nField])
 321         {
 322             if (GetField(nField).IsEllipsized())
 323             {
 324                 // update the rect of this tooltip:
 325                 m_tooltips[nField]->SetRect(rc);
 326
 327                 // update also the text:
 328                 m_tooltips[nField]->SetTip(GetStatusText(nField));
 329             }
 330             else
 331             {
 332                 // delete the tooltip associated with this pane; it's not needed anymore
 333                 wxDELETE(m_tooltips[nField]);
 334             }
 335         }
 336         else
 337         {
 338             // create a new tooltip for this pane if needed
 339             if (GetField(nField).IsEllipsized())
 340                 m_tooltips[nField] = new wxToolTip(this, nField, GetStatusText(nField), rc);
 341             //else: leave m_tooltips[nField]==NULL
 342         }
 343     }
 344 }
 345
 346 wxStatusBar::MSWBorders wxStatusBar::MSWGetBorders() const
 347 {
 348     int aBorders[3];
 349     SendMessage(GetHwnd(), SB_GETBORDERS, 0, (LPARAM)aBorders);
 350
 351     MSWBorders borders;
 352     borders.horz = aBorders[0];
 353     borders.vert = aBorders[1];
 354     borders.between = aBorders[2];
 355     return borders;
 356 }
 357
 358 int wxStatusBar::GetBorderX() const
 359 {
 360     return MSWGetBorders().horz;
 361 }
 362
 363 int wxStatusBar::GetBorderY() const
 364 {
 365     return MSWGetBorders().vert;
 366 }
 367
 368 int wxStatusBar::MSWGetBorderWidth() const
 369 {
 370     return MSWGetBorders().between;
 371 }
 372
 373 /* static */
 374 const wxStatusBar::MSWMetrics& wxStatusBar::MSWGetMetrics()
 375 {
 376     static MSWMetrics s_metrics = { 0, 0 };
 377     if ( !s_metrics.textMargin )
 378     {
 379         // Grip size should be self explanatory (the only problem with it is
 380         // that it's hard coded as we don't know how to find its size using
 381         // API) but the margin might merit an explanation: Windows offsets the
 382         // text drawn in status bar panes so we need to take this extra margin
 383         // into account to make sure the text drawn by user fits inside the
 384         // pane. Notice that it's not the value returned by SB_GETBORDERS
 385         // which, at least on this Windows 2003 system, returns {0, 2, 2}
 386         if ( wxUxThemeEngine::GetIfActive() )
 387         {
 388             s_metrics.gripWidth = 20;
 389             s_metrics.textMargin = 8;
 390         }
 391         else // classic/unthemed look
 392         {
 393             s_metrics.gripWidth = 18;
 394             s_metrics.textMargin = 4;
 395         }
 396     }
 397
 398     return s_metrics;
 399 }
 400
 401 void wxStatusBar::SetMinHeight(int height)
 402 {
 403     SendMessage(GetHwnd(), SB_SETMINHEIGHT, height + 2*GetBorderY(), 0);
 404
 405     // we have to send a (dummy) WM_SIZE to redraw it now
 406     SendMessage(GetHwnd(), WM_SIZE, 0, 0);
 407 }
 408
 409 bool wxStatusBar::GetFieldRect(int i, wxRect& rect) const
 410 {
 411     wxCHECK_MSG( (i >= 0) && ((size_t)i < m_panes.GetCount()), false,
 412                  "invalid statusbar field index" );
 413
 414     RECT r;
 415     if ( !::SendMessage(GetHwnd(), SB_GETRECT, i, (LPARAM)&r) )
 416     {
 417         wxLogLastError("SendMessage(SB_GETRECT)");
 418     }
 419
 420 #if wxUSE_UXTHEME
 421     wxUxThemeHandle theme(const_cast<wxStatusBar*>(this), L"Status");
 422     if ( theme )
 423     {
 424         // by default Windows has a 2 pixel border to the right of the left
 425         // divider (or it could be a bug) but it looks wrong so remove it
 426         if ( i != 0 )
 427         {
 428             r.left -= 2;
 429         }
 430
 431         wxUxThemeEngine::Get()->GetThemeBackgroundContentRect(theme, NULL,
 432                                                               1 /* SP_PANE */, 0,
 433                                                               &r, &r);
 434     }
 435 #endif
 436
 437     wxCopyRECTToRect(r, rect);
 438
 439     return true;
 440 }
 441
 442 wxSize wxStatusBar::DoGetBestSize() const
 443 {
 444     const MSWBorders borders = MSWGetBorders();
 445
 446     // calculate width
 447     int width = 0;
 448     for ( size_t i = 0; i < m_panes.GetCount(); ++i )
 449     {
 450         int widthField =
 451             m_bSameWidthForAllPanes ? DEFAULT_FIELD_WIDTH : m_panes[i].GetWidth();
 452         if ( widthField >= 0 )
 453         {
 454             width += widthField;
 455         }
 456         else
 457         {
 458             // variable width field, its width is really a proportion
 459             // related to the other fields
 460             width += -widthField*DEFAULT_FIELD_WIDTH;
 461         }
 462
 463         // add the space between fields
 464         width += borders.between;
 465     }
 466
 467     if ( !width )
 468     {
 469         // still need something even for an empty status bar
 470         width = 2*DEFAULT_FIELD_WIDTH;
 471     }
 472
 473     // calculate height
 474     int height;
 475     wxGetCharSize(GetHWND(), NULL, &height, GetFont());
 476     height = EDIT_HEIGHT_FROM_CHAR_HEIGHT(height);
 477     height += borders.vert;
 478
 479     wxSize best(width, height);
 480     CacheBestSize(best);
 481     return best;
 482 }
 483
 484 void wxStatusBar::DoMoveWindow(int x, int y, int width, int height)
 485 {
 486     if ( GetParent()->IsSizeDeferred() )
 487     {
 488         wxWindowMSW::DoMoveWindow(x, y, width, height);
 489     }
 490     else
 491     {
 492         // parent pos/size isn't deferred so do it now but don't send
 493         // WM_WINDOWPOSCHANGING since we don't want to change pos/size later
 494         // we must use SWP_NOCOPYBITS here otherwise it paints incorrectly
 495         // if other windows are size deferred
 496         ::SetWindowPos(GetHwnd(), NULL, x, y, width, height,
 497                        SWP_NOZORDER | SWP_NOOWNERZORDER | SWP_NOACTIVATE
 498 #ifndef __WXWINCE__
 499                        | SWP_NOCOPYBITS | SWP_NOSENDCHANGING
 500 #endif
 501                        );
 502     }
 503
 504     // we have to trigger wxSizeEvent if there are children window in status
 505     // bar because GetFieldRect returned incorrect (not updated) values up to
 506     // here, which almost certainly resulted in incorrectly redrawn statusbar
 507     if ( m_children.GetCount() > 0 )
 508     {
 509         wxSizeEvent event(GetClientSize(), m_windowId);
 510         event.SetEventObject(this);
 511         HandleWindowEvent(event);
 512     }
 513 }
 514
 515 void wxStatusBar::SetStatusStyles(int n, const int styles[])
 516 {
 517     wxStatusBarBase::SetStatusStyles(n, styles);
 518
 519     if (n != (int)m_panes.GetCount())
 520         return;
 521
 522     for (int i = 0; i < n; i++)
 523     {
 524         int style;
 525         switch(styles[i])
 526         {
 527         case wxSB_RAISED:
 528             style = SBT_POPOUT;
 529             break;
 530         case wxSB_FLAT:
 531             style = SBT_NOBORDERS;
 532             break;
 533         case wxSB_NORMAL:
 534         default:
 535             style = 0;
 536             break;
 537         }
 538
 539         // The SB_SETTEXT message is both used to set the field's text as well as
 540         // the fields' styles.
 541         // NOTE: MSDN library doesn't mention that nField and style have to be 'ORed'
 542         wxString text = GetStatusText(i);
 543         if (!StatusBar_SetText(GetHwnd(), style | i, text.wx_str()))
 544         {
 545             wxLogLastError("StatusBar_SetText");
 546         }
 547     }
 548 }
 549
 550 WXLRESULT
 551 wxStatusBar::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
 552 {
 553 #ifndef __WXWINCE__
 554     if ( nMsg == WM_WINDOWPOSCHANGING )
 555     {
 556         WINDOWPOS *lpPos = (WINDOWPOS *)lParam;
 557         int x, y, w, h;
 558         GetPosition(&x, &y);
 559         GetSize(&w, &h);
 560
 561         // we need real window coords and not wx client coords
 562         AdjustForParentClientOrigin(x, y);
 563
 564         lpPos->x  = x;
 565         lpPos->y  = y;
 566         lpPos->cx = w;
 567         lpPos->cy = h;
 568
 569         return 0;
 570     }
 571
 572     if ( nMsg == WM_NCLBUTTONDOWN )
 573     {
 574         // if hit-test is on gripper then send message to TLW to begin
 575         // resizing. It is possible to send this message to any window.
 576         if ( wParam == HTBOTTOMRIGHT )
 577         {
 578             wxWindow *win;
 579
 580             for ( win = GetParent(); win; win = win->GetParent() )
 581             {
 582                 if ( win->IsTopLevel() )
 583                 {
 584                     SendMessage(GetHwndOf(win), WM_NCLBUTTONDOWN,
 585                                 wParam, lParam);
 586
 587                     return 0;
 588                 }
 589             }
 590         }
 591     }
 592 #endif
 593
 594     if ( nMsg == WM_SIZE )
 595     {
 596         MSWUpdateFieldsWidths();
 597
 598         if ( HasFlag(wxSTB_ELLIPSIZE_START) ||
 599                 HasFlag(wxSTB_ELLIPSIZE_MIDDLE) ||
 600                     HasFlag(wxSTB_ELLIPSIZE_END) )
 601         {
 602             for (int i=0; i<GetFieldsCount(); i++)
 603             {
 604                 // re-set the field text, in case we need to ellipsize
 605                 // (or de-ellipsize) some parts of it
 606                 DoUpdateStatusText(i);
 607             }
 608         }
 609     }
 610
 611     return wxStatusBarBase::MSWWindowProc(nMsg, wParam, lParam);
 612 }
 613
 614 #if wxUSE_TOOLTIPS
 615 bool wxStatusBar::MSWProcessMessage(WXMSG* pMsg)
 616 {
 617     if ( HasFlag(wxSTB_SHOW_TIPS) )
 618     {
 619         // for a tooltip to be shown, we need to relay mouse events to it;
 620         // this is typically done by wxWindowMSW::MSWProcessMessage but only
 621         // if wxWindow::m_tooltip pointer is non-NULL.
 622         // Since wxStatusBar has multiple tooltips for a single HWND, it keeps
 623         // wxWindow::m_tooltip == NULL and then relays mouse events here:
 624         MSG *msg = (MSG *)pMsg;
 625         if ( msg->message == WM_MOUSEMOVE )
 626             wxToolTip::RelayEvent(pMsg);
 627     }
 628
 629     return wxWindow::MSWProcessMessage(pMsg);
 630 }
 631
 632 bool wxStatusBar::MSWOnNotify(int WXUNUSED(idCtrl), WXLPARAM lParam, WXLPARAM* WXUNUSED(result))
 633 {
 634     if ( HasFlag(wxSTB_SHOW_TIPS) )
 635     {
 636         // see comment in wxStatusBar::MSWProcessMessage for more info;
 637         // basically we need to override wxWindow::MSWOnNotify because
 638         // we have wxWindow::m_tooltip always NULL but we still use tooltips...
 639
 640         NMHDR* hdr = (NMHDR *)lParam;
 641
 642         wxString str;
 643         if (hdr->idFrom < m_tooltips.size() && m_tooltips[hdr->idFrom])
 644             str = m_tooltips[hdr->idFrom]->GetTip();
 645
 646         if ( HandleTooltipNotify(hdr->code, lParam, str))
 647         {
 648             // processed
 649             return true;
 650         }
 651     }
 652
 653     return false;
 654 }
 655 #endif // wxUSE_TOOLTIPS
 656
 657 #endif // wxUSE_STATUSBAR && wxUSE_NATIVE_STATUSBAR