1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: src/msw/statusbar.cpp
3 // Purpose: native implementation of wxStatusBar
4 // Author: Vadim Zeitlin
8 // Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 // for compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
27 #if wxUSE_STATUSBAR && wxUSE_NATIVE_STATUSBAR
29 #include "wx/statusbr.h"
32 #include "wx/msw/wrapcctl.h" // include <commctrl.h> "properly"
34 #include "wx/settings.h"
35 #include "wx/dcclient.h"
38 #include "wx/control.h"
41 #include "wx/msw/private.h"
42 #include "wx/tooltip.h"
46 #include "wx/msw/uxtheme.h"
49 // ----------------------------------------------------------------------------
51 // ----------------------------------------------------------------------------
56 // no idea for a default width, just choose something
57 static const int DEFAULT_FIELD_WIDTH
= 25;
59 } // anonymous namespace
61 // ----------------------------------------------------------------------------
63 // ----------------------------------------------------------------------------
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))
71 // ============================================================================
73 // ============================================================================
75 // ----------------------------------------------------------------------------
77 // ----------------------------------------------------------------------------
79 wxStatusBar::wxStatusBar()
87 WXDWORD
wxStatusBar::MSWGetStyle(long style
, WXDWORD
*exstyle
) const
89 WXDWORD msStyle
= wxStatusBarBase::MSWGetStyle(style
, exstyle
);
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
;
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
104 if ( !(style
& wxSTB_SIZEGRIP
) )
111 // may be some versions of comctl32.dll do need it - anyhow, it won't
113 msStyle
|= SBARS_SIZEGRIP
;
120 bool wxStatusBar::Create(wxWindow
*parent
,
123 const wxString
& name
)
125 if ( !CreateControl(parent
, id
, wxDefaultPosition
, wxDefaultSize
,
126 style
, wxDefaultValidator
, name
) )
129 if ( !MSWCreateControl(STATUSCLASSNAME
, wxString(),
130 wxDefaultPosition
, wxDefaultSize
) )
135 // cache the DC instance used by DoUpdateStatusText:
136 m_pDC
= new wxClientDC(this);
138 // we must refresh the frame size when the statusbar is created, because
139 // its client area might change
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();
149 wxStatusBar::~wxStatusBar()
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
154 PostSizeEventToParent();
157 // delete existing tooltips
158 for (size_t i
=0; i
<m_tooltips
.size(); i
++)
160 wxDELETE(m_tooltips
[i
]);
162 #endif // wxUSE_TOOLTIPS
167 bool wxStatusBar::SetFont(const wxFont
& font
)
169 if (!wxWindow::SetFont(font
))
172 if (m_pDC
) m_pDC
->SetFont(font
);
176 void wxStatusBar::SetFieldsCount(int nFields
, const int *widths
)
178 // this is a Windows limitation
179 wxASSERT_MSG( (nFields
> 0) && (nFields
< 255), "too many fields" );
181 // keep in synch also our m_tooltips array
184 // reset all current tooltips
185 for (size_t i
=0; i
<m_tooltips
.size(); i
++)
187 wxDELETE(m_tooltips
[i
]);
190 // shrink/expand the array:
191 m_tooltips
.resize(nFields
, NULL
);
192 #endif // wxUSE_TOOLTIPS
194 wxStatusBarBase::SetFieldsCount(nFields
, widths
);
196 MSWUpdateFieldsWidths();
199 void wxStatusBar::SetStatusWidths(int n
, const int widths
[])
201 wxStatusBarBase::SetStatusWidths(n
, widths
);
203 MSWUpdateFieldsWidths();
206 void wxStatusBar::MSWUpdateFieldsWidths()
208 if ( m_panes
.IsEmpty() )
211 const int count
= m_panes
.GetCount();
213 const int extraWidth
= MSWGetBorderWidth() + MSWGetMetrics().textMargin
;
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
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
224 widthAvailable
-= gripWidth
;
226 // distribute the available space (client width) among the various fields:
228 wxArrayInt widthsAbs
= CalculateAbsWidths(widthAvailable
);
231 // update the field widths in the native control:
233 int *pWidths
= new int[count
];
237 for ( i
= 0; i
< count
; i
++ )
239 nCurPos
+= widthsAbs
[i
] + extraWidth
;
240 pWidths
[i
] = nCurPos
;
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
;
248 if ( !StatusBar_SetParts(GetHwnd(), count
, pWidths
) )
250 wxLogLastError("StatusBar_SetParts");
253 // Now that all parts have been created, set their text.
254 for ( i
= 0; i
< count
; i
++ )
256 DoUpdateStatusText(i
);
262 void wxStatusBar::DoUpdateStatusText(int nField
)
267 // Get field style, if any
269 switch(m_panes
[nField
].GetStyle())
275 style
= SBT_NOBORDERS
;
285 GetFieldRect(nField
, rc
);
287 const int maxWidth
= rc
.GetWidth() - MSWGetMetrics().textMargin
;
289 wxString text
= GetStatusText(nField
);
291 // do we need to ellipsize this string?
292 wxEllipsizeMode ellmode
= (wxEllipsizeMode
)-1;
293 if (HasFlag(wxSTB_ELLIPSIZE_START
)) ellmode
= wxELLIPSIZE_START
;
294 else if (HasFlag(wxSTB_ELLIPSIZE_MIDDLE
)) ellmode
= wxELLIPSIZE_MIDDLE
;
295 else if (HasFlag(wxSTB_ELLIPSIZE_END
)) ellmode
= wxELLIPSIZE_END
;
297 if (ellmode
== (wxEllipsizeMode
)-1)
299 // if we have the wxSTB_SHOW_TIPS we must set the ellipsized flag even if
300 // we don't ellipsize the text but just truncate it
301 if (HasFlag(wxSTB_SHOW_TIPS
))
302 SetEllipsizedFlag(nField
, m_pDC
->GetTextExtent(text
).GetWidth() > maxWidth
);
306 text
= wxControl::Ellipsize(text
,
310 wxELLIPSIZE_FLAGS_EXPAND_TABS
);
312 // update the ellipsization status for this pane; this is used later to
313 // decide whether a tooltip should be shown or not for this pane
314 // (if we have wxSTB_SHOW_TIPS)
315 SetEllipsizedFlag(nField
, text
!= GetStatusText(nField
));
318 // Set the status text in the native control passing both field number and style.
319 // NOTE: MSDN library doesn't mention that nField and style have to be 'ORed'
320 if ( !StatusBar_SetText(GetHwnd(), nField
| style
, text
.wx_str()) )
322 wxLogLastError("StatusBar_SetText");
326 if (HasFlag(wxSTB_SHOW_TIPS
))
328 wxASSERT(m_tooltips
.size() == m_panes
.GetCount());
330 if (m_tooltips
[nField
])
332 if (GetField(nField
).IsEllipsized())
334 // update the rect of this tooltip:
335 m_tooltips
[nField
]->SetRect(rc
);
337 // update also the text:
338 m_tooltips
[nField
]->SetTip(GetStatusText(nField
));
342 // delete the tooltip associated with this pane; it's not needed anymore
343 wxDELETE(m_tooltips
[nField
]);
348 // create a new tooltip for this pane if needed
349 if (GetField(nField
).IsEllipsized())
350 m_tooltips
[nField
] = new wxToolTip(this, nField
, GetStatusText(nField
), rc
);
351 //else: leave m_tooltips[nField]==NULL
354 #endif // wxUSE_TOOLTIPS
357 wxStatusBar::MSWBorders
wxStatusBar::MSWGetBorders() const
360 SendMessage(GetHwnd(), SB_GETBORDERS
, 0, (LPARAM
)aBorders
);
363 borders
.horz
= aBorders
[0];
364 borders
.vert
= aBorders
[1];
365 borders
.between
= aBorders
[2];
369 int wxStatusBar::GetBorderX() const
371 return MSWGetBorders().horz
;
374 int wxStatusBar::GetBorderY() const
376 return MSWGetBorders().vert
;
379 int wxStatusBar::MSWGetBorderWidth() const
381 return MSWGetBorders().between
;
385 const wxStatusBar::MSWMetrics
& wxStatusBar::MSWGetMetrics()
387 static MSWMetrics s_metrics
= { 0, 0 };
388 if ( !s_metrics
.textMargin
)
390 // Grip size should be self explanatory (the only problem with it is
391 // that it's hard coded as we don't know how to find its size using
392 // API) but the margin might merit an explanation: Windows offsets the
393 // text drawn in status bar panes so we need to take this extra margin
394 // into account to make sure the text drawn by user fits inside the
395 // pane. Notice that it's not the value returned by SB_GETBORDERS
396 // which, at least on this Windows 2003 system, returns {0, 2, 2}
398 if ( wxUxThemeEngine::GetIfActive() )
400 s_metrics
.gripWidth
= 20;
401 s_metrics
.textMargin
= 8;
403 else // classic/unthemed look
404 #endif // wxUSE_UXTHEME
406 s_metrics
.gripWidth
= 18;
407 s_metrics
.textMargin
= 4;
414 void wxStatusBar::SetMinHeight(int height
)
416 // It looks like we need to count the border twice to really make the
417 // controls taking exactly height pixels fully fit in the status bar:
418 // at least under Windows 7 the checkbox in the custom status bar of the
419 // statbar sample gets truncated otherwise.
420 height
+= 4*GetBorderY();
422 // We need to set the size and not the size to reflect the height because
423 // wxFrame uses our size and not the minimal size as it assumes that the
424 // size of a status bar never changes anyhow.
427 SendMessage(GetHwnd(), SB_SETMINHEIGHT
, height
, 0);
429 // we have to send a (dummy) WM_SIZE to redraw it now
430 SendMessage(GetHwnd(), WM_SIZE
, 0, 0);
433 bool wxStatusBar::GetFieldRect(int i
, wxRect
& rect
) const
435 wxCHECK_MSG( (i
>= 0) && ((size_t)i
< m_panes
.GetCount()), false,
436 "invalid statusbar field index" );
439 if ( !::SendMessage(GetHwnd(), SB_GETRECT
, i
, (LPARAM
)&r
) )
441 wxLogLastError("SendMessage(SB_GETRECT)");
445 wxUxThemeHandle
theme(const_cast<wxStatusBar
*>(this), L
"Status");
448 // by default Windows has a 2 pixel border to the right of the left
449 // divider (or it could be a bug) but it looks wrong so remove it
455 wxUxThemeEngine::Get()->GetThemeBackgroundContentRect(theme
, NULL
,
461 wxCopyRECTToRect(r
, rect
);
466 wxSize
wxStatusBar::DoGetBestSize() const
468 const MSWBorders borders
= MSWGetBorders();
472 for ( size_t i
= 0; i
< m_panes
.GetCount(); ++i
)
475 m_bSameWidthForAllPanes
? DEFAULT_FIELD_WIDTH
: m_panes
[i
].GetWidth();
476 if ( widthField
>= 0 )
482 // variable width field, its width is really a proportion
483 // related to the other fields
484 width
+= -widthField
*DEFAULT_FIELD_WIDTH
;
487 // add the space between fields
488 width
+= borders
.between
;
493 // still need something even for an empty status bar
494 width
= 2*DEFAULT_FIELD_WIDTH
;
497 // calculate height: by default it should be just big enough to show text
498 // (see SetMinHeight() for the explanation of 4 factor)
499 int height
= GetCharHeight();
500 height
+= 4*borders
.vert
;
502 wxSize
best(width
, height
);
507 void wxStatusBar::DoMoveWindow(int x
, int y
, int width
, int height
)
509 if ( GetParent()->IsSizeDeferred() )
511 wxWindowMSW::DoMoveWindow(x
, y
, width
, height
);
515 // parent pos/size isn't deferred so do it now but don't send
516 // WM_WINDOWPOSCHANGING since we don't want to change pos/size later
517 // we must use SWP_NOCOPYBITS here otherwise it paints incorrectly
518 // if other windows are size deferred
519 ::SetWindowPos(GetHwnd(), NULL
, x
, y
, width
, height
,
520 SWP_NOZORDER
| SWP_NOOWNERZORDER
| SWP_NOACTIVATE
522 | SWP_NOCOPYBITS
| SWP_NOSENDCHANGING
527 // we have to trigger wxSizeEvent if there are children window in status
528 // bar because GetFieldRect returned incorrect (not updated) values up to
529 // here, which almost certainly resulted in incorrectly redrawn statusbar
530 if ( m_children
.GetCount() > 0 )
532 wxSizeEvent
event(GetClientSize(), m_windowId
);
533 event
.SetEventObject(this);
534 HandleWindowEvent(event
);
538 void wxStatusBar::SetStatusStyles(int n
, const int styles
[])
540 wxStatusBarBase::SetStatusStyles(n
, styles
);
542 if (n
!= (int)m_panes
.GetCount())
545 for (int i
= 0; i
< n
; i
++)
554 style
= SBT_NOBORDERS
;
562 // The SB_SETTEXT message is both used to set the field's text as well as
563 // the fields' styles.
564 // NOTE: MSDN library doesn't mention that nField and style have to be 'ORed'
565 wxString text
= GetStatusText(i
);
566 if (!StatusBar_SetText(GetHwnd(), style
| i
, text
.wx_str()))
568 wxLogLastError("StatusBar_SetText");
574 wxStatusBar::MSWWindowProc(WXUINT nMsg
, WXWPARAM wParam
, WXLPARAM lParam
)
577 if ( nMsg
== WM_WINDOWPOSCHANGING
)
579 WINDOWPOS
*lpPos
= (WINDOWPOS
*)lParam
;
584 // we need real window coords and not wx client coords
585 AdjustForParentClientOrigin(x
, y
);
595 if ( nMsg
== WM_NCLBUTTONDOWN
)
597 // if hit-test is on gripper then send message to TLW to begin
598 // resizing. It is possible to send this message to any window.
599 if ( wParam
== HTBOTTOMRIGHT
)
603 for ( win
= GetParent(); win
; win
= win
->GetParent() )
605 if ( win
->IsTopLevel() )
607 SendMessage(GetHwndOf(win
), WM_NCLBUTTONDOWN
,
617 if ( nMsg
== WM_SIZE
)
619 MSWUpdateFieldsWidths();
621 if ( HasFlag(wxSTB_ELLIPSIZE_START
) ||
622 HasFlag(wxSTB_ELLIPSIZE_MIDDLE
) ||
623 HasFlag(wxSTB_ELLIPSIZE_END
) )
625 for (int i
=0; i
<GetFieldsCount(); i
++)
627 // re-set the field text, in case we need to ellipsize
628 // (or de-ellipsize) some parts of it
629 DoUpdateStatusText(i
);
634 return wxStatusBarBase::MSWWindowProc(nMsg
, wParam
, lParam
);
638 bool wxStatusBar::MSWProcessMessage(WXMSG
* pMsg
)
640 if ( HasFlag(wxSTB_SHOW_TIPS
) )
642 // for a tooltip to be shown, we need to relay mouse events to it;
643 // this is typically done by wxWindowMSW::MSWProcessMessage but only
644 // if wxWindow::m_tooltip pointer is non-NULL.
645 // Since wxStatusBar has multiple tooltips for a single HWND, it keeps
646 // wxWindow::m_tooltip == NULL and then relays mouse events here:
647 MSG
*msg
= (MSG
*)pMsg
;
648 if ( msg
->message
== WM_MOUSEMOVE
)
649 wxToolTip::RelayEvent(pMsg
);
652 return wxWindow::MSWProcessMessage(pMsg
);
655 bool wxStatusBar::MSWOnNotify(int WXUNUSED(idCtrl
), WXLPARAM lParam
, WXLPARAM
* WXUNUSED(result
))
657 if ( HasFlag(wxSTB_SHOW_TIPS
) )
659 // see comment in wxStatusBar::MSWProcessMessage for more info;
660 // basically we need to override wxWindow::MSWOnNotify because
661 // we have wxWindow::m_tooltip always NULL but we still use tooltips...
663 NMHDR
* hdr
= (NMHDR
*)lParam
;
666 if (hdr
->idFrom
< m_tooltips
.size() && m_tooltips
[hdr
->idFrom
])
667 str
= m_tooltips
[hdr
->idFrom
]->GetTip();
669 if ( HandleTooltipNotify(hdr
->code
, lParam
, str
))
678 #endif // wxUSE_TOOLTIPS
680 #endif // wxUSE_STATUSBAR && wxUSE_NATIVE_STATUSBAR