#include <EffectUI.h>

Inheritance diagram for EffectUIHost:

Collaboration diagram for EffectUIHost:

Public Member Functions
	EffectUIHost (wxWindow parent, AudacityProject &project, Effect effect, EffectUIClientInterface *client)

	EffectUIHost (wxWindow parent, AudacityProject &project, AudacityCommand command, EffectUIClientInterface *client)

virtual	~EffectUIHost ()

bool	TransferDataToWindow () override

bool	TransferDataFromWindow () override

int	ShowModal () override

bool	Initialize ()

Public Member Functions inherited from wxDialogWrapper
	wxDialogWrapper ()

	wxDialogWrapper (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))

bool	Create (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))

void	SetTitle (const TranslatableString &title)

void	SetLabel (const TranslatableString &title)

void	SetName (const TranslatableString &title)

void	SetName ()

Public Member Functions inherited from wxTabTraversalWrapper< wxDialog >
	wxTabTraversalWrapper (Args &&... args)

	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete

	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete

wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete

wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Public Member Functions inherited from EffectUIHostInterface
virtual	~EffectUIHostInterface ()

Private Member Functions
wxPanel *	BuildButtonBar (wxWindow *parent)

void	OnInitDialog (wxInitDialogEvent &evt)

void	OnErase (wxEraseEvent &evt)

void	OnPaint (wxPaintEvent &evt)

void	OnClose (wxCloseEvent &evt)

void	OnApply (wxCommandEvent &evt)

void	DoCancel ()

void	OnCancel (wxCommandEvent &evt)

void	OnHelp (wxCommandEvent &evt)

void	OnDebug (wxCommandEvent &evt)

void	OnMenu (wxCommandEvent &evt)

void	OnEnable (wxCommandEvent &evt)

void	OnPlay (wxCommandEvent &evt)

void	OnRewind (wxCommandEvent &evt)

void	OnFFwd (wxCommandEvent &evt)

void	OnPlayback (wxCommandEvent &evt)

void	OnCapture (wxCommandEvent &evt)

void	OnUserPreset (wxCommandEvent &evt)

void	OnFactoryPreset (wxCommandEvent &evt)

void	OnDeletePreset (wxCommandEvent &evt)

void	OnSaveAs (wxCommandEvent &evt)

void	OnImport (wxCommandEvent &evt)

void	OnExport (wxCommandEvent &evt)

void	OnOptions (wxCommandEvent &evt)

void	OnDefaults (wxCommandEvent &evt)

void	UpdateControls ()

wxBitmap	CreateBitmap (const char *const xpm[], bool up, bool pusher)

void	LoadUserPresets ()

void	InitializeRealtime ()

void	CleanupRealtime ()

void	Resume ()

Private Attributes
AudacityProject *	mProject

wxWindow *	mParent

Effect *	mEffect

AudacityCommand *	mCommand

EffectUIClientInterface *	mClient

RegistryPaths	mUserPresets

bool	mInitialized

bool	mSupportsRealtime

bool	mIsGUI

bool	mIsBatch

wxButton *	mApplyBtn

wxButton *	mCloseBtn

wxButton *	mMenuBtn

wxButton *	mPlayBtn

wxButton *	mRewindBtn

wxButton *	mFFwdBtn

wxCheckBox *	mEnableCb

wxButton *	mEnableToggleBtn

wxButton *	mPlayToggleBtn

wxBitmap	mPlayBM

wxBitmap	mPlayDisabledBM

wxBitmap	mStopBM

wxBitmap	mStopDisabledBM

bool	mEnabled

bool	mDisableTransport

bool	mPlaying

bool	mCapturing

SelectedRegion	mRegion

double	mPlayPos

bool	mDismissed {}

bool	mNeedsResume {}

Detailed Description

Definition at line 117 of file EffectUI.h.

Constructor & Destructor Documentation

◆ EffectUIHost() [1/2]

EffectUIHost::EffectUIHost	(	wxWindow *	parent,
		AudacityProject &	project,
		Effect *	effect,
		EffectUIClientInterface *	client
	)

Definition at line 719 of file EffectUI.cpp.

 :  wxDialogWrapper(parent, wxID_ANY, effect->GetName(),
                    wxDefaultPosition, wxDefaultSize,
                    wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER | wxMINIMIZE_BOX | wxMAXIMIZE_BOX)
 {
 #if defined(__WXMAC__)
    // Make sure the effect window actually floats above the main window
    [ [((NSView *)GetHandle()) window] setLevel:NSFloatingWindowLevel];
 #endif
    
    SetName( effect->GetName() );
    SetExtraStyle(GetExtraStyle() | wxWS_EX_VALIDATE_RECURSIVELY);
    
    mParent = parent;
    mEffect = effect;
    mCommand = NULL;
    mClient = client;
    
    mProject = &project;
    
    mInitialized = false;
    mSupportsRealtime = false;
    
    mDisableTransport = false;
    
    mEnabled = true;
    
    mPlayPos = 0.0;
    mClient->SetHostUI(this);
 }

◆ EffectUIHost() [2/2]

EffectUIHost::EffectUIHost	(	wxWindow *	parent,
		AudacityProject &	project,
		AudacityCommand *	command,
		EffectUIClientInterface *	client
	)

Definition at line 753 of file EffectUI.cpp.

 :  wxDialogWrapper(parent, wxID_ANY, XO("Some Command") /*command->GetName()*/,
                    wxDefaultPosition, wxDefaultSize,
                    wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER | wxMINIMIZE_BOX | wxMAXIMIZE_BOX)
 {
 #if defined(__WXMAC__)
    // Make sure the effect window actually floats above the main window
    [ [((NSView *)GetHandle()) window] setLevel:NSFloatingWindowLevel];
 #endif
    
    //SetName( command->GetName() );
    SetExtraStyle(wxWS_EX_VALIDATE_RECURSIVELY);
    
    mParent = parent;
    mEffect = NULL;
    mCommand = command;
    mClient = client;
    
    mProject = &project;
    
    mInitialized = false;
    mSupportsRealtime = false;
    
    mDisableTransport = false;
    
    mEnabled = true;
    
    mPlayPos = 0.0;
    mClient->SetHostUI(this);
 }

References mClient, mCommand, mDisableTransport, mEffect, mEnabled, mInitialized, mParent, mPlayPos, mProject, mSupportsRealtime, and EffectUIClientInterface::SetHostUI().

Here is the call graph for this function:

◆ ~EffectUIHost()

EffectUIHost::~EffectUIHost ( )

virtual

Definition at line 790 of file EffectUI.cpp.

 {
    CleanupRealtime();
    
    if (mClient)
    {
       if (mNeedsResume)
          Resume();
       
       mClient->CloseUI();
       mClient = NULL;
    }
 }

References CleanupRealtime(), EffectUIClientInterface::CloseUI(), mClient, mNeedsResume, and Resume().

Here is the call graph for this function:

Member Function Documentation

◆ BuildButtonBar()

wxPanel * EffectUIHost::BuildButtonBar ( wxWindow * parent )

private

