PluginActions::Handler Struct Reference

Inheritance diagram for PluginActions::Handler:

Collaboration diagram for PluginActions::Handler:

Public Member Functions
void	OnResetConfig (const CommandContext &context)
void	OnManageGenerators (const CommandContext &context)
void	OnEffect (const CommandContext &context)
void	OnManageEffects (const CommandContext &context)
void	OnAddRealtimeEffects (const CommandContext &context)
void	OnAnalyzer2 (wxCommandEvent &evt)
void	OnRepeatLastGenerator (const CommandContext &context)
void	OnRepeatLastEffect (const CommandContext &context)
void	OnRepeatLastAnalyzer (const CommandContext &context)
void	OnRepeatLastTool (const CommandContext &context)
void	OnManageAnalyzers (const CommandContext &context)
void	OnManageTools (const CommandContext &context)
void	OnManageMacros (const CommandContext &context)
void	OnApplyMacrosPalette (const CommandContext &context)
void	OnScreenshot (const CommandContext &context)
void	OnBenchmark (const CommandContext &context)
void	OnSimulateRecordingErrors (const CommandContext &context)
void	OnDetectUpstreamDropouts (const CommandContext &context)
void	OnWriteJournal (const CommandContext &)
void	OnApplyMacroDirectly (const CommandContext &context)
void	OnApplyMacroDirectlyByName (const CommandContext &context, const MacroID &Name)
void	OnAudacityCommand (const CommandContext &ctx)

Detailed Description

Definition at line 733 of file PluginMenus.cpp.

Member Function Documentation

OnAddRealtimeEffects()

void PluginActions::Handler::OnAddRealtimeEffects ( const CommandContext &  context )

inline

Definition at line 805 of file PluginMenus.cpp.

{
   auto& project = context.project;
   DoManageRealtimeEffectsSidePanel(project);
}

References anonymous_namespace{PluginMenus.cpp}::DoManageRealtimeEffectsSidePanel(), and CommandContext::project.

Here is the call graph for this function:

OnAnalyzer2()

void PluginActions::Handler::OnAnalyzer2 ( wxCommandEvent &  evt )

inline

Definition at line 811 of file PluginMenus.cpp.

{ return; }

OnApplyMacroDirectly()

void PluginActions::Handler::OnApplyMacroDirectly ( const CommandContext &  context )

inline

Definition at line 977 of file PluginMenus.cpp.

{
   const MacroID& Name = context.parameter.GET();
   OnApplyMacroDirectlyByName(context, Name);
}

References Identifier::GET(), OnApplyMacroDirectlyByName(), and CommandContext::parameter.

Here is the call graph for this function:

OnApplyMacroDirectlyByName()

void PluginActions::Handler::OnApplyMacroDirectlyByName ( const CommandContext &  context, const MacroID &  Name  )

inline

Definition at line 982 of file PluginMenus.cpp.

{
   auto &project = context.project;
   auto &window = ProjectWindow::Get( project );
   //wxLogDebug( "Macro was: %s", context.parameter);
   ApplyMacroDialog dlg( &window, project );
   //const auto &Name = context.parameter;
 
// We used numbers previously, but macros could get renumbered, making
// macros containing macros unpredictable.
#ifdef MACROS_BY_NUMBERS
   long item=0;
   // Take last three letters (of e.g. Macro007) and convert to a number.
   Name.Mid( Name.length() - 3 ).ToLong( &item, 10 );
   dlg.ApplyMacroToProject( item, false );
#else
   dlg.ApplyMacroToProject( Name, false );
#endif
   /* i18n-hint: %s will be the name of the macro which will be
    * repeated if this menu item is chosen */
   MenuManager::ModifyUndoMenuItems( project );
 
   TranslatableString desc;
   EffectManager& em = EffectManager::Get();
   auto shortDesc = em.GetCommandName(Name);
   auto& undoManager = UndoManager::Get(project);
   auto& commandManager = CommandManager::Get(project);
   int cur = undoManager.GetCurrentState();
   if (undoManager.UndoAvailable()) {
       undoManager.GetShortDescription(cur, &desc);
       commandManager.Modify(wxT("RepeatLastTool"), XXO("&Repeat %s")
          .Format(desc));
       auto& menuManager = MenuManager::Get(project);
       menuManager.mLastTool = Name;
       menuManager.mLastToolRegistration = MenuCreator::repeattypeapplymacro;
   }
 
}

