LyricsWindow Class Reference

#include <LyricsWindow.h>

Inheritance diagram for LyricsWindow:

Collaboration diagram for LyricsWindow:

Public Member Functions
	LyricsWindow (AudacityProject *parent)
LyricsPanel *	GetLyricsPanel ()
Public Member Functions inherited from PrefsListener
	PrefsListener ()
virtual	~PrefsListener ()
virtual void	UpdatePrefs ()=0

Private Member Functions
void	OnCloseWindow (wxCloseEvent &WXUNUSED(event))
void	OnStyle_BouncingBall (wxCommandEvent &evt)
void	OnStyle_Highlight (wxCommandEvent &evt)
void	OnTimer (Observer::Message)
void	SetWindowTitle ()
void	UpdatePrefs () override

Private Attributes
std::weak_ptr< AudacityProject >	mProject
LyricsPanel *	mLyricsPanel
Observer::Subscription	mTimerSubscription
Observer::Subscription	mTitleChangeSubscription

Additional Inherited Members
Static Public Member Functions inherited from PrefsListener
static void	Broadcast (int id=0)
	Call this static function to notify all PrefsListener objects. More...
Protected Member Functions inherited from PrefsListener
virtual void	UpdateSelectedPrefs (int id)

Detailed Description

Definition at line 24 of file LyricsWindow.h.

Constructor & Destructor Documentation

LyricsWindow()

LyricsWindow::LyricsWindow

(

AudacityProject *

parent

)

Definition at line 54 of file LyricsWindow.cpp.

   : wxFrame( &GetProjectFrame( *parent ), -1, wxString{},
            wxPoint(100, 300), gSize,
            //v Bug in wxFRAME_FLOAT_ON_PARENT:
            // If both the project frame and LyricsWindow are minimized and you restore LyricsWindow,
            // you can't restore project frame until you close LyricsWindow, but then project frame and
            // LyricsWindow are restored but LyricsWindow is unresponsive because it thinks it's not shown.
            //    wxDEFAULT_FRAME_STYLE | wxFRAME_FLOAT_ON_PARENT)
            wxDEFAULT_FRAME_STYLE)
{
   //vvv Still necessary? It's commented out in ToolManager and Meter, so I did so here.
   //   #ifdef __WXMAC__
   //      // WXMAC doesn't support wxFRAME_FLOAT_ON_PARENT, so we do
   //      SetWindowClass((WindowRef) MacGetWindowRef(), kFloatingWindowClass);
   //   #endif
   auto pProject = parent->shared_from_this();
   mProject = pProject;
 
   SetWindowTitle();
   mTitleChangeSubscription = ProjectFileIO::Get(*parent)
      .Subscribe([this](ProjectFileIOMessage message){
         if (message == ProjectFileIOMessage::ProjectTitleChange)
            SetWindowTitle();
      });
 
   // loads either the XPM or the windows resource, depending on the platform
#if !defined(__WXMAC__) && !defined(__WXX11__)
   {
#ifdef __WXMSW__
      wxIcon ic{ wxICON(AudacityLogo) };
#else
      wxIcon ic{wxICON(AudacityLogo48x48)};
#endif
      SetIcon(ic);
   }
   #endif
 
   wxPoint panelPos(0, 0);
   wxSize panelSize = gSize;
 
   //vvv not yet working right in ported version, so choice is disabled.
   // It seems when you select highlight style, the TrackPanel timer stops working, but
   // going back to bouncing ball style starts it up again (!!!), per breakpoints in TrackPanel::OnTimer().
   //
   //wxToolBar* pToolBar = this->CreateToolBar();
   //const int kHorizMargin = 8;
   //wxASSERT(pToolBar); // To justify safenew
   //wxRadioButton* pRadioButton_BouncingBall =
   //   safenew wxRadioButton(pToolBar, kID_RadioButton_BouncingBall, _("Bouncing Ball"), wxPoint(kHorizMargin, 4),
   //       wxDefaultSize, wxRB_GROUP);
   //wxSize tbSize = pToolBar->GetSize();
   //wxSize btnSize = pRadioButton_BouncingBall->GetSize();
   //int top = (tbSize.GetHeight() - btnSize.GetHeight()) / 2;
   //pRadioButton_BouncingBall->Move(kHorizMargin, top);
   //pToolBar->AddControl(pRadioButton_BouncingBall);
   //
   //int left = kHorizMargin + btnSize.GetWidth() + kHorizMargin; //vvv Doesn't actually work. Probably need sizers.
   //wxRadioButton* pRadioButton_Highlight =
   //   safenew wxRadioButton(pToolBar, kID_RadioButton_Highlight, _("Highlight"), wxPoint(left, top));
   //pToolBar->AddControl(pRadioButton_Highlight);
   //
   //panelPos.x += tbSize.GetHeight();
   //panelSize.y -= tbSize.GetHeight();
   //
   //#if defined(__WXMAC__)
   //   wxColour face = wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE);
   //   pRadioButton_BouncingBall->SetBackgroundColour(face);
   //   pRadioButton_Highlight->SetBackgroundColour(face);
   //#endif
   //
   //pToolBar->Realize();
 
   mLyricsPanel = safenew LyricsPanel(this, -1, parent, panelPos, panelSize);
   RTL_WORKAROUND(mLyricsPanel);
 
   //vvv Highlight style is broken in ported version.
   //switch (mLyricsPanel->GetLyricsStyle())
   //{
   //   case LyricsPanel::kBouncingBallLyrics:
   //      pRadioButton_BouncingBall->SetValue(true); break;
   //   case LyricsPanel::kHighlightLyrics:
   //   default:
   //      pRadioButton_Highlight->SetValue(true); break;
   //}
 
   // Events from the project don't propagate directly to this other frame, so...
   if (pProject)
      mTimerSubscription = ProjectWindow::Get( *pProject ).GetPlaybackScroller()
         .Subscribe(*this, &LyricsWindow::OnTimer);
   Center();
}

