RealtimeEffectListWindow Class Reference

Inheritance diagram for RealtimeEffectListWindow:

Collaboration diagram for RealtimeEffectListWindow:

Public Member Functions
	RealtimeEffectListWindow (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxScrolledWindowStyle, const wxString &name=wxPanelNameStr)
void	SetFooter (wxWindow *footer)
void	OnEffectListItemChange (const RealtimeEffectListMessage &msg)
void	ResetDelegate ()
void	SetDelegate (AudacityProject &project, const std::shared_ptr< EffectListUIDelegate > &delegate)
void	EnableEffects (bool enable)
void	ReloadEffectsList ()
void	OnAddEffectClicked (const wxCommandEvent &event)
void	InsertEffectRow (size_t index, const std::shared_ptr< RealtimeEffectState > &pState)

Private Attributes
wxWeakRef< AudacityProject >	mProject
AButton *	mAddEffect {nullptr}
wxWindow *	mEffectListContainer {nullptr}
wxWindow *	mFooter {nullptr}
std::shared_ptr< EffectListUIDelegate >	mDelegate
Observer::Subscription	mEffectListItemMovedSubscription

Detailed Description

Definition at line 761 of file RealtimeEffectPanel.cpp.

Constructor & Destructor Documentation

RealtimeEffectListWindow()

RealtimeEffectListWindow::RealtimeEffectListWindow ( wxWindow *  parent, wxWindowID  winid = wxID_ANY, const wxPoint &  pos = wxDefaultPosition, const wxSize &  size = wxDefaultSize, long  style = wxScrolledWindowStyle, const wxString &  name = wxPanelNameStr  )

inline

i18n-hint: undo history record first parameter - realtime effect name second parameter - track name

i18n-hint: undo history record first parameter - realtime effect name second parameter - track name

Definition at line 774 of file RealtimeEffectPanel.cpp.

      : wxScrolledWindow(parent, winid, pos, size, style, name)
   {
#ifdef __WXMSW__
      //Fixes flickering on redraw
      wxScrolledWindow::SetDoubleBuffered(true);
#endif
      auto rootSizer = std::make_unique<wxBoxSizer>(wxVERTICAL);
 
      auto effectListContainer = safenew ThemedWindowWrapper<wxPanel>(this, wxID_ANY);
      effectListContainer->SetBackgroundColorIndex(clrMedium);
      effectListContainer->SetSizer(safenew wxBoxSizer(wxVERTICAL));
      effectListContainer->SetDoubleBuffered(true);
      effectListContainer->Hide();
      mEffectListContainer = effectListContainer;
 
      auto addEffect = safenew ThemedAButtonWrapper<AButton>(this, wxID_ANY);
      addEffect->SetImageIndices(0,
            bmpHButtonNormal,
            bmpHButtonHover,
            bmpHButtonDown,
            bmpHButtonHover,
            bmpHButtonDisabled);
      addEffect->SetTranslatableLabel(XO("Add effect"));
      addEffect->SetButtonType(AButton::TextButton);
      addEffect->SetBackgroundColorIndex(clrMedium);
      addEffect->SetForegroundColorIndex(clrTrackPanelText);
      addEffect->Bind(wxEVT_BUTTON, &RealtimeEffectListWindow::OnAddEffectClicked, this);
      mAddEffect = addEffect;
 
      //indicates the insertion position of the item
      auto dropHintLine = safenew ThemedWindowWrapper<DropHintLine>(effectListContainer, wxID_ANY);
      dropHintLine->SetBackgroundColorIndex(clrDropHintHighlight);
      dropHintLine->Hide();
 
      rootSizer->Add(mEffectListContainer, 0, wxEXPAND | wxBOTTOM, 10);
      rootSizer->Add(addEffect, 0, wxLEFT | wxRIGHT | wxBOTTOM | wxEXPAND, 20);
 
      SetSizer(rootSizer.release());
      SetMinSize({});
 
      Bind(EVT_MOVABLE_CONTROL_DRAG_STARTED, [dropHintLine](const MovableControlEvent& event)
      {
         if(auto window = dynamic_cast<wxWindow*>(event.GetEventObject()))
            window->Raise();
      });
      Bind(EVT_MOVABLE_CONTROL_DRAG_POSITION, [this, dropHintLine](const MovableControlEvent& event)
      {
         constexpr auto DropHintLineHeight { 3 };//px
 
         auto sizer = mEffectListContainer->GetSizer();
         assert(sizer != nullptr);
 
         if(event.GetSourceIndex() == event.GetTargetIndex())
         {
            //do not display hint line if position didn't change
            dropHintLine->Hide();
            return;
         }
 
         if(!dropHintLine->IsShown())
         {
            dropHintLine->Show();
            dropHintLine->Raise();
            if(auto window = dynamic_cast<wxWindow*>(event.GetEventObject()))
               window->Raise();
         }
 
         auto item = sizer->GetItem(event.GetTargetIndex());
         dropHintLine->SetSize(item->GetSize().x, DropHintLineHeight);
 
         if(event.GetTargetIndex() > event.GetSourceIndex())
            dropHintLine->SetPosition(item->GetRect().GetBottomLeft() - wxPoint(0, DropHintLineHeight));
         else
            dropHintLine->SetPosition(item->GetRect().GetTopLeft());
      });
 
      Bind(EVT_MOVABLE_CONTROL_DRAG_FINISHED, [this, dropHintLine](const MovableControlEvent& event)
      {
         dropHintLine->Hide();
 
         if(!mDelegate || !mProject)
            return;
 
         const auto from = event.GetSourceIndex();
         const auto to = event.GetTargetIndex();
         if(from != to)
         {
            auto& effectList = mDelegate->GetEffectList();
            auto effectName =
               effectList.GetStateAt(from)->GetEffect()->GetName();
            bool up = (to < from);
            effectList.MoveEffect(from, to);
            ProjectHistory::Get(*mProject).PushState(
               (up
                  ? XO("Moved %s up in %s")
                  : XO("Moved %s down in %s"))
                  .Format(effectName, mDelegate->GetSourceName()),
               XO("Change effect order"), UndoPush::CONSOLIDATE);
         }
         else
         {
            wxWindowUpdateLocker freeze(this);
            Layout();
         }
      });
 
      SetScrollRate(0, 20);
#if defined(__WXMSW__) || defined(__WXMAC__)
#endif
   }

