Audacity  3.0.3
Public Member Functions | List of all members
ComponentInterface Class Referenceabstract

ComponentInterface provides name / vendor / version functions to identify plugins. It is what makes a class a plug-in. Additionally it provides an optional parameter definitions function, for those components such as commands, effects and (soon) preference pagess that define parameters. More...

#include <ComponentInterface.h>

Inheritance diagram for ComponentInterface:
[legend]

Public Member Functions

virtual ~ComponentInterface ()
 
virtual PluginPath GetPath ()=0
 
virtual ComponentInterfaceSymbol GetSymbol ()=0
 
virtual VendorSymbol GetVendor ()=0
 
virtual wxString GetVersion ()=0
 
virtual TranslatableString GetDescription ()=0
 
TranslatableString GetName ()
 
virtual bool DefineParams (ShuttleParams &WXUNUSED(S))
 

Detailed Description

ComponentInterface provides name / vendor / version functions to identify plugins. It is what makes a class a plug-in. Additionally it provides an optional parameter definitions function, for those components such as commands, effects and (soon) preference pagess that define parameters.

Definition at line 61 of file ComponentInterface.h.

Constructor & Destructor Documentation

◆ ~ComponentInterface()

ComponentInterface::~ComponentInterface ( )
virtualdefault

Member Function Documentation

◆ DefineParams()

virtual bool ComponentInterface::DefineParams ( ShuttleParams WXUNUSEDS)
inlinevirtual

Definition at line 85 of file ComponentInterface.h.

85 { return false;};

Referenced by AudacityCommand::GetAutomationParameters(), Effect::GetAutomationParameters(), EffectManager::GetCommandDefinition(), AudacityCommand::Init(), AudacityCommand::SetAutomationParameters(), and Effect::SetAutomationParameters().

Here is the caller graph for this function:

◆ GetDescription()

virtual TranslatableString ComponentInterface::GetDescription ( )
pure virtual

Implemented in WaveformPrefs, WarningsPrefs, TracksPrefs, TracksBehaviorsPrefs, ThemePrefs, SpectrumPrefs, RecordingPrefs, QualityPrefs, PlaybackPrefs, MousePrefs, ModulePrefs, LibraryPrefs, KeyConfigPrefs, ImportExportPrefs, GUIPrefs, ExtImportPrefs, EffectsPrefs, DirectoriesPrefs, DevicePrefs, BatchPrefs, ApplicationPrefs, EffectWahwah, VSTEffectsModule, VSTEffect, VSTSubProcess, VampEffect, VampEffectsModule, EffectTruncSilence, EffectToneGen, EffectTimeScale, EffectStereoToMono, EffectSilence, EffectScienFilter, EffectReverse, EffectReverb, EffectRepeat, EffectRepair, EffectPhaser, EffectPaulstretch, NyquistEffect, NyquistEffectsModule, EffectNormalize, EffectNoiseRemoval, EffectNoiseReduction, EffectNoise, LV2Effect, LV2EffectsModule, EffectLoudness, BuiltinEffectsModule, LadspaEffectsModule, LadspaEffect, EffectInvert, EffectFindClipping, EffectFade, EffectEqualization, Effect, EffectEcho, EffectDtmf, EffectDistortion, EffectCompressor, EffectClickRemoval, EffectChangeSpeed, EffectBassTreble, EffectAutoDuck, AudioUnitEffectsModule, AudioUnitEffect, EffectAmplify, SetTrackCommand, SetTrackVisualsCommand, SetTrackAudioCommand, SetTrackStatusCommand, SetProjectCommand, SetLabelCommand, SetEnvelopeCommand, SetClipCommand, SelectCommand, SelectTracksCommand, SelectFrequenciesCommand, SelectTimeCommand, ScreenshotCommand, SetPreferenceCommand, GetPreferenceCommand, ClearLogCommand, SaveLogCommand, SaveCopyCommand, SaveProjectCommand, OpenProjectCommand, MessageCommand, BuiltinCommandsModule, ExportCommand, ImportCommand, CommentCommand, HelpCommand, GetTrackInfoCommand, GetInfoCommand, DragCommand, DemoCommand, CompareAudioCommand, and AudacityCommand.

Referenced by Effect::GetDescription().

Here is the caller graph for this function:

◆ GetName()

TranslatableString ComponentInterface::GetName ( )

Definition at line 2083 of file PluginManager.cpp.

2084 {
2085  return GetSymbol().Msgid();
2086 }

References PluginManager::GetSymbol(), and ComponentInterfaceSymbol::Msgid().

Referenced by AudacityCommand::CreateUI(), AudacityCommand::DoAudacityCommand(), Effect::DoEffect(), AudioUnitEffect::Export(), AudacityCommand::MessageBox(), Effect::MessageBox(), EffectUIHost::OnApply(), EffectUIHost::OnMenu(), Effect::Preview(), NyquistEffect::ProcessOne(), AudacityCommand::SetAutomationParameters(), and Effect::SetAutomationParameters().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetPath()