References ApplyMacroDialog::ApplyMacroToProject(), desc, EffectManager::Get(), UndoManager::Get(), CommandManager::Get(), MenuManager::Get(), ProjectWindow::Get(), EffectManager::GetCommandName(), MenuManager::ModifyUndoMenuItems(), CommandContext::project, MenuCreator::repeattypeapplymacro, wxT(), and XXO.

Referenced by OnApplyMacroDirectly(), and OnRepeatLastTool().

Here is the call graph for this function:

Here is the caller graph for this function:

OnApplyMacrosPalette()

void PluginActions::Handler::OnApplyMacrosPalette ( const CommandContext &  context )

inline

Definition at line 906 of file PluginMenus.cpp.

{
   auto &project = context.project;
   CommandManager::Get(project).RegisterLastTool(context);  //Register Palette as Last Tool
   auto macrosWindow = &GetAttachedWindows(project)
      .AttachedWindows::Get< MacrosWindow >( sMacrosWindowKey );
   if (macrosWindow) {
      macrosWindow->Show();
      macrosWindow->Raise();
      macrosWindow->UpdateDisplay( false );
   }
}

References CommandManager::Get(), GetAttachedWindows(), CommandContext::project, CommandManager::RegisterLastTool(), anonymous_namespace{PluginMenus.cpp}::sMacrosWindowKey, and MacrosWindow::UpdateDisplay().

Here is the call graph for this function:

OnAudacityCommand()

void PluginActions::Handler::OnAudacityCommand ( const CommandContext &  ctx )

inline

Definition at line 1021 of file PluginMenus.cpp.

{
   // using GET in a log message for devs' eyes only
   wxLogDebug( "Command was: %s", ctx.parameter.GET());
   // Not configured, so prompt user.
   MacroCommands::DoAudacityCommand(
      EffectManager::Get().GetEffectByIdentifier(ctx.parameter),
      ctx, EffectManager::kNone);
}

References MacroCommands::DoAudacityCommand(), EffectManager::Get(), Identifier::GET(), EffectManager::kNone, and CommandContext::parameter.

Here is the call graph for this function:

OnBenchmark()

void PluginActions::Handler::OnBenchmark ( const CommandContext &  context )

inline

Definition at line 925 of file PluginMenus.cpp.

{
   auto &project = context.project;
   CommandManager::Get(project).RegisterLastTool(context);  //Register Run Benchmark as Last Tool
   auto &window = GetProjectFrame( project );
   ::RunBenchmark( &window, project);
}

References CommandManager::Get(), GetProjectFrame(), CommandContext::project, CommandManager::RegisterLastTool(), and RunBenchmark().

Here is the call graph for this function:

OnDetectUpstreamDropouts()

void PluginActions::Handler::OnDetectUpstreamDropouts ( const CommandContext &  context )

inline

Definition at line 944 of file PluginMenus.cpp.

{
   auto &project = context.project;
   auto &commandManager = CommandManager::Get( project );
 
   auto gAudioIO = AudioIO::Get();
   auto &setting = gAudioIO->mDetectUpstreamDropouts;
   auto oldValue = setting.load(std::memory_order_relaxed);
   commandManager.Check(wxT("DetectUpstreamDropouts"), !oldValue);
   setting.store(!oldValue, std::memory_order_relaxed);
}

References AudioIO::Get(), CommandManager::Get(), CommandContext::project, and wxT().

