src/msw/toolbar.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/msw/toolbar.cpp
   3 // Purpose:     wxToolBar
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     04/01/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   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_TOOLBAR && wxUSE_TOOLBAR_NATIVE && !defined(__SMARTPHONE__)
  28
  29 #include "wx/toolbar.h"
  30
  31 #ifndef WX_PRECOMP
  32     #include "wx/msw/wrapcctl.h" // include <commctrl.h> "properly"
  33     #include "wx/dynarray.h"
  34     #include "wx/frame.h"
  35     #include "wx/log.h"
  36     #include "wx/intl.h"
  37     #include "wx/settings.h"
  38     #include "wx/bitmap.h"
  39     #include "wx/region.h"
  40     #include "wx/dcmemory.h"
  41     #include "wx/control.h"
  42     #include "wx/app.h"         // for GetComCtl32Version
  43     #include "wx/image.h"
  44     #include "wx/stattext.h"
  45 #endif
  46
  47 #include "wx/artprov.h"
  48 #include "wx/sysopt.h"
  49 #include "wx/dcclient.h"
  50 #include "wx/scopedarray.h"
  51
  52 #include "wx/msw/private.h"
  53 #include "wx/msw/dc.h"
  54
  55 #if wxUSE_UXTHEME
  56 #include "wx/msw/uxtheme.h"
  57 #endif
  58
  59 // this define controls whether the code for button colours remapping (only
  60 // useful for 16 or 256 colour images) is active at all, it's always turned off
  61 // for CE where it doesn't compile (and is probably not needed anyhow) and may
  62 // also be turned off for other systems if you always use 24bpp images and so
  63 // never need it
  64 #ifndef __WXWINCE__
  65     #define wxREMAP_BUTTON_COLOURS
  66 #endif // !__WXWINCE__
  67
  68 // ----------------------------------------------------------------------------
  69 // constants
  70 // ----------------------------------------------------------------------------
  71
  72 // these standard constants are not always defined in compilers headers
  73
  74 // Styles
  75 #ifndef TBSTYLE_FLAT
  76     #define TBSTYLE_LIST            0x1000
  77     #define TBSTYLE_FLAT            0x0800
  78 #endif
  79
  80 #ifndef TBSTYLE_TRANSPARENT
  81     #define TBSTYLE_TRANSPARENT     0x8000
  82 #endif
  83
  84 #ifndef TBSTYLE_TOOLTIPS
  85     #define TBSTYLE_TOOLTIPS        0x0100
  86 #endif
  87
  88 // Messages
  89 #ifndef TB_GETSTYLE
  90     #define TB_SETSTYLE             (WM_USER + 56)
  91     #define TB_GETSTYLE             (WM_USER + 57)
  92 #endif
  93
  94 #ifndef TB_HITTEST
  95     #define TB_HITTEST              (WM_USER + 69)
  96 #endif
  97
  98 #ifndef TB_GETMAXSIZE
  99     #define TB_GETMAXSIZE           (WM_USER + 83)
 100 #endif
 101
 102 // ----------------------------------------------------------------------------
 103 // wxWin macros
 104 // ----------------------------------------------------------------------------
 105
 106 IMPLEMENT_DYNAMIC_CLASS(wxToolBar, wxControl)
 107
 108 /*
 109     TOOLBAR PROPERTIES
 110         tool
 111             bitmap
 112             bitmap2
 113             tooltip
 114             longhelp
 115             radio (bool)
 116             toggle (bool)
 117         separator
 118         style ( wxNO_BORDER | wxTB_HORIZONTAL)
 119         bitmapsize
 120         margins
 121         packing
 122         separation
 123
 124         dontattachtoframe
 125 */
 126
 127 BEGIN_EVENT_TABLE(wxToolBar, wxToolBarBase)
 128     EVT_MOUSE_EVENTS(wxToolBar::OnMouseEvent)
 129     EVT_SYS_COLOUR_CHANGED(wxToolBar::OnSysColourChanged)
 130 END_EVENT_TABLE()
 131
 132 // ----------------------------------------------------------------------------
 133 // private classes
 134 // ----------------------------------------------------------------------------
 135
 136 class wxToolBarTool : public wxToolBarToolBase
 137 {
 138 public:
 139     wxToolBarTool(wxToolBar *tbar,
 140                   int id,
 141                   const wxString& label,
 142                   const wxBitmap& bmpNormal,
 143                   const wxBitmap& bmpDisabled,
 144                   wxItemKind kind,
 145                   wxObject *clientData,
 146                   const wxString& shortHelp,
 147                   const wxString& longHelp)
 148         : wxToolBarToolBase(tbar, id, label, bmpNormal, bmpDisabled, kind,
 149                             clientData, shortHelp, longHelp)
 150     {
 151         m_nSepCount = 0;
 152         m_staticText = NULL;
 153     }
 154
 155     wxToolBarTool(wxToolBar *tbar, wxControl *control, const wxString& label)
 156         : wxToolBarToolBase(tbar, control, label)
 157     {
 158         if ( IsControl() && !m_label.empty() )
 159         {
 160             // create a control to render the control's label
 161             m_staticText = new wxStaticText
 162                                (
 163                                  m_tbar,
 164                                  wxID_ANY,
 165                                  m_label,
 166                                  wxDefaultPosition,
 167                                  wxDefaultSize,
 168                                  wxALIGN_CENTRE | wxST_NO_AUTORESIZE
 169                                );
 170         }
 171         else // no label
 172         {
 173             m_staticText = NULL;
 174         }
 175
 176         m_nSepCount = 1;
 177     }
 178
 179     virtual ~wxToolBarTool()
 180     {
 181         delete m_staticText;
 182     }
 183
 184     virtual void SetLabel(const wxString& label)
 185     {
 186         if ( label == m_label )
 187             return;
 188
 189         wxToolBarToolBase::SetLabel(label);
 190
 191         if ( m_staticText )
 192             m_staticText->SetLabel(label);
 193
 194         // we need to update the label shown in the toolbar because it has a
 195         // pointer to the internal buffer of the old label
 196         //
 197         // TODO: use TB_SETBUTTONINFO
 198     }
 199
 200     wxStaticText* GetStaticText()
 201     {
 202         wxASSERT_MSG( IsControl(),
 203                       wxT("only makes sense for embedded control tools") );
 204
 205         return m_staticText;
 206     }
 207
 208     // set/get the number of separators which we use to cover the space used by
 209     // a control in the toolbar
 210     void SetSeparatorsCount(size_t count) { m_nSepCount = count; }
 211     size_t GetSeparatorsCount() const { return m_nSepCount; }
 212
 213     // we need ids for the spacers which we want to modify later on, this
 214     // function will allocate a valid/unique id for a spacer if not done yet
 215     void AllocSpacerId()
 216     {
 217         if ( m_id == wxID_SEPARATOR )
 218             m_id = wxWindow::NewControlId();
 219     }
 220
 221     // this method is used for controls only and offsets the control by the
 222     // given amount (in pixels) in horizontal direction
 223     void MoveBy(int offset)
 224     {
 225         wxControl * const control = GetControl();
 226
 227         control->Move(control->GetPosition().x + offset, wxDefaultCoord);
 228
 229         if ( m_staticText )
 230         {
 231             m_staticText->Move(m_staticText->GetPosition().x + offset,
 232                                wxDefaultCoord);
 233         }
 234     }
 235
 236 private:
 237     size_t m_nSepCount;
 238     wxStaticText *m_staticText;
 239
 240     wxDECLARE_NO_COPY_CLASS(wxToolBarTool);
 241 };
 242
 243 // ----------------------------------------------------------------------------
 244 // helper functions
 245 // ----------------------------------------------------------------------------
 246
 247 // return the rectangle of the item at the given index
 248 //
 249 // returns an empty (0, 0, 0, 0) rectangle if fails so the caller may compare
 250 // r.right or r.bottom with 0 to check for this
 251 static RECT wxGetTBItemRect(HWND hwnd, int index)
 252 {
 253     RECT r;
 254
 255     // note that we use TB_GETITEMRECT and not TB_GETRECT because the latter
 256     // only appeared in v4.70 of comctl32.dll
 257     if ( !::SendMessage(hwnd, TB_GETITEMRECT, index, (LPARAM)&r) )
 258     {
 259         wxLogLastError(wxT("TB_GETITEMRECT"));
 260
 261         r.top =
 262         r.left =
 263         r.right =
 264         r.bottom = 0;
 265     }
 266
 267     return r;
 268 }
 269
 270 // ============================================================================
 271 // implementation
 272 // ============================================================================
 273
 274 // ----------------------------------------------------------------------------
 275 // wxToolBarTool
 276 // ----------------------------------------------------------------------------
 277
 278 wxToolBarToolBase *wxToolBar::CreateTool(int id,
 279                                          const wxString& label,
 280                                          const wxBitmap& bmpNormal,
 281                                          const wxBitmap& bmpDisabled,
 282                                          wxItemKind kind,
 283                                          wxObject *clientData,
 284                                          const wxString& shortHelp,
 285                                          const wxString& longHelp)
 286 {
 287     return new wxToolBarTool(this, id, label, bmpNormal, bmpDisabled, kind,
 288                              clientData, shortHelp, longHelp);
 289 }
 290
 291 wxToolBarToolBase *
 292 wxToolBar::CreateTool(wxControl *control, const wxString& label)
 293 {
 294     return new wxToolBarTool(this, control, label);
 295 }
 296
 297 // ----------------------------------------------------------------------------
 298 // wxToolBar construction
 299 // ----------------------------------------------------------------------------
 300
 301 void wxToolBar::Init()
 302 {
 303     m_hBitmap = 0;
 304     m_disabledImgList = NULL;
 305
 306     m_nButtons = 0;
 307     m_totalFixedSize = 0;
 308
 309     // even though modern Windows applications typically use 24*24 (or even
 310     // 32*32) size for their bitmaps, the native control itself still uses the
 311     // old 16*15 default size (see TB_SETBITMAPSIZE documentation in MSDN), so
 312     // default to it so that we don't call SetToolBitmapSize() unnecessarily in
 313     // wxToolBarBase::AdjustToolBitmapSize()
 314     m_defaultWidth = 16;
 315     m_defaultHeight = 15;
 316
 317     m_pInTool = NULL;
 318 }
 319
 320 bool wxToolBar::Create(wxWindow *parent,
 321                        wxWindowID id,
 322                        const wxPoint& pos,
 323                        const wxSize& size,
 324                        long style,
 325                        const wxString& name)
 326 {
 327     // common initialisation
 328     if ( !CreateControl(parent, id, pos, size, style, wxDefaultValidator, name) )
 329         return false;
 330
 331     FixupStyle();
 332
 333     // MSW-specific initialisation
 334     if ( !MSWCreateToolbar(pos, size) )
 335         return false;
 336
 337     wxSetCCUnicodeFormat(GetHwnd());
 338
 339     // we always erase our background on WM_PAINT so there is no need to do it
 340     // in WM_ERASEBKGND too (by default this won't be done but if the toolbar
 341     // has a non default background colour, then it would be used in both
 342     // places resulting in flicker)
 343     SetBackgroundStyle(wxBG_STYLE_PAINT);
 344
 345     return true;
 346 }
 347
 348 bool wxToolBar::MSWCreateToolbar(const wxPoint& pos, const wxSize& size)
 349 {
 350     if ( !MSWCreateControl(TOOLBARCLASSNAME, wxEmptyString, pos, size) )
 351         return false;
 352
 353     // toolbar-specific post initialisation
 354     ::SendMessage(GetHwnd(), TB_BUTTONSTRUCTSIZE, sizeof(TBBUTTON), 0);
 355
 356 #ifdef TB_SETEXTENDEDSTYLE
 357     if ( wxApp::GetComCtl32Version() >= 471 )
 358         ::SendMessage(GetHwnd(), TB_SETEXTENDEDSTYLE, 0, TBSTYLE_EX_DRAWDDARROWS);
 359 #endif
 360
 361     return true;
 362 }
 363
 364 void wxToolBar::Recreate()
 365 {
 366     const HWND hwndOld = GetHwnd();
 367     if ( !hwndOld )
 368     {
 369         // we haven't been created yet, no need to recreate
 370         return;
 371     }
 372
 373     // get the position and size before unsubclassing the old toolbar
 374     const wxPoint pos = GetPosition();
 375     const wxSize size = GetSize();
 376
 377     UnsubclassWin();
 378
 379     if ( !MSWCreateToolbar(pos, size) )
 380     {
 381         // what can we do?
 382         wxFAIL_MSG( wxT("recreating the toolbar failed") );
 383
 384         return;
 385     }
 386
 387     // reparent all our children under the new toolbar
 388     for ( wxWindowList::compatibility_iterator node = m_children.GetFirst();
 389           node;
 390           node = node->GetNext() )
 391     {
 392         wxWindow *win = node->GetData();
 393         if ( !win->IsTopLevel() )
 394             ::SetParent(GetHwndOf(win), GetHwnd());
 395     }
 396
 397     // only destroy the old toolbar now --
 398     // after all the children had been reparented
 399     ::DestroyWindow(hwndOld);
 400
 401     // it is for the old bitmap control and can't be used with the new one
 402     if ( m_hBitmap )
 403     {
 404         ::DeleteObject((HBITMAP) m_hBitmap);
 405         m_hBitmap = 0;
 406     }
 407
 408     wxDELETE(m_disabledImgList);
 409
 410     Realize();
 411 }
 412
 413 wxToolBar::~wxToolBar()
 414 {
 415     // we must refresh the frame size when the toolbar is deleted but the frame
 416     // is not - otherwise toolbar leaves a hole in the place it used to occupy
 417     SendSizeEventToParent();
 418
 419     if ( m_hBitmap )
 420         ::DeleteObject((HBITMAP) m_hBitmap);
 421
 422     delete m_disabledImgList;
 423 }
 424
 425 wxSize wxToolBar::DoGetBestSize() const
 426 {
 427     wxSize sizeBest;
 428
 429     SIZE size;
 430     if ( !::SendMessage(GetHwnd(), TB_GETMAXSIZE, 0, (LPARAM)&size) )
 431     {
 432         // maybe an old (< 0x400) Windows version? try to approximate the
 433         // toolbar size ourselves
 434         sizeBest = GetToolSize();
 435         sizeBest.y += 2 * ::GetSystemMetrics(SM_CYBORDER); // Add borders
 436         sizeBest.x *= GetToolsCount();
 437
 438         // reverse horz and vertical components if necessary
 439         if ( IsVertical() )
 440         {
 441             int t = sizeBest.x;
 442             sizeBest.x = sizeBest.y;
 443             sizeBest.y = t;
 444         }
 445     }
 446     else // TB_GETMAXSIZE succeeded
 447     {
 448         // but it could still return an incorrect result due to what appears to
 449         // be a bug in old comctl32.dll versions which don't handle controls in
 450         // the toolbar correctly, so work around it (see SF patch 1902358)
 451         if ( !IsVertical() && wxApp::GetComCtl32Version() < 600 )
 452         {
 453             // calculate the toolbar width in alternative way
 454             const RECT rcFirst = wxGetTBItemRect(GetHwnd(), 0);
 455             const RECT rcLast = wxGetTBItemRect(GetHwnd(), GetToolsCount() - 1);
 456
 457             const int widthAlt = rcLast.right - rcFirst.left;
 458             if ( widthAlt > size.cx )
 459                 size.cx = widthAlt;
 460         }
 461
 462         sizeBest.x = size.cx;
 463         sizeBest.y = size.cy;
 464     }
 465
 466     if ( !IsVertical() )
 467     {
 468         // Without the extra height, DoGetBestSize can report a size that's
 469         // smaller than the actual window, causing windows to overlap slightly
 470         // in some circumstances, leading to missing borders (especially noticeable
 471         // in AUI layouts).
 472         if (!(GetWindowStyle() & wxTB_NODIVIDER))
 473             sizeBest.y += 2;
 474         sizeBest.y ++;
 475     }
 476
 477     CacheBestSize(sizeBest);
 478
 479     return sizeBest;
 480 }
 481
 482 WXDWORD wxToolBar::MSWGetStyle(long style, WXDWORD *exstyle) const
 483 {
 484     // toolbars never have border, giving one to them results in broken
 485     // appearance
 486     WXDWORD msStyle = wxControl::MSWGetStyle
 487                       (
 488                         (style & ~wxBORDER_MASK) | wxBORDER_NONE, exstyle
 489                       );
 490
 491     if ( !(style & wxTB_NO_TOOLTIPS) )
 492         msStyle |= TBSTYLE_TOOLTIPS;
 493
 494     if ( style & wxTB_FLAT && wxApp::GetComCtl32Version() > 400 )
 495         msStyle |= TBSTYLE_FLAT;
 496
 497     if ( style & wxTB_HORZ_LAYOUT && wxApp::GetComCtl32Version() >= 470 )
 498         msStyle |= TBSTYLE_LIST;
 499
 500     if ( style & wxTB_NODIVIDER )
 501         msStyle |= CCS_NODIVIDER;
 502
 503     if ( style & wxTB_NOALIGN )
 504         msStyle |= CCS_NOPARENTALIGN;
 505
 506     if ( style & wxTB_VERTICAL )
 507         msStyle |= CCS_VERT;
 508
 509     if( style & wxTB_BOTTOM )
 510         msStyle |= CCS_BOTTOM;
 511
 512     if ( style & wxTB_RIGHT )
 513         msStyle |= CCS_RIGHT;
 514
 515     // always use TBSTYLE_TRANSPARENT because the background is not drawn
 516     // correctly without it in all themes and, for whatever reason, the control
 517     // also flickers horribly when it is resized if this style is not used
 518     //
 519     // note that this is implicitly enabled by the native toolbar itself when
 520     // TBSTYLE_FLAT is used (i.e. it's impossible to use TBSTYLE_FLAT without
 521     // TBSTYLE_TRANSPARENT) but turn it on explicitly in any case
 522     msStyle |= TBSTYLE_TRANSPARENT;
 523
 524     return msStyle;
 525 }
 526
 527 // ----------------------------------------------------------------------------
 528 // adding/removing tools
 529 // ----------------------------------------------------------------------------
 530
 531 bool wxToolBar::DoInsertTool(size_t WXUNUSED(pos),
 532                              wxToolBarToolBase * WXUNUSED(tool))
 533 {
 534     // nothing special to do here - we really create the toolbar buttons in
 535     // Realize() later
 536     InvalidateBestSize();
 537     return true;
 538 }
 539
 540 bool wxToolBar::DoDeleteTool(size_t pos, wxToolBarToolBase *tool)
 541 {
 542     // the main difficulty we have here is with the controls in the toolbars:
 543     // as we (sometimes) use several separators to cover up the space used by
 544     // them, the indices are not the same for us and the toolbar
 545
 546     // first determine the position of the first button to delete: it may be
 547     // different from pos if we use several separators to cover the space used
 548     // by a control
 549     wxToolBarToolsList::compatibility_iterator node;
 550     for ( node = m_tools.GetFirst(); node; node = node->GetNext() )
 551     {
 552         wxToolBarToolBase *tool2 = node->GetData();
 553         if ( tool2 == tool )
 554         {
 555             // let node point to the next node in the list
 556             node = node->GetNext();
 557
 558             break;
 559         }
 560
 561         if ( tool2->IsControl() )
 562             pos += ((wxToolBarTool *)tool2)->GetSeparatorsCount() - 1;
 563     }
 564
 565     // now determine the number of buttons to delete and the area taken by them
 566     size_t nButtonsToDelete = 1;
 567
 568     // get the size of the button we're going to delete
 569     const RECT r = wxGetTBItemRect(GetHwnd(), pos);
 570
 571     int width = r.right - r.left;
 572
 573     if ( tool->IsControl() )
 574     {
 575         nButtonsToDelete = ((wxToolBarTool *)tool)->GetSeparatorsCount();
 576         width *= nButtonsToDelete;
 577     }
 578
 579     // do delete all buttons
 580     m_nButtons -= nButtonsToDelete;
 581     while ( nButtonsToDelete-- > 0 )
 582     {
 583         if ( !::SendMessage(GetHwnd(), TB_DELETEBUTTON, pos, 0) )
 584         {
 585             wxLogLastError(wxT("TB_DELETEBUTTON"));
 586
 587             return false;
 588         }
 589     }
 590
 591     // and finally reposition all the controls after this button (the toolbar
 592     // takes care of all normal items)
 593     for ( /* node -> first after deleted */ ; node; node = node->GetNext() )
 594     {
 595         wxToolBarTool *tool2 = (wxToolBarTool*)node->GetData();
 596         if ( tool2->IsControl() )
 597         {
 598             tool2->MoveBy(-width);
 599         }
 600     }
 601
 602     InvalidateBestSize();
 603
 604     return true;
 605 }
 606
 607 void wxToolBar::CreateDisabledImageList()
 608 {
 609     wxDELETE(m_disabledImgList);
 610
 611     // as we can't use disabled image list with older versions of comctl32.dll,
 612     // don't even bother creating it
 613     if ( wxApp::GetComCtl32Version() >= 470 )
 614     {
 615         // search for the first disabled button img in the toolbar, if any
 616         for ( wxToolBarToolsList::compatibility_iterator
 617                 node = m_tools.GetFirst(); node; node = node->GetNext() )
 618         {
 619             wxToolBarToolBase *tool = node->GetData();
 620             wxBitmap bmpDisabled = tool->GetDisabledBitmap();
 621             if ( bmpDisabled.Ok() )
 622             {
 623                 m_disabledImgList = new wxImageList
 624                                         (
 625                                             m_defaultWidth,
 626                                             m_defaultHeight,
 627                                             bmpDisabled.GetMask() != NULL,
 628                                             GetToolsCount()
 629                                         );
 630                 break;
 631             }
 632         }
 633
 634         // we don't have any disabled bitmaps
 635     }
 636 }
 637
 638 bool wxToolBar::Realize()
 639 {
 640     if ( !wxToolBarBase::Realize() )
 641         return false;
 642
 643     const size_t nTools = GetToolsCount();
 644
 645 #ifdef wxREMAP_BUTTON_COLOURS
 646     // don't change the values of these constants, they can be set from the
 647     // user code via wxSystemOptions
 648     enum
 649     {
 650         Remap_None = -1,
 651         Remap_Bg,
 652         Remap_Buttons,
 653         Remap_TransparentBg
 654     };
 655
 656     // the user-specified option overrides anything, but if it wasn't set, only
 657     // remap the buttons on 8bpp displays as otherwise the bitmaps usually look
 658     // much worse after remapping
 659     static const wxChar *remapOption = wxT("msw.remap");
 660     const int remapValue = wxSystemOptions::HasOption(remapOption)
 661                                 ? wxSystemOptions::GetOptionInt(remapOption)
 662                                 : wxDisplayDepth() <= 8 ? Remap_Buttons
 663                                                         : Remap_None;
 664
 665 #endif // wxREMAP_BUTTON_COLOURS
 666
 667     // delete all old buttons, if any
 668     for ( size_t pos = 0; pos < m_nButtons; pos++ )
 669     {
 670         if ( !::SendMessage(GetHwnd(), TB_DELETEBUTTON, 0, 0) )
 671         {
 672             wxLogDebug(wxT("TB_DELETEBUTTON failed"));
 673         }
 674     }
 675
 676     // First, add the bitmap: we use one bitmap for all toolbar buttons
 677     // ----------------------------------------------------------------
 678
 679     wxToolBarToolsList::compatibility_iterator node;
 680     int bitmapId = 0;
 681
 682     if ( !HasFlag(wxTB_NOICONS) )
 683     {
 684         // if we already have a bitmap, we'll replace the existing one --
 685         // otherwise we'll install a new one
 686         HBITMAP oldToolBarBitmap = (HBITMAP)m_hBitmap;
 687
 688         const wxCoord totalBitmapWidth  = m_defaultWidth *
 689                                           wx_truncate_cast(wxCoord, nTools),
 690                       totalBitmapHeight = m_defaultHeight;
 691
 692         // Create a bitmap and copy all the tool bitmaps into it
 693         wxMemoryDC dcAllButtons;
 694         wxBitmap bitmap(totalBitmapWidth, totalBitmapHeight);
 695         dcAllButtons.SelectObject(bitmap);
 696
 697 #ifdef wxREMAP_BUTTON_COLOURS
 698         if ( remapValue != Remap_TransparentBg )
 699 #endif // wxREMAP_BUTTON_COLOURS
 700         {
 701             // VZ: why do we hardcode grey colour for CE?
 702             dcAllButtons.SetBackground(wxBrush(
 703 #ifdef __WXWINCE__
 704                                         wxColour(0xc0, 0xc0, 0xc0)
 705 #else // !__WXWINCE__
 706                                         GetBackgroundColour()
 707 #endif // __WXWINCE__/!__WXWINCE__
 708                                        ));
 709             dcAllButtons.Clear();
 710         }
 711
 712         m_hBitmap = bitmap.GetHBITMAP();
 713         HBITMAP hBitmap = (HBITMAP)m_hBitmap;
 714
 715 #ifdef wxREMAP_BUTTON_COLOURS
 716         if ( remapValue == Remap_Bg )
 717         {
 718             dcAllButtons.SelectObject(wxNullBitmap);
 719
 720             // Even if we're not remapping the bitmap
 721             // content, we still have to remap the background.
 722             hBitmap = (HBITMAP)MapBitmap((WXHBITMAP) hBitmap,
 723                 totalBitmapWidth, totalBitmapHeight);
 724
 725             dcAllButtons.SelectObject(bitmap);
 726         }
 727 #endif // wxREMAP_BUTTON_COLOURS
 728
 729         // the button position
 730         wxCoord x = 0;
 731
 732         // the number of buttons (not separators)
 733         int nButtons = 0;
 734
 735         CreateDisabledImageList();
 736         for ( node = m_tools.GetFirst(); node; node = node->GetNext() )
 737         {
 738             wxToolBarToolBase *tool = node->GetData();
 739             if ( tool->IsButton() )
 740             {
 741                 const wxBitmap& bmp = tool->GetNormalBitmap();
 742
 743                 const int w = bmp.GetWidth();
 744                 const int h = bmp.GetHeight();
 745
 746                 if ( bmp.Ok() )
 747                 {
 748                     int xOffset = wxMax(0, (m_defaultWidth - w)/2);
 749                     int yOffset = wxMax(0, (m_defaultHeight - h)/2);
 750
 751                     // notice the last parameter: do use mask
 752                     dcAllButtons.DrawBitmap(bmp, x + xOffset, yOffset, true);
 753                 }
 754                 else
 755                 {
 756                     wxFAIL_MSG( wxT("invalid tool button bitmap") );
 757                 }
 758
 759                 // also deal with disabled bitmap if we want to use them
 760                 if ( m_disabledImgList )
 761                 {
 762                     wxBitmap bmpDisabled = tool->GetDisabledBitmap();
 763 #if wxUSE_IMAGE && wxUSE_WXDIB
 764                     if ( !bmpDisabled.Ok() )
 765                     {
 766                         // no disabled bitmap specified but we still need to
 767                         // fill the space in the image list with something, so
 768                         // we grey out the normal bitmap
 769                         wxImage
 770                           imgGreyed = bmp.ConvertToImage().ConvertToGreyscale();
 771
 772 #ifdef wxREMAP_BUTTON_COLOURS
 773                         if ( remapValue == Remap_Buttons )
 774                         {
 775                             // we need to have light grey background colour for
 776                             // MapBitmap() to work correctly
 777                             for ( int y = 0; y < h; y++ )
 778                             {
 779                                 for ( int x = 0; x < w; x++ )
 780                                 {
 781                                     if ( imgGreyed.IsTransparent(x, y) )
 782                                         imgGreyed.SetRGB(x, y,
 783                                                          wxLIGHT_GREY->Red(),
 784                                                          wxLIGHT_GREY->Green(),
 785                                                          wxLIGHT_GREY->Blue());
 786                                 }
 787                             }
 788                         }
 789 #endif // wxREMAP_BUTTON_COLOURS
 790
 791                         bmpDisabled = wxBitmap(imgGreyed);
 792                     }
 793 #endif // wxUSE_IMAGE
 794
 795 #ifdef wxREMAP_BUTTON_COLOURS
 796                     if ( remapValue == Remap_Buttons )
 797                         MapBitmap(bmpDisabled.GetHBITMAP(), w, h);
 798 #endif // wxREMAP_BUTTON_COLOURS
 799
 800                     m_disabledImgList->Add(bmpDisabled);
 801                 }
 802
 803                 // still inc width and number of buttons because otherwise the
 804                 // subsequent buttons will all be shifted which is rather confusing
 805                 // (and like this you'd see immediately which bitmap was bad)
 806                 x += m_defaultWidth;
 807                 nButtons++;
 808             }
 809         }
 810
 811         dcAllButtons.SelectObject(wxNullBitmap);
 812
 813         // don't delete this HBITMAP!
 814         bitmap.SetHBITMAP(0);
 815
 816 #ifdef wxREMAP_BUTTON_COLOURS
 817         if ( remapValue == Remap_Buttons )
 818         {
 819             // Map to system colours
 820             hBitmap = (HBITMAP)MapBitmap((WXHBITMAP) hBitmap,
 821                                          totalBitmapWidth, totalBitmapHeight);
 822         }
 823 #endif // wxREMAP_BUTTON_COLOURS
 824
 825         bool addBitmap = true;
 826
 827         if ( oldToolBarBitmap )
 828         {
 829 #ifdef TB_REPLACEBITMAP
 830             if ( wxApp::GetComCtl32Version() >= 400 )
 831             {
 832                 TBREPLACEBITMAP replaceBitmap;
 833                 replaceBitmap.hInstOld = NULL;
 834                 replaceBitmap.hInstNew = NULL;
 835                 replaceBitmap.nIDOld = (UINT_PTR)oldToolBarBitmap;
 836                 replaceBitmap.nIDNew = (UINT_PTR)hBitmap;
 837                 replaceBitmap.nButtons = nButtons;
 838                 if ( !::SendMessage(GetHwnd(), TB_REPLACEBITMAP,
 839                                     0, (LPARAM) &replaceBitmap) )
 840                 {
 841                     wxFAIL_MSG(wxT("Could not replace the old bitmap"));
 842                 }
 843
 844                 ::DeleteObject(oldToolBarBitmap);
 845
 846                 // already done
 847                 addBitmap = false;
 848             }
 849             else
 850 #endif // TB_REPLACEBITMAP
 851             {
 852                 // we can't replace the old bitmap, so we will add another one
 853                 // (awfully inefficient, but what else to do?) and shift the bitmap
 854                 // indices accordingly
 855                 addBitmap = true;
 856
 857                 bitmapId = m_nButtons;
 858             }
 859         }
 860
 861         if ( addBitmap ) // no old bitmap or we can't replace it
 862         {
 863             TBADDBITMAP addBitmap;
 864             addBitmap.hInst = 0;
 865             addBitmap.nID = (UINT_PTR)hBitmap;
 866             if ( ::SendMessage(GetHwnd(), TB_ADDBITMAP,
 867                                (WPARAM) nButtons, (LPARAM)&addBitmap) == -1 )
 868             {
 869                 wxFAIL_MSG(wxT("Could not add bitmap to toolbar"));
 870             }
 871         }
 872
 873         // disable image lists are only supported in comctl32.dll 4.70+
 874         if ( wxApp::GetComCtl32Version() >= 470 )
 875         {
 876             HIMAGELIST hil = m_disabledImgList
 877                                 ? GetHimagelistOf(m_disabledImgList)
 878                                 : 0;
 879
 880             // notice that we set the image list even if don't have one right
 881             // now as we could have it before and need to reset it in this case
 882             HIMAGELIST oldImageList = (HIMAGELIST)
 883               ::SendMessage(GetHwnd(), TB_SETDISABLEDIMAGELIST, 0, (LPARAM)hil);
 884
 885             // delete previous image list if any
 886             if ( oldImageList )
 887                 ::DeleteObject(oldImageList);
 888         }
 889     }
 890
 891
 892     // Next add the buttons and separators
 893     // -----------------------------------
 894
 895     wxScopedArray<TBBUTTON> buttons(new TBBUTTON[nTools]);
 896
 897     // this array will hold the indices of all controls in the toolbar
 898     wxArrayInt controlIds;
 899
 900     bool lastWasRadio = false;
 901     int i = 0;
 902     for ( node = m_tools.GetFirst(); node; node = node->GetNext() )
 903     {
 904         wxToolBarTool *tool = static_cast<wxToolBarTool *>(node->GetData());
 905
 906         // don't add separators to the vertical toolbar with old comctl32.dll
 907         // versions as they didn't handle this properly
 908         if ( IsVertical() && tool->IsSeparator() &&
 909                 wxApp::GetComCtl32Version() <= 472 )
 910         {
 911             continue;
 912         }
 913
 914         TBBUTTON& button = buttons[i];
 915
 916         wxZeroMemory(button);
 917
 918         bool isRadio = false;
 919         switch ( tool->GetStyle() )
 920         {
 921             case wxTOOL_STYLE_CONTROL:
 922             case wxTOOL_STYLE_SEPARATOR:
 923                 if ( tool->IsStretchableSpace() )
 924                 {
 925                     // we're going to modify the size of this button later and
 926                     // so we need a valid id for it and not wxID_SEPARATOR
 927                     // which is used by spacers by default
 928                     tool->AllocSpacerId();
 929
 930                     // also set the number of separators so that the logic in
 931                     // HandlePaint() works correctly
 932                     tool->SetSeparatorsCount(1);
 933                 }
 934
 935                 button.idCommand = tool->GetId();
 936                 button.fsState = TBSTATE_ENABLED;
 937                 button.fsStyle = TBSTYLE_SEP;
 938                 break;
 939
 940             case wxTOOL_STYLE_BUTTON:
 941                 if ( !HasFlag(wxTB_NOICONS) )
 942                     button.iBitmap = bitmapId;
 943
 944                 if ( HasFlag(wxTB_TEXT) )
 945                 {
 946                     const wxString& label = tool->GetLabel();
 947                     if ( !label.empty() )
 948                         button.iString = (INT_PTR)label.wx_str();
 949                 }
 950
 951                 button.idCommand = tool->GetId();
 952
 953                 if ( tool->IsEnabled() )
 954                     button.fsState |= TBSTATE_ENABLED;
 955                 if ( tool->IsToggled() )
 956                     button.fsState |= TBSTATE_CHECKED;
 957
 958                 switch ( tool->GetKind() )
 959                 {
 960                     case wxITEM_RADIO:
 961                         button.fsStyle = TBSTYLE_CHECKGROUP;
 962
 963                         if ( !lastWasRadio )
 964                         {
 965                             // the first item in the radio group is checked by
 966                             // default to be consistent with wxGTK and the menu
 967                             // radio items
 968                             button.fsState |= TBSTATE_CHECKED;
 969
 970                             if (tool->Toggle(true))
 971                             {
 972                                 DoToggleTool(tool, true);
 973                             }
 974                         }
 975                         else if ( tool->IsToggled() )
 976                         {
 977                             wxToolBarToolsList::compatibility_iterator nodePrev = node->GetPrevious();
 978                             int prevIndex = i - 1;
 979                             while ( nodePrev )
 980                             {
 981                                 TBBUTTON& prevButton = buttons[prevIndex];
 982                                 wxToolBarToolBase *tool = nodePrev->GetData();
 983                                 if ( !tool->IsButton() || tool->GetKind() != wxITEM_RADIO )
 984                                     break;
 985
 986                                 if ( tool->Toggle(false) )
 987                                     DoToggleTool(tool, false);
 988
 989                                 prevButton.fsState &= ~TBSTATE_CHECKED;
 990                                 nodePrev = nodePrev->GetPrevious();
 991                                 prevIndex--;
 992                             }
 993                         }
 994
 995                         isRadio = true;
 996                         break;
 997
 998                     case wxITEM_CHECK:
 999                         button.fsStyle = TBSTYLE_CHECK;
1000                         break;
1001
1002                     case wxITEM_NORMAL:
1003                         button.fsStyle = TBSTYLE_BUTTON;
1004                         break;
1005
1006                    case wxITEM_DROPDOWN:
1007                         button.fsStyle = TBSTYLE_DROPDOWN;
1008                         break;
1009
1010                     default:
1011                         wxFAIL_MSG( wxT("unexpected toolbar button kind") );
1012                         button.fsStyle = TBSTYLE_BUTTON;
1013                         break;
1014                 }
1015
1016                 bitmapId++;
1017                 break;
1018         }
1019
1020         lastWasRadio = isRadio;
1021
1022         i++;
1023     }
1024
1025     if ( !::SendMessage(GetHwnd(), TB_ADDBUTTONS, i, (LPARAM)buttons.get()) )
1026     {
1027         wxLogLastError(wxT("TB_ADDBUTTONS"));
1028     }
1029
1030
1031     // Adjust controls and stretchable spaces
1032     // --------------------------------------
1033
1034     // adjust the controls size to fit nicely in the toolbar and compute its
1035     // total size while doing it
1036     m_totalFixedSize = 0;
1037     int toolIndex = 0;
1038     for ( node = m_tools.GetFirst(); node; node = node->GetNext(), toolIndex++ )
1039     {
1040         wxToolBarTool * const tool = (wxToolBarTool*)node->GetData();
1041
1042         const RECT r = wxGetTBItemRect(GetHwnd(), toolIndex);
1043
1044         if ( !tool->IsControl() )
1045         {
1046             if ( IsVertical() )
1047                 m_totalFixedSize += r.bottom - r.top;
1048             else
1049                 m_totalFixedSize += r.right - r.left;
1050
1051             continue;
1052         }
1053
1054         if ( IsVertical() )
1055         {
1056             // don't embed controls in the vertical toolbar, this doesn't look
1057             // good and wxGTK doesn't do it neither (and the code below can't
1058             // deal with this case)
1059             continue;
1060         }
1061
1062         wxControl * const control = tool->GetControl();
1063         wxStaticText * const staticText = tool->GetStaticText();
1064
1065         wxSize size = control->GetSize();
1066         wxSize staticTextSize;
1067         if ( staticText )
1068         {
1069             staticTextSize = staticText->GetSize();
1070             staticTextSize.y += 3; // margin between control and its label
1071         }
1072
1073         // TB_SETBUTTONINFO message is only supported by comctl32.dll 4.71+
1074 #ifdef TB_SETBUTTONINFO
1075         // available in headers, now check whether it is available now
1076         // (during run-time)
1077         if ( wxApp::GetComCtl32Version() >= 471 )
1078         {
1079             // set the (underlying) separators width to be that of the
1080             // control
1081             TBBUTTONINFO tbbi;
1082             tbbi.cbSize = sizeof(tbbi);
1083             tbbi.dwMask = TBIF_SIZE;
1084             tbbi.cx = (WORD)size.x;
1085             if ( !::SendMessage(GetHwnd(), TB_SETBUTTONINFO,
1086                                 tool->GetId(), (LPARAM)&tbbi) )
1087             {
1088                 // the id is probably invalid?
1089                 wxLogLastError(wxT("TB_SETBUTTONINFO"));
1090             }
1091         }
1092         else
1093 #endif // comctl32.dll 4.71
1094         // TB_SETBUTTONINFO unavailable
1095         {
1096             // try adding several separators to fit the controls width
1097             int widthSep = r.right - r.left;
1098
1099             TBBUTTON tbb;
1100             wxZeroMemory(tbb);
1101             tbb.idCommand = 0;
1102             tbb.fsState = TBSTATE_ENABLED;
1103             tbb.fsStyle = TBSTYLE_SEP;
1104
1105             size_t nSeparators = size.x / widthSep;
1106             for ( size_t nSep = 0; nSep < nSeparators; nSep++ )
1107             {
1108                 if ( !::SendMessage(GetHwnd(), TB_INSERTBUTTON,
1109                                     toolIndex, (LPARAM)&tbb) )
1110                 {
1111                     wxLogLastError(wxT("TB_INSERTBUTTON"));
1112                 }
1113
1114                 toolIndex++;
1115             }
1116
1117             // remember the number of separators we used - we'd have to
1118             // delete all of them later
1119             tool->SetSeparatorsCount(nSeparators);
1120
1121             // adjust the controls width to exactly cover the separators
1122             size.x = (nSeparators + 1)*widthSep;
1123             control->SetSize(size.x, wxDefaultCoord);
1124         }
1125
1126         // position the control itself correctly vertically centering it on the
1127         // icon area of the toolbar
1128         int height = r.bottom - r.top - staticTextSize.y;
1129
1130         int diff = height - size.y;
1131         if ( diff < 0 || !HasFlag(wxTB_TEXT) )
1132         {
1133             // not enough room for the static text
1134             if ( staticText )
1135                 staticText->Hide();
1136
1137             // recalculate height & diff without the staticText control
1138             height = r.bottom - r.top;
1139             diff = height - size.y;
1140             if ( diff < 0 )
1141             {
1142                 // the control is too high, resize to fit
1143                 control->SetSize(wxDefaultCoord, height - 2);
1144
1145                 diff = 2;
1146             }
1147         }
1148         else // enough space for both the control and the label
1149         {
1150             if ( staticText )
1151                 staticText->Show();
1152         }
1153
1154         control->Move(r.left, r.top + (diff + 1) / 2);
1155         if ( staticText )
1156         {
1157             staticText->Move(r.left + (size.x - staticTextSize.x)/2,
1158                              r.bottom - staticTextSize.y);
1159         }
1160
1161         m_totalFixedSize += size.x;
1162     }
1163
1164     // the max index is the "real" number of buttons - i.e. counting even the
1165     // separators which we added just for aligning the controls
1166     m_nButtons = toolIndex;
1167
1168     if ( !IsVertical() )
1169     {
1170         if ( m_maxRows == 0 )
1171             // if not set yet, only one row
1172             SetRows(1);
1173     }
1174     else if ( m_nButtons > 0 ) // vertical non empty toolbar
1175     {
1176         // if not set yet, have one column
1177         m_maxRows = 1;
1178         SetRows(m_nButtons);
1179     }
1180
1181     InvalidateBestSize();
1182     UpdateSize();
1183
1184     return true;
1185 }
1186
1187 void wxToolBar::UpdateStretchableSpacersSize()
1188 {
1189 #ifdef TB_SETBUTTONINFO
1190     // we can't resize the spacers if TB_SETBUTTONINFO is not supported (we
1191     // could try to do it with multiple separators as for the controls but this
1192     // is too painful and it just doesn't seem to be worth doing for the
1193     // ancient systems)
1194     if ( wxApp::GetComCtl32Version() < 471 )
1195         return;
1196
1197     // check if we have any stretchable spacers in the first place
1198     unsigned numSpaces = 0;
1199     wxToolBarToolsList::compatibility_iterator node;
1200     for ( node = m_tools.GetFirst(); node; node = node->GetNext() )
1201     {
1202         wxToolBarTool * const tool = (wxToolBarTool*)node->GetData();
1203         if ( tool->IsStretchableSpace() )
1204             numSpaces++;
1205     }
1206
1207     if ( !numSpaces )
1208         return;
1209
1210     // we do, adjust their size: either distribute the extra size among them or
1211     // reduce their size if there is not enough place for all tools
1212     const int totalSize = IsVertical() ? GetClientSize().y : GetClientSize().x;
1213     const int extraSize = totalSize - m_totalFixedSize;
1214     const int sizeSpacer = extraSize > 0 ? extraSize / numSpaces : 1;
1215
1216     // the last spacer should consume all remaining space if we have too much
1217     // of it (which can be greater than sizeSpacer because of the rounding)
1218     const int sizeLastSpacer = extraSize > 0
1219                                 ? extraSize - (numSpaces - 1)*sizeSpacer
1220                                 : 1;
1221
1222     // cumulated offset by which we need to move all the following controls to
1223     // the right: while the toolbar takes care of the normal items, we must
1224     // move the controls manually ourselves to ensure they remain at the
1225     // correct place
1226     int offset = 0;
1227     int toolIndex = 0;
1228     for ( node = m_tools.GetFirst(); node; node = node->GetNext(), toolIndex++ )
1229     {
1230         wxToolBarTool * const tool = (wxToolBarTool*)node->GetData();
1231
1232         if ( tool->IsControl() && offset )
1233         {
1234             tool->MoveBy(offset);
1235
1236             continue;
1237         }
1238
1239         if ( !tool->IsStretchableSpace() )
1240             continue;
1241
1242         const RECT rcOld = wxGetTBItemRect(GetHwnd(), toolIndex);
1243
1244         WinStruct<TBBUTTONINFO> tbbi;
1245         tbbi.dwMask = TBIF_SIZE;
1246         tbbi.cx = --numSpaces ? sizeSpacer : sizeLastSpacer;
1247
1248         if ( !::SendMessage(GetHwnd(), TB_SETBUTTONINFO,
1249                             tool->GetId(), (LPARAM)&tbbi) )
1250         {
1251             wxLogLastError(wxT("TB_SETBUTTONINFO"));
1252         }
1253         else
1254         {
1255             // we successfully resized this one, move all the controls after it
1256             // by the corresponding amount (may be positive or negative)
1257             offset += tbbi.cx - (rcOld.right - rcOld.left);
1258         }
1259     }
1260 #endif // TB_SETBUTTONINFO
1261 }
1262
1263 // ----------------------------------------------------------------------------
1264 // message handlers
1265 // ----------------------------------------------------------------------------
1266
1267 bool wxToolBar::MSWCommand(WXUINT WXUNUSED(cmd), WXWORD id_)
1268 {
1269     // cast to signed is important as we compare this id with (signed) ints in
1270     // FindById() and without the cast we'd get a positive int from a
1271     // "negative" (i.e. > 32767) WORD
1272     const int id = (signed short)id_;
1273
1274     wxToolBarToolBase *tool = FindById(id);
1275     if ( !tool )
1276         return false;
1277
1278     bool toggled = false; // just to suppress warnings
1279
1280     LRESULT state = ::SendMessage(GetHwnd(), TB_GETSTATE, id, 0);
1281
1282     if ( tool->CanBeToggled() )
1283     {
1284         toggled = (state & TBSTATE_CHECKED) != 0;
1285
1286         // ignore the event when a radio button is released, as this doesn't
1287         // seem to happen at all, and is handled otherwise
1288         if ( tool->GetKind() == wxITEM_RADIO && !toggled )
1289             return true;
1290
1291         tool->Toggle(toggled);
1292         UnToggleRadioGroup(tool);
1293     }
1294
1295     // Without the two lines of code below, if the toolbar was repainted during
1296     // OnLeftClick(), then it could end up without the tool bitmap temporarily
1297     // (see http://lists.nongnu.org/archive/html/lmi/2008-10/msg00014.html).
1298     // The Update() call bellow ensures that this won't happen, by repainting
1299     // invalidated areas of the toolbar immediately.
1300     //
1301     // To complicate matters, the tool would be drawn in depressed state (this
1302     // code is called when mouse button is released, not pressed). That's not
1303     // ideal, having the tool pressed for the duration of OnLeftClick()
1304     // provides the user with useful visual clue that the app is busy reacting
1305     // to the event. So we manually put the tool into pressed state, handle the
1306     // event and then finally restore tool's original state.
1307     ::SendMessage(GetHwnd(), TB_SETSTATE, id, MAKELONG(state | TBSTATE_PRESSED, 0));
1308     Update();
1309
1310     bool allowLeftClick = OnLeftClick(id, toggled);
1311
1312     // Restore the unpressed state. Enabled/toggled state might have been
1313     // changed since so take care of it.
1314     if (tool->IsEnabled())
1315         state |= TBSTATE_ENABLED;
1316     else
1317         state &= ~TBSTATE_ENABLED;
1318     if (tool->IsToggled())
1319         state |= TBSTATE_CHECKED;
1320     else
1321         state &= ~TBSTATE_CHECKED;
1322     ::SendMessage(GetHwnd(), TB_SETSTATE, id, MAKELONG(state, 0));
1323
1324     // OnLeftClick() can veto the button state change - for buttons which
1325     // may be toggled only, of couse
1326     if ( !allowLeftClick && tool->CanBeToggled() )
1327     {
1328         // revert back
1329         tool->Toggle(!toggled);
1330
1331         ::SendMessage(GetHwnd(), TB_CHECKBUTTON, id, MAKELONG(!toggled, 0));
1332     }
1333
1334     return true;
1335 }
1336
1337 bool wxToolBar::MSWOnNotify(int WXUNUSED(idCtrl),
1338                             WXLPARAM lParam,
1339                             WXLPARAM *WXUNUSED(result))
1340 {
1341     LPNMHDR hdr = (LPNMHDR)lParam;
1342     if ( hdr->code == TBN_DROPDOWN )
1343     {
1344         LPNMTOOLBAR tbhdr = (LPNMTOOLBAR)lParam;
1345
1346         wxCommandEvent evt(wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, tbhdr->iItem);
1347         if ( HandleWindowEvent(evt) )
1348         {
1349             // Event got handled, don't display default popup menu
1350             return false;
1351         }
1352
1353         const wxToolBarToolBase * const tool = FindById(tbhdr->iItem);
1354         wxCHECK_MSG( tool, false, wxT("drop down message for unknown tool") );
1355
1356         wxMenu * const menu = tool->GetDropdownMenu();
1357         if ( !menu )
1358             return false;
1359
1360         // Display popup menu below button
1361         const RECT r = wxGetTBItemRect(GetHwnd(), GetToolPos(tbhdr->iItem));
1362         if ( r.right )
1363             PopupMenu(menu, r.left, r.bottom);
1364
1365         return true;
1366     }
1367
1368
1369     if( !HasFlag(wxTB_NO_TOOLTIPS) )
1370     {
1371 #if wxUSE_TOOLTIPS
1372         // First check if this applies to us
1373
1374         // the tooltips control created by the toolbar is sometimes Unicode, even
1375         // in an ANSI application - this seems to be a bug in comctl32.dll v5
1376         UINT code = hdr->code;
1377         if ( (code != (UINT) TTN_NEEDTEXTA) && (code != (UINT) TTN_NEEDTEXTW) )
1378             return false;
1379
1380         HWND toolTipWnd = (HWND)::SendMessage(GetHwnd(), TB_GETTOOLTIPS, 0, 0);
1381         if ( toolTipWnd != hdr->hwndFrom )
1382             return false;
1383
1384         LPTOOLTIPTEXT ttText = (LPTOOLTIPTEXT)lParam;
1385         int id = (int)ttText->hdr.idFrom;
1386
1387         wxToolBarToolBase *tool = FindById(id);
1388         if ( tool )
1389             return HandleTooltipNotify(code, lParam, tool->GetShortHelp());
1390 #else
1391         wxUnusedVar(lParam);
1392 #endif
1393     }
1394
1395     return false;
1396 }
1397
1398 // ----------------------------------------------------------------------------
1399 // toolbar geometry
1400 // ----------------------------------------------------------------------------
1401
1402 void wxToolBar::SetToolBitmapSize(const wxSize& size)
1403 {
1404     wxToolBarBase::SetToolBitmapSize(size);
1405
1406     ::SendMessage(GetHwnd(), TB_SETBITMAPSIZE, 0, MAKELONG(size.x, size.y));
1407 }
1408
1409 void wxToolBar::SetRows(int nRows)
1410 {
1411     if ( nRows == m_maxRows )
1412     {
1413         // avoid resizing the frame uselessly
1414         return;
1415     }
1416
1417     // TRUE in wParam means to create at least as many rows, FALSE -
1418     // at most as many
1419     RECT rect;
1420     ::SendMessage(GetHwnd(), TB_SETROWS,
1421                   MAKEWPARAM(nRows, !(GetWindowStyle() & wxTB_VERTICAL)),
1422                   (LPARAM) &rect);
1423
1424     m_maxRows = nRows;
1425
1426     UpdateSize();
1427 }
1428
1429 // The button size is bigger than the bitmap size
1430 wxSize wxToolBar::GetToolSize() const
1431 {
1432     // TB_GETBUTTONSIZE is supported from version 4.70
1433 #if defined(_WIN32_IE) && (_WIN32_IE >= 0x300 ) \
1434     && !( defined(__GNUWIN32__) && !wxCHECK_W32API_VERSION( 1, 0 ) ) \
1435     && !defined (__DIGITALMARS__)
1436     if ( wxApp::GetComCtl32Version() >= 470 )
1437     {
1438         DWORD dw = ::SendMessage(GetHwnd(), TB_GETBUTTONSIZE, 0, 0);
1439
1440         return wxSize(LOWORD(dw), HIWORD(dw));
1441     }
1442     else
1443 #endif // comctl32.dll 4.70+
1444     {
1445         // defaults
1446         return wxSize(m_defaultWidth + 8, m_defaultHeight + 7);
1447     }
1448 }
1449
1450 static
1451 wxToolBarToolBase *GetItemSkippingDummySpacers(const wxToolBarToolsList& tools,
1452                                                size_t index )
1453 {
1454     wxToolBarToolsList::compatibility_iterator current = tools.GetFirst();
1455
1456     for ( ; current ; current = current->GetNext() )
1457     {
1458         if ( index == 0 )
1459             return current->GetData();
1460
1461         wxToolBarTool *tool = (wxToolBarTool *)current->GetData();
1462         size_t separators = tool->GetSeparatorsCount();
1463
1464         // if it is a normal button, sepcount == 0, so skip 1 item (the button)
1465         // otherwise, skip as many items as the separator count, plus the
1466         // control itself
1467         index -= separators ? separators + 1 : 1;
1468     }
1469
1470     return 0;
1471 }
1472
1473 wxToolBarToolBase *wxToolBar::FindToolForPosition(wxCoord x, wxCoord y) const
1474 {
1475     POINT pt;
1476     pt.x = x;
1477     pt.y = y;
1478     int index = (int)::SendMessage(GetHwnd(), TB_HITTEST, 0, (LPARAM)&pt);
1479
1480     // MBN: when the point ( x, y ) is close to the toolbar border
1481     //      TB_HITTEST returns m_nButtons ( not -1 )
1482     if ( index < 0 || (size_t)index >= m_nButtons )
1483         // it's a separator or there is no tool at all there
1484         return NULL;
1485
1486     // when TB_SETBUTTONINFO is available (both during compile- and run-time),
1487     // we don't use the dummy separators hack
1488 #ifdef TB_SETBUTTONINFO
1489     if ( wxApp::GetComCtl32Version() >= 471 )
1490     {
1491         return m_tools.Item((size_t)index)->GetData();
1492     }
1493     else
1494 #endif // TB_SETBUTTONINFO
1495     {
1496         return GetItemSkippingDummySpacers( m_tools, (size_t) index );
1497     }
1498 }
1499
1500 void wxToolBar::UpdateSize()
1501 {
1502     wxPoint pos = GetPosition();
1503     ::SendMessage(GetHwnd(), TB_AUTOSIZE, 0, 0);
1504     if (pos != GetPosition())
1505         Move(pos);
1506
1507     // In case Realize is called after the initial display (IOW the programmer
1508     // may have rebuilt the toolbar) give the frame the option of resizing the
1509     // toolbar to full width again, but only if the parent is a frame and the
1510     // toolbar is managed by the frame.  Otherwise assume that some other
1511     // layout mechanism is controlling the toolbar size and leave it alone.
1512     SendSizeEventToParent();
1513 }
1514
1515 // ----------------------------------------------------------------------------
1516 // toolbar styles
1517 // ---------------------------------------------------------------------------
1518
1519 // get the TBSTYLE of the given toolbar window
1520 long wxToolBar::GetMSWToolbarStyle() const
1521 {
1522     return ::SendMessage(GetHwnd(), TB_GETSTYLE, 0, 0L);
1523 }
1524
1525 void wxToolBar::SetWindowStyleFlag(long style)
1526 {
1527     // the style bits whose changes force us to recreate the toolbar
1528     static const long MASK_NEEDS_RECREATE = wxTB_TEXT | wxTB_NOICONS;
1529
1530     const long styleOld = GetWindowStyle();
1531
1532     wxToolBarBase::SetWindowStyleFlag(style);
1533
1534     // don't recreate an empty toolbar: not only this is unnecessary, but it is
1535     // also fatal as we'd then try to recreate the toolbar when it's just being
1536     // created
1537     if ( GetToolsCount() &&
1538             (style & MASK_NEEDS_RECREATE) != (styleOld & MASK_NEEDS_RECREATE) )
1539     {
1540         // to remove the text labels, simply re-realizing the toolbar is enough
1541         // but I don't know of any way to add the text to an existing toolbar
1542         // other than by recreating it entirely
1543         Recreate();
1544     }
1545 }
1546
1547 // ----------------------------------------------------------------------------
1548 // tool state
1549 // ----------------------------------------------------------------------------
1550
1551 void wxToolBar::DoEnableTool(wxToolBarToolBase *tool, bool enable)
1552 {
1553     ::SendMessage(GetHwnd(), TB_ENABLEBUTTON,
1554                   (WPARAM)tool->GetId(), (LPARAM)MAKELONG(enable, 0));
1555 }
1556
1557 void wxToolBar::DoToggleTool(wxToolBarToolBase *tool, bool toggle)
1558 {
1559     ::SendMessage(GetHwnd(), TB_CHECKBUTTON,
1560                   (WPARAM)tool->GetId(), (LPARAM)MAKELONG(toggle, 0));
1561 }
1562
1563 void wxToolBar::DoSetToggle(wxToolBarToolBase *WXUNUSED(tool), bool WXUNUSED(toggle))
1564 {
1565     // VZ: AFAIK, the button has to be created either with TBSTYLE_CHECK or
1566     //     without, so we really need to delete the button and recreate it here
1567     wxFAIL_MSG( wxT("not implemented") );
1568 }
1569
1570 void wxToolBar::SetToolNormalBitmap( int id, const wxBitmap& bitmap )
1571 {
1572     wxToolBarTool* tool = static_cast<wxToolBarTool*>(FindById(id));
1573     if ( tool )
1574     {
1575         wxCHECK_RET( tool->IsButton(), wxT("Can only set bitmap on button tools."));
1576
1577         tool->SetNormalBitmap(bitmap);
1578         Realize();
1579     }
1580 }
1581
1582 void wxToolBar::SetToolDisabledBitmap( int id, const wxBitmap& bitmap )
1583 {
1584     wxToolBarTool* tool = static_cast<wxToolBarTool*>(FindById(id));
1585     if ( tool )
1586     {
1587         wxCHECK_RET( tool->IsButton(), wxT("Can only set bitmap on button tools."));
1588
1589         tool->SetDisabledBitmap(bitmap);
1590         Realize();
1591     }
1592 }
1593
1594 // ----------------------------------------------------------------------------
1595 // event handlers
1596 // ----------------------------------------------------------------------------
1597
1598 // Responds to colour changes, and passes event on to children.
1599 void wxToolBar::OnSysColourChanged(wxSysColourChangedEvent& event)
1600 {
1601     wxRGBToColour(m_backgroundColour, ::GetSysColor(COLOR_BTNFACE));
1602
1603     // Remap the buttons
1604     Realize();
1605
1606     // Relayout the toolbar
1607     int nrows = m_maxRows;
1608     m_maxRows = 0;      // otherwise SetRows() wouldn't do anything
1609     SetRows(nrows);
1610
1611     Refresh();
1612
1613     // let the event propagate further
1614     event.Skip();
1615 }
1616
1617 void wxToolBar::OnMouseEvent(wxMouseEvent& event)
1618 {
1619     if ( event.Leaving() )
1620     {
1621         if ( m_pInTool )
1622         {
1623             OnMouseEnter(wxID_ANY);
1624             m_pInTool = NULL;
1625         }
1626
1627         event.Skip();
1628         return;
1629     }
1630
1631     if ( event.RightDown() )
1632     {
1633         // find the tool under the mouse
1634         wxCoord x = 0, y = 0;
1635         event.GetPosition(&x, &y);
1636
1637         wxToolBarToolBase *tool = FindToolForPosition(x, y);
1638         OnRightClick(tool ? tool->GetId() : -1, x, y);
1639     }
1640     else
1641     {
1642         event.Skip();
1643     }
1644 }
1645
1646 bool wxToolBar::HandleSize(WXWPARAM WXUNUSED(wParam), WXLPARAM lParam)
1647 {
1648     // wait until we have some tools
1649     if ( !GetToolsCount() )
1650         return false;
1651
1652     // calculate our minor dimension ourselves - we're confusing the standard
1653     // logic (TB_AUTOSIZE) with our horizontal toolbars and other hacks
1654     const RECT r = wxGetTBItemRect(GetHwnd(), 0);
1655     if ( !r.right )
1656         return false;
1657
1658     int w, h;
1659
1660     if ( IsVertical() )
1661     {
1662         w = r.right - r.left;
1663         if ( m_maxRows )
1664         {
1665             w *= (m_nButtons + m_maxRows - 1)/m_maxRows;
1666         }
1667         h = HIWORD(lParam);
1668     }
1669     else
1670     {
1671         w = LOWORD(lParam);
1672         if (HasFlag( wxTB_FLAT ))
1673             h = r.bottom - r.top - 3;
1674         else
1675             h = r.bottom - r.top;
1676         if ( m_maxRows )
1677         {
1678             // FIXME: hardcoded separator line height...
1679             h += HasFlag(wxTB_NODIVIDER) ? 4 : 6;
1680             h *= m_maxRows;
1681         }
1682     }
1683
1684     if ( MAKELPARAM(w, h) != lParam )
1685     {
1686         // size really changed
1687         SetSize(w, h);
1688     }
1689
1690     UpdateStretchableSpacersSize();
1691
1692     // message processed
1693     return true;
1694 }
1695
1696 #ifdef wxHAS_MSW_BACKGROUND_ERASE_HOOK
1697
1698 bool wxToolBar::HandlePaint(WXWPARAM wParam, WXLPARAM lParam)
1699 {
1700     // we must prevent the dummy separators corresponding to controls or
1701     // stretchable spaces from being seen: we used to do it by painting over
1702     // them but this, unsurprisingly, resulted in a lot of flicker so now we
1703     // prevent the toolbar from painting them at all
1704
1705     // compute the region containing all dummy separators which we don't want
1706     // to be seen
1707     wxRegion rgnDummySeps;
1708     const wxRect rectTotal = GetClientRect();
1709     int toolIndex = 0;
1710     for ( wxToolBarToolsList::compatibility_iterator node = m_tools.GetFirst();
1711           node;
1712           node = node->GetNext() )
1713     {
1714         wxToolBarTool * const
1715             tool = static_cast<wxToolBarTool *>(node->GetData());
1716
1717         if ( tool->IsControl() || tool->IsStretchableSpace() )
1718         {
1719             const size_t numSeps = tool->GetSeparatorsCount();
1720             for ( size_t n = 0; n < numSeps; n++, toolIndex++ )
1721             {
1722                 // for some reason TB_GETITEMRECT returns a rectangle 1 pixel
1723                 // shorter than the full window size (at least under Windows 7)
1724                 // but we need to erase the full height below
1725                 RECT rcItem = wxGetTBItemRect(GetHwnd(), toolIndex);
1726                 rcItem.top = 0;
1727                 rcItem.bottom = rectTotal.height;
1728
1729                 rgnDummySeps.Union(wxRectFromRECT(rcItem));
1730             }
1731         }
1732         else
1733         {
1734             // normal tools never correspond to more than one native button
1735             toolIndex++;
1736         }
1737     }
1738
1739     if ( rgnDummySeps.IsOk() )
1740     {
1741         // exclude the area occupied by the controls and stretchable spaces
1742         // from the update region to prevent the toolbar from drawing
1743         // separators in it
1744         if ( !::ValidateRgn(GetHwnd(), GetHrgnOf(rgnDummySeps)) )
1745         {
1746             wxLogLastError(wxT("ValidateRgn()"));
1747         }
1748     }
1749
1750     // still let the native control draw everything else normally but set up a
1751     // hook to be able to process the next WM_ERASEBKGND sent to our parent
1752     // because toolbar will ask it to erase its background from its WM_PAINT
1753     // handler (when using TBSTYLE_TRANSPARENT which we do always use)
1754     //
1755     // installing hook is not completely trivial as all kinds of strange
1756     // situations are possible: sometimes we can be called recursively from
1757     // inside the native toolbar WM_PAINT handler so the hook might already be
1758     // installed and sometimes the native toolbar might not send WM_ERASEBKGND
1759     // to the parent at all for whatever reason, so deal with all these cases
1760     wxWindow * const parent = GetParent();
1761     const bool hadHook = parent->MSWHasEraseBgHook();
1762     if ( !hadHook )
1763         GetParent()->MSWSetEraseBgHook(this);
1764
1765     MSWDefWindowProc(WM_PAINT, wParam, lParam);
1766
1767     if ( !hadHook )
1768         GetParent()->MSWSetEraseBgHook(NULL);
1769
1770
1771     if ( rgnDummySeps.IsOk() )
1772     {
1773         // erase the dummy separators region ourselves now as nobody painted
1774         // over them
1775         WindowHDC hdc(GetHwnd());
1776         ::SelectClipRgn(hdc, GetHrgnOf(rgnDummySeps));
1777         MSWDoEraseBackground(hdc);
1778     }
1779
1780     return true;
1781 }
1782
1783 WXHBRUSH wxToolBar::MSWGetToolbarBgBrush()
1784 {
1785     // we conservatively use a solid brush here but we could also use a themed
1786     // brush by using DrawThemeBackground() to create a bitmap brush (it'd need
1787     // to be invalidated whenever the toolbar is resized and, also, correctly
1788     // aligned using SetBrushOrgEx() before each use -- there is code for doing
1789     // this in wxNotebook already so it'd need to be refactored into wxWindow)
1790     //
1791     // however inasmuch as there is a default background for the toolbar at all
1792     // (and this is not a trivial question as different applications use very
1793     // different colours), it seems to be a solid one and using REBAR
1794     // background brush as we used to do before doesn't look good at all under
1795     // Windows 7 (and probably Vista too), so for now we just keep it simple
1796     wxColour const
1797         colBg = m_hasBgCol ? GetBackgroundColour()
1798                            : wxSystemSettings::GetColour(wxSYS_COLOUR_BTNFACE);
1799     wxBrush * const
1800         brush = wxTheBrushList->FindOrCreateBrush(colBg);
1801
1802     return brush ? static_cast<WXHBRUSH>(brush->GetResourceHandle()) : 0;
1803 }
1804
1805 WXHBRUSH wxToolBar::MSWGetBgBrushForChild(WXHDC hDC, wxWindowMSW *child)
1806 {
1807     WXHBRUSH hbr = wxToolBarBase::MSWGetBgBrushForChild(hDC, child);
1808     if ( hbr )
1809         return hbr;
1810
1811     // the base class version only returns a brush for erasing children
1812     // background if we have a non-default background colour but as the toolbar
1813     // doesn't erase its own background by default, we need to always do it for
1814     // (semi-)transparent children
1815     if ( child->GetParent() == this && child->HasTransparentBackground() )
1816         return MSWGetToolbarBgBrush();
1817
1818     return 0;
1819 }
1820
1821 void wxToolBar::MSWDoEraseBackground(WXHDC hDC)
1822 {
1823     wxFillRect(GetHwnd(), (HDC)hDC, (HBRUSH)MSWGetToolbarBgBrush());
1824 }
1825
1826 bool wxToolBar::MSWEraseBgHook(WXHDC hDC)
1827 {
1828     // toolbar WM_PAINT handler offsets the DC origin before sending
1829     // WM_ERASEBKGND to the parent but as we handle it in the toolbar itself,
1830     // we need to reset it back
1831     HDC hdc = (HDC)hDC;
1832     POINT ptOldOrg;
1833     if ( !::SetWindowOrgEx(hdc, 0, 0, &ptOldOrg) )
1834     {
1835         wxLogLastError(wxT("SetWindowOrgEx(tbar-bg-hdc)"));
1836         return false;
1837     }
1838
1839     MSWDoEraseBackground(hDC);
1840
1841     ::SetWindowOrgEx(hdc, ptOldOrg.x, ptOldOrg.y, NULL);
1842
1843     return true;
1844 }
1845
1846 #endif // wxHAS_MSW_BACKGROUND_ERASE_HOOK
1847
1848 void wxToolBar::HandleMouseMove(WXWPARAM WXUNUSED(wParam), WXLPARAM lParam)
1849 {
1850     wxCoord x = GET_X_LPARAM(lParam),
1851             y = GET_Y_LPARAM(lParam);
1852     wxToolBarToolBase* tool = FindToolForPosition( x, y );
1853
1854     // has the current tool changed?
1855     if ( tool != m_pInTool )
1856     {
1857         m_pInTool = tool;
1858         OnMouseEnter(tool ? tool->GetId() : wxID_ANY);
1859     }
1860 }
1861
1862 WXLRESULT wxToolBar::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
1863 {
1864     switch ( nMsg )
1865     {
1866         case WM_MOUSEMOVE:
1867             // we don't handle mouse moves, so always pass the message to
1868             // wxControl::MSWWindowProc (HandleMouseMove just calls OnMouseEnter)
1869             HandleMouseMove(wParam, lParam);
1870             break;
1871
1872         case WM_SIZE:
1873             if ( HandleSize(wParam, lParam) )
1874                 return 0;
1875             break;
1876
1877 #ifdef wxHAS_MSW_BACKGROUND_ERASE_HOOK
1878         case WM_PAINT:
1879             // refreshing the controls in the toolbar inside a composite window
1880             // results in an endless stream of WM_PAINT messages -- and seems
1881             // to be unnecessary anyhow as everything works just fine without
1882             // any special workarounds in this case
1883             if ( !IsDoubleBuffered() && HandlePaint(wParam, lParam) )
1884                 return 0;
1885             break;
1886 #endif // wxHAS_MSW_BACKGROUND_ERASE_HOOK
1887     }
1888
1889     return wxControl::MSWWindowProc(nMsg, wParam, lParam);
1890 }
1891
1892 // ----------------------------------------------------------------------------
1893 // private functions
1894 // ----------------------------------------------------------------------------
1895
1896 #ifdef wxREMAP_BUTTON_COLOURS
1897
1898 WXHBITMAP wxToolBar::MapBitmap(WXHBITMAP bitmap, int width, int height)
1899 {
1900     MemoryHDC hdcMem;
1901
1902     if ( !hdcMem )
1903     {
1904         wxLogLastError(wxT("CreateCompatibleDC"));
1905
1906         return bitmap;
1907     }
1908
1909     SelectInHDC bmpInHDC(hdcMem, (HBITMAP)bitmap);
1910
1911     if ( !bmpInHDC )
1912     {
1913         wxLogLastError(wxT("SelectObject"));
1914
1915         return bitmap;
1916     }
1917
1918     wxCOLORMAP *cmap = wxGetStdColourMap();
1919
1920     for ( int i = 0; i < width; i++ )
1921     {
1922         for ( int j = 0; j < height; j++ )
1923         {
1924             COLORREF pixel = ::GetPixel(hdcMem, i, j);
1925
1926             for ( size_t k = 0; k < wxSTD_COL_MAX; k++ )
1927             {
1928                 COLORREF col = cmap[k].from;
1929                 if ( abs(GetRValue(pixel) - GetRValue(col)) < 10 &&
1930                      abs(GetGValue(pixel) - GetGValue(col)) < 10 &&
1931                      abs(GetBValue(pixel) - GetBValue(col)) < 10 )
1932                 {
1933                     if ( cmap[k].to != pixel )
1934                         ::SetPixel(hdcMem, i, j, cmap[k].to);
1935                     break;
1936                 }
1937             }
1938         }
1939     }
1940
1941     return bitmap;
1942 }
1943
1944 #endif // wxREMAP_BUTTON_COLOURS
1945
1946 #endif // wxUSE_TOOLBAR