virtual PluginPath ComponentInterface::GetPath ( )
pure virtual

Implemented in VSTEffectsModule, VSTEffect, VSTSubProcess, VampEffect, VampEffectsModule, NyquistEffect, NyquistEffectsModule, LV2Effect, LV2EffectsModule, BuiltinEffectsModule, LadspaEffectsModule, LadspaEffect, Effect, AudioUnitEffectsModule, AudioUnitEffect, BuiltinCommandsModule, AudacityCommand, and PrefsPanel.

Referenced by PluginManager::GetID(), ModuleManager::GetID(), and Effect::GetPath().

Here is the caller graph for this function:

◆ GetSymbol()

virtual ComponentInterfaceSymbol ComponentInterface::GetSymbol ( )
pure virtual

Implemented in AudacityCommand, SetTrackNameCommand, SetWaveClipNameCommand, WaveformPrefs, WarningsPrefs, TracksPrefs, TracksBehaviorsPrefs, ThemePrefs, SpectrumPrefs, RecordingPrefs, QualityPrefs, PlaybackPrefs, MousePrefs, ModulePrefs, LibraryPrefs, KeyConfigPrefs, ImportExportPrefs, GUIPrefs, ExtImportPrefs, EffectsPrefs, DirectoriesPrefs, DevicePrefs, BatchPrefs, ApplicationPrefs, EffectWahwah, VSTEffectsModule, VSTEffect, VSTSubProcess, VampEffect, VampEffectsModule, EffectTruncSilence, EffectToneGen, EffectTimeScale, EffectStereoToMono, EffectSilence, EffectScienFilter, EffectSBSMS, EffectReverse, EffectReverb, EffectRepeat, EffectRepair, EffectPhaser, EffectPaulstretch, NyquistEffect, NyquistEffectsModule, EffectNormalize, EffectNoiseRemoval, EffectNoiseReduction, EffectNoise, LV2Effect, LV2EffectsModule, EffectLoudness, BuiltinEffectsModule, LadspaEffectsModule, LadspaEffect, EffectInvert, EffectFindClipping, EffectFade, EffectEqualization, Effect, EffectEcho, EffectDtmf, EffectDistortion, EffectCompressor, EffectClickRemoval, EffectChangeSpeed, EffectBassTreble, EffectAutoDuck, AudioUnitEffectsModule, AudioUnitEffect, EffectAmplify, SetTrackCommand, SetTrackVisualsCommand, SetTrackAudioCommand, SetTrackStatusCommand, SetProjectCommand, SetLabelCommand, SetEnvelopeCommand, SetClipCommand, SelectCommand, SelectTracksCommand, SelectFrequenciesCommand, SelectTimeCommand, ScreenshotCommand, SetPreferenceCommand, GetPreferenceCommand, ClearLogCommand, SaveLogCommand, SaveCopyCommand, SaveProjectCommand, OpenProjectCommand, MessageCommand, BuiltinCommandsModule, ExportCommand, ImportCommand, CommentCommand, HelpCommand, GetTrackInfoCommand, GetInfoCommand, DragCommand, DemoCommand, CompareAudioCommand, and OldStyleCommandType.

Referenced by PluginManager::GetID(), ModuleManager::GetID(), PrefsPanel::GetPath(), and Effect::GetSymbol().

Here is the caller graph for this function:

◆ GetVendor()

virtual VendorSymbol ComponentInterface::GetVendor ( )
pure virtual

Implemented in VSTEffectsModule, VSTEffect, VSTSubProcess, VampEffect, VampEffectsModule, NyquistEffect, NyquistEffectsModule, LV2Effect, LV2EffectsModule, BuiltinEffectsModule, LadspaEffectsModule, LadspaEffect, Effect, AudioUnitEffectsModule, AudioUnitEffect, BuiltinCommandsModule, AudacityCommand, and PrefsPanel.

Referenced by PluginManager::GetID(), ModuleManager::GetID(), and Effect::GetVendor().

Here is the caller graph for this function:

◆ GetVersion()

virtual wxString ComponentInterface::GetVersion ( )
pure virtual

Implemented in VSTEffectsModule, VSTEffect, VSTSubProcess, VampEffect, VampEffectsModule, NyquistEffect, NyquistEffectsModule, LV2Effect, LV2EffectsModule, BuiltinEffectsModule, LadspaEffectsModule, LadspaEffect, Effect, AudioUnitEffectsModule, AudioUnitEffect, BuiltinCommandsModule, AudacityCommand, and PrefsPanel.

Referenced by Effect::GetVersion().

Here is the caller graph for this function:

The documentation for this class was generated from the following files:
ComponentInterface::GetSymbol
virtual ComponentInterfaceSymbol GetSymbol()=0
ComponentInterfaceSymbol::Msgid
const TranslatableString & Msgid() const
Definition: ComponentInterfaceSymbol.h:56