Here is the call graph for this function:

OnEffect()

void PluginActions::Handler::OnEffect ( const CommandContext &  context )

inline

Definition at line 793 of file PluginMenus.cpp.

{
   // using GET to interpret parameter as a PluginID
   EffectUI::DoEffect(context.parameter.GET(), context, 0);
}

References EffectUI::DoEffect(), Identifier::GET(), and CommandContext::parameter.

Here is the call graph for this function:

OnManageAnalyzers()

void PluginActions::Handler::OnManageAnalyzers ( const CommandContext &  context )

inline

Definition at line 881 of file PluginMenus.cpp.

{
   auto &project = context.project;
   DoManagePluginsMenu(project);
}

References anonymous_namespace{PluginMenus.cpp}::DoManagePluginsMenu(), and CommandContext::project.

Here is the call graph for this function:

OnManageEffects()

void PluginActions::Handler::OnManageEffects ( const CommandContext &  context )

inline

Definition at line 799 of file PluginMenus.cpp.

{
   auto &project = context.project;
   DoManagePluginsMenu(project);
}

References anonymous_namespace{PluginMenus.cpp}::DoManagePluginsMenu(), and CommandContext::project.

Here is the call graph for this function:

OnManageGenerators()

void PluginActions::Handler::OnManageGenerators ( const CommandContext &  context )

inline

Definition at line 787 of file PluginMenus.cpp.

{
   auto &project = context.project;
   DoManagePluginsMenu(project);
}

References anonymous_namespace{PluginMenus.cpp}::DoManagePluginsMenu(), and CommandContext::project.

Here is the call graph for this function:

OnManageMacros()

void PluginActions::Handler::OnManageMacros ( const CommandContext &  context )

inline

Definition at line 893 of file PluginMenus.cpp.

{
   auto &project = context.project;
   CommandManager::Get(project).RegisterLastTool(context);  //Register Macros as Last Tool
   auto macrosWindow = &GetAttachedWindows(project)
      .AttachedWindows::Get< MacrosWindow >( sMacrosWindowKey );
   if (macrosWindow) {
      macrosWindow->Show();
      macrosWindow->Raise();
      macrosWindow->UpdateDisplay( true );
   }
}

References CommandManager::Get(), GetAttachedWindows(), CommandContext::project, CommandManager::RegisterLastTool(), anonymous_namespace{PluginMenus.cpp}::sMacrosWindowKey, and MacrosWindow::UpdateDisplay().

Here is the call graph for this function:

OnManageTools()

void PluginActions::Handler::OnManageTools ( const CommandContext &  context )

inline

Definition at line 887 of file PluginMenus.cpp.

{
   auto &project = context.project;
   DoManagePluginsMenu(project);
}

References anonymous_namespace{PluginMenus.cpp}::DoManagePluginsMenu(), and CommandContext::project.

Here is the call graph for this function:

OnRepeatLastAnalyzer()

void PluginActions::Handler::OnRepeatLastAnalyzer ( const CommandContext &  context )

inline

Definition at line 835 of file PluginMenus.cpp.

{
   auto& menuManager = MenuManager::Get(context.project);
   switch (menuManager.mLastAnalyzerRegistration) {
   case MenuCreator::repeattypeplugin:
     {
       auto lastEffect = menuManager.mLastAnalyzer;
       if (!lastEffect.empty())
       {
         EffectUI::DoEffect(
            lastEffect, context, menuManager.mRepeatAnalyzerFlags);
       }
     }
      break;
   case MenuCreator::repeattypeunique:
      CommandManager::Get(context.project).DoRepeatProcess(context,
         menuManager.mLastAnalyzerRegisteredId);
      break;
   }
}

References EffectUI::DoEffect(), CommandManager::DoRepeatProcess(), CommandManager::Get(), MenuManager::Get(), CommandContext::project, MenuCreator::repeattypeplugin, and MenuCreator::repeattypeunique.

