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

ConfigClientInterface is an unholy get/set configuration class, which differentiates between private and shared config. It should probably be replaced with a Shuttle. More...

#include <ConfigInterface.h>

Inheritance diagram for ConfigClientInterface:
[legend]

Public Member Functions

virtual ~ConfigClientInterface ()
 
virtual bool HasSharedConfigGroup (const RegistryPath &group)=0
 
virtual bool GetSharedConfigSubgroups (const RegistryPath &group, RegistryPaths &subgroups)=0
 
virtual bool GetSharedConfig (const RegistryPath &group, const RegistryPath &key, wxString &value, const wxString &defval)=0
 
virtual bool GetSharedConfig (const RegistryPath &group, const RegistryPath &key, int &value, int defval)=0
 
virtual bool GetSharedConfig (const RegistryPath &group, const RegistryPath &key, bool &value, bool defval)=0
 
virtual bool GetSharedConfig (const RegistryPath &group, const RegistryPath &key, float &value, float defval)=0
 
virtual bool GetSharedConfig (const RegistryPath &group, const RegistryPath &key, double &value, double defval)=0
 
virtual bool SetSharedConfig (const RegistryPath &group, const RegistryPath &key, const wxString &value)=0
 
virtual bool SetSharedConfig (const RegistryPath &group, const RegistryPath &key, const int &value)=0
 
virtual bool SetSharedConfig (const RegistryPath &group, const RegistryPath &key, const bool &value)=0
 
virtual bool SetSharedConfig (const RegistryPath &group, const RegistryPath &key, const float &value)=0
 
virtual bool SetSharedConfig (const RegistryPath &group, const RegistryPath &key, const double &value)=0
 
virtual bool RemoveSharedConfigSubgroup (const RegistryPath &group)=0
 
virtual bool RemoveSharedConfig (const RegistryPath &group, const RegistryPath &key)=0
 
virtual bool HasPrivateConfigGroup (const RegistryPath &group)=0
 
virtual bool GetPrivateConfigSubgroups (const RegistryPath &group, RegistryPaths &subgroups)=0
 
virtual bool GetPrivateConfig (const RegistryPath &group, const RegistryPath &key, wxString &value, const wxString &defval)=0
 
virtual bool GetPrivateConfig (const RegistryPath &group, const RegistryPath &key, int &value, int defval)=0
 
virtual bool GetPrivateConfig (const RegistryPath &group, const RegistryPath &key, bool &value, bool defval)=0
 
virtual bool GetPrivateConfig (const RegistryPath &group, const RegistryPath &key, float &value, float defval)=0
 
virtual bool GetPrivateConfig (const RegistryPath &group, const RegistryPath &key, double &value, double defval)=0
 
virtual bool SetPrivateConfig (const RegistryPath &group, const RegistryPath &key, const wxString &value)=0
 
virtual bool SetPrivateConfig (const RegistryPath &group, const RegistryPath &key, const int &value)=0
 
virtual bool SetPrivateConfig (const RegistryPath &group, const RegistryPath &key, const bool &value)=0
 
virtual bool SetPrivateConfig (const RegistryPath &group, const RegistryPath &key, const float &value)=0
 
virtual bool SetPrivateConfig (const RegistryPath &group, const RegistryPath &key, const double &value)=0
 
virtual bool RemovePrivateConfigSubgroup (const RegistryPath &group)=0
 
virtual bool RemovePrivateConfig (const RegistryPath &group, const RegistryPath &key)=0
 

Detailed Description

ConfigClientInterface is an unholy get/set configuration class, which differentiates between private and shared config. It should probably be replaced with a Shuttle.

Definition at line 56 of file ConfigInterface.h.

Constructor & Destructor Documentation

◆ ~ConfigClientInterface()

virtual ConfigClientInterface::~ConfigClientInterface ( )
inlinevirtual

Definition at line 59 of file ConfigInterface.h.

59 {};

Member Function Documentation

◆ GetPrivateConfig() [1/5]

virtual bool ConfigClientInterface::GetPrivateConfig ( const RegistryPath group,
const RegistryPath key,
bool &  value,
bool  defval 
)
pure virtual

Implemented in Effect.

◆ GetPrivateConfig() [2/5]

virtual bool ConfigClientInterface::GetPrivateConfig ( const RegistryPath group,
const RegistryPath key,
double &  value,
double  defval 
)
pure virtual

Implemented in Effect.

◆ GetPrivateConfig() [3/5]

virtual bool ConfigClientInterface::GetPrivateConfig ( const RegistryPath group,
const RegistryPath key,
float &  value,
float  defval 
)
pure virtual

Implemented in Effect.

◆ GetPrivateConfig() [4/5]

virtual bool ConfigClientInterface::GetPrivateConfig ( const RegistryPath group,
const RegistryPath key,
int &  value,
int  defval 
)
pure virtual

Implemented in Effect.

◆ GetPrivateConfig() [5/5]

virtual bool ConfigClientInterface::GetPrivateConfig ( const RegistryPath group,
const RegistryPath key,
wxString &  value,
const wxString &  defval 
)
pure virtual

Implemented in Effect.

Referenced by LV2Effect::LoadParameters(), VSTEffect::LoadParameters(), AudioUnitEffect::LoadPreset(), AudioUnitEffect::SetHost(), LV2Effect::SetHost(), and VSTEffect::SetHost().

Here is the caller graph for this function:

◆ GetPrivateConfigSubgroups()

virtual bool ConfigClientInterface::GetPrivateConfigSubgroups ( const RegistryPath group,
RegistryPaths subgroups 
)
pure virtual

Implemented in Effect.

◆ GetSharedConfig() [1/5]

