src/common/tbarbase.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/common/tbarbase.cpp
   3 // Purpose:     wxToolBarBase implementation
   4 // Author:      Julian Smart
   5 // Modified by: VZ at 11.12.99 (wxScrollableToolBar split off)
   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
  28
  29 #include "wx/toolbar.h"
  30
  31 #ifndef WX_PRECOMP
  32     #include "wx/control.h"
  33     #include "wx/frame.h"
  34     #include "wx/settings.h"
  35     #if WXWIN_COMPATIBILITY_2_8
  36         #include "wx/image.h"
  37     #endif // WXWIN_COMPATIBILITY_2_8
  38     #include "wx/menu.h"
  39 #endif
  40
  41 // ----------------------------------------------------------------------------
  42 // wxWidgets macros
  43 // ----------------------------------------------------------------------------
  44
  45 BEGIN_EVENT_TABLE(wxToolBarBase, wxControl)
  46 END_EVENT_TABLE()
  47
  48 #include "wx/listimpl.cpp"
  49
  50 WX_DEFINE_LIST(wxToolBarToolsList)
  51
  52 // ============================================================================
  53 // implementation
  54 // ============================================================================
  55
  56 // ----------------------------------------------------------------------------
  57 // wxToolBarToolBase
  58 // ----------------------------------------------------------------------------
  59
  60 IMPLEMENT_DYNAMIC_CLASS(wxToolBarToolBase, wxObject)
  61
  62 wxToolBarToolBase::~wxToolBarToolBase()
  63 {
  64     delete m_dropdownMenu;
  65     if ( IsControl() )
  66         GetControl()->Destroy();
  67 }
  68
  69
  70 bool wxToolBarToolBase::Enable(bool enable)
  71 {
  72     if ( m_enabled == enable )
  73         return false;
  74
  75     m_enabled = enable;
  76
  77     return true;
  78 }
  79
  80 bool wxToolBarToolBase::Toggle(bool toggle)
  81 {
  82     wxASSERT_MSG( CanBeToggled(), wxT("can't toggle this tool") );
  83
  84     if ( m_toggled == toggle )
  85         return false;
  86
  87     m_toggled = toggle;
  88
  89     return true;
  90 }
  91
  92 bool wxToolBarToolBase::SetToggle(bool toggle)
  93 {
  94     wxItemKind kind = toggle ? wxITEM_CHECK : wxITEM_NORMAL;
  95     if ( m_kind == kind )
  96         return false;
  97
  98     m_kind = kind;
  99
 100     return true;
 101 }
 102
 103 bool wxToolBarToolBase::SetShortHelp(const wxString& help)
 104 {
 105     if ( m_shortHelpString == help )
 106         return false;
 107
 108     m_shortHelpString = help;
 109
 110     return true;
 111 }
 112
 113 bool wxToolBarToolBase::SetLongHelp(const wxString& help)
 114 {
 115     if ( m_longHelpString == help )
 116         return false;
 117
 118     m_longHelpString = help;
 119
 120     return true;
 121 }
 122
 123
 124 void wxToolBarToolBase::SetDropdownMenu(wxMenu* menu)
 125 {
 126     delete m_dropdownMenu;
 127     m_dropdownMenu = menu;
 128 }
 129
 130
 131 // ----------------------------------------------------------------------------
 132 // wxToolBarBase adding/deleting items
 133 // ----------------------------------------------------------------------------
 134
 135 wxToolBarBase::wxToolBarBase()
 136 {
 137     // the list owns the pointers
 138     m_xMargin = m_yMargin = 0;
 139     m_maxRows = m_maxCols = 0;
 140     m_toolPacking = m_toolSeparation = 0;
 141     m_defaultWidth = 16;
 142     m_defaultHeight = 15;
 143 }
 144
 145 void wxToolBarBase::FixupStyle()
 146 {
 147     if ( !HasFlag(wxTB_TOP | wxTB_LEFT | wxTB_RIGHT | wxTB_BOTTOM) )
 148     {
 149         // this is the default
 150         m_windowStyle |= wxTB_TOP;
 151     }
 152 }
 153
 154 wxToolBarToolBase *wxToolBarBase::DoAddTool(int id,
 155                                             const wxString& label,
 156                                             const wxBitmap& bitmap,
 157                                             const wxBitmap& bmpDisabled,
 158                                             wxItemKind kind,
 159                                             const wxString& shortHelp,
 160                                             const wxString& longHelp,
 161                                             wxObject *clientData,
 162                                             wxCoord WXUNUSED(xPos),
 163                                             wxCoord WXUNUSED(yPos))
 164 {
 165     InvalidateBestSize();
 166     return InsertTool(GetToolsCount(), id, label, bitmap, bmpDisabled,
 167                       kind, shortHelp, longHelp, clientData);
 168 }
 169
 170 wxToolBarToolBase *wxToolBarBase::InsertTool(size_t pos,
 171                                              int id,
 172                                              const wxString& label,
 173                                              const wxBitmap& bitmap,
 174                                              const wxBitmap& bmpDisabled,
 175                                              wxItemKind kind,
 176                                              const wxString& shortHelp,
 177                                              const wxString& longHelp,
 178                                              wxObject *clientData)
 179 {
 180     wxCHECK_MSG( pos <= GetToolsCount(), NULL,
 181                  wxT("invalid position in wxToolBar::InsertTool()") );
 182
 183     return DoInsertNewTool(pos, CreateTool(id, label, bitmap, bmpDisabled, kind,
 184                                            clientData, shortHelp, longHelp));
 185 }
 186
 187 wxToolBarToolBase *wxToolBarBase::AddTool(wxToolBarToolBase *tool)
 188 {
 189     return InsertTool(GetToolsCount(), tool);
 190 }
 191
 192 wxToolBarToolBase *
 193 wxToolBarBase::InsertTool(size_t pos, wxToolBarToolBase *tool)
 194 {
 195     wxCHECK_MSG( pos <= GetToolsCount(), NULL,
 196                  wxT("invalid position in wxToolBar::InsertTool()") );
 197
 198     if ( !tool || !DoInsertTool(pos, tool) )
 199     {
 200         return NULL;
 201     }
 202
 203     m_tools.Insert(pos, tool);
 204     tool->Attach(this);
 205
 206     return tool;
 207 }
 208
 209 wxToolBarToolBase *
 210 wxToolBarBase::AddControl(wxControl *control, const wxString& label)
 211 {
 212     return InsertControl(GetToolsCount(), control, label);
 213 }
 214
 215 wxToolBarToolBase *
 216 wxToolBarBase::InsertControl(size_t pos,
 217                              wxControl *control,
 218                              const wxString& label)
 219 {
 220     wxCHECK_MSG( control, NULL,
 221                  wxT("toolbar: can't insert NULL control") );
 222
 223     wxCHECK_MSG( control->GetParent() == this, NULL,
 224                  wxT("control must have toolbar as parent") );
 225
 226     return DoInsertNewTool(pos, CreateTool(control, label));
 227 }
 228
 229 wxControl *wxToolBarBase::FindControl( int id )
 230 {
 231     for ( wxToolBarToolsList::compatibility_iterator node = m_tools.GetFirst();
 232           node;
 233           node = node->GetNext() )
 234     {
 235         const wxToolBarToolBase * const tool = node->GetData();
 236         if ( tool->IsControl() )
 237         {
 238             wxControl * const control = tool->GetControl();
 239
 240             if ( !control )
 241             {
 242                 wxFAIL_MSG( wxT("NULL control in toolbar?") );
 243             }
 244             else if ( control->GetId() == id )
 245             {
 246                 // found
 247                 return control;
 248             }
 249         }
 250     }
 251
 252    return NULL;
 253 }
 254
 255 wxToolBarToolBase *wxToolBarBase::AddSeparator()
 256 {
 257     return InsertSeparator(GetToolsCount());
 258 }
 259
 260 wxToolBarToolBase *wxToolBarBase::InsertSeparator(size_t pos)
 261 {
 262     return DoInsertNewTool(pos, CreateSeparator());
 263 }
 264
 265 wxToolBarToolBase *wxToolBarBase::AddStretchableSpace()
 266 {
 267     return InsertStretchableSpace(GetToolsCount());
 268 }
 269
 270 wxToolBarToolBase *wxToolBarBase::InsertStretchableSpace(size_t pos)
 271 {
 272     wxToolBarToolBase * const tool = CreateSeparator();
 273     if ( tool )
 274     {
 275         // this is a hack but we know that all the current implementations
 276         // don't really use the tool when it's created, they will do it
 277         // InsertTool() at earliest and maybe even in Realize() much later
 278         //
 279         // so we can create the tool as a plain separator and mark it as being
 280         // a stretchable space later
 281         tool->MakeStretchable();
 282     }
 283
 284     return DoInsertNewTool(pos, tool);
 285 }
 286
 287 wxToolBarToolBase *wxToolBarBase::RemoveTool(int id)
 288 {
 289     size_t pos = 0;
 290     wxToolBarToolsList::compatibility_iterator node;
 291     for ( node = m_tools.GetFirst(); node; node = node->GetNext() )
 292     {
 293         if ( node->GetData()->GetId() == id )
 294             break;
 295
 296         pos++;
 297     }
 298
 299     if ( !node )
 300     {
 301         // don't give any error messages - sometimes we might call RemoveTool()
 302         // without knowing whether the tool is or not in the toolbar
 303         return NULL;
 304     }
 305
 306     wxToolBarToolBase *tool = node->GetData();
 307     wxCHECK_MSG( tool, NULL, "NULL tool in the tools list?" );
 308
 309     if ( !DoDeleteTool(pos, tool) )
 310         return NULL;
 311
 312     m_tools.Erase(node);
 313
 314     tool->Detach();
 315
 316     return tool;
 317 }
 318
 319 bool wxToolBarBase::DeleteToolByPos(size_t pos)
 320 {
 321     wxCHECK_MSG( pos < GetToolsCount(), false,
 322                  wxT("invalid position in wxToolBar::DeleteToolByPos()") );
 323
 324     wxToolBarToolsList::compatibility_iterator node = m_tools.Item(pos);
 325
 326     if ( !DoDeleteTool(pos, node->GetData()) )
 327     {
 328         return false;
 329     }
 330
 331     delete node->GetData();
 332     m_tools.Erase(node);
 333
 334     return true;
 335 }
 336
 337 bool wxToolBarBase::DeleteTool(int id)
 338 {
 339     size_t pos = 0;
 340     wxToolBarToolsList::compatibility_iterator node;
 341     for ( node = m_tools.GetFirst(); node; node = node->GetNext() )
 342     {
 343         if ( node->GetData()->GetId() == id )
 344             break;
 345
 346         pos++;
 347     }
 348
 349     if ( !node || !DoDeleteTool(pos, node->GetData()) )
 350     {
 351         return false;
 352     }
 353
 354     delete node->GetData();
 355     m_tools.Erase(node);
 356
 357     return true;
 358 }
 359
 360 wxToolBarToolBase *wxToolBarBase::FindById(int id) const
 361 {
 362     wxToolBarToolBase *tool = NULL;
 363
 364     for ( wxToolBarToolsList::compatibility_iterator node = m_tools.GetFirst();
 365           node;
 366           node = node->GetNext() )
 367     {
 368         tool = node->GetData();
 369         if ( tool->GetId() == id )
 370         {
 371             // found
 372             break;
 373         }
 374
 375         tool = NULL;
 376     }
 377
 378     return tool;
 379 }
 380
 381 void wxToolBarBase::UnToggleRadioGroup(wxToolBarToolBase *tool)
 382 {
 383     wxCHECK_RET( tool, wxT("NULL tool in wxToolBarTool::UnToggleRadioGroup") );
 384
 385     if ( !tool->IsButton() || tool->GetKind() != wxITEM_RADIO )
 386         return;
 387
 388     wxToolBarToolsList::compatibility_iterator node = m_tools.Find(tool);
 389     wxCHECK_RET( node, wxT("invalid tool in wxToolBarTool::UnToggleRadioGroup") );
 390
 391     wxToolBarToolsList::compatibility_iterator nodeNext = node->GetNext();
 392     while ( nodeNext )
 393     {
 394         wxToolBarToolBase *toolNext = nodeNext->GetData();
 395
 396         if ( !toolNext->IsButton() || toolNext->GetKind() != wxITEM_RADIO )
 397             break;
 398
 399         if ( toolNext->Toggle(false) )
 400         {
 401             DoToggleTool(toolNext, false);
 402         }
 403
 404         nodeNext = nodeNext->GetNext();
 405     }
 406
 407     wxToolBarToolsList::compatibility_iterator nodePrev = node->GetPrevious();
 408     while ( nodePrev )
 409     {
 410         wxToolBarToolBase *toolNext = nodePrev->GetData();
 411
 412         if ( !toolNext->IsButton() || toolNext->GetKind() != wxITEM_RADIO )
 413             break;
 414
 415         if ( toolNext->Toggle(false) )
 416         {
 417             DoToggleTool(toolNext, false);
 418         }
 419
 420         nodePrev = nodePrev->GetPrevious();
 421     }
 422 }
 423
 424 void wxToolBarBase::ClearTools()
 425 {
 426     while ( GetToolsCount() )
 427     {
 428         DeleteToolByPos(0);
 429     }
 430 }
 431
 432 void wxToolBarBase::AdjustToolBitmapSize()
 433 {
 434     const wxSize sizeOrig(m_defaultWidth, m_defaultHeight);
 435
 436     wxSize sizeActual(sizeOrig);
 437
 438     for ( wxToolBarToolsList::const_iterator i = m_tools.begin();
 439           i != m_tools.end();
 440           ++i )
 441     {
 442         const wxBitmap& bmp = (*i)->GetNormalBitmap();
 443         if ( bmp.IsOk() )
 444             sizeActual.IncTo(bmp.GetSize());
 445     }
 446
 447     if ( sizeActual != sizeOrig )
 448         SetToolBitmapSize(sizeActual);
 449 }
 450
 451 bool wxToolBarBase::Realize()
 452 {
 453     // check if we have anything to do
 454     if ( m_tools.empty() )
 455         return false;
 456
 457     // make sure tool size is larger enough for all all bitmaps to fit in
 458     // (this is consistent with what other ports do):
 459     AdjustToolBitmapSize();
 460
 461     return true;
 462 }
 463
 464 wxToolBarBase::~wxToolBarBase()
 465 {
 466     WX_CLEAR_LIST(wxToolBarToolsList, m_tools);
 467
 468     // notify the frame that it doesn't have a tool bar any longer to avoid
 469     // dangling pointers
 470     wxFrame *frame = wxDynamicCast(GetParent(), wxFrame);
 471     if ( frame && frame->GetToolBar() == this )
 472     {
 473         frame->SetToolBar(NULL);
 474     }
 475 }
 476
 477 // ----------------------------------------------------------------------------
 478 // wxToolBarBase tools state
 479 // ----------------------------------------------------------------------------
 480
 481 void wxToolBarBase::EnableTool(int id, bool enable)
 482 {
 483     wxToolBarToolBase *tool = FindById(id);
 484     if ( tool )
 485     {
 486         if ( tool->Enable(enable) )
 487         {
 488             DoEnableTool(tool, enable);
 489         }
 490     }
 491 }
 492
 493 void wxToolBarBase::ToggleTool(int id, bool toggle)
 494 {
 495     wxToolBarToolBase *tool = FindById(id);
 496     if ( tool && tool->CanBeToggled() )
 497     {
 498         if ( tool->Toggle(toggle) )
 499         {
 500             UnToggleRadioGroup(tool);
 501             DoToggleTool(tool, toggle);
 502         }
 503     }
 504 }
 505
 506 void wxToolBarBase::SetToggle(int id, bool toggle)
 507 {
 508     wxToolBarToolBase *tool = FindById(id);
 509     if ( tool )
 510     {
 511         if ( tool->SetToggle(toggle) )
 512         {
 513             DoSetToggle(tool, toggle);
 514         }
 515     }
 516 }
 517
 518 void wxToolBarBase::SetToolShortHelp(int id, const wxString& help)
 519 {
 520     wxToolBarToolBase *tool = FindById(id);
 521     if ( tool )
 522     {
 523         (void)tool->SetShortHelp(help);
 524     }
 525 }
 526
 527 void wxToolBarBase::SetToolLongHelp(int id, const wxString& help)
 528 {
 529     wxToolBarToolBase *tool = FindById(id);
 530     if ( tool )
 531     {
 532         (void)tool->SetLongHelp(help);
 533     }
 534 }
 535
 536 wxObject *wxToolBarBase::GetToolClientData(int id) const
 537 {
 538     wxToolBarToolBase *tool = FindById(id);
 539
 540     return tool ? tool->GetClientData() : NULL;
 541 }
 542
 543 void wxToolBarBase::SetToolClientData(int id, wxObject *clientData)
 544 {
 545     wxToolBarToolBase *tool = FindById(id);
 546
 547     wxCHECK_RET( tool, wxT("no such tool in wxToolBar::SetToolClientData") );
 548
 549     tool->SetClientData(clientData);
 550 }
 551
 552 int wxToolBarBase::GetToolPos(int id) const
 553 {
 554     size_t pos = 0;
 555     wxToolBarToolsList::compatibility_iterator node;
 556
 557     for ( node = m_tools.GetFirst(); node; node = node->GetNext() )
 558     {
 559         if ( node->GetData()->GetId() == id )
 560             return pos;
 561
 562         pos++;
 563     }
 564
 565     return wxNOT_FOUND;
 566 }
 567
 568 bool wxToolBarBase::GetToolState(int id) const
 569 {
 570     wxToolBarToolBase *tool = FindById(id);
 571     wxCHECK_MSG( tool, false, wxT("no such tool") );
 572
 573     return tool->IsToggled();
 574 }
 575
 576 bool wxToolBarBase::GetToolEnabled(int id) const
 577 {
 578     wxToolBarToolBase *tool = FindById(id);
 579     wxCHECK_MSG( tool, false, wxT("no such tool") );
 580
 581     return tool->IsEnabled();
 582 }
 583
 584 wxString wxToolBarBase::GetToolShortHelp(int id) const
 585 {
 586     wxToolBarToolBase *tool = FindById(id);
 587     wxCHECK_MSG( tool, wxEmptyString, wxT("no such tool") );
 588
 589     return tool->GetShortHelp();
 590 }
 591
 592 wxString wxToolBarBase::GetToolLongHelp(int id) const
 593 {
 594     wxToolBarToolBase *tool = FindById(id);
 595     wxCHECK_MSG( tool, wxEmptyString, wxT("no such tool") );
 596
 597     return tool->GetLongHelp();
 598 }
 599
 600 // ----------------------------------------------------------------------------
 601 // wxToolBarBase geometry
 602 // ----------------------------------------------------------------------------
 603
 604 void wxToolBarBase::SetMargins(int x, int y)
 605 {
 606     m_xMargin = x;
 607     m_yMargin = y;
 608 }
 609
 610 void wxToolBarBase::SetRows(int WXUNUSED(nRows))
 611 {
 612     // nothing
 613 }
 614
 615 bool wxToolBarBase::IsVertical() const
 616 {
 617     return HasFlag(wxTB_LEFT | wxTB_RIGHT);
 618 }
 619
 620
 621 // ----------------------------------------------------------------------------
 622 // event processing
 623 // ----------------------------------------------------------------------------
 624
 625 // Only allow toggle if returns true
 626 bool wxToolBarBase::OnLeftClick(int id, bool toggleDown)
 627 {
 628     wxCommandEvent event(wxEVT_COMMAND_TOOL_CLICKED, id);
 629     event.SetEventObject(this);
 630
 631     // we use SetInt() to make wxCommandEvent::IsChecked() return toggleDown
 632     event.SetInt((int)toggleDown);
 633
 634     // and SetExtraLong() for backwards compatibility
 635     event.SetExtraLong((long)toggleDown);
 636
 637     // Send events to this toolbar instead (and thence up the window hierarchy)
 638     HandleWindowEvent(event);
 639
 640     return true;
 641 }
 642
 643 // Call when right button down.
 644 void wxToolBarBase::OnRightClick(int id,
 645                                  long WXUNUSED(x),
 646                                  long WXUNUSED(y))
 647 {
 648     wxCommandEvent event(wxEVT_COMMAND_TOOL_RCLICKED, id);
 649     event.SetEventObject(this);
 650     event.SetInt(id);
 651
 652     GetEventHandler()->ProcessEvent(event);
 653 }
 654
 655 // Called when the mouse cursor enters a tool bitmap (no button pressed).
 656 // Argument is wxID_ANY if mouse is exiting the toolbar.
 657 // Note that for this event, the id of the window is used,
 658 // and the integer parameter of wxCommandEvent is used to retrieve
 659 // the tool id.
 660 void wxToolBarBase::OnMouseEnter(int id)
 661 {
 662     wxCommandEvent event(wxEVT_COMMAND_TOOL_ENTER, GetId());
 663     event.SetEventObject(this);
 664     event.SetInt(id);
 665
 666     wxFrame *frame = wxDynamicCast(GetParent(), wxFrame);
 667     if ( frame )
 668     {
 669         wxString help;
 670         if ( id != wxID_ANY )
 671         {
 672            const wxToolBarToolBase * const tool = FindById(id);
 673            if ( tool )
 674                help = tool->GetLongHelp();
 675         }
 676
 677         // call DoGiveHelp() even if help string is empty to avoid showing the
 678         // help for the previously selected tool when another one is selected
 679         frame->DoGiveHelp(help, id != wxID_ANY);
 680     }
 681
 682     (void)GetEventHandler()->ProcessEvent(event);
 683 }
 684
 685 // ----------------------------------------------------------------------------
 686 // UI updates
 687 // ----------------------------------------------------------------------------
 688
 689 // Do the toolbar button updates (check for EVT_UPDATE_UI handlers)
 690 void wxToolBarBase::UpdateWindowUI(long flags)
 691 {
 692     wxWindowBase::UpdateWindowUI(flags);
 693
 694     // don't waste time updating state of tools in a hidden toolbar
 695     if ( !IsShown() )
 696         return;
 697
 698     // There is no sense in updating the toolbar UI
 699     // if the parent window is about to get destroyed
 700     wxWindow *tlw = wxGetTopLevelParent( this );
 701     if (tlw && wxPendingDelete.Member( tlw ))
 702         return;
 703
 704     wxEvtHandler* evtHandler = GetEventHandler() ;
 705
 706     for ( wxToolBarToolsList::compatibility_iterator node = m_tools.GetFirst();
 707           node;
 708           node = node->GetNext() )
 709     {
 710         wxToolBarToolBase * const tool = node->GetData();
 711         if ( tool->IsSeparator() )
 712             continue;
 713
 714         int id = tool->GetId();
 715
 716         wxUpdateUIEvent event(id);
 717         event.SetEventObject(this);
 718
 719         if ( evtHandler->ProcessEvent(event) )
 720         {
 721             if ( event.GetSetEnabled() )
 722                 EnableTool(id, event.GetEnabled());
 723             if ( event.GetSetChecked() )
 724                 ToggleTool(id, event.GetChecked());
 725 #if 0
 726             if ( event.GetSetText() )
 727                 // Set tooltip?
 728 #endif // 0
 729         }
 730     }
 731 }
 732
 733 bool wxToolBarBase::SetDropdownMenu(int toolid, wxMenu* menu)
 734 {
 735     wxToolBarToolBase * const tool = FindById(toolid);
 736     wxCHECK_MSG( tool, false, wxT("invalid tool id") );
 737
 738     wxCHECK_MSG( tool->GetKind() == wxITEM_DROPDOWN, false,
 739                     wxT("menu can be only associated with drop down tools") );
 740
 741     tool->SetDropdownMenu(menu);
 742
 743     return true;
 744 }
 745
 746 #if WXWIN_COMPATIBILITY_2_8
 747
 748 bool wxCreateGreyedImage(const wxImage& in, wxImage& out)
 749 {
 750 #if wxUSE_IMAGE
 751     out = in.ConvertToGreyscale();
 752     if ( out.Ok() )
 753         return true;
 754 #endif // wxUSE_IMAGE
 755     return false;
 756 }
 757
 758 #endif // WXWIN_COMPATIBILITY_2_8
 759
 760 #endif // wxUSE_TOOLBAR