Here is the call graph for this function:

OnRepeatLastEffect()

void PluginActions::Handler::OnRepeatLastEffect ( const CommandContext &  context )

inline

Definition at line 824 of file PluginMenus.cpp.

{
   auto& menuManager = MenuManager::Get(context.project);
   auto lastEffect = menuManager.mLastEffect;
   if (!lastEffect.empty())
   {
      EffectUI::DoEffect(
         lastEffect, context, menuManager.mRepeatEffectFlags);
   }
}

References EffectUI::DoEffect(), MenuManager::Get(), and CommandContext::project.

Here is the call graph for this function:

OnRepeatLastGenerator()

void PluginActions::Handler::OnRepeatLastGenerator ( const CommandContext &  context )

inline

Definition at line 813 of file PluginMenus.cpp.

{
   auto& menuManager = MenuManager::Get(context.project);
   auto lastEffect = menuManager.mLastGenerator;
   if (!lastEffect.empty())
   {
      EffectUI::DoEffect(
         lastEffect, context, menuManager.mRepeatGeneratorFlags | EffectManager::kRepeatGen);
   }
}

References EffectUI::DoEffect(), MenuManager::Get(), EffectManager::kRepeatGen, and CommandContext::project.

Here is the call graph for this function:

OnRepeatLastTool()

void PluginActions::Handler::OnRepeatLastTool ( const CommandContext &  context )

inline

Definition at line 856 of file PluginMenus.cpp.

{
   auto& menuManager = MenuManager::Get(context.project);
   switch (menuManager.mLastToolRegistration) {
     case MenuCreator::repeattypeplugin:
     {
        auto lastEffect = menuManager.mLastTool;
        if (!lastEffect.empty())
        {
           EffectUI::DoEffect(
              lastEffect, context, menuManager.mRepeatToolFlags);
        }
     }
       break;
     case MenuCreator::repeattypeunique:
        CommandManager::Get(context.project).DoRepeatProcess(context,
           menuManager.mLastToolRegisteredId);
        break;
     case MenuCreator::repeattypeapplymacro:
        OnApplyMacroDirectlyByName(context, menuManager.mLastTool);
        break;
   }
}

References EffectUI::DoEffect(), CommandManager::DoRepeatProcess(), CommandManager::Get(), MenuManager::Get(), OnApplyMacroDirectlyByName(), CommandContext::project, MenuCreator::repeattypeapplymacro, MenuCreator::repeattypeplugin, and MenuCreator::repeattypeunique.

Here is the call graph for this function:

OnResetConfig()

void PluginActions::Handler::OnResetConfig ( const CommandContext &  context )

inline

Definition at line 735 of file PluginMenus.cpp.

