Change ScrubBar to ScrubRuler

This also makes it clearer in the code when we are dealing with a Toolbar ID (for the scrubbing toolbar) and when we are dealing with a button ID (for enabling/disabling the scrub ruler).

src/AllThemeResources.h

@@ -82,7 +82,7 @@ from there.  Audacity will look for a file called "Pause.png".
    DEFINE_IMAGE( bmpVolumeSlider, wxImage( 100, 28 ), wxT("VolumeSlider"));
    DEFINE_IMAGE( bmpVolumeSliderThumb, wxImage( 10, 28 ), wxT("VolumeSliderThumb"));
    DEFINE_IMAGE( bmpSliderThumb, wxImage( 11, 14 ), wxT("SliderThumb"));
-   DEFINE_IMAGE( bmpToggleScrubBar, wxImage( 20, 20 ), wxT("ToggleScrubBar"));
+   DEFINE_IMAGE( bmpToggleScrubRuler, wxImage( 20, 20 ), wxT("ToggleScrubBar"));
 
    SET_THEME_FLAGS(  resFlagNone  );
    DEFINE_IMAGE( bmpMacUpButton, wxImage( 36, 36 ), wxT("MacUpButton"));

src/Menus.cpp

@@ -728,7 +728,7 @@ void AudacityProject::CreateMenusAndCommands()
       c->AddCheck(wxT("ShowTranscriptionTB"), _("Tra&nscription Toolbar"), FN(OnShowTranscriptionToolBar), 0, AlwaysEnabledFlag, AlwaysEnabledFlag);
       /* i18n-hint: Clicking this menu item shows the toolbar with the big buttons on it (play record etc)*/
       c->AddCheck(wxT("ShowTransportTB"), _("&Transport Toolbar"), FN(OnShowTransportToolBar), 0, AlwaysEnabledFlag, AlwaysEnabledFlag);
-      /* i18n-hint: Clicking this menu item shows the toolbar that enables Scrub or Seek playback and Scrub Bar*/
+      /* i18n-hint: Clicking this menu item shows the toolbar that enables Scrub or Seek playback and Scrub Ruler*/
       c->AddCheck(wxT("ShowScrubbingTB"), _("Scru&b Toolbar"), FN(OnShowScrubbingToolBar), 0, AlwaysEnabledFlag, AlwaysEnabledFlag);
 
       c->AddSeparator();

src/toolbars/ScrubbingToolBar.cpp

@@ -110,9 +110,9 @@ void ScrubbingToolBar::Populate()
              _("Scrub"), true);
    AddButton(bmpSeek, bmpSeek, bmpSeekDisabled, STBSeekID,
              _("Seek"), true);
-   AddButton(bmpToggleScrubBar, bmpToggleScrubBar, bmpToggleScrubBar,
+   AddButton(bmpToggleScrubRuler, bmpToggleScrubRuler, bmpToggleScrubRuler,
-             STBBarID,
+             STBRulerID,
-             _("Scrub bar"), true);
+             _("Scrub Ruler"), true);
 
 
    RegenerateTooltips();
@@ -173,11 +173,11 @@ void ScrubbingToolBar::RegenerateTooltips()
       fn(*seekButton, label, wxT("Seek"));
 
       label = (
-               project->GetRulerPanel()->ShowingScrubBar()
+               project->GetRulerPanel()->ShowingScrubRuler()
-               ? _("Hide Scrub Bar")
+               ? _("Hide Scrub Ruler")
-               : _("Show Scrub Bar")
+               : _("Show Scrub Ruler")
                );
-      fn(*mButtons[STBBarID], label, wxT("ToggleScrubBar"));
+      fn(*mButtons[STBRulerID], label, wxT("ToggleScrubRuler"));
    }
 #endif
 }
@@ -197,8 +197,8 @@ void ScrubbingToolBar::OnButton(wxCommandEvent &event)
       case STBSeekID:
          scrubber.OnSeek(event);
          break;
-      case STBBarID:
+      case STBRulerID:
-         scrubber.OnToggleScrubBar(event);
+         scrubber.OnToggleScrubRuler(event);
          break;
       default:
          wxASSERT(false);
@@ -244,9 +244,9 @@ void ScrubbingToolBar::EnableDisableButtons()
          seekButton->Disable();
    }
 
-   const auto barButton = mButtons[STBBarID];
+   const auto barButton = mButtons[STBRulerID];
    barButton->Enable();
-   if (p->GetRulerPanel()->ShowingScrubBar())
+   if (p->GetRulerPanel()->ShowingScrubRuler())
       barButton->PushDown();
    else
       barButton->PopUp();

src/toolbars/ScrubbingToolBar.h

@@ -30,7 +30,7 @@ class AButton;
 enum {
    STBScrubID,
    STBSeekID,
-   STBBarID,
+   STBRulerID,
 
    STBNumButtons,
    STBFirstButton = STBScrubID

src/tracks/ui/Scrubbing.cpp

@@ -242,9 +242,9 @@ namespace {
          &Scrubber::OnSeek,        true,       &Scrubber::Seeks,
       },
 
-      { wxT("ToggleScrubBar"),            XO("Scrub Bar"),   XO(""),
+      { wxT("ToggleScrubRuler"),            XO("Scrub Ruler"),   XO(""),
          AlwaysEnabledFlag,
-         &Scrubber::OnToggleScrubBar, true,    &Scrubber::ShowsBar,
+         &Scrubber::OnToggleScrubRuler, true,    &Scrubber::ShowsBar,
       },
    };
 
@@ -556,7 +556,7 @@ void Scrubber::StopScrubbing()
 
 bool Scrubber::ShowsBar() const
 {
-   return mProject->GetRulerPanel()->ShowingScrubBar();
+   return mProject->GetRulerPanel()->ShowingScrubRuler();
 }
 
 bool Scrubber::IsScrubbing() const
@@ -915,9 +915,9 @@ void Scrubber::OnSeek(wxCommandEvent&)
    CheckMenuItems();
 }
 
