X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0cd159592e4d9c979aa5a626627cdd9158fcc34f..ee6c519a4b1c8e919c1353b977e6396a160bc4b3:/src/msw/statusbar.cpp diff --git a/src/msw/statusbar.cpp b/src/msw/statusbar.cpp index 0dcc35899c..321df1bb05 100644 --- a/src/msw/statusbar.cpp +++ b/src/msw/statusbar.cpp @@ -9,6 +9,14 @@ // Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// +// ============================================================================ +// declarations +// ============================================================================ + +// ---------------------------------------------------------------------------- +// headers +// ---------------------------------------------------------------------------- + // for compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" @@ -27,17 +35,28 @@ #include "wx/dcclient.h" #include "wx/intl.h" #include "wx/log.h" + #include "wx/control.h" #endif #include "wx/msw/private.h" +#include "wx/tooltip.h" #include #if wxUSE_UXTHEME #include "wx/msw/uxtheme.h" #endif +// ---------------------------------------------------------------------------- +// constants +// ---------------------------------------------------------------------------- + +namespace +{ + // no idea for a default width, just choose something -#define DEFAULT_FIELD_WIDTH 25 +static const int DEFAULT_FIELD_WIDTH = 25; + +} // anonymous namespace // ---------------------------------------------------------------------------- // macros @@ -65,67 +84,56 @@ wxStatusBar::wxStatusBar() m_pDC = NULL; } -bool wxStatusBar::Create(wxWindow *parent, - wxWindowID id, - long style, - const wxString& name) +WXDWORD wxStatusBar::MSWGetStyle(long style, WXDWORD *exstyle) const { - wxCHECK_MSG( parent, false, wxT("status bar must have a parent") ); + WXDWORD msStyle = wxStatusBarBase::MSWGetStyle(style, exstyle); - SetName(name); - SetWindowStyleFlag(style); - SetParent(parent); - - parent->AddChild(this); - - m_windowId = id == wxID_ANY ? NewControlId() : id; - - DWORD wstyle = WS_CHILD | WS_VISIBLE; - - if ( style & wxCLIP_SIBLINGS ) - wstyle |= WS_CLIPSIBLINGS; + // wxSTB_SIZEGRIP is part of our default style but it doesn't make sense to + // show size grip if this is the status bar of a non-resizable TLW so turn + // it off in such case + wxWindow * const parent = GetParent(); + wxCHECK_MSG( parent, msStyle, wxS("Status bar must have a parent") ); + if ( parent->IsTopLevel() && !parent->HasFlag(wxRESIZE_BORDER) ) + style &= ~wxSTB_SIZEGRIP; // setting SBARS_SIZEGRIP is perfectly useless: it's always on by default // (at least in the version of comctl32.dll I'm using), and the only way to // turn it off is to use CCS_TOP style - as we position the status bar - // manually anyhow (see DoMoveWindow), use CCS_TOP style if wxST_SIZEGRIP + // manually anyhow (see DoMoveWindow), use CCS_TOP style if wxSTB_SIZEGRIP // is not given - if ( !(style & wxST_SIZEGRIP) ) + if ( !(style & wxSTB_SIZEGRIP) ) { - wstyle |= CCS_TOP; + msStyle |= CCS_TOP; } else { #ifndef __WXWINCE__ // may be some versions of comctl32.dll do need it - anyhow, it won't // do any harm - wstyle |= SBARS_SIZEGRIP; + msStyle |= SBARS_SIZEGRIP; #endif } - m_hWnd = CreateWindow - ( - STATUSCLASSNAME, - _T(""), - wstyle, - 0, 0, 0, 0, - GetHwndOf(parent), - (HMENU)wxUIntToPtr(m_windowId.GetValue()), - wxGetInstance(), - NULL - ); - if ( m_hWnd == 0 ) - { - wxLogSysError(_("Failed to create a status bar.")); + return msStyle; +} + +bool wxStatusBar::Create(wxWindow *parent, + wxWindowID id, + long style, + const wxString& name) +{ + if ( !CreateControl(parent, id, wxDefaultPosition, wxDefaultSize, + style, wxDefaultValidator, name) ) + return false; + if ( !MSWCreateControl(STATUSCLASSNAME, wxString(), + wxDefaultPosition, wxDefaultSize) ) return false; - } SetFieldsCount(1); - SubclassWin(m_hWnd); - InheritAttributes(); - SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_MENUBAR)); + // cache the DC instance used by DoUpdateStatusText: + m_pDC = new wxClientDC(this); // we must refresh the frame size when the statusbar is created, because // its client area might change @@ -135,9 +143,6 @@ bool wxStatusBar::Create(wxWindow *parent, // work correctly, we need to wait until we return to the main loop PostSizeEventToParent(); - // cache the DC instance used by UpdateFieldText - m_pDC = new wxClientDC(this); - return true; } @@ -147,6 +152,16 @@ wxStatusBar::~wxStatusBar() // frame is not - otherwise statusbar leaves a hole in the place it used to // occupy PostSizeEventToParent(); + +#if wxUSE_TOOLTIPS + // delete existing tooltips + for (size_t i=0; iSetFont(font); + if (m_pDC) m_pDC->SetFont(font); return true; } void wxStatusBar::SetFieldsCount(int nFields, const int *widths) { // this is a Windows limitation - wxASSERT_MSG( (nFields > 0) && (nFields < 255), _T("too many fields") ); + wxASSERT_MSG( (nFields > 0) && (nFields < 255), "too many fields" ); + + // keep in synch also our m_tooltips array + +#if wxUSE_TOOLTIPS + // reset all current tooltips + for (size_t i=0; i= 0) && ((size_t)nField < m_panes.GetCount()), - _T("invalid statusbar field index") ); + // The total width of the panes passed to Windows must be equal to the + // total width available, including the grip. Otherwise we get an extra + // separator line just before it. + pWidths[count - 1] += gripWidth; - if ( strText == GetStatusText(nField) ) + if ( !StatusBar_SetParts(GetHwnd(), count, pWidths) ) { - // don't call StatusBar_SetText() to avoid flicker - return; + wxLogLastError("StatusBar_SetParts"); } - wxStatusBarBase::SetStatusText(strText, nField); + // Now that all parts have been created, set their text. + for ( i = 0; i < count; i++ ) + { + DoUpdateStatusText(i); + } - UpdateFieldText(nField); + delete [] pWidths; } -void wxStatusBar::UpdateFieldText(int nField) +void wxStatusBar::DoUpdateStatusText(int nField) { if (!m_pDC) return; // Get field style, if any int style; - switch(m_panes[nField].nStyle) + switch(m_panes[nField].GetStyle()) { case wxSB_RAISED: style = SBT_POPOUT; @@ -244,64 +284,165 @@ void wxStatusBar::UpdateFieldText(int nField) wxRect rc; GetFieldRect(nField, rc); - int margin; - if (nField == GetFieldsCount()-1) - margin = -6; // windows reports a smaller rect for the last field; enlarge it - else - margin = 4; + const int maxWidth = rc.GetWidth() - MSWGetMetrics().textMargin; + + wxString text = GetStatusText(nField); // do we need to ellipsize this string? - wxString ellipsizedStr = - wxControl::Ellipsize(GetStatusText(nField), *m_pDC, - GetLayoutDirection() == wxLayout_RightToLeft ? wxELLIPSIZE_START : wxELLIPSIZE_END, - rc.GetWidth() - margin, // leave a small margin - wxELLIPSIZE_EXPAND_TAB); - - // Pass both field number and style. MSDN library doesn't mention - // that nField and style have to be 'ORed' - if ( !StatusBar_SetText(GetHwnd(), nField | style, ellipsizedStr.wx_str()) ) + wxEllipsizeMode ellmode = (wxEllipsizeMode)-1; + if (HasFlag(wxSTB_ELLIPSIZE_START)) ellmode = wxELLIPSIZE_START; + else if (HasFlag(wxSTB_ELLIPSIZE_MIDDLE)) ellmode = wxELLIPSIZE_MIDDLE; + else if (HasFlag(wxSTB_ELLIPSIZE_END)) ellmode = wxELLIPSIZE_END; + + if (ellmode == (wxEllipsizeMode)-1) + { + // if we have the wxSTB_SHOW_TIPS we must set the ellipsized flag even if + // we don't ellipsize the text but just truncate it + if (HasFlag(wxSTB_SHOW_TIPS)) + SetEllipsizedFlag(nField, m_pDC->GetTextExtent(text).GetWidth() > maxWidth); + } + else + { + text = wxControl::Ellipsize(text, + *m_pDC, + ellmode, + maxWidth, + wxELLIPSIZE_FLAGS_EXPAND_TABS); + + // update the ellipsization status for this pane; this is used later to + // decide whether a tooltip should be shown or not for this pane + // (if we have wxSTB_SHOW_TIPS) + SetEllipsizedFlag(nField, text != GetStatusText(nField)); + } + + // Set the status text in the native control passing both field number and style. + // NOTE: MSDN library doesn't mention that nField and style have to be 'ORed' + if ( !StatusBar_SetText(GetHwnd(), nField | style, text.t_str()) ) { - wxLogLastError(wxT("StatusBar_SetText")); + wxLogLastError("StatusBar_SetText"); + } + +#if wxUSE_TOOLTIPS + if (HasFlag(wxSTB_SHOW_TIPS)) + { + wxASSERT(m_tooltips.size() == m_panes.GetCount()); + + if (m_tooltips[nField]) + { + if (GetField(nField).IsEllipsized()) + { + // update the rect of this tooltip: + m_tooltips[nField]->SetRect(rc); + + // update also the text: + m_tooltips[nField]->SetTip(GetStatusText(nField)); + } + else + { + // delete the tooltip associated with this pane; it's not needed anymore + wxDELETE(m_tooltips[nField]); + } + } + else + { + // create a new tooltip for this pane if needed + if (GetField(nField).IsEllipsized()) + m_tooltips[nField] = new wxToolTip(this, nField, GetStatusText(nField), rc); + //else: leave m_tooltips[nField]==NULL + } } +#endif // wxUSE_TOOLTIPS } -int wxStatusBar::GetBorderX() const +wxStatusBar::MSWBorders wxStatusBar::MSWGetBorders() const { int aBorders[3]; SendMessage(GetHwnd(), SB_GETBORDERS, 0, (LPARAM)aBorders); - return aBorders[0]; + MSWBorders borders; + borders.horz = aBorders[0]; + borders.vert = aBorders[1]; + borders.between = aBorders[2]; + return borders; +} + +int wxStatusBar::GetBorderX() const +{ + return MSWGetBorders().horz; } int wxStatusBar::GetBorderY() const { - int aBorders[3]; - SendMessage(GetHwnd(), SB_GETBORDERS, 0, (LPARAM)aBorders); + return MSWGetBorders().vert; +} + +int wxStatusBar::MSWGetBorderWidth() const +{ + return MSWGetBorders().between; +} + +/* static */ +const wxStatusBar::MSWMetrics& wxStatusBar::MSWGetMetrics() +{ + static MSWMetrics s_metrics = { 0, 0 }; + if ( !s_metrics.textMargin ) + { + // Grip size should be self explanatory (the only problem with it is + // that it's hard coded as we don't know how to find its size using + // API) but the margin might merit an explanation: Windows offsets the + // text drawn in status bar panes so we need to take this extra margin + // into account to make sure the text drawn by user fits inside the + // pane. Notice that it's not the value returned by SB_GETBORDERS + // which, at least on this Windows 2003 system, returns {0, 2, 2} +#if wxUSE_UXTHEME + if ( wxUxThemeEngine::GetIfActive() ) + { + s_metrics.gripWidth = 20; + s_metrics.textMargin = 8; + } + else // classic/unthemed look +#endif // wxUSE_UXTHEME + { + s_metrics.gripWidth = 18; + s_metrics.textMargin = 4; + } + } - return aBorders[1]; + return s_metrics; } void wxStatusBar::SetMinHeight(int height) { - SendMessage(GetHwnd(), SB_SETMINHEIGHT, height + 2*GetBorderY(), 0); + // It looks like we need to count the border twice to really make the + // controls taking exactly height pixels fully fit in the status bar: + // at least under Windows 7 the checkbox in the custom status bar of the + // statbar sample gets truncated otherwise. + height += 4*GetBorderY(); + + // We need to set the size and not the size to reflect the height because + // wxFrame uses our size and not the minimal size as it assumes that the + // size of a status bar never changes anyhow. + SetSize(-1, height); + + SendMessage(GetHwnd(), SB_SETMINHEIGHT, height, 0); - // have to send a (dummy) WM_SIZE to redraw it now + // we have to send a (dummy) WM_SIZE to redraw it now SendMessage(GetHwnd(), WM_SIZE, 0, 0); } bool wxStatusBar::GetFieldRect(int i, wxRect& rect) const { wxCHECK_MSG( (i >= 0) && ((size_t)i < m_panes.GetCount()), false, - _T("invalid statusbar field index") ); + "invalid statusbar field index" ); RECT r; if ( !::SendMessage(GetHwnd(), SB_GETRECT, i, (LPARAM)&r) ) { - wxLogLastError(wxT("SendMessage(SB_GETRECT)")); + wxLogLastError("SendMessage(SB_GETRECT)"); } #if wxUSE_UXTHEME - wxUxThemeHandle theme((wxStatusBar *)this, L"Status"); // const_cast + wxUxThemeHandle theme(const_cast(this), L"Status"); if ( theme ) { // by default Windows has a 2 pixel border to the right of the left @@ -324,15 +465,14 @@ bool wxStatusBar::GetFieldRect(int i, wxRect& rect) const wxSize wxStatusBar::DoGetBestSize() const { - int borders[3]; - SendMessage(GetHwnd(), SB_GETBORDERS, 0, (LPARAM)borders); + const MSWBorders borders = MSWGetBorders(); // calculate width int width = 0; for ( size_t i = 0; i < m_panes.GetCount(); ++i ) { int widthField = - m_bSameWidthForAllPanes ? DEFAULT_FIELD_WIDTH : m_panes[i].nWidth; + m_bSameWidthForAllPanes ? DEFAULT_FIELD_WIDTH : m_panes[i].GetWidth(); if ( widthField >= 0 ) { width += widthField; @@ -345,7 +485,7 @@ wxSize wxStatusBar::DoGetBestSize() const } // add the space between fields - width += borders[2]; + width += borders.between; } if ( !width ) @@ -354,11 +494,10 @@ wxSize wxStatusBar::DoGetBestSize() const width = 2*DEFAULT_FIELD_WIDTH; } - // calculate height - int height; - wxGetCharSize(GetHWND(), NULL, &height, GetFont()); - height = EDIT_HEIGHT_FROM_CHAR_HEIGHT(height); - height += borders[1]; + // calculate height: by default it should be just big enough to show text + // (see SetMinHeight() for the explanation of 4 factor) + int height = GetCharHeight(); + height += 4*borders.vert; wxSize best(width, height); CacheBestSize(best); @@ -385,9 +524,6 @@ void wxStatusBar::DoMoveWindow(int x, int y, int width, int height) ); } - // adjust fields widths to the new size - SetFieldsWidth(); - // we have to trigger wxSizeEvent if there are children window in status // bar because GetFieldRect returned incorrect (not updated) values up to // here, which almost certainly resulted in incorrectly redrawn statusbar @@ -422,13 +558,14 @@ void wxStatusBar::SetStatusStyles(int n, const int styles[]) style = 0; break; } + // The SB_SETTEXT message is both used to set the field's text as well as - // the fields' styles. MSDN library doesn't mention - // that nField and style have to be 'ORed' + // the fields' styles. + // NOTE: MSDN library doesn't mention that nField and style have to be 'ORed' wxString text = GetStatusText(i); - if (!StatusBar_SetText(GetHwnd(), style | i, text.wx_str())) + if (!StatusBar_SetText(GetHwnd(), style | i, text.t_str())) { - wxLogLastError(wxT("StatusBar_SetText")); + wxLogLastError("StatusBar_SetText"); } } } @@ -479,13 +616,65 @@ wxStatusBar::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam) if ( nMsg == WM_SIZE ) { - for (int i=0; imessage == WM_MOUSEMOVE ) + wxToolTip::RelayEvent(pMsg); + } + + return wxWindow::MSWProcessMessage(pMsg); +} + +bool wxStatusBar::MSWOnNotify(int WXUNUSED(idCtrl), WXLPARAM lParam, WXLPARAM* WXUNUSED(result)) +{ + if ( HasFlag(wxSTB_SHOW_TIPS) ) + { + // see comment in wxStatusBar::MSWProcessMessage for more info; + // basically we need to override wxWindow::MSWOnNotify because + // we have wxWindow::m_tooltip always NULL but we still use tooltips... + + NMHDR* hdr = (NMHDR *)lParam; + + wxString str; + if (hdr->idFrom < m_tooltips.size() && m_tooltips[hdr->idFrom]) + str = m_tooltips[hdr->idFrom]->GetTip(); + + if ( HandleTooltipNotify(hdr->code, lParam, str)) + { + // processed + return true; + } + } + + return false; +} +#endif // wxUSE_TOOLTIPS + #endif // wxUSE_STATUSBAR && wxUSE_NATIVE_STATUSBAR