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