Definition at line 859 of file EffectUI.cpp.

 {
    mSupportsRealtime = mEffect && mEffect->SupportsRealtime();
    mIsGUI = mClient->IsGraphicalUI();
    mIsBatch = (mEffect && mEffect->IsBatchProcessing()) ||
       (mCommand && mCommand->IsBatchProcessing());
  
    int margin = 0;
 #if defined(__WXMAC__)
    margin = 3; // I'm sure it's needed because of the order things are created...
 #endif
  
    const auto bar = safenew wxPanelWrapper(parent, wxID_ANY);
  
    // This fools NVDA into not saying "Panel" when the dialog gets focus
    bar->SetName(TranslatableString::Inaudible);
    bar->SetLabel(TranslatableString::Inaudible);
  
    ShuttleGui S{ bar, eIsCreating,
       false /* horizontal */,
       { -1, -1 } /* minimum size */
    };
    {
       S.SetBorder( margin );
  
       if (!mIsGUI)
       {
          mMenuBtn = S.Id( kMenuID )
             .ToolTip(XO("Manage presets and options"))
             .AddButton( XXO("&Manage"), wxALIGN_CENTER | wxTOP | wxBOTTOM );
       }
       else
       {
          mMenuBtn = S.Id( kMenuID )
             .ToolTip(XO("Manage presets and options"))
             .Name(XO("&Manage"))
             .AddBitmapButton( CreateBitmap(effect_menu_xpm, true, true) );
          mMenuBtn->SetBitmapPressed(CreateBitmap(effect_menu_xpm, false, true));
       }
  
       S.AddSpace( 5, 5 );
  
       if (!mIsBatch)
       {
          if (!mIsGUI)
          {
             if (mSupportsRealtime)
             {
                mPlayToggleBtn = S.Id( kPlayID )
                   .ToolTip(XO("Start and stop playback"))
                   .AddButton( XXO("Start &Playback"),
                               wxALIGN_CENTER | wxTOP | wxBOTTOM );
             }
             else if (mEffect &&
                (mEffect->GetType() != EffectTypeAnalyze) &&
                (mEffect->GetType() != EffectTypeTool) )
             {
                mPlayToggleBtn = S.Id( kPlayID )
                   .ToolTip(XO("Preview effect"))
                   .AddButton( XXO("&Preview"),
                               wxALIGN_CENTER | wxTOP | wxBOTTOM );
             }
          }
          else
          {
             mPlayBM = CreateBitmap(effect_play_xpm, true, false);
             mPlayDisabledBM = CreateBitmap(effect_play_disabled_xpm, true, true);
             mStopBM = CreateBitmap(effect_stop_xpm, true, false);
             mStopDisabledBM = CreateBitmap(effect_stop_disabled_xpm, true, false);
             mPlayBtn = S.Id( kPlayID ).AddBitmapButton( mPlayBM );
             mPlayBtn->SetBitmapDisabled(mPlayDisabledBM);
             mPlayBtn->SetBitmapPressed(CreateBitmap(effect_play_xpm, false, true));
             if (!mSupportsRealtime)
             {
                mPlayBtn->SetToolTip(_("Preview effect"));
 #if defined(__WXMAC__)
                mPlayBtn->SetName(_("Preview effect"));
 #else
                mPlayBtn->SetLabel(_("&Preview effect"));
 #endif
             }
          }
  
          if (mSupportsRealtime)
          {
             if (!mIsGUI)
             {
                mRewindBtn = S.Id( kRewindID )
                   .ToolTip(XO("Skip backward"))
                   .AddButton( XXO("Skip &Backward"),
                               wxALIGN_CENTER | wxTOP | wxBOTTOM );
             }
             else
             {
                mRewindBtn = S.Id( kRewindID )
                   .ToolTip(XO("Skip backward"))
                   .Name(XO("Skip &Backward"))
                   .AddBitmapButton( CreateBitmap(
                      effect_rewind_xpm, true, true) );
                mRewindBtn->SetBitmapDisabled(
                      CreateBitmap(effect_rewind_disabled_xpm, true, false));
                mRewindBtn->SetBitmapPressed(CreateBitmap(effect_rewind_xpm, false, true));
             }
  
             if (!mIsGUI)
             {
                mFFwdBtn = S.Id( kFFwdID )
                   .ToolTip(XO("Skip forward"))
                   .AddButton( XXO("Skip &Forward"),
                      wxALIGN_CENTER | wxTOP | wxBOTTOM );
             }
             else
             {
                mFFwdBtn = S.Id( kFFwdID )
                   .ToolTip(XO("Skip forward"))
                   .Name(XO("Skip &Forward"))
                   .AddBitmapButton( CreateBitmap(
                      effect_ffwd_xpm, true, true) );
                mFFwdBtn->SetBitmapDisabled(
                   CreateBitmap(effect_ffwd_disabled_xpm, true, false));
                mFFwdBtn->SetBitmapPressed(CreateBitmap(effect_ffwd_xpm, false, true));
             }
  
             S.AddSpace( 5, 5 );
  
             mEnableCb = S.Id( kEnableID )
                .Position(wxALIGN_CENTER | wxTOP | wxBOTTOM)
                .Name(XO("Enable"))
                .AddCheckBox( XXO("&Enable"), mEnabled );
             //
          }
       }
    }
  
    bar->GetSizer()->SetSizeHints( bar );
  
    return bar;
 }

References _, CreateBitmap(), EffectTypeAnalyze, EffectTypeTool, eIsCreating, Effect::GetType(), TranslatableString::Inaudible, AudacityCommand::IsBatchProcessing(), Effect::IsBatchProcessing(), EffectUIClientInterface::IsGraphicalUI(), kEnableID, kFFwdID, kMenuID, kPlayID, kRewindID, mClient, mCommand, mEffect, mEnableCb, mEnabled, mFFwdBtn, mIsBatch, mIsGUI, mMenuBtn, mPlayBM, mPlayBtn, mPlayDisabledBM, mPlayToggleBtn, mRewindBtn, mStopBM, mStopDisabledBM, mSupportsRealtime, safenew, Effect::SupportsRealtime(), XO, and XXO.

Referenced by Initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CleanupRealtime()

void EffectUIHost::CleanupRealtime ( )

private

Definition at line 1809 of file EffectUI.cpp.

 {
    if (mSupportsRealtime && mInitialized)
    {
       RealtimeEffectManager::Get().RealtimeRemoveEffect(mEffect);
       
       mInitialized = false;
    }
 }

References RealtimeEffectManager::Get(), mEffect, mInitialized, mSupportsRealtime, and RealtimeEffectManager::RealtimeRemoveEffect().

Referenced by OnClose(), and ~EffectUIHost().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CreateBitmap()

wxBitmap EffectUIHost::CreateBitmap	(	const char *const	xpm[],
		bool	up,
		bool	pusher
	)

private

Definition at line 1668 of file EffectUI.cpp.

 {
    wxMemoryDC dc;
    wxBitmap pic(xpm);
    
    wxBitmap mod(pic.GetWidth() + 6, pic.GetHeight() + 6, 24);
    dc.SelectObject(mod);
    
 #if defined(__WXGTK__)
    wxColour newColour = wxSystemSettings::GetColour(wxSYS_COLOUR_BACKGROUND);
 #else
    wxColour newColour = wxSystemSettings::GetColour(wxSYS_COLOUR_BTNFACE);
 #endif
    
    dc.SetBackground(wxBrush(newColour));
    dc.Clear();
    
    int offset = 3;
    if (pusher)
    {
       if (!up)
       {
          offset += 1;
       }
    }
    
    dc.DrawBitmap(pic, offset, offset, true);
    
    dc.SelectObject(wxNullBitmap);
    
    return mod;
 }