{
   auto &project = context.project;
   auto &menuManager = MenuManager::Get(project);
   menuManager.mLastAnalyzerRegistration = MenuCreator::repeattypenone;
   menuManager.mLastToolRegistration = MenuCreator::repeattypenone;
   menuManager.mLastGenerator = "";
   menuManager.mLastEffect = "";
   menuManager.mLastAnalyzer = "";
   menuManager.mLastTool = "";
 
   ResetPreferences();
 
   // Directory will be reset on next restart.
   FileNames::UpdateDefaultPath(FileNames::Operation::Temp, TempDirectory::DefaultTempDir());
 
   // There are many more things we could reset here.
   // Beeds discussion as to which make sense to.
   // Maybe in future versions?
   // - Reset Effects
   // - Reset Recording and Playback volumes
   // - Reset Selection formats (and for spectral too)
   // - Reset Play-at-speed speed to x1
   // - Stop playback/recording and unapply pause.
   // - Set Zoom sensibly.
   gPrefs->Write("/GUI/SyncLockTracks", 0);
   gPrefs->Write("/AudioIO/SoundActivatedRecord", 0);
   gPrefs->Write("/SelectionToolbarMode", 0);
   gPrefs->Flush();
   DoReloadPreferences(project);
 
   ProjectWindow::OnResetWindow(context);
   ToolManager::OnResetToolBars(context);
 
   // These are necessary to preserve the newly correctly laid out toolbars.
   // In particular the Device Toolbar ends up short on next restart, 
   // if they are left out.
   gPrefs->Write(wxT("/PrefsVersion"), wxString(wxT(AUDACITY_PREFS_VERSION_STRING)));
 
   // write out the version numbers to the prefs file for future checking
   gPrefs->Write(wxT("/Version/Major"), AUDACITY_VERSION);
   gPrefs->Write(wxT("/Version/Minor"), AUDACITY_RELEASE);
   gPrefs->Write(wxT("/Version/Micro"), AUDACITY_REVISION);
 
   gPrefs->Flush();
 
   ProjectSelectionManager::Get( project )
      .AS_SetSnapTo(gPrefs->ReadLong("/SnapTo", SNAP_OFF));
   ProjectSelectionManager::Get( project )
      .AS_SetRate(gPrefs->ReadDouble("/DefaultProjectSampleRate", 44100.0));
}

References ProjectSelectionManager::AS_SetRate(), ProjectSelectionManager::AS_SetSnapTo(), AUDACITY_PREFS_VERSION_STRING, TempDirectory::DefaultTempDir(), DoReloadPreferences(), FileConfig::Flush(), MenuManager::Get(), ProjectSelectionManager::Get(), gPrefs, ToolManager::OnResetToolBars(), ProjectWindow::OnResetWindow(), CommandContext::project, MenuCreator::repeattypenone, ResetPreferences(), SNAP_OFF, FileNames::UpdateDefaultPath(), and wxT().

Here is the call graph for this function:

OnScreenshot()

void PluginActions::Handler::OnScreenshot ( const CommandContext &  context )

inline

Definition at line 919 of file PluginMenus.cpp.

{
   CommandManager::Get(context.project).RegisterLastTool(context);  //Register Screenshot as Last Tool
   ::OpenScreenshotTools( context.project );
}

References CommandManager::Get(), OpenScreenshotTools(), CommandContext::project, and CommandManager::RegisterLastTool().

Here is the call graph for this function:

OnSimulateRecordingErrors()

void PluginActions::Handler::OnSimulateRecordingErrors ( const CommandContext &  context )

inline

Definition at line 933 of file PluginMenus.cpp.

{
   auto &project = context.project;
   auto &commandManager = CommandManager::Get( project );
 
   auto gAudioIO = AudioIO::Get();
   bool &setting = gAudioIO->mSimulateRecordingErrors;
   commandManager.Check(wxT("SimulateRecordingErrors"), !setting);
   setting = !setting;
}

References AudioIO::Get(), CommandManager::Get(), CommandContext::project, and wxT().

Here is the call graph for this function:

OnWriteJournal()

void PluginActions::Handler::OnWriteJournal ( const CommandContext &  )

inline

Definition at line 956 of file PluginMenus.cpp.

{
   auto OnMessage =
      /* i18n-hint a "journal" is a text file that records
       the user's interactions with the application */
      XO("A journal will be recorded after Audacity restarts.");
   auto OffMessage =
      /* i18n-hint a "journal" is a text file that records
       the user's interactions with the application */
      XO("No journal will be recorded after Audacity restarts.");
 
   using namespace Journal;
   bool enabled = RecordEnabled();
   if ( SetRecordEnabled(!enabled) )
      enabled = !enabled;
   if ( enabled )
      AudacityMessageBox( OnMessage );
   else
      AudacityMessageBox( OffMessage );
}

References AudacityMessageBox(), Journal::RecordEnabled(), Journal::SetRecordEnabled(), and XO.

Here is the call graph for this function:

---

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

• PluginMenus.cpp