virtual bool ConfigClientInterface::GetSharedConfig ( const RegistryPath group,
const RegistryPath key,
bool &  value,
bool  defval 
)
pure virtual

Implemented in Effect.

◆ GetSharedConfig() [2/5]

virtual bool ConfigClientInterface::GetSharedConfig ( const RegistryPath group,
const RegistryPath key,
double &  value,
double  defval 
)
pure virtual

Implemented in Effect.

◆ GetSharedConfig() [3/5]

virtual bool ConfigClientInterface::GetSharedConfig ( const RegistryPath group,
const RegistryPath key,
float &  value,
float  defval 
)
pure virtual

Implemented in Effect.

◆ GetSharedConfig() [4/5]

virtual bool ConfigClientInterface::GetSharedConfig ( const RegistryPath group,
const RegistryPath key,
int &  value,
int  defval 
)
pure virtual

Implemented in Effect.

◆ GetSharedConfig() [5/5]

virtual bool ConfigClientInterface::GetSharedConfig ( const RegistryPath group,
const RegistryPath key,
wxString &  value,
const wxString &  defval 
)
pure virtual

Implemented in Effect.

Referenced by LV2Effect::PopulateUI(), VSTEffect::PopulateUI(), AudioUnitEffect::SetHost(), LV2Effect::SetHost(), VSTEffect::SetHost(), AudioUnitEffect::ShowOptions(), LV2Effect::ShowOptions(), and VSTEffect::ShowOptions().

Here is the caller graph for this function:

◆ GetSharedConfigSubgroups()

virtual bool ConfigClientInterface::GetSharedConfigSubgroups ( const RegistryPath group,
RegistryPaths subgroups 
)
pure virtual

Implemented in Effect.

◆ HasPrivateConfigGroup()

virtual bool ConfigClientInterface::HasPrivateConfigGroup ( const RegistryPath group)
pure virtual

Implemented in Effect.

◆ HasSharedConfigGroup()

virtual bool ConfigClientInterface::HasSharedConfigGroup ( const RegistryPath group)
pure virtual

Implemented in Effect.

◆ RemovePrivateConfig()

virtual bool ConfigClientInterface::RemovePrivateConfig ( const RegistryPath group,
const RegistryPath key 
)
pure virtual

Implemented in Effect.

Referenced by AudioUnitEffect::LoadPreset().

Here is the caller graph for this function:

◆ RemovePrivateConfigSubgroup()

virtual bool ConfigClientInterface::RemovePrivateConfigSubgroup ( const RegistryPath group)
pure virtual

Implemented in Effect.

◆ RemoveSharedConfig()

virtual bool ConfigClientInterface::RemoveSharedConfig ( const RegistryPath group,
const RegistryPath key 
)
pure virtual

Implemented in Effect.

◆ RemoveSharedConfigSubgroup()

virtual bool ConfigClientInterface::RemoveSharedConfigSubgroup ( const RegistryPath group)
pure virtual

Implemented in Effect.

◆ SetPrivateConfig() [1/5]

virtual bool ConfigClientInterface::SetPrivateConfig ( const RegistryPath group,
const RegistryPath key,
const bool &  value 
)
pure virtual

Implemented in Effect.

◆ SetPrivateConfig() [2/5]

virtual bool ConfigClientInterface::SetPrivateConfig ( const RegistryPath group,
const RegistryPath key,
const double &  value 
)
pure virtual

Implemented in Effect.

◆ SetPrivateConfig() [3/5]

virtual bool ConfigClientInterface::SetPrivateConfig ( const RegistryPath group,
const RegistryPath key,
const float &  value 
)
pure virtual

Implemented in Effect.

◆ SetPrivateConfig() [4/5]

virtual bool ConfigClientInterface::SetPrivateConfig ( const RegistryPath group,
const RegistryPath key,
const int &  value 
)
pure virtual

Implemented in Effect.

◆ SetPrivateConfig() [5/5]

virtual bool ConfigClientInterface::SetPrivateConfig ( const RegistryPath group,
const RegistryPath key,
const wxString &  value 
)
pure virtual

Implemented in Effect.

Referenced by AudioUnitEffectImportDialog::Import(), LV2Effect::SaveParameters(), VSTEffect::SaveParameters(), AudioUnitEffect::SavePreset(), AudioUnitEffect::SetHost(), LV2Effect::SetHost(), and VSTEffect::SetHost().

Here is the caller graph for this function:

◆ SetSharedConfig() [1/5]

virtual bool ConfigClientInterface::SetSharedConfig ( const RegistryPath group,
const RegistryPath key,
const bool &  value 
)
pure virtual

Implemented in Effect.

◆ SetSharedConfig() [2/5]

virtual bool ConfigClientInterface::SetSharedConfig ( const RegistryPath group,
const RegistryPath key,
const double &  value 
)
pure virtual

Implemented in Effect.

◆ SetSharedConfig() [3/5]

virtual bool ConfigClientInterface::SetSharedConfig ( const RegistryPath group,
const RegistryPath key,
const float &  value 
)
pure virtual

Implemented in Effect.

◆ SetSharedConfig() [4/5]

virtual bool ConfigClientInterface::SetSharedConfig ( const RegistryPath group,
const RegistryPath key,
const int &  value 
)
pure virtual

Implemented in Effect.

◆ SetSharedConfig() [5/5]

virtual bool ConfigClientInterface::SetSharedConfig ( const RegistryPath group,
const RegistryPath key,
const wxString &  value 
)
pure virtual

Implemented in Effect.

Referenced by AudioUnitEffectOptionsDialog::OnOk(), LV2EffectSettingsDialog::OnOk(), and VSTEffectOptionsDialog::OnOk().

Here is the caller graph for this function:

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