Referenced by BuildButtonBar().

Here is the caller graph for this function:

◆ DoCancel()

void EffectUIHost::DoCancel ( )

private

Definition at line 1213 of file EffectUI.cpp.

 {
    if (!mDismissed) {
       if( mEffect )
          mEffect->mUIResultID = wxID_CANCEL;
       
       if (IsModal())
          EndModal(false);
       else
          Hide();
       
       mDismissed = true;
    }
 }

References mDismissed, mEffect, and Effect::mUIResultID.

Referenced by OnCancel(), and OnClose().

Here is the caller graph for this function:

◆ Initialize()

bool EffectUIHost::Initialize ( )

Definition at line 998 of file EffectUI.cpp.

 {
    {
       auto gAudioIO = AudioIO::Get();
       mDisableTransport = !gAudioIO->IsAvailable(mProject);
       mPlaying = gAudioIO->IsStreamActive(); // not exactly right, but will suffice
       mCapturing = gAudioIO->IsStreamActive() && gAudioIO->GetNumCaptureChannels() > 0 && !gAudioIO->IsMonitoring();
    }
  
    EffectPanel *w {};
    ShuttleGui S{ this, eIsCreating };
    {
       S.StartHorizontalLay( wxEXPAND );
       {
          Destroy_ptr<EffectPanel> uw{ safenew EffectPanel( S.GetParent() ) };
          RTL_WORKAROUND(uw.get());
  
          // Try to give the window a sensible default/minimum size
          uw->SetMinSize(wxSize(wxMax(600, mParent->GetSize().GetWidth() * 2 / 3),
             mParent->GetSize().GetHeight() / 2));
  
          ShuttleGui S1{ uw.get(), eIsCreating };
          if (!mClient->PopulateUI(S1))
          {
             return false;
          }
  
          S.Prop( 1 )
             .Position(wxEXPAND)
             .AddWindow((w = uw.release()));
       }
       S.EndHorizontalLay();
  
       S.StartPanel();
       {
          const auto bar = BuildButtonBar( S.GetParent() );
  
          long buttons;
          if ( mEffect && mEffect->ManualPage().empty() && mEffect->HelpPage().empty()) {
             buttons = eApplyButton | eCloseButton;
             this->SetAcceleratorTable(wxNullAcceleratorTable);
          }
          else {
             buttons = eApplyButton | eCloseButton | eHelpButton;
             wxAcceleratorEntry entries[1];
 #if defined(__WXMAC__)
             // Is there a standard shortcut on Mac?
 #else
             entries[0].Set(wxACCEL_NORMAL, (int) WXK_F1, wxID_HELP);
 #endif
             wxAcceleratorTable accel(1, entries);
             this->SetAcceleratorTable(accel);
          }
  
          if (mEffect && mEffect->mUIDebug) {
             buttons |= eDebugButton;
          }
  
          S.AddStandardButtons(buttons, bar);
       }
       S.EndPanel();
    }
  
    Layout();
    Fit();
    Center();
  
    mApplyBtn = (wxButton *) FindWindow(wxID_APPLY);
    mCloseBtn = (wxButton *) FindWindow(wxID_CANCEL);
  
    UpdateControls();
  
    w->SetAccept(!mIsGUI);
    (!mIsGUI ? w : FindWindow(wxID_APPLY))->SetFocus();
  
    LoadUserPresets();
  
    InitializeRealtime();
  
    SetMinSize(GetSize());
    return true;
 }

References BuildButtonBar(), eApplyButton, eCloseButton, eDebugButton, eHelpButton, eIsCreating, AudioIO::Get(), Effect::HelpPage(), InitializeRealtime(), LoadUserPresets(), Effect::ManualPage(), mApplyBtn, mCapturing, mClient, mCloseBtn, mDisableTransport, mEffect, mIsGUI, mParent, mPlaying, mProject, Effect::mUIDebug, EffectUIClientInterface::PopulateUI(), RTL_WORKAROUND, safenew, and UpdateControls().

Here is the call graph for this function:

◆ InitializeRealtime()

void EffectUIHost::InitializeRealtime ( )

private

Definition at line 1791 of file EffectUI.cpp.

 {
    if (mSupportsRealtime && !mInitialized)
    {
       RealtimeEffectManager::Get().RealtimeAddEffect(mEffect);
       
       wxTheApp->Bind(EVT_AUDIOIO_PLAYBACK,
                      &EffectUIHost::OnPlayback,
                      this);
       
       wxTheApp->Bind(EVT_AUDIOIO_CAPTURE,
                      &EffectUIHost::OnCapture,
                      this);
       
       mInitialized = true;
    }
 }

References RealtimeEffectManager::Get(), mEffect, mInitialized, mSupportsRealtime, OnCapture(), OnPlayback(), and RealtimeEffectManager::RealtimeAddEffect().

Referenced by Initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadUserPresets()

void EffectUIHost::LoadUserPresets ( )

private

Definition at line 1779 of file EffectUI.cpp.

 {
    mUserPresets.clear();
    
    if( mEffect )
       mEffect->GetPrivateConfigSubgroups(mEffect->GetUserPresetsGroup(wxEmptyString), mUserPresets);
    
    std::sort( mUserPresets.begin(), mUserPresets.end() );
    
    return;
 }

References Effect::GetPrivateConfigSubgroups(), Effect::GetUserPresetsGroup(), mEffect, and mUserPresets.

Referenced by Initialize(), OnDeletePreset(), OnImport(), OnMenu(), and OnSaveAs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnApply()

void EffectUIHost::OnApply ( wxCommandEvent & evt )

private

Definition at line 1132 of file EffectUI.cpp.

 {
    auto &project = *mProject;
  
    // On wxGTK (wx2.8.12), the default action is still executed even if
    // the button is disabled.  This appears to affect all wxDialogs, not
    // just our Effects dialogs.  So, this is a only temporary workaround
    // for legacy effects that disable the OK button.  Hopefully this has
    // been corrected in wx3.
    if (!FindWindow(wxID_APPLY)->IsEnabled())
    {
       return;
    }
    
    // Honor the "select all if none" preference...a little hackish, but whatcha gonna do...
    if (!mIsBatch &&
        mEffect &&
        mEffect->GetType() != EffectTypeGenerate &&
        mEffect->GetType() != EffectTypeTool &&
        ViewInfo::Get( project ).selectedRegion.isPoint())
    {
       auto flags = AlwaysEnabledFlag;
       bool allowed =
       MenuManager::Get( project ).ReportIfActionNotAllowed(
          mEffect->GetName(),
          flags,
          WaveTracksSelectedFlag() | TimeSelectedFlag());
       if (!allowed)
          return;
    }
    
    if (!mClient->ValidateUI())
    {
       return;
    }
    
    // This will take care of calling TransferDataFromWindow() for an effect.
    if (mEffect &&  !mEffect->SaveUserPreset(mEffect->GetCurrentSettingsGroup()))
    {
       return;
    }
    // This will take care of calling TransferDataFromWindow() for a command.
    if (mCommand ){
       wxString params;
       mCommand->GetAutomationParameters( params );
    }
    
    if( mEffect )
       mEffect->mUIResultID = evt.GetId();
    
    if (IsModal())
    {
       mDismissed = true;
       
       EndModal(true);
       
       Close();
       
       return;
    }
    
    // Progress dialog no longer yields, so this "shouldn't" be necessary (yet to be proven
    // for sure), but it is a nice visual cue that something is going on.
    mApplyBtn->Disable();
    auto cleanup = finally( [&] { mApplyBtn->Enable(); } );
  
    if( mEffect ) {
       CommandContext context( project );
       // This is absolute hackage...but easy and I can't think of another way just now.
       //
       // It should callback to the EffectManager to kick off the processing
       EffectUI::DoEffect(mEffect->GetID(), context,
          EffectManager::kConfigured);
    }
  
    if( mCommand )
       // PRL:  I don't like the global and would rather pass *mProject!
       // But I am preserving old behavior
       mCommand->Apply( CommandContext{ project } );
 }