References CONSOLIDATE, ProjectHistory::Get(), MovableControlEvent::GetSourceIndex(), MovableControlEvent::GetTargetIndex(), mAddEffect, mDelegate, mEffectListContainer, mProject, OnAddEffectClicked(), ProjectHistory::PushState(), safenew, AButton::TextButton, and XO().

Here is the call graph for this function:

Member Function Documentation

EnableEffects()

void RealtimeEffectListWindow::EnableEffects ( bool  enable )

inline

Definition at line 1011 of file RealtimeEffectPanel.cpp.

   {
      if (mDelegate)
         mDelegate->GetEffectList().SetActive(enable);
   }

References mDelegate.

Referenced by RealtimeEffectPanel::MakeMasterEffectPane(), and RealtimeEffectPanel::MakeTrackEffectPane().

Here is the caller graph for this function:

InsertEffectRow()

void RealtimeEffectListWindow::InsertEffectRow ( size_t  index, const std::shared_ptr< RealtimeEffectState > &  pState  )

inline

Definition at line 1090 of file RealtimeEffectPanel.cpp.

   {
      if(!mDelegate || !mProject)
         return;
 
      // See comment in ReloadEffectsList
      if(!mEffectListContainer->IsShown())
         mEffectListContainer->Show();
 
      auto row = safenew ThemedWindowWrapper<RealtimeEffectControl>(mEffectListContainer, wxID_ANY);
      row->SetBackgroundColorIndex(clrEffectListItemBackground);
      row->SetEffect(*mProject, mDelegate, pState);
      mEffectListContainer->GetSizer()->Insert(index, row, 0, wxEXPAND);
   }

References mDelegate, mEffectListContainer, mProject, and safenew.

Referenced by OnEffectListItemChange(), and ReloadEffectsList().

Here is the caller graph for this function:

OnAddEffectClicked()

void RealtimeEffectListWindow::OnAddEffectClicked ( const wxCommandEvent &  event )

inline

i18n-hint: undo history record first parameter - realtime effect name second parameter - track name

Definition at line 1047 of file RealtimeEffectPanel.cpp.

   {
      if(!mDelegate || !mProject)
         return;
 
      const auto effectId = EffectsMenuHelper::PickEffect(
         *mProject,
         dynamic_cast<wxWindow*>(event.GetEventObject()),
         {}
      );
 
      if(!effectId || effectId->empty())
         return;
 
      auto plug = PluginManager::Get().GetPlugin(*effectId);
      if(!plug)
         return;
 
      if(!PluginManager::IsPluginAvailable(*plug)) {
         BasicUI::ShowMessageBox(
            XO("This plugin could not be loaded.\nIt may have been deleted."),
            BasicUI::MessageBoxOptions()
               .Caption(XO("Plugin Error")));
 
         return;
      }
 
      if(const auto state = AudioIO::Get()->AddState(*mProject, mDelegate->GetChannelGroup(), *effectId))
      {
         auto effect = state->GetEffect();
         assert(effect); // postcondition of AddState
         const auto effectName = effect->GetName();
         ProjectHistory::Get(*mProject).PushState(
            XO("Added %s to %s").Format(effectName, mDelegate->GetSourceName()),
            //i18n-hint: undo history record
            XO("Add %s").Format(effectName));
      }
   }

References AudioIO::Get(), PluginManager::Get(), ProjectHistory::Get(), PluginManager::GetPlugin(), PluginManager::IsPluginAvailable(), mDelegate, mProject, ProjectHistory::PushState(), BasicUI::ShowMessageBox(), and XO().

Referenced by RealtimeEffectListWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

OnEffectListItemChange()

void RealtimeEffectListWindow::OnEffectListItemChange ( const RealtimeEffectListMessage &  msg )

inline

Definition at line 916 of file RealtimeEffectPanel.cpp.

   {
      auto sizer = mEffectListContainer->GetSizer();
      const auto insertItem = [this, &msg](){
         auto& effects = mDelegate->GetEffectList();
         InsertEffectRow(msg.srcIndex, effects.GetStateAt(msg.srcIndex));
         if(mFooter != nullptr)
            mFooter->Hide();
      };
      const auto removeItem = [&](){
         auto& ui = RealtimeEffectStateUI::Get(*msg.affectedState);
         // Don't need to auto-save changed settings of effect that is deleted
         // Undo history push will do it anyway
         ui.Hide();
 
         auto window = sizer->GetItem(msg.srcIndex)->GetWindow();
         sizer->Remove(msg.srcIndex);
         wxTheApp->CallAfter([ref = wxWeakRef { window }] {
            if(ref) ref->Destroy();
         });
 
         if(sizer->IsEmpty())
         {
            if(mEffectListContainer->IsDescendant(FindFocus()))
               mAddEffect->SetFocus();
 
            mEffectListContainer->Hide();
            if(mFooter != nullptr)
               mFooter->Show();
         }
      };
 
      wxWindowUpdateLocker freeze(this);
      if(msg.type == RealtimeEffectListMessage::Type::Move)
      {
         const auto sizer = mEffectListContainer->GetSizer();
 
         const auto movedItem = sizer->GetItem(msg.srcIndex);
 
         const auto proportion = movedItem->GetProportion();
         const auto flag = movedItem->GetFlag();
         const auto border = movedItem->GetBorder();
         const auto window = movedItem->GetWindow();
 
         if(msg.srcIndex < msg.dstIndex)
            window->MoveAfterInTabOrder(sizer->GetItem(msg.dstIndex)->GetWindow());
         else
            window->MoveBeforeInTabOrder(sizer->GetItem(msg.dstIndex)->GetWindow());
 
         sizer->Remove(msg.srcIndex);
         sizer->Insert(msg.dstIndex, window, proportion, flag, border);
      }
      else if(msg.type == RealtimeEffectListMessage::Type::Insert)
      {
         insertItem();
      }
      else if(msg.type == RealtimeEffectListMessage::Type::WillReplace)
      {
         removeItem();
      }
      else if(msg.type == RealtimeEffectListMessage::Type::DidReplace)
      {
         insertItem();
      }
      else if(msg.type == RealtimeEffectListMessage::Type::Remove)
      {
         removeItem();
      }
      SendSizeEventToParent();
   }

References RealtimeEffectListMessage::affectedState, RealtimeEffectListMessage::DidReplace, RealtimeEffectListMessage::dstIndex, BasicUI::FindFocus(), flag, RealtimeEffectStateUI::Get(), RealtimeEffectListMessage::Insert, InsertEffectRow(), mAddEffect, mDelegate, mEffectListContainer, mFooter, RealtimeEffectListMessage::Move, RealtimeEffectListMessage::Remove, RealtimeEffectListMessage::srcIndex, RealtimeEffectListMessage::type, and RealtimeEffectListMessage::WillReplace.

Referenced by SetDelegate().

Here is the call graph for this function:

Here is the caller graph for this function:

ReloadEffectsList()

void RealtimeEffectListWindow::ReloadEffectsList ( )

inline

Definition at line 1017 of file RealtimeEffectPanel.cpp.

   {
      wxWindowUpdateLocker freeze(this);
 
      //delete items that were added to the sizer
      mEffectListContainer->Hide();
      mEffectListContainer->GetSizer()->Clear(true);
 
 
      if(!mDelegate || mDelegate->GetEffectList().GetStatesCount() == 0)
         mEffectListContainer->Hide();
 
      auto isEmpty{true};
      if(mDelegate)
      {
         auto& effects = mDelegate->GetEffectList();
         isEmpty = effects.GetStatesCount() == 0;
         for(size_t i = 0, count = effects.GetStatesCount(); i < count; ++i)
            InsertEffectRow(i, effects.GetStateAt(i));
      }
      mAddEffect->SetEnabled(!!mDelegate);
      //Workaround for GTK: Underlying GTK widget does not update
      //its size when wxWindow size is set to zero
      mEffectListContainer->Show(!isEmpty);
      if(mFooter != nullptr)
         mFooter->Show(isEmpty);
 
      SendSizeEventToParent();
   }

References InsertEffectRow(), mAddEffect, mDelegate, mEffectListContainer, mFooter, and AButton::SetEnabled().

Referenced by ResetDelegate(), and SetDelegate().

Here is the call graph for this function:

Here is the caller graph for this function:

ResetDelegate()

void RealtimeEffectListWindow::ResetDelegate ( )

inline

Definition at line 987 of file RealtimeEffectPanel.cpp.

   {
      mEffectListItemMovedSubscription.Reset();
 
      mProject.Release();
      mDelegate.reset();
      ReloadEffectsList();
   }

References mDelegate, mEffectListItemMovedSubscription, mProject, ReloadEffectsList(), and Observer::Subscription::Reset().

Referenced by RealtimeEffectPanel::ResetTrack().

Here is the call graph for this function:

Here is the caller graph for this function:

SetDelegate()

void RealtimeEffectListWindow::SetDelegate ( AudacityProject &  project, const std::shared_ptr< EffectListUIDelegate > &  delegate  )

inline

Definition at line 996 of file RealtimeEffectPanel.cpp.

   {
      mEffectListItemMovedSubscription.Reset();
 
      mProject = &project;
      mDelegate = delegate;
      ReloadEffectsList();
 
      if (mDelegate)
      {
         mEffectListItemMovedSubscription = mDelegate->GetEffectList().Subscribe(
            *this, &RealtimeEffectListWindow::OnEffectListItemChange);
      }
   }

References mDelegate, mEffectListItemMovedSubscription, mProject, OnEffectListItemChange(), project, ReloadEffectsList(), and Observer::Subscription::Reset().

Referenced by RealtimeEffectPanel::RealtimeEffectPanel(), and RealtimeEffectPanel::SetTrack().

Here is the call graph for this function:

Here is the caller graph for this function:

SetFooter()

void RealtimeEffectListWindow::SetFooter ( wxWindow *  footer )

inline

Definition at line 899 of file RealtimeEffectPanel.cpp.

   {
      if(footer == mFooter)
         return;
 
      if(mFooter != nullptr)
      {
         GetSizer()->Detach(mFooter);
         mFooter->Destroy();
      }
 
      mFooter = footer;
      GetSizer()->Add(mFooter, 0, wxEXPAND);
 
      Layout();
   }

References mFooter.

Member Data Documentation

mAddEffect

AButton* RealtimeEffectListWindow::mAddEffect {nullptr}

private

Definition at line 765 of file RealtimeEffectPanel.cpp.

Referenced by OnEffectListItemChange(), RealtimeEffectListWindow(), and ReloadEffectsList().

mDelegate

std::shared_ptr<EffectListUIDelegate> RealtimeEffectListWindow::mDelegate

private

Definition at line 769 of file RealtimeEffectPanel.cpp.

Referenced by EnableEffects(), InsertEffectRow(), OnAddEffectClicked(), OnEffectListItemChange(), RealtimeEffectListWindow(), ReloadEffectsList(), ResetDelegate(), and SetDelegate().

mEffectListContainer

wxWindow* RealtimeEffectListWindow::mEffectListContainer {nullptr}

private

Definition at line 766 of file RealtimeEffectPanel.cpp.

Referenced by InsertEffectRow(), OnEffectListItemChange(), RealtimeEffectListWindow(), and ReloadEffectsList().

mEffectListItemMovedSubscription

Observer::Subscription RealtimeEffectListWindow::mEffectListItemMovedSubscription

private

Definition at line 771 of file RealtimeEffectPanel.cpp.

Referenced by ResetDelegate(), and SetDelegate().

mFooter

wxWindow* RealtimeEffectListWindow::mFooter {nullptr}

private

Definition at line 767 of file RealtimeEffectPanel.cpp.

Referenced by OnEffectListItemChange(), ReloadEffectsList(), and SetFooter().

mProject

wxWeakRef<AudacityProject> RealtimeEffectListWindow::mProject

private

Definition at line 764 of file RealtimeEffectPanel.cpp.

Referenced by InsertEffectRow(), OnAddEffectClicked(), RealtimeEffectListWindow(), ResetDelegate(), and SetDelegate().

---

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

• RealtimeEffectPanel.cpp