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