References AlwaysEnabledFlag, AudacityCommand::Apply(), EffectUI::DoEffect(), EffectTypeGenerate, EffectTypeTool, MenuManager::Get(), ViewInfo::Get(), AudacityCommand::GetAutomationParameters(), Effect::GetCurrentSettingsGroup(), Effect::GetID(), ComponentInterface::GetName(), Effect::GetType(), NotifyingSelectedRegion::isPoint(), EffectManager::kConfigured, mApplyBtn, mClient, mCommand, mDismissed, mEffect, mIsBatch, mProject, Effect::mUIResultID, params, MenuManager::ReportIfActionNotAllowed(), Effect::SaveUserPreset(), ViewInfo::selectedRegion, TimeSelectedFlag(), EffectUIClientInterface::ValidateUI(), and WaveTracksSelectedFlag().

Referenced by OnDebug().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnCancel()

void EffectUIHost::OnCancel ( wxCommandEvent & evt )

private

Definition at line 1228 of file EffectUI.cpp.

 {
    DoCancel();
    Close();
 }

References DoCancel().

Here is the call graph for this function:

◆ OnCapture()

void EffectUIHost::OnCapture ( wxCommandEvent & evt )

private

Definition at line 1500 of file EffectUI.cpp.

 {
    evt.Skip();
    
    if (evt.GetInt() != 0)
    {
       if (evt.GetEventObject() != mProject)
       {
          mDisableTransport = true;
       }
       else
       {
          mCapturing = true;
       }
    }
    else
    {
       mDisableTransport = false;
       mCapturing = false;
    }
    
    UpdateControls();
 }

References mCapturing, mDisableTransport, mProject, and UpdateControls().

Referenced by InitializeRealtime().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnClose()

void EffectUIHost::OnClose ( wxCloseEvent & evt )

private

Definition at line 1116 of file EffectUI.cpp.

 {
    DoCancel();
    
    CleanupRealtime();
    
    Hide();
    
    if (mNeedsResume)
       Resume();
    mClient->CloseUI();
    mClient = NULL;
    
    Destroy();
 }

References CleanupRealtime(), EffectUIClientInterface::CloseUI(), DoCancel(), mClient, mNeedsResume, and Resume().

Here is the call graph for this function:

◆ OnDebug()

void EffectUIHost::OnDebug ( wxCommandEvent & evt )

private

Definition at line 1248 of file EffectUI.cpp.

 {
    OnApply(evt);
    if( mEffect )
       mEffect->mUIResultID = evt.GetId();
 }

References mEffect, Effect::mUIResultID, and OnApply().

Here is the call graph for this function:

◆ OnDefaults()

void EffectUIHost::OnDefaults ( wxCommandEvent & evt )

private

Definition at line 1661 of file EffectUI.cpp.

 {
    mEffect->LoadFactoryDefaults();
    
    return;
 }

References Effect::LoadFactoryDefaults(), and mEffect.

Here is the call graph for this function:

◆ OnDeletePreset()

void EffectUIHost::OnDeletePreset ( wxCommandEvent & evt )

private

Definition at line 1540 of file EffectUI.cpp.

 {
    auto preset = mUserPresets[evt.GetId() - kDeletePresetID];
    
    int res = AudacityMessageBox(
                                 XO("Are you sure you want to delete \"%s\"?").Format( preset ),
                                 XO("Delete Preset"),
                                 wxICON_QUESTION | wxYES_NO);
    if (res == wxYES)
    {
       mEffect->RemovePrivateConfigSubgroup(mEffect->GetUserPresetsGroup(preset));
    }
    
    LoadUserPresets();
    
    return;
 }

References AudacityMessageBox(), Effect::GetUserPresetsGroup(), kDeletePresetID, LoadUserPresets(), mEffect, mUserPresets, Effect::RemovePrivateConfigSubgroup(), and XO.

Here is the call graph for this function:

◆ OnEnable()

void EffectUIHost::OnEnable ( wxCommandEvent & evt )

private

Definition at line 1357 of file EffectUI.cpp.

 {
    mEnabled = mEnableCb->GetValue();
    
    if (mEnabled) {
       Resume();
       mNeedsResume = false;
    }
    else
    {
       RealtimeEffectManager::Get().RealtimeSuspendOne( *mEffect );
       mNeedsResume = true;
    }
    
    UpdateControls();
 }

References RealtimeEffectManager::Get(), mEffect, mEnableCb, mEnabled, mNeedsResume, RealtimeEffectManager::RealtimeSuspendOne(), Resume(), and UpdateControls().

Here is the call graph for this function:

◆ OnErase()

void EffectUIHost::OnErase ( wxEraseEvent & evt )

private

Definition at line 1104 of file EffectUI.cpp.

 {
    // Ignore it
 }

◆ OnExport()

void EffectUIHost::OnExport ( wxCommandEvent & evt )

private

Definition at line 1645 of file EffectUI.cpp.

 {
    // may throw
    // exceptions are handled in AudacityApp::OnExceptionInMainLoop
    mClient->ExportPresets();
    
    return;
 }

References EffectUIClientInterface::ExportPresets(), and mClient.

Here is the call graph for this function:

◆ OnFactoryPreset()

void EffectUIHost::OnFactoryPreset ( wxCommandEvent & evt )

private

Definition at line 1533 of file EffectUI.cpp.

 {
    mEffect->LoadFactoryPreset(evt.GetId() - kFactoryPresetsID);
    
    return;
 }

References kFactoryPresetsID, Effect::LoadFactoryPreset(), and mEffect.

Here is the call graph for this function:

◆ OnFFwd()

void EffectUIHost::OnFFwd ( wxCommandEvent & evt )

private

Definition at line 1447 of file EffectUI.cpp.

 {
    if (mPlaying)
    {
       double seek;
       gPrefs->Read(wxT("/AudioIO/SeekShortPeriod"), &seek, 1.0);
       
       auto gAudioIO = AudioIO::Get();
       double pos = gAudioIO->GetStreamTime();
       if (mRegion.t0() < mRegion.t1() && pos + seek > mRegion.t1())
       {
          seek = mRegion.t1() - pos;
       }
       
       gAudioIO->SeekStream(seek);
    }
    else
    {
       // It allows to play past end of selection...probably useless
       mPlayPos = mRegion.t1();
    }
 }

