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