anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl Class Reference

Inheritance diagram for anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl:

Collaboration diagram for anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl:

Public Member Functions
	RealtimeEffectControl ()=default
	RealtimeEffectControl (wxWindow *parent, wxWindowID winid, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize)
void	Create (wxWindow *parent, wxWindowID winid, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize)
void	SetEffect (AudacityProject &project, const std::shared_ptr< EffectListUIDelegate > &delegate, const std::shared_ptr< RealtimeEffectState > &pState)
void	RemoveFromList ()
void	OnOptionsClicked (wxCommandEvent &event)
void	OnChangeButtonClicked (wxCommandEvent &event)
void	OnPaint (wxPaintEvent &)
void	OnFocusChange (wxFocusEvent &evt)
Public Member Functions inherited from ListNavigationEnabled< MovableControl >
	ListNavigationEnabled ()
void	SetInTabOrder (bool inTabOrder)

Private Attributes
wxWeakRef< AudacityProject >	mProject
std::shared_ptr< EffectListUIDelegate >	mDelegate
std::shared_ptr< RealtimeEffectState >	mEffectState
std::shared_ptr< EffectSettingsAccess >	mSettingsAccess
ThemedAButtonWrapper< AButton > *	mChangeButton {nullptr}
AButton *	mEnableButton {nullptr}
ThemedAButtonWrapper< AButton > *	mOptionsButton {}
Observer::Subscription	mSubscription

Detailed Description

Definition at line 443 of file RealtimeEffectPanel.cpp.

Constructor & Destructor Documentation

RealtimeEffectControl() [1/2]

anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::RealtimeEffectControl ( )

default

RealtimeEffectControl() [2/2]

anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::RealtimeEffectControl ( wxWindow *  parent, wxWindowID  winid, const wxPoint &  pos = wxDefaultPosition, const wxSize &  size = wxDefaultSize  )

inline

Definition at line 460 of file RealtimeEffectPanel.cpp.

      {
         Create(parent, winid, pos, size);
      }

References size.

Member Function Documentation

Create()

void anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::Create ( wxWindow *  parent, wxWindowID  winid, const wxPoint &  pos = wxDefaultPosition, const wxSize &  size = wxDefaultSize  )

inline

Definition at line 468 of file RealtimeEffectPanel.cpp.

      {
 
         //Prevents flickering and paint order issues
         MovableControl::SetBackgroundStyle(wxBG_STYLE_PAINT);
         MovableControl::Create(parent, winid, pos, size, wxNO_BORDER | wxWANTS_CHARS);
 
         Bind(wxEVT_PAINT, &RealtimeEffectControl::OnPaint, this);
         Bind(wxEVT_SET_FOCUS, &RealtimeEffectControl::OnFocusChange, this);
         Bind(wxEVT_KILL_FOCUS, &RealtimeEffectControl::OnFocusChange, this);
 
         auto sizer = std::make_unique<wxBoxSizer>(wxHORIZONTAL);
 
         //On/off button
         auto enableButton = safenew ThemedAButtonWrapper<AButton>(this);
         enableButton->SetTranslatableLabel(XO("Power"));
         enableButton->SetImageIndices(0, bmpEffectOff, bmpEffectOff, bmpEffectOn, bmpEffectOn, bmpEffectOff);
         enableButton->SetButtonToggles(true);
         enableButton->SetBackgroundColorIndex(clrEffectListItemBackground);
         mEnableButton = enableButton;
 
         enableButton->Bind(wxEVT_BUTTON, [this](wxCommandEvent&) {
            if(mDelegate && mEffectState)
            {
               mEffectState->SetActive(mEnableButton->IsDown());
               if (mProject)
               {
                  ProjectHistory::Get(*mProject).ModifyState(false);
                  UndoManager::Get(*mProject).MarkUnsaved();
               }
            }
         });
 
         //Central button with effect name, show settings
         const auto optionsButton = safenew ThemedAButtonWrapper<AButton>(this, wxID_ANY);
         optionsButton->SetImageIndices(0,
            bmpHButtonNormal,
            bmpHButtonHover,
            bmpHButtonDown,
            bmpHButtonHover,
            bmpHButtonDisabled);
         optionsButton->SetBackgroundColorIndex(clrEffectListItemBackground);
         optionsButton->SetForegroundColorIndex(clrTrackPanelText);
         optionsButton->SetButtonType(AButton::TextButton);
         optionsButton->Bind(wxEVT_BUTTON, &RealtimeEffectControl::OnOptionsClicked, this);
 
         //Remove/replace effect
         auto changeButton = safenew ThemedAButtonWrapper<AButton>(this);
         changeButton->SetImageIndices(0, bmpMoreNormal, bmpMoreHover, bmpMoreDown, bmpMoreHover, bmpMoreDisabled);
         changeButton->SetBackgroundColorIndex(clrEffectListItemBackground);
         changeButton->SetTranslatableLabel(XO("Replace effect"));
         changeButton->Bind(wxEVT_BUTTON, &RealtimeEffectControl::OnChangeButtonClicked, this);
 
         auto dragArea = safenew wxStaticBitmap(this, wxID_ANY, theTheme.Bitmap(bmpDragArea));
         dragArea->Disable();
         sizer->Add(dragArea, 0, wxLEFT | wxCENTER, 5);
         sizer->Add(enableButton, 0, wxLEFT | wxCENTER, 5);
         sizer->Add(optionsButton, 1, wxLEFT | wxCENTER, 5);
         sizer->Add(changeButton, 0, wxLEFT | wxRIGHT | wxCENTER, 5);
         mChangeButton = changeButton;
         mOptionsButton = optionsButton;
 
         auto vSizer = std::make_unique<wxBoxSizer>(wxVERTICAL);
         vSizer->Add(sizer.release(), 0, wxUP | wxDOWN | wxEXPAND, 10);
 
         SetSizer(vSizer.release());
 
         SetInTabOrder(false);
 
#if wxUSE_ACCESSIBILITY
         SetAccessible(safenew RealtimeEffectControlAx(this));
#endif
      }