References AudioIO::Get(), gPrefs, mPlaying, mPlayPos, mRegion, SelectedRegion::t0(), and SelectedRegion::t1().

Here is the call graph for this function:

◆ OnHelp()

void EffectUIHost::OnHelp ( wxCommandEvent & evt )

private

Definition at line 1234 of file EffectUI.cpp.

 {
    if (mEffect && mEffect->GetFamily() == NYQUISTEFFECTS_FAMILY && (mEffect->ManualPage().empty())) {
       // Old ShowHelp required when there is no on-line manual.
       // Always use default web browser to allow full-featured HTML pages.
       HelpSystem::ShowHelp(FindWindow(wxID_HELP), mEffect->HelpPage(), wxEmptyString, true, true);
    }
    else if( mEffect )
    {
       // otherwise use the NEW ShowHelp
       HelpSystem::ShowHelp(FindWindow(wxID_HELP), mEffect->ManualPage(), true);
    }
 }

References Effect::GetFamily(), Effect::HelpPage(), Effect::ManualPage(), mEffect, NYQUISTEFFECTS_FAMILY, and HelpSystem::ShowHelp().

Here is the call graph for this function:

◆ OnImport()

void EffectUIHost::OnImport ( wxCommandEvent & evt )

private

Definition at line 1636 of file EffectUI.cpp.

 {
    mClient->ImportPresets();
    
    LoadUserPresets();
    
    return;
 }

References EffectUIClientInterface::ImportPresets(), LoadUserPresets(), and mClient.

Here is the call graph for this function:

◆ OnInitDialog()

void EffectUIHost::OnInitDialog ( wxInitDialogEvent & evt )

private

Definition at line 1081 of file EffectUI.cpp.

 {
    // Do default handling
    wxDialogWrapper::OnInitDialog(evt);
    
 #if wxCHECK_VERSION(3, 0, 0)
    //#warning "check to see if this still needed in wx3"
 #endif
    
    // Pure hackage coming down the pike...
    //
    // I have no idea why, but if a wxTextCtrl is the first control in the
    // panel, then its contents will not be automatically selected when the
    // dialog is displayed.
    //
    // So, we do the selection manually.
    wxTextCtrl *focused = wxDynamicCast(FindFocus(), wxTextCtrl);
    if (focused)
    {
       focused->SelectAll();
    }
 }

◆ OnMenu()

void EffectUIHost::OnMenu ( wxCommandEvent & evt )

private

Definition at line 1255 of file EffectUI.cpp.

 {
    wxMenu menu;
    if( !mEffect )
       return;
    
    LoadUserPresets();
    
    if (mUserPresets.size() == 0)
    {
       menu.Append(kUserPresetsDummyID, _("User Presets"))->Enable(false);
    }
    else
    {
       auto sub = std::make_unique<wxMenu>();
       for (size_t i = 0, cnt = mUserPresets.size(); i < cnt; i++)
       {
          sub->Append(kUserPresetsID + i, mUserPresets[i]);
       }
       menu.Append(0, _("User Presets"), sub.release());
    }
    
    menu.Append(kSaveAsID, _("Save Preset..."));
    
    if (mUserPresets.size() == 0)
    {
       menu.Append(kDeletePresetDummyID, _("Delete Preset"))->Enable(false);
    }
    else
    {
       auto sub = std::make_unique<wxMenu>();
       for (size_t i = 0, cnt = mUserPresets.size(); i < cnt; i++)
       {
          sub->Append(kDeletePresetID + i, mUserPresets[i]);
       }
       menu.Append(0, _("Delete Preset"), sub.release());
    }
    
    menu.AppendSeparator();
    
    auto factory = mEffect->GetFactoryPresets();
    
    {
       auto sub = std::make_unique<wxMenu>();
       sub->Append(kDefaultsID, _("Defaults"));
       if (factory.size() > 0)
       {
          sub->AppendSeparator();
          for (size_t i = 0, cnt = factory.size(); i < cnt; i++)
          {
             auto label = factory[i];
             if (label.empty())
             {
                label = _("None");
             }
             
             sub->Append(kFactoryPresetsID + i, label);
          }
       }
       menu.Append(0, _("Factory Presets"), sub.release());
    }
    
    menu.AppendSeparator();
    menu.Append(kImportID, _("Import..."))->Enable(mClient->CanExportPresets());
    menu.Append(kExportID, _("Export..."))->Enable(mClient->CanExportPresets());
    menu.AppendSeparator();
    menu.Append(kOptionsID, _("Options..."))->Enable(mClient->HasOptions());
    menu.AppendSeparator();
    
    {
       auto sub = std::make_unique<wxMenu>();
       
       sub->Append(kDummyID, wxString::Format(_("Type: %s"),
                                              ::wxGetTranslation( mEffect->GetFamily().Translation() )));
       sub->Append(kDummyID, wxString::Format(_("Name: %s"), mEffect->GetName().Translation()));
       sub->Append(kDummyID, wxString::Format(_("Version: %s"), mEffect->GetVersion()));
       sub->Append(kDummyID, wxString::Format(_("Vendor: %s"), mEffect->GetVendor().Translation()));
       sub->Append(kDummyID, wxString::Format(_("Description: %s"), mEffect->GetDescription().Translation()));
       
       menu.Append(0, _("About"), sub.release());
    }
    
    wxWindow *btn = FindWindow(kMenuID);
    wxRect r = btn->GetRect();
    btn->PopupMenu(&menu, r.GetLeft(), r.GetBottom());
 }

References _, EffectUIClientInterface::CanExportPresets(), TranslatableString::empty(), factory, Effect::GetDescription(), Effect::GetFactoryPresets(), Effect::GetFamily(), ComponentInterface::GetName(), Effect::GetVendor(), Effect::GetVersion(), EffectUIClientInterface::HasOptions(), kDefaultsID, kDeletePresetDummyID, kDeletePresetID, kDummyID, kExportID, kFactoryPresetsID, kImportID, kMenuID, kOptionsID, kSaveAsID, kUserPresetsDummyID, kUserPresetsID, label, LoadUserPresets(), mClient, mEffect, mUserPresets, ComponentInterfaceSymbol::Translation(), and TranslatableString::Translation().

Here is the call graph for this function:

◆ OnOptions()

void EffectUIHost::OnOptions ( wxCommandEvent & evt )

private

Definition at line 1654 of file EffectUI.cpp.

 {
    mClient->ShowOptions();
    
    return;
 }

References mClient, and EffectUIClientInterface::ShowOptions().

Here is the call graph for this function:

◆ OnPaint()

void EffectUIHost::OnPaint ( wxPaintEvent & evt )

private

Definition at line 1109 of file EffectUI.cpp.

 {
    wxPaintDC dc(this);
    
    dc.Clear();
 }

◆ OnPlay()

void EffectUIHost::OnPlay ( wxCommandEvent & evt )

private