-void Scrubber::OnToggleScrubBar(wxCommandEvent&)
+void Scrubber::OnToggleScrubRuler(wxCommandEvent&)
 {
-   mProject->GetRulerPanel()->OnToggleScrubBar();
+   mProject->GetRulerPanel()->OnToggleScrubRuler();
    const auto toolbar = mProject->GetToolManager()->GetToolBar(ScrubbingBarID);
    toolbar->EnableDisableButtons();
    CheckMenuItems();
@@ -928,7 +928,7 @@ enum { CMD_ID = 8000 };
 BEGIN_EVENT_TABLE(Scrubber, wxEvtHandler)
    EVT_MENU(CMD_ID,     Scrubber::OnScrub)
    EVT_MENU(CMD_ID + 1, Scrubber::OnSeek)
-   EVT_MENU(CMD_ID + 2, Scrubber::OnToggleScrubBar)
+   EVT_MENU(CMD_ID + 2, Scrubber::OnToggleScrubRuler)
 END_EVENT_TABLE()
 
 BEGIN_EVENT_TABLE(Scrubber::Forwarder, wxEvtHandler)

src/tracks/ui/Scrubbing.h

@@ -124,7 +124,7 @@ public:
    void OnScrubOrSeek(bool seek);
    void OnScrub(wxCommandEvent&);
    void OnSeek(wxCommandEvent&);
-   void OnToggleScrubBar(wxCommandEvent&);
+   void OnToggleScrubRuler(wxCommandEvent&);
 
    // A string to put in the leftmost part of the status bar
    // when scrub or seek is in progress, or else empty.

src/widgets/Ruler.cpp

@@ -1911,7 +1911,7 @@ enum {
    OnTimelineToolTipID,
    OnAutoScrollID,
    OnLockPlayRegionID,
-   OnScrubBarID,
+   OnScrubRulerID,
 
    OnTogglePinnedStateID,
 };
@@ -1928,7 +1928,7 @@ BEGIN_EVENT_TABLE(AdornedRulerPanel, OverlayPanel)
    EVT_MENU(OnTimelineToolTipID, AdornedRulerPanel::OnTimelineToolTips)
    EVT_MENU(OnAutoScrollID, AdornedRulerPanel::OnAutoScroll)
    EVT_MENU(OnLockPlayRegionID, AdornedRulerPanel::OnLockPlayRegion)
-   EVT_MENU(OnScrubBarID, AdornedRulerPanel::OnToggleScrubBarFromMenu)
+   EVT_MENU(OnScrubRulerID, AdornedRulerPanel::OnToggleScrubRulerFromMenu)
 
    // Pop up menus on Windows
    EVT_CONTEXT_MENU(AdornedRulerPanel::OnContextMenu)
@@ -2803,13 +2803,13 @@ void AdornedRulerPanel::UpdateStatusBarAndTooltips(StatusChoice choice)
 // This version toggles ruler state indirectly via the scrubber
 // to ensure that all the places where the state is shown update.
 // For example buttons and menus must update.
-void AdornedRulerPanel::OnToggleScrubBarFromMenu(wxCommandEvent& Evt)
+void AdornedRulerPanel::OnToggleScrubRulerFromMenu(wxCommandEvent& Evt)
 {
    auto &scrubber = mProject->GetScrubber();
-   scrubber.OnToggleScrubBar( Evt );
+   scrubber.OnToggleScrubRuler( Evt );
 }
 
-void AdornedRulerPanel::OnToggleScrubBar(/*wxCommandEvent&*/)
+void AdornedRulerPanel::OnToggleScrubRuler(/*wxCommandEvent&*/)
 {
    mShowScrubbing = !mShowScrubbing;
    WriteScrubEnabledPref(mShowScrubbing);
@@ -2925,11 +2925,11 @@ void AdornedRulerPanel::ShowMenu(const wxPoint & pos)
       prlitem = rulerMenu.Append(OnLockPlayRegionID, _("Unlock Play Region"));
    prlitem->Enable(mProject->IsPlayRegionLocked() || (mPlayRegionStart != mPlayRegionEnd));
 
-   wxMenuItem *baritem;
+   wxMenuItem *ruleritem;
    if (mShowScrubbing)
-      baritem = rulerMenu.Append(OnScrubBarID, _("Disable Scrub Bar"));
+      ruleritem = rulerMenu.Append(OnScrubRulerID, _("Disable Scrub Ruler"));
    else
-      baritem = rulerMenu.Append(OnScrubBarID, _("Enable Scrub Bar"));
+      ruleritem = rulerMenu.Append(OnScrubRulerID, _("Enable Scrub Ruler"));
 
    PopupMenu(&rulerMenu, pos);
 }

src/widgets/Ruler.h

@@ -329,9 +329,9 @@ public:
    void HideQuickPlayIndicator( bool repaint_all=false);
    void UpdateQuickPlayPos(wxCoord &mousPosX);
 
-   bool ShowingScrubBar() const { return mShowScrubbing; }
+   bool ShowingScrubRuler() const { return mShowScrubbing; }
-   void OnToggleScrubBar(/*wxCommandEvent& */);
+   void OnToggleScrubRuler(/*wxCommandEvent& */);
-   void OnToggleScrubBarFromMenu(wxCommandEvent& );
+   void OnToggleScrubRulerFromMenu(wxCommandEvent& );
    void SetPanelSize();