Member Function Documentation

GetLyricsPanel()

LyricsPanel * LyricsWindow::GetLyricsPanel ( )

inline

Definition at line 31 of file LyricsWindow.h.

{ return mLyricsPanel; };

References mLyricsPanel.

Referenced by OnTimer().

Here is the caller graph for this function:

OnCloseWindow()

void LyricsWindow::OnCloseWindow ( wxCloseEvent &  WXUNUSEDevent )

private

Definition at line 147 of file LyricsWindow.cpp.

{
  this->Hide();
}

OnStyle_BouncingBall()

void LyricsWindow::OnStyle_BouncingBall ( wxCommandEvent &  evt )

private

Definition at line 152 of file LyricsWindow.cpp.

{
   mLyricsPanel->SetLyricsStyle(LyricsPanel::kBouncingBallLyrics);
}

References LyricsPanel::kBouncingBallLyrics, mLyricsPanel, and LyricsPanel::SetLyricsStyle().

Here is the call graph for this function:

OnStyle_Highlight()

void LyricsWindow::OnStyle_Highlight ( wxCommandEvent &  evt )

private

Definition at line 157 of file LyricsWindow.cpp.

{
   mLyricsPanel->SetLyricsStyle(LyricsPanel::kHighlightLyrics);
}

References LyricsPanel::kHighlightLyrics, mLyricsPanel, and LyricsPanel::SetLyricsStyle().

Here is the call graph for this function:

OnTimer()

void LyricsWindow::OnTimer ( Observer::Message  )

private

Definition at line 162 of file LyricsWindow.cpp.

{
   if (auto pProject = mProject.lock()) {
      if (ProjectAudioIO::Get( *pProject ).IsAudioActive())
      {
         auto gAudioIO = AudioIO::Get();
         GetLyricsPanel()->Update(gAudioIO->GetStreamTime());
      }
      else
      {
         // Reset lyrics display.
         const auto &selectedRegion = ViewInfo::Get( *pProject ).selectedRegion;
         GetLyricsPanel()->Update(selectedRegion.t0());
      }
   }
}

References AudioIO::Get(), ProjectAudioIO::Get(), ViewInfo::Get(), GetLyricsPanel(), ProjectAudioIO::IsAudioActive(), mProject, ViewInfo::selectedRegion, and LyricsPanel::Update().

Here is the call graph for this function:

SetWindowTitle()

void LyricsWindow::SetWindowTitle ( )

private

Definition at line 179 of file LyricsWindow.cpp.

{
   wxString name;
   if (auto pProject = mProject.lock()) {
      name = pProject->GetProjectName();
      if (!name.empty())
         name.Prepend(wxT(" - "));
   }
 
   SetTitle(AudacityKaraokeTitle.Format(name).Translation());
}

References AudacityKaraokeTitle, TranslatableString::empty(), mProject, name, and wxT().

Referenced by UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

UpdatePrefs()

void LyricsWindow::UpdatePrefs ( )

overrideprivatevirtual

Implements PrefsListener.

Definition at line 191 of file LyricsWindow.cpp.

{
   SetWindowTitle();
}

References SetWindowTitle().

Here is the call graph for this function:

Member Data Documentation

mLyricsPanel

LyricsPanel* LyricsWindow::mLyricsPanel

private

Definition at line 46 of file LyricsWindow.h.

Referenced by GetLyricsPanel(), OnStyle_BouncingBall(), and OnStyle_Highlight().

mProject

std::weak_ptr<AudacityProject> LyricsWindow::mProject

private

Definition at line 45 of file LyricsWindow.h.

Referenced by OnTimer(), and SetWindowTitle().

mTimerSubscription

Observer::Subscription LyricsWindow::mTimerSubscription

private

Definition at line 47 of file LyricsWindow.h.

mTitleChangeSubscription

Observer::Subscription LyricsWindow::mTitleChangeSubscription

private

Definition at line 48 of file LyricsWindow.h.

---

The documentation for this class was generated from the following files:

• LyricsWindow.h
• LyricsWindow.cpp