Definition at line 1374 of file EffectUI.cpp.

 {
    if (!mSupportsRealtime)
    {
       if (!mClient->ValidateUI() || !mEffect->TransferDataFromWindow())
       {
          return;
       }
       
       mEffect->Preview(false);
       
       return;
    }
    
    if (mPlaying)
    {
       auto gAudioIO = AudioIO::Get();
       mPlayPos = gAudioIO->GetStreamTime();
       auto &projectAudioManager = ProjectAudioManager::Get( *mProject );
       projectAudioManager.Stop();
    }
    else
    {
       auto &viewInfo = ViewInfo::Get( *mProject );
       const auto &selectedRegion = viewInfo.selectedRegion;
       const auto &playRegion = viewInfo.playRegion;
       if ( playRegion.Locked() )
       {
          mRegion.setTimes(playRegion.GetStart(), playRegion.GetEnd());
          mPlayPos = mRegion.t0();
       }
       else if (selectedRegion.t0() != mRegion.t0() ||
                selectedRegion.t1() != mRegion.t1())
       {
          mRegion = selectedRegion;
          mPlayPos = mRegion.t0();
       }
       
       if (mPlayPos > mRegion.t1())
       {
          mPlayPos = mRegion.t1();
       }
       
       auto &projectAudioManager = ProjectAudioManager::Get( *mProject );
       projectAudioManager.PlayPlayRegion(
                                          SelectedRegion(mPlayPos, mRegion.t1()),
                                          DefaultPlayOptions( *mProject ),
                                          PlayMode::normalPlay );
    }
 }

References DefaultPlayOptions(), AudioIO::Get(), ProjectAudioManager::Get(), ViewInfo::Get(), mClient, mEffect, mPlaying, mPlayPos, mProject, mRegion, mSupportsRealtime, normalPlay, Effect::Preview(), SelectedRegion::setTimes(), SelectedRegion::t0(), SelectedRegion::t1(), Effect::TransferDataFromWindow(), and EffectUIClientInterface::ValidateUI().

Here is the call graph for this function:

◆ OnPlayback()

void EffectUIHost::OnPlayback ( wxCommandEvent & evt )

private

Definition at line 1470 of file EffectUI.cpp.

 {
    evt.Skip();
    
    if (evt.GetInt() != 0)
    {
       if (evt.GetEventObject() != mProject)
       {
          mDisableTransport = true;
       }
       else
       {
          mPlaying = true;
       }
    }
    else
    {
       mDisableTransport = false;
       mPlaying = false;
    }
    
    if (mPlaying)
    {
       mRegion = ViewInfo::Get( *mProject ).selectedRegion;
       mPlayPos = mRegion.t0();
    }
    
    UpdateControls();
 }

References ViewInfo::Get(), mDisableTransport, mPlaying, mPlayPos, mProject, mRegion, ViewInfo::selectedRegion, SelectedRegion::t0(), and UpdateControls().

Referenced by InitializeRealtime().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnRewind()

void EffectUIHost::OnRewind ( wxCommandEvent & evt )

private

Definition at line 1425 of file EffectUI.cpp.

 {
    if (mPlaying)
    {
       auto gAudioIO = AudioIO::Get();
       double seek;
       gPrefs->Read(wxT("/AudioIO/SeekShortPeriod"), &seek, 1.0);
       
       double pos = gAudioIO->GetStreamTime();
       if (pos - seek < mRegion.t0())
       {
          seek = pos - mRegion.t0();
       }
       
       gAudioIO->SeekStream(-seek);
    }
    else
    {
       mPlayPos = mRegion.t0();
    }
 }

References AudioIO::Get(), gPrefs, mPlaying, mPlayPos, mRegion, and SelectedRegion::t0().

Here is the call graph for this function:

◆ OnSaveAs()

void EffectUIHost::OnSaveAs ( wxCommandEvent & evt )

private

Definition at line 1558 of file EffectUI.cpp.

 {
    wxTextCtrl *text;
    wxString name;
    wxDialogWrapper dlg(this, wxID_ANY, XO("Save Preset"));
    
    ShuttleGui S(&dlg, eIsCreating);
    
    S.StartPanel();
    {
       S.StartVerticalLay(1);
       {
          S.StartHorizontalLay(wxALIGN_LEFT, 0);
          {
             text = S.AddTextBox(XXO("Preset name:"), name, 30);
          }
          S.EndHorizontalLay();
          S.SetBorder(10);
          S.AddStandardButtons();
       }
       S.EndVerticalLay();
    }
    S.EndPanel();
    
    dlg.SetSize(dlg.GetSizer()->GetMinSize());
    dlg.Center();
    dlg.Fit();
    
    while (true)
    {
       int rc = dlg.ShowModal();
       
       if (rc != wxID_OK)
       {
          break;
       }
       
       name = text->GetValue();
       if (name.empty())
       {
          AudacityMessageDialog md(
                                   this,
                                   XO("You must specify a name"),
                                   XO("Save Preset") );
          md.Center();
          md.ShowModal();
          continue;
       }
       
       if ( make_iterator_range( mUserPresets ).contains( name ) )
       {
          AudacityMessageDialog md(
                                   this,
                                   XO("Preset already exists.\n\nReplace?"),
                                   XO("Save Preset"),
                                   wxYES_NO | wxCANCEL | wxICON_EXCLAMATION );
          md.Center();
          int choice = md.ShowModal();
          if (choice == wxID_CANCEL)
          {
             break;
          }
          
          if (choice == wxID_NO)
          {
             continue;
          }
       }
       
       mEffect->SaveUserPreset(mEffect->GetUserPresetsGroup(name));
       LoadUserPresets();
       
       break;
    }
    
    return;
 }

References ShuttleGui::AddStandardButtons(), ShuttleGuiBase::AddTextBox(), eIsCreating, TranslatableString::empty(), ShuttleGuiBase::EndHorizontalLay(), ShuttleGuiBase::EndPanel(), ShuttleGuiBase::EndVerticalLay(), Effect::GetUserPresetsGroup(), LoadUserPresets(), make_iterator_range(), mEffect, mUserPresets, name, Effect::SaveUserPreset(), ShuttleGuiBase::SetBorder(), ShuttleGuiBase::StartHorizontalLay(), ShuttleGuiBase::StartPanel(), ShuttleGuiBase::StartVerticalLay(), XO, and XXO.

Here is the call graph for this function:

◆ OnUserPreset()

void EffectUIHost::OnUserPreset ( wxCommandEvent & evt )

private

Definition at line 1524 of file EffectUI.cpp.

 {
    int preset = evt.GetId() - kUserPresetsID;
    
    mEffect->LoadUserPreset(mEffect->GetUserPresetsGroup(mUserPresets[preset]));
    
    return;
 }

References Effect::GetUserPresetsGroup(), kUserPresetsID, Effect::LoadUserPreset(), mEffect, and mUserPresets.

Here is the call graph for this function:

◆ Resume()

void EffectUIHost::Resume ( )

private

Definition at line 1342 of file EffectUI.cpp.

 {
    if (!mClient->ValidateUI()) {
       // If we're previewing we should still be able to stop playback
       // so don't disable transport buttons.
       //   mEffect->EnableApply(false);   // currently this would also disable transport buttons.
       // The preferred behaviour is currently undecided, so for now
       // just disallow enabling until settings are valid.
       mEnabled = false;
       mEnableCb->SetValue(mEnabled);
       return;
    }
    RealtimeEffectManager::Get().RealtimeResumeOne( *mEffect );
 }

References RealtimeEffectManager::Get(), mClient, mEffect, mEnableCb, mEnabled, RealtimeEffectManager::RealtimeResumeOne(), and EffectUIClientInterface::ValidateUI().

Referenced by OnClose(), OnEnable(), and ~EffectUIHost().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ShowModal()

int EffectUIHost::ShowModal ( )

override

Definition at line 830 of file EffectUI.cpp.

 {
 #if defined(__WXMSW__)
    // Swap the Close and Apply buttons
    wxSizer *sz = mApplyBtn->GetContainingSizer();
    wxASSERT(mApplyBtn->GetParent()); // To justify safenew
    wxButton *apply = safenew wxButton(mApplyBtn->GetParent(), wxID_APPLY);
    sz->Replace(mCloseBtn, apply);
    sz->Replace(mApplyBtn, mCloseBtn);
    sz->Layout();
    mApplyBtn->Destroy();
    mApplyBtn = apply;
    mApplyBtn->SetDefault();
    mApplyBtn->SetLabel(wxGetStockLabel(wxID_OK, 0));
    mCloseBtn->SetLabel(wxGetStockLabel(wxID_CANCEL, 0));
 #else
    mApplyBtn->SetLabel(wxGetStockLabel(wxID_OK));
    mCloseBtn->SetLabel(wxGetStockLabel(wxID_CANCEL));
 #endif
    
    Layout();
    
    return wxDialogWrapper::ShowModal();
 }

References mApplyBtn, mCloseBtn, and safenew.

◆ TransferDataFromWindow()

bool EffectUIHost::TransferDataFromWindow ( )

override

Definition at line 817 of file EffectUI.cpp.

 {
    if( mEffect)
       return mEffect->TransferDataFromWindow();
    if( mCommand)
       return mCommand->TransferDataFromWindow();
    return false;
 }

References mCommand, mEffect, AudacityCommand::TransferDataFromWindow(), and Effect::TransferDataFromWindow().

Here is the call graph for this function:

◆ TransferDataToWindow()

bool EffectUIHost::TransferDataToWindow ( )

override

Definition at line 808 of file EffectUI.cpp.

 {
    if( mEffect )
       return mEffect->TransferDataToWindow();
    if( mCommand )
       return mCommand->TransferDataToWindow();
    return false;
 }

References mCommand, mEffect, AudacityCommand::TransferDataToWindow(), and Effect::TransferDataToWindow().

Here is the call graph for this function:

◆ UpdateControls()

void EffectUIHost::UpdateControls ( )

private

Definition at line 1701 of file EffectUI.cpp.

 {
    if (mIsBatch)
    {
       return;
    }
  
    if (mCapturing || mDisableTransport)
    {
       // Don't allow focus to get trapped
       wxWindow *focus = FindFocus();
       if (focus == mRewindBtn || focus == mFFwdBtn || focus == mPlayBtn || focus == mEnableCb)
       {
          mCloseBtn->SetFocus();
       }
    }
    
    mApplyBtn->Enable(!mCapturing);
    if (mEffect && (mEffect->GetType() != EffectTypeAnalyze) && (mEffect->GetType() != EffectTypeTool) )
    {
       (!mIsGUI ? mPlayToggleBtn : mPlayBtn)->Enable(!(mCapturing || mDisableTransport));
    }
    
    if (mSupportsRealtime)
    {
       mRewindBtn->Enable(!(mCapturing || mDisableTransport));
       mFFwdBtn->Enable(!(mCapturing || mDisableTransport));
       mEnableCb->Enable(!(mCapturing || mDisableTransport));
       
       wxBitmapButton *bb;
       
       if (mPlaying)
       {
          if (!mIsGUI)
          {
             /* i18n-hint: The access key "&P" should be the same in
              "Stop &Playback" and "Start &Playback" */
             mPlayToggleBtn->SetLabel(_("Stop &Playback"));
             mPlayToggleBtn->Refresh();
          }
          else
          {
             bb = (wxBitmapButton *) mPlayBtn;
             bb->SetBitmapLabel(mStopBM);
             bb->SetBitmapDisabled(mStopDisabledBM);
             bb->SetToolTip(_("Stop"));
 #if defined(__WXMAC__)
             bb->SetName(_("Stop &Playback"));
 #else
             bb->SetLabel(_("Stop &Playback"));
 #endif
          }
       }
       else
       {
          if (!mIsGUI)
          {
             /* i18n-hint: The access key "&P" should be the same in
              "Stop &Playback" and "Start &Playback" */
             mPlayToggleBtn->SetLabel(_("Start &Playback"));
             mPlayToggleBtn->Refresh();
          }
          else
          {
             bb = (wxBitmapButton *) mPlayBtn;
             bb->SetBitmapLabel(mPlayBM);
             bb->SetBitmapDisabled(mPlayDisabledBM);
             bb->SetToolTip(_("Play"));
 #if defined(__WXMAC__)
             bb->SetName(_("Start &Playback"));
 #else
             bb->SetLabel(_("Start &Playback"));
 #endif
          }
       }
    }
 }

References _, EffectTypeAnalyze, EffectTypeTool, Effect::GetType(), mApplyBtn, mCapturing, mCloseBtn, mDisableTransport, mEffect, mEnableCb, mFFwdBtn, mIsBatch, mIsGUI, mPlayBM, mPlayBtn, mPlayDisabledBM, mPlaying, mPlayToggleBtn, mRewindBtn, mStopBM, mStopDisabledBM, and mSupportsRealtime.

Referenced by Initialize(), OnCapture(), OnEnable(), and OnPlayback().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mApplyBtn

wxButton* EffectUIHost::mApplyBtn

private

Definition at line 188 of file EffectUI.h.

Referenced by Initialize(), OnApply(), ShowModal(), and UpdateControls().

◆ mCapturing

bool EffectUIHost::mCapturing

private

Definition at line 208 of file EffectUI.h.

Referenced by Initialize(), OnCapture(), and UpdateControls().

◆ mClient

EffectUIClientInterface* EffectUIHost::mClient

private

Definition at line 180 of file EffectUI.h.

Referenced by BuildButtonBar(), EffectUIHost(), Initialize(), OnApply(), OnClose(), OnExport(), OnImport(), OnMenu(), OnOptions(), OnPlay(), Resume(), and ~EffectUIHost().

◆ mCloseBtn

wxButton* EffectUIHost::mCloseBtn

private

Definition at line 189 of file EffectUI.h.

Referenced by Initialize(), ShowModal(), and UpdateControls().

◆ mCommand

AudacityCommand* EffectUIHost::mCommand

private

Definition at line 179 of file EffectUI.h.

Referenced by BuildButtonBar(), EffectUIHost(), OnApply(), TransferDataFromWindow(), and TransferDataToWindow().

◆ mDisableTransport

bool EffectUIHost::mDisableTransport

private

Definition at line 206 of file EffectUI.h.

Referenced by EffectUIHost(), Initialize(), OnCapture(), OnPlayback(), and UpdateControls().

◆ mDismissed

bool EffectUIHost::mDismissed {}

private

Definition at line 213 of file EffectUI.h.

Referenced by DoCancel(), and OnApply().

