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 #endif
  31
  32 #include "wx/msw/private.h"
  33 #include <windowsx.h>
  34
  35 #if wxUSE_UXTHEME
  36     #include "wx/msw/uxtheme.h"
  37 #endif
  38
  39 // ----------------------------------------------------------------------------
  40 // macros
  41 // ----------------------------------------------------------------------------
  42
  43 // windowsx.h and commctrl.h don't define those, so we do it here
  44 #define StatusBar_SetParts(h, n, w) SendMessage(h, SB_SETPARTS, (WPARAM)n, (LPARAM)w)
  45 #define StatusBar_SetText(h, n, t)  SendMessage(h, SB_SETTEXT, (WPARAM)n, (LPARAM)(LPCTSTR)t)
  46 #define StatusBar_GetTextLen(h, n)  LOWORD(SendMessage(h, SB_GETTEXTLENGTH, (WPARAM)n, 0))
  47 #define StatusBar_GetText(h, n, s)  LOWORD(SendMessage(h, SB_GETTEXT, (WPARAM)n, (LPARAM)(LPTSTR)s))
  48
  49 // ============================================================================
  50 // implementation
  51 // ============================================================================
  52
  53 // ----------------------------------------------------------------------------
  54 // wxStatusBar class
  55 // ----------------------------------------------------------------------------
  56
  57 wxStatusBar::wxStatusBar()
  58 {
  59     SetParent(NULL);
  60     m_hWnd = 0;
  61     m_windowId = 0;
  62 }
  63
  64 bool wxStatusBar::Create(wxWindow *parent,
  65                          wxWindowID id,
  66                          long style,
  67                          const wxString& name)
  68 {
  69     wxCHECK_MSG( parent, false, wxT("status bar must have a parent") );
  70
  71     SetName(name);
  72     SetWindowStyleFlag(style);
  73     SetParent(parent);
  74
  75     parent->AddChild(this);
  76
  77     m_windowId = id == wxID_ANY ? NewControlId() : id;
  78
  79     DWORD wstyle = WS_CHILD | WS_VISIBLE;
  80
  81     if ( style & wxCLIP_SIBLINGS )
  82         wstyle |= WS_CLIPSIBLINGS;
  83
  84     // setting SBARS_SIZEGRIP is perfectly useless: it's always on by default
  85     // (at least in the version of comctl32.dll I'm using), and the only way to
  86     // turn it off is to use CCS_TOP style - as we position the status bar
  87     // manually anyhow (see DoMoveWindow), use CCS_TOP style if wxST_SIZEGRIP
  88     // is not given
  89     if ( !(style & wxST_SIZEGRIP) )
  90     {
  91         wstyle |= CCS_TOP;
  92     }
  93     else
  94     {
  95 #ifndef __WXWINCE__
  96         // may be some versions of comctl32.dll do need it - anyhow, it won't
  97         // do any harm
  98         wstyle |= SBARS_SIZEGRIP;
  99 #endif
 100     }
 101
 102     m_hWnd = CreateWindow
 103              (
 104                 STATUSCLASSNAME,
 105                 _T(""),
 106                 wstyle,
 107                 0, 0, 0, 0,
 108                 GetHwndOf(parent),
 109                 (HMENU)wxUIntToPtr(m_windowId.GetValue()),
 110                 wxGetInstance(),
 111                 NULL
 112              );
 113     if ( m_hWnd == 0 )
 114     {
 115         wxLogSysError(_("Failed to create a status bar."));
 116
 117         return false;
 118     }
 119
 120     SetFieldsCount(1);
 121     SubclassWin(m_hWnd);
 122     InheritAttributes();
 123
 124     SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_MENUBAR));
 125
 126     // we must refresh the frame size when the statusbar is created, because
 127     // its client area might change
 128     wxFrame *frame = wxDynamicCast(GetParent(), wxFrame);
 129     if ( frame )
 130     {
 131         frame->SendSizeEvent();
 132     }
 133
 134     return true;
 135 }
 136
 137 wxStatusBar::~wxStatusBar()
 138 {
 139     // we must refresh the frame size when the statusbar is deleted but the
 140     // frame is not - otherwise statusbar leaves a hole in the place it used to
 141     // occupy
 142     wxFrame *frame = wxDynamicCast(GetParent(), wxFrame);
 143     if ( frame && !frame->IsBeingDeleted() )
 144     {
 145         frame->SendSizeEvent();
 146     }
 147 }
 148
 149 void wxStatusBar::SetFieldsCount(int nFields, const int *widths)
 150 {
 151     // this is a Windows limitation
 152     wxASSERT_MSG( (nFields > 0) && (nFields < 255), _T("too many fields") );
 153
 154     wxStatusBarBase::SetFieldsCount(nFields, widths);
 155
 156     SetFieldsWidth();
 157 }
 158
 159 void wxStatusBar::SetStatusWidths(int n, const int widths[])
 160 {
 161     wxStatusBarBase::SetStatusWidths(n, widths);
 162
 163     SetFieldsWidth();
 164 }
 165
 166 void wxStatusBar::SetFieldsWidth()
 167 {
 168     if ( !m_nFields )
 169         return;
 170
 171     int aBorders[3];
 172     SendMessage(GetHwnd(), SB_GETBORDERS, 0, (LPARAM)aBorders);
 173
 174     int extraWidth = aBorders[2]; // space between fields
 175
 176     wxArrayInt widthsAbs =
 177         CalculateAbsWidths(GetClientSize().x - extraWidth*(m_nFields - 1));
 178
 179     int *pWidths = new int[m_nFields];
 180
 181     int nCurPos = 0;
 182     for ( int i = 0; i < m_nFields; i++ ) {
 183         nCurPos += widthsAbs[i] + extraWidth;
 184         pWidths[i] = nCurPos;
 185     }
 186
 187     if ( !StatusBar_SetParts(GetHwnd(), m_nFields, pWidths) ) {
 188         wxLogLastError(wxT("StatusBar_SetParts"));
 189     }
 190
 191     delete [] pWidths;
 192 }
 193
 194 void wxStatusBar::SetStatusText(const wxString& strText, int nField)
 195 {
 196     wxCHECK_RET( (nField >= 0) && (nField < m_nFields),
 197                  _T("invalid statusbar field index") );
 198
 199     if ( strText == GetStatusText(nField) )
 200     {
 201        // don't call StatusBar_SetText() to avoid flicker
 202        return;
 203     }
 204
 205     // Get field style, if any
 206     int style;
 207     if (m_statusStyles)
 208     {
 209         switch(m_statusStyles[nField])
 210         {
 211         case wxSB_RAISED:
 212             style = SBT_POPOUT;
 213             break;
 214         case wxSB_FLAT:
 215             style = SBT_NOBORDERS;
 216             break;
 217         case wxSB_NORMAL:
 218         default:
 219             style = 0;
 220             break;
 221         }
 222     }
 223     else
 224         style = 0;
 225
 226     // Pass both field number and style. MSDN library doesn't mention
 227     // that nField and style have to be 'ORed'
 228     if ( !StatusBar_SetText(GetHwnd(), nField | style, strText.wx_str()) )
 229     {
 230         wxLogLastError(wxT("StatusBar_SetText"));
 231     }
 232 }
 233
 234 wxString wxStatusBar::GetStatusText(int nField) const
 235 {
 236     wxCHECK_MSG( (nField >= 0) && (nField < m_nFields), wxEmptyString,
 237                  _T("invalid statusbar field index") );
 238
 239     wxString str;
 240     int len = StatusBar_GetTextLen(GetHwnd(), nField);
 241     if ( len > 0 )
 242     {
 243         StatusBar_GetText(GetHwnd(), nField, wxStringBuffer(str, len));
 244     }
 245
 246     return str;
 247 }
 248
 249 int wxStatusBar::GetBorderX() const
 250 {
 251     int aBorders[3];
 252     SendMessage(GetHwnd(), SB_GETBORDERS, 0, (LPARAM)aBorders);
 253
 254     return aBorders[0];
 255 }
 256
 257 int wxStatusBar::GetBorderY() const
 258 {
 259     int aBorders[3];
 260     SendMessage(GetHwnd(), SB_GETBORDERS, 0, (LPARAM)aBorders);
 261
 262     return aBorders[1];
 263 }
 264
 265 void wxStatusBar::SetMinHeight(int height)
 266 {
 267     SendMessage(GetHwnd(), SB_SETMINHEIGHT, height + 2*GetBorderY(), 0);
 268
 269     // have to send a (dummy) WM_SIZE to redraw it now
 270     SendMessage(GetHwnd(), WM_SIZE, 0, 0);
 271 }
 272
 273 bool wxStatusBar::GetFieldRect(int i, wxRect& rect) const
 274 {
 275     wxCHECK_MSG( (i >= 0) && (i < m_nFields), false,
 276                  _T("invalid statusbar field index") );
 277
 278     RECT r;
 279     if ( !::SendMessage(GetHwnd(), SB_GETRECT, i, (LPARAM)&r) )
 280     {
 281         wxLogLastError(wxT("SendMessage(SB_GETRECT)"));
 282     }
 283
 284 #if wxUSE_UXTHEME
 285     wxUxThemeHandle theme((wxStatusBar *)this, L"Status"); // const_cast
 286     if ( theme )
 287     {
 288         // by default Windows has a 2 pixel border to the right of the left
 289         // divider (or it could be a bug) but it looks wrong so remove it
 290         if ( i != 0 )
 291         {
 292             r.left -= 2;
 293         }
 294
 295         wxUxThemeEngine::Get()->GetThemeBackgroundContentRect(theme, NULL,
 296                                                               1 /* SP_PANE */, 0,
 297                                                               &r, &r);
 298     }
 299 #endif
 300
 301     wxCopyRECTToRect(r, rect);
 302
 303     return true;
 304 }
 305
 306 // no idea for a default width, just choose something
 307 #define DEFAULT_FIELD_WIDTH 25
 308
 309 wxSize wxStatusBar::DoGetBestSize() const
 310 {
 311     int borders[3];
 312     SendMessage(GetHwnd(), SB_GETBORDERS, 0, (LPARAM)borders);
 313
 314     // calculate width
 315     int width = 0;
 316     for ( int i = 0; i < m_nFields; ++i )
 317     {
 318         int widthField = m_statusWidths ? m_statusWidths[i]
 319                                         : DEFAULT_FIELD_WIDTH;
 320         if ( widthField >= 0 )
 321         {
 322             width += widthField;
 323         }
 324         else
 325         {
 326             // variable width field, its width is really a proportion
 327             // related to the other fields
 328             width += -widthField*DEFAULT_FIELD_WIDTH;
 329         }
 330
 331         // add the space between fields
 332         width += borders[2];
 333     }
 334
 335     if ( !width )
 336     {
 337         // still need something even for an empty status bar
 338         width = 2*DEFAULT_FIELD_WIDTH;
 339     }
 340
 341
 342     // calculate height
 343     int height;
 344     wxGetCharSize(GetHWND(), NULL, &height, GetFont());
 345     height = EDIT_HEIGHT_FROM_CHAR_HEIGHT(height);
 346     height += borders[1];
 347
 348     wxSize best(width, height);
 349     CacheBestSize(best);
 350     return best;
 351 }
 352
 353 void wxStatusBar::DoMoveWindow(int x, int y, int width, int height)
 354 {
 355     if ( GetParent()->IsSizeDeferred() )
 356     {
 357         wxWindowMSW::DoMoveWindow(x, y, width, height);
 358     }
 359     else
 360     {
 361         // parent pos/size isn't deferred so do it now but don't send
 362         // WM_WINDOWPOSCHANGING since we don't want to change pos/size later
 363         // we must use SWP_NOCOPYBITS here otherwise it paints incorrectly
 364         // if other windows are size deferred
 365         ::SetWindowPos(GetHwnd(), NULL, x, y, width, height,
 366                        SWP_NOZORDER | SWP_NOOWNERZORDER | SWP_NOACTIVATE
 367 #ifndef __WXWINCE__
 368                        | SWP_NOCOPYBITS | SWP_NOSENDCHANGING
 369 #endif
 370                        );
 371     }
 372
 373     // adjust fields widths to the new size
 374     SetFieldsWidth();
 375
 376     // we have to trigger wxSizeEvent if there are children window in status
 377     // bar because GetFieldRect returned incorrect (not updated) values up to
 378     // here, which almost certainly resulted in incorrectly redrawn statusbar
 379     if ( m_children.GetCount() > 0 )
 380     {
 381         wxSizeEvent event(GetClientSize(), m_windowId);
 382         event.SetEventObject(this);
 383         HandleWindowEvent(event);
 384     }
 385 }
 386
 387 void wxStatusBar::SetStatusStyles(int n, const int styles[])
 388 {
 389     wxStatusBarBase::SetStatusStyles(n, styles);
 390
 391     if (n != m_nFields)
 392         return;
 393
 394     for (int i = 0; i < n; i++)
 395     {
 396         int style;
 397         switch(styles[i])
 398         {
 399         case wxSB_RAISED:
 400             style = SBT_POPOUT;
 401             break;
 402         case wxSB_FLAT:
 403             style = SBT_NOBORDERS;
 404             break;
 405         case wxSB_NORMAL:
 406         default:
 407             style = 0;
 408             break;
 409         }
 410         // The SB_SETTEXT message is both used to set the field's text as well as
 411         // the fields' styles. MSDN library doesn't mention
 412         // that nField and style have to be 'ORed'
 413         wxString text = GetStatusText(i);
 414         if (!StatusBar_SetText(GetHwnd(), style | i, text.wx_str()))
 415         {
 416             wxLogLastError(wxT("StatusBar_SetText"));
 417         }
 418     }
 419 }
 420
 421 WXLRESULT
 422 wxStatusBar::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
 423 {
 424 #ifndef __WXWINCE__
 425     if ( nMsg == WM_WINDOWPOSCHANGING )
 426     {
 427         WINDOWPOS *lpPos = (WINDOWPOS *)lParam;
 428         int x, y, w, h;
 429         GetPosition(&x, &y);
 430         GetSize(&w, &h);
 431
 432         // we need real window coords and not wx client coords
 433         AdjustForParentClientOrigin(x, y);
 434
 435         lpPos->x  = x;
 436         lpPos->y  = y;
 437         lpPos->cx = w;
 438         lpPos->cy = h;
 439
 440         return 0;
 441     }
 442
 443     if ( nMsg == WM_NCLBUTTONDOWN )
 444     {
 445         // if hit-test is on gripper then send message to TLW to begin
 446         // resizing. It is possible to send this message to any window.
 447         if ( wParam == HTBOTTOMRIGHT )
 448         {
 449             wxWindow *win;
 450
 451             for ( win = GetParent(); win; win = win->GetParent() )
 452             {
 453                 if ( win->IsTopLevel() )
 454                 {
 455                     SendMessage(GetHwndOf(win), WM_NCLBUTTONDOWN,
 456                                 wParam, lParam);
 457
 458                     return 0;
 459                 }
 460             }
 461         }
 462     }
 463 #endif
 464
 465     return wxStatusBarBase::MSWWindowProc(nMsg, wParam, lParam);
 466 }
 467
 468 #endif // wxUSE_STATUSBAR && wxUSE_NATIVE_STATUSBAR