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