◆ mEffect

Effect* EffectUIHost::mEffect

private

Definition at line 178 of file EffectUI.h.

Referenced by BuildButtonBar(), CleanupRealtime(), DoCancel(), EffectUIHost(), Initialize(), InitializeRealtime(), LoadUserPresets(), OnApply(), OnDebug(), OnDefaults(), OnDeletePreset(), OnEnable(), OnFactoryPreset(), OnHelp(), OnMenu(), OnPlay(), OnSaveAs(), OnUserPreset(), Resume(), TransferDataFromWindow(), TransferDataToWindow(), and UpdateControls().

◆ mEnableCb

wxCheckBox* EffectUIHost::mEnableCb

private

Definition at line 194 of file EffectUI.h.

Referenced by BuildButtonBar(), OnEnable(), Resume(), and UpdateControls().

◆ mEnabled

bool EffectUIHost::mEnabled

private

Definition at line 204 of file EffectUI.h.

Referenced by BuildButtonBar(), EffectUIHost(), OnEnable(), and Resume().

◆ mEnableToggleBtn

wxButton* EffectUIHost::mEnableToggleBtn

private

Definition at line 196 of file EffectUI.h.

◆ mFFwdBtn

wxButton* EffectUIHost::mFFwdBtn

private

Definition at line 193 of file EffectUI.h.

Referenced by BuildButtonBar(), and UpdateControls().

◆ mInitialized

bool EffectUIHost::mInitialized

private

Definition at line 183 of file EffectUI.h.

Referenced by CleanupRealtime(), EffectUIHost(), and InitializeRealtime().

◆ mIsBatch

bool EffectUIHost::mIsBatch

private

Definition at line 186 of file EffectUI.h.

Referenced by BuildButtonBar(), OnApply(), and UpdateControls().

◆ mIsGUI

bool EffectUIHost::mIsGUI

private

Definition at line 185 of file EffectUI.h.

Referenced by BuildButtonBar(), Initialize(), and UpdateControls().

◆ mMenuBtn

wxButton* EffectUIHost::mMenuBtn

private

Definition at line 190 of file EffectUI.h.

Referenced by BuildButtonBar().

◆ mNeedsResume

bool EffectUIHost::mNeedsResume {}

private

Definition at line 214 of file EffectUI.h.

Referenced by OnClose(), OnEnable(), and ~EffectUIHost().

◆ mParent

wxWindow* EffectUIHost::mParent

private

Definition at line 177 of file EffectUI.h.

Referenced by EffectUIHost(), and Initialize().

◆ mPlayBM

wxBitmap EffectUIHost::mPlayBM

private

Definition at line 199 of file EffectUI.h.

Referenced by BuildButtonBar(), and UpdateControls().

◆ mPlayBtn

wxButton* EffectUIHost::mPlayBtn

private

Definition at line 191 of file EffectUI.h.

Referenced by BuildButtonBar(), and UpdateControls().

◆ mPlayDisabledBM

wxBitmap EffectUIHost::mPlayDisabledBM

private

Definition at line 200 of file EffectUI.h.

Referenced by BuildButtonBar(), and UpdateControls().

◆ mPlaying

bool EffectUIHost::mPlaying

private

Definition at line 207 of file EffectUI.h.

Referenced by Initialize(), OnFFwd(), OnPlay(), OnPlayback(), OnRewind(), and UpdateControls().

◆ mPlayPos

double EffectUIHost::mPlayPos

private

Definition at line 211 of file EffectUI.h.

Referenced by EffectUIHost(), OnFFwd(), OnPlay(), OnPlayback(), and OnRewind().

◆ mPlayToggleBtn

wxButton* EffectUIHost::mPlayToggleBtn

private

Definition at line 197 of file EffectUI.h.

Referenced by BuildButtonBar(), and UpdateControls().

◆ mProject

AudacityProject* EffectUIHost::mProject

private

Definition at line 176 of file EffectUI.h.

Referenced by EffectUIHost(), Initialize(), OnApply(), OnCapture(), OnPlay(), and OnPlayback().

◆ mRegion

SelectedRegion EffectUIHost::mRegion

private

Definition at line 210 of file EffectUI.h.

Referenced by OnFFwd(), OnPlay(), OnPlayback(), and OnRewind().

◆ mRewindBtn

wxButton* EffectUIHost::mRewindBtn

private

Definition at line 192 of file EffectUI.h.

Referenced by BuildButtonBar(), and UpdateControls().

◆ mStopBM

wxBitmap EffectUIHost::mStopBM

private

Definition at line 201 of file EffectUI.h.

Referenced by BuildButtonBar(), and UpdateControls().

◆ mStopDisabledBM

wxBitmap EffectUIHost::mStopDisabledBM

private

Definition at line 202 of file EffectUI.h.

Referenced by BuildButtonBar(), and UpdateControls().

◆ mSupportsRealtime

bool EffectUIHost::mSupportsRealtime

private

Definition at line 184 of file EffectUI.h.

Referenced by BuildButtonBar(), CleanupRealtime(), EffectUIHost(), InitializeRealtime(), OnPlay(), and UpdateControls().

◆ mUserPresets

RegistryPaths EffectUIHost::mUserPresets

private

Definition at line 182 of file EffectUI.h.

Referenced by LoadUserPresets(), OnDeletePreset(), OnMenu(), OnSaveAs(), and OnUserPreset().

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EffectUIHost() [1/2]

◆ EffectUIHost() [2/2]

◆ ~EffectUIHost()

Member Function Documentation

◆ BuildButtonBar()

◆ CleanupRealtime()

◆ CreateBitmap()

◆ DoCancel()

◆ Initialize()

◆ InitializeRealtime()

◆ LoadUserPresets()

◆ OnApply()

◆ OnCancel()

◆ OnCapture()

◆ OnClose()

◆ OnDebug()

◆ OnDefaults()

◆ OnDeletePreset()

◆ OnEnable()

◆ OnErase()

◆ OnExport()

◆ OnFactoryPreset()

◆ OnFFwd()

◆ OnHelp()

◆ OnImport()

◆ OnInitDialog()

◆ OnMenu()

◆ OnOptions()

◆ OnPaint()

◆ OnPlay()

◆ OnPlayback()

◆ OnRewind()

◆ OnSaveAs()

◆ OnUserPreset()

◆ Resume()

◆ ShowModal()

◆ TransferDataFromWindow()

◆ TransferDataToWindow()

◆ UpdateControls()

Member Data Documentation

◆ mApplyBtn

◆ mCapturing

◆ mClient

◆ mCloseBtn

◆ mCommand

◆ mDisableTransport

◆ mDismissed

◆ mEffect

◆ mEnableCb

◆ mEnabled

◆ mEnableToggleBtn

◆ mFFwdBtn

◆ mInitialized

◆ mIsBatch

◆ mIsGUI

◆ mMenuBtn

◆ mNeedsResume

◆ mParent

◆ mPlayBM

◆ mPlayBtn

◆ mPlayDisabledBM

◆ mPlaying

◆ mPlayPos

◆ mPlayToggleBtn

◆ mProject

◆ mRegion

◆ mRewindBtn

◆ mStopBM

◆ mStopDisabledBM

◆ mSupportsRealtime

◆ mUserPresets