References ThemeBase::Bitmap(), MovableControl::Create(), ProjectHistory::Get(), UndoManager::Get(), UndoManager::MarkUnsaved(), ProjectHistory::ModifyState(), safenew, size, AButton::TextButton, theTheme, and XO().

Here is the call graph for this function:

OnChangeButtonClicked()

void anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::OnChangeButtonClicked ( wxCommandEvent &  event )

inline

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

Definition at line 624 of file RealtimeEffectPanel.cpp.

      {
         if(!mDelegate || mProject == nullptr)
            return;
 
         if(mEffectState == nullptr)
            return;//not initialized
 
         const auto effectID = EffectsMenuHelper::PickEffect(
            *mProject,
            mChangeButton,
            mEffectState->GetID()
         );
         if(!effectID)
            return;//nothing
 
         if(effectID->empty())
            RemoveFromList();
         else
         {
            auto &project = *mProject;
            auto &em = RealtimeEffectManager::Get(project);
            auto oIndex = em.FindState(mDelegate->GetChannelGroup(), mEffectState);
            if (!oIndex)
               return;
 
            auto oldName = GetEffectName(*mEffectState);
 
            if (auto state = AudioIO::Get()
               ->ReplaceState(project, mDelegate->GetChannelGroup(), *oIndex, *effectID)
            ){
               // Message subscription took care of updating the button text
               // and destroyed `this`!
               auto effect = state->GetEffect();
               assert(effect); // postcondition of ReplaceState
               ProjectHistory::Get(project).PushState(
                  /*i18n-hint: undo history,
                   first and second parameters - realtime effect names
                   */
                  XO("Replaced %s with %s")
                     .Format(oldName, effect->GetName()),
                  XO("Replace %s").Format(oldName));
            }
         }
      }

References AudioIO::Get(), ProjectHistory::Get(), RealtimeEffectManager::Get(), anonymous_namespace{RealtimeEffectPanel.cpp}::GetEffectName(), project, ProjectHistory::PushState(), and XO().

Here is the call graph for this function:

OnFocusChange()

void anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::OnFocusChange ( wxFocusEvent &  evt )

inline

Definition at line 689 of file RealtimeEffectPanel.cpp.

      {
         Refresh(false);
         evt.Skip();
      }

OnOptionsClicked()

void anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::OnOptionsClicked ( wxCommandEvent &  event )

inline

TODO: effect is not available

Definition at line 602 of file RealtimeEffectPanel.cpp.

      {
         if(!mDelegate || !mEffectState)
            return;//not initialized
 
         const auto ID = mEffectState->GetID();
         const auto effectPlugin = EffectManager::Get().GetEffect(ID);
 
         if(effectPlugin == nullptr)
         {
            return;
         }
 
         if(!mProject)
            return;
         auto& effectStateUI = RealtimeEffectStateUI::Get(*mEffectState);
 
         effectStateUI.SetTargetName(mDelegate->GetSourceName());
         effectStateUI.Toggle(*mProject);
      }

References EffectManager::Get(), RealtimeEffectStateUI::Get(), and EffectManager::GetEffect().

Here is the call graph for this function:

OnPaint()

void anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::OnPaint ( wxPaintEvent &  )

inline

Definition at line 672 of file RealtimeEffectPanel.cpp.

      {
         wxBufferedPaintDC dc(this);
         const auto rect = wxRect(GetSize());
 
         dc.SetPen(*wxTRANSPARENT_PEN);
         dc.SetBrush(GetBackgroundColour());
         dc.DrawRectangle(rect);
 
         dc.SetPen(theTheme.Colour(clrEffectListItemBorder));
         dc.SetBrush(theTheme.Colour(clrEffectListItemBorder));
         dc.DrawLine(rect.GetBottomLeft(), rect.GetBottomRight());
 
         if(HasFocus())
            AColor::DrawFocus(dc, GetClientRect().Deflate(3, 3));
      }

References ThemeBase::Colour(), AColor::DrawFocus(), and theTheme.

Here is the call graph for this function:

RemoveFromList()

void anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::RemoveFromList ( )

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

Definition at line 577 of file RealtimeEffectPanel.cpp.

      {
         if(!mDelegate || !mProject || mEffectState == nullptr)
            return;
 
         auto& ui = RealtimeEffectStateUI::Get(*mEffectState);
         // Don't need autosave for the effect that is being removed
         ui.Hide();
 
         //After AudioIO::RemoveState call this will be destroyed
         auto effectName = GetEffectName(*mEffectState);
 
         AudioIO::Get()->RemoveState(*mProject, mDelegate->GetChannelGroup(), std::move(mEffectState));
         ProjectHistory::Get(*mProject).PushState(
            XO("Removed %s from %s").Format(effectName, mDelegate->GetSourceName()),
            XO("Remove %s").Format(effectName)
         );
      }

References AudioIO::Get(), ProjectHistory::Get(), RealtimeEffectStateUI::Get(), anonymous_namespace{RealtimeEffectPanel.cpp}::GetEffectName(), ProjectHistory::PushState(), AudioIO::RemoveState(), and XO().

Here is the call graph for this function:

SetEffect()

void anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::SetEffect ( AudacityProject &  project, const std::shared_ptr< EffectListUIDelegate > &  delegate, const std::shared_ptr< RealtimeEffectState > &  pState  )

inline

Definition at line 545 of file RealtimeEffectPanel.cpp.

      {
         mProject = &project;
         mDelegate = delegate;
         mEffectState = pState;
 
         mSubscription = mEffectState->Subscribe([this](RealtimeEffectStateChange state) {
            state == RealtimeEffectStateChange::EffectOn
               ? mEnableButton->PushDown()
               : mEnableButton->PopUp();
         });
 
         TranslatableString label;
         if (pState) {
            label = GetEffectName(*mEffectState);
            mSettingsAccess = pState->GetAccess();
         }
         else
            mSettingsAccess.reset();
         if (mEnableButton)
            mSettingsAccess && mSettingsAccess->Get().extra.GetActive()
               ? mEnableButton->PushDown()
               : mEnableButton->PopUp();
         if (mOptionsButton)
         {
            mOptionsButton->SetTranslatableLabel(label);
            mOptionsButton->SetEnabled(pState && GetPlugin(pState->GetID()));
         }
      }

References EffectOn, anonymous_namespace{RealtimeEffectPanel.cpp}::GetEffectName(), anonymous_namespace{RealtimeEffectPanel.cpp}::GetPlugin(), label, and project.

Here is the call graph for this function:

Member Data Documentation

mChangeButton

ThemedAButtonWrapper<AButton>* anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::mChangeButton {nullptr}

private

Definition at line 451 of file RealtimeEffectPanel.cpp.

mDelegate

std::shared_ptr<EffectListUIDelegate> anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::mDelegate

private

Definition at line 446 of file RealtimeEffectPanel.cpp.

mEffectState

std::shared_ptr<RealtimeEffectState> anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::mEffectState

private

Definition at line 448 of file RealtimeEffectPanel.cpp.

mEnableButton

AButton* anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::mEnableButton {nullptr}

private

Definition at line 452 of file RealtimeEffectPanel.cpp.

mOptionsButton

ThemedAButtonWrapper<AButton>* anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::mOptionsButton {}

private

Definition at line 453 of file RealtimeEffectPanel.cpp.

mProject

wxWeakRef<AudacityProject> anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::mProject

private

Definition at line 445 of file RealtimeEffectPanel.cpp.

mSettingsAccess

std::shared_ptr<EffectSettingsAccess> anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::mSettingsAccess

private

Definition at line 449 of file RealtimeEffectPanel.cpp.

mSubscription

Observer::Subscription anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::mSubscription

private

Definition at line 455 of file RealtimeEffectPanel.cpp.

---

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

• RealtimeEffectPanel.cpp