#include <PluginDescriptor.h>

Inheritance diagram for PluginDescriptor:

Collaboration diagram for PluginDescriptor:

Public Member Functions
PluginType	GetPluginType () const

const wxString &	GetID () const

const wxString &	GetProviderID () const

const PluginPath &	GetPath () const

const ComponentInterfaceSymbol &	GetSymbol () const

const wxString &	GetUntranslatedVersion () const

const wxString &	GetVendor () const

bool	IsEnabled () const

bool	IsValid () const

void	SetEnabled (bool enable)

void	SetValid (bool valid)

wxString	GetEffectFamily () const

EffectType	GetEffectType () const

bool	IsEffectDefault () const

bool	IsEffectInteractive () const

bool	IsEffectLegacy () const

bool	IsEffectRealtime () const

bool	IsEffectAutomatable () const

const wxString &	GetImporterIdentifier () const

const TranslatableString &	GetImporterFilterDescription () const

const FileExtensions &	GetImporterExtensions () const

void	WriteXML (XMLWriter &writer) const

bool	HandleXMLTag (const std::string_view &tag, const AttributesList &attrs) override

XMLTagHandler *	HandleXMLChild (const std::string_view &tag) override

void	HandleXMLEndTag (const std::string_view &) override

void	SetPluginType (PluginType type)

void	SetID (const PluginID &ID)

void	SetProviderID (const PluginID &providerID)

void	SetPath (const PluginPath &path)

void	SetSymbol (const ComponentInterfaceSymbol &symbol)

void	SetVersion (const wxString &version)

void	SetVendor (const wxString &vendor)

void	SetEffectFamily (const wxString &family)

void	SetEffectType (EffectType type)

void	SetEffectDefault (bool dflt)

void	SetEffectInteractive (bool interactive)

void	SetEffectLegacy (bool legacy)

void	SetRealtimeSupport (EffectDefinitionInterface::RealtimeSince realtime)

wxString	SerializeRealtimeSupport () const
	for serialization More...

void	DeserializeRealtimeSupport (const wxString &value)
	for deserialization More...

void	SetEffectAutomatable (bool automatable)

void	SetImporterIdentifier (const wxString &identifier)

void	SetImporterFilterDescription (const TranslatableString &filterDesc)

void	SetImporterExtensions (FileExtensions extensions)

Public Member Functions inherited from XMLTagHandler
	XMLTagHandler ()

virtual	~XMLTagHandler ()

virtual bool	HandleXMLTag (const std::string_view &tag, const AttributesList &attrs)=0

virtual void	HandleXMLEndTag (const std::string_view &WXUNUSED(tag))

virtual void	HandleXMLContent (const std::string_view &WXUNUSED(content))

virtual XMLTagHandler *	HandleXMLChild (const std::string_view &tag)=0

void	ReadXMLEndTag (const char *tag)

void	ReadXMLContent (const char *s, int len)

XMLTagHandler *	ReadXMLChild (const char *tag)

Static Public Attributes
static constexpr auto	XMLNodeName { "PluginDescriptor" }

Private Attributes
PluginType	mPluginType { PluginTypeNone }

wxString	mID

PluginPath	mPath

ComponentInterfaceSymbol	mSymbol

wxString	mVersion

wxString	mVendor

wxString	mProviderID

bool	mEnabled {false}

bool	mValid {false}

wxString	mEffectFamily

EffectType	mEffectType {EffectTypeNone}

bool	mEffectInteractive {false}

bool	mEffectDefault {false}

bool	mEffectLegacy {false}

EffectDefinitionInterface::RealtimeSince	mEffectRealtime

bool	mEffectAutomatable {false}

wxString	mImporterIdentifier

FileExtensions	mImporterExtensions

Detailed Description

Represents either a PluginProvider or a loaded plug-in and caches some information about it

Definition at line 42 of file PluginDescriptor.h.

Member Function Documentation

◆ DeserializeRealtimeSupport()

void PluginDescriptor::DeserializeRealtimeSupport ( const wxString & value )

for deserialization

Definition at line 223 of file PluginDescriptor.cpp.

{
   // Interpret the values stored by SerializeRealtimeSupport, or by previous
   // versions of Audacity
   if (value == After_3_1_string)
      mEffectRealtime = EffectDefinitionInterface::RealtimeSince::After_3_1;
   else {
      // This leaves some open-endedness for future versions of Audacity to
      // define other string values they interpret one way, but we interpret
      // otherwise
      long number;
      value.ToLong(&number);
      mEffectRealtime = number
         ? EffectDefinitionInterface::RealtimeSince::Always
         : EffectDefinitionInterface::RealtimeSince::Never;
   }
}

References EffectDefinitionInterface::After_3_1, After_3_1_string, EffectDefinitionInterface::Always, mEffectRealtime, and EffectDefinitionInterface::Never.

Referenced by HandleXMLTag(), and PluginManager::LoadGroup().

Here is the caller graph for this function:

◆ GetEffectFamily()

wxString PluginDescriptor::GetEffectFamily ( ) const

Definition at line 137 of file PluginDescriptor.cpp.

{
   return mEffectFamily;
}

References mEffectFamily.

Referenced by PluginManager::SettingsPath(), and WriteXML().

Here is the caller graph for this function:

◆ GetEffectType()

EffectType PluginDescriptor::GetEffectType ( ) const

Definition at line 142 of file PluginDescriptor.cpp.

{
   return mEffectType;
}

References mEffectType.

Referenced by AudacityApplicationLogic::DoEffect(), and WriteXML().

Here is the caller graph for this function:

◆ GetID()

const PluginID & PluginDescriptor::GetID ( ) const

Definition at line 50 of file PluginDescriptor.cpp.

{
   return mID;
}

References mID.

Referenced by anonymous_namespace{MenuHelper.cpp}::AddEffectMenuItemGroup(), anonymous_namespace{MenuHelper.cpp}::AddSortedEffectMenuItems(), anonymous_namespace{MenuHelper.cpp}::ComapareEffectsByTypeAndPublisher(), anonymous_namespace{MenuHelper.cpp}::CompareEffectsByPublisher(), anonymous_namespace{MenuHelper.cpp}::CompareEffectsByPublisherAndName(), anonymous_namespace{MenuHelper.cpp}::CompareEffectsByType(), anonymous_namespace{MenuHelper.cpp}::CompareEffectsByTypeAndName(), PluginManager::GetPlugin(), anonymous_namespace{MenuHelper.cpp}::IsEnabledPlugin(), PluginManager::IsPluginAvailable(), PluginManager::RegisterPlugin(), and WriteXML().

Here is the caller graph for this function:

◆ GetImporterExtensions()

const FileExtensions & PluginDescriptor::GetImporterExtensions ( ) const

Definition at line 258 of file PluginDescriptor.cpp.

{
   return mImporterExtensions;
}

References mImporterExtensions.

◆ GetImporterFilterDescription()

const TranslatableString & PluginDescriptor::GetImporterFilterDescription ( ) const

◆ GetImporterIdentifier()

const wxString & PluginDescriptor::GetImporterIdentifier ( ) const

Definition at line 248 of file PluginDescriptor.cpp.

{
   return mImporterIdentifier;
}

References mImporterIdentifier.

◆ GetPath()

const PluginPath & PluginDescriptor::GetPath ( ) const

Definition at line 60 of file PluginDescriptor.cpp.

{
   return mPath;
}

References mPath.

Here is the caller graph for this function:

◆ GetPluginType()

PluginType PluginDescriptor::GetPluginType ( ) const

Definition at line 45 of file PluginDescriptor.cpp.

{
   return mPluginType;
}

References mPluginType.

Referenced by anonymous_namespace{MenuHelper.cpp}::AddEffectMenuItemGroup(), MacroCommands::ApplyEffectCommand(), PluginManager::SettingsPath(), and WriteXML().

Here is the caller graph for this function:

◆ GetProviderID()

const PluginID & PluginDescriptor::GetProviderID ( ) const

Definition at line 55 of file PluginDescriptor.cpp.

{
   return mProviderID;
}

References mProviderID.

Referenced by PluginManager::IsPluginAvailable(), and WriteXML().

Here is the caller graph for this function:

◆ GetSymbol()

const ComponentInterfaceSymbol & PluginDescriptor::GetSymbol ( ) const

Definition at line 65 of file PluginDescriptor.cpp.

{
   return mSymbol;
}

References mSymbol.

Here is the caller graph for this function:

◆ GetUntranslatedVersion()

const wxString & PluginDescriptor::GetUntranslatedVersion ( ) const

Definition at line 70 of file PluginDescriptor.cpp.

{
   return mVersion;
}

References mVersion.

Referenced by WriteXML().

Here is the caller graph for this function:

◆ GetVendor()

const wxString & PluginDescriptor::GetVendor ( ) const

Definition at line 75 of file PluginDescriptor.cpp.

{
   return mVendor;
}

References mVendor.

Referenced by anonymous_namespace{RealtimeEffectPanel.cpp}::GetSafeVendor(), PluginManager::SettingsPath(), and WriteXML().

Here is the caller graph for this function:

◆ HandleXMLChild()

XMLTagHandler * PluginDescriptor::HandleXMLChild ( const std::string_view & tag )

overridevirtual

Implements XMLTagHandler.

Definition at line 332 of file PluginDescriptor.cpp.

{
   return nullptr;
}

◆ HandleXMLEndTag()

void PluginDescriptor::HandleXMLEndTag ( const std::string_view & basic_string_view )

override

Definition at line 337 of file PluginDescriptor.cpp.

{
 
}

◆ HandleXMLTag()

bool PluginDescriptor::HandleXMLTag	(	const std::string_view &	tag,
		const AttributesList &	attrs
	)

overridevirtual

Implements XMLTagHandler.

Definition at line 288 of file PluginDescriptor.cpp.

{
   if(tag == XMLNodeName)
   {
      for(auto& p : attrs)
      {
         auto key = wxString(p.first.data(), p.first.length());
         auto& attr = p.second;
         if(key == AttrType)
            SetPluginType(static_cast<PluginType>(attr.Get<int>()));
         else if(key == AttrEffectType)
            SetEffectType(static_cast<EffectType>(attr.Get<int>()));
         else if(key == AttrEffectDefault)
            SetEffectDefault(attr.Get<bool>());
         else if(key == AttrEffectRealtime)
            DeserializeRealtimeSupport(attr.ToWString());
         else if(key == AttrEffectAutomatable)
            SetEffectAutomatable(attr.Get<bool>());
         else if(key == AttrEffectInteractive)
            SetEffectInteractive(attr.Get<bool>());
         else if(key == AttrEnabled)
            SetEnabled(attr.Get<bool>());
         else if(key == AttrValid)
            SetValid(attr.Get<bool>());
         else if(key == AttrID)
            SetID(attr.ToWString());
         else if(key == AttrPath)
            SetPath(attr.ToWString());
         else if(key == AttrName)
            SetSymbol(attr.ToWString());
         else if(key == AttrVendor)
            SetVendor(attr.ToWString());
         else if(key == AttrVersion)
            SetVersion(attr.ToWString());
         else if(key == AttrEffectFamily)
            SetEffectFamily(attr.ToWString());
         else if(key == AttrProviderID)
            SetProviderID(attr.ToWString());
      }
      return true;
   }
   return false;
}

Here is the call graph for this function:

◆ IsEffectAutomatable()

bool PluginDescriptor::IsEffectAutomatable ( ) const

Definition at line 167 of file PluginDescriptor.cpp.

{
   return mEffectAutomatable;
}

References mEffectAutomatable.

Referenced by WriteXML().

Here is the caller graph for this function:

◆ IsEffectDefault()

bool PluginDescriptor::IsEffectDefault ( ) const

Definition at line 152 of file PluginDescriptor.cpp.

{
   return mEffectDefault;
}

References mEffectDefault.

Referenced by anonymous_namespace{MenuHelper.cpp}::AddSortedEffectMenuItems(), anonymous_namespace{MenuHelper.cpp}::CompareEffectsByPublisherAndName(), anonymous_namespace{MenuHelper.cpp}::CompareEffectsByTypeAndName(), anonymous_namespace{MenuHelper.cpp}::IsDefaultPlugin(), and WriteXML().

Here is the caller graph for this function:

◆ IsEffectInteractive()

bool PluginDescriptor::IsEffectInteractive ( ) const

Definition at line 147 of file PluginDescriptor.cpp.

{
   return mEffectInteractive;
}

References mEffectInteractive.

Referenced by anonymous_namespace{MenuHelper.cpp}::AddSortedEffectMenuItems(), and WriteXML().

Here is the caller graph for this function:

◆ IsEffectLegacy()

bool PluginDescriptor::IsEffectLegacy ( ) const

Definition at line 157 of file PluginDescriptor.cpp.

{
   return mEffectLegacy;
}

References mEffectLegacy.

◆ IsEffectRealtime()

bool PluginDescriptor::IsEffectRealtime ( ) const

Definition at line 162 of file PluginDescriptor.cpp.

{
   return mEffectRealtime != EffectDefinitionInterface::RealtimeSince::Never;
}

References mEffectRealtime, and EffectDefinitionInterface::Never.

◆ IsEnabled()

bool PluginDescriptor::IsEnabled ( ) const

Definition at line 80 of file PluginDescriptor.cpp.

{
   return mEnabled;
}

References mEnabled.

Referenced by anonymous_namespace{MenuHelper.cpp}::IsEnabledPlugin(), anonymous_namespace{TrackMenus.cpp}::TracksMenu(), and WriteXML().

Here is the caller graph for this function:

◆ IsValid()

bool PluginDescriptor::IsValid ( ) const

Definition at line 85 of file PluginDescriptor.cpp.

{
   return mValid;
}

References mValid.

Referenced by WriteXML().

Here is the caller graph for this function:

◆ SerializeRealtimeSupport()

wxString PluginDescriptor::SerializeRealtimeSupport ( ) const

for serialization

Definition at line 205 of file PluginDescriptor.cpp.

{
   // Write a string value that converts to 0 or 1, therefore to a boolean,
   // when read as a boolean from a config file by Audacity 3.1 or earlier
   switch (mEffectRealtime) {
   case EffectDefinitionInterface::RealtimeSince::Never:
   default:
      // A value that earlier Audacity interprets as false
      return "0";
   case EffectDefinitionInterface::RealtimeSince::After_3_1:
      // A different value that earlier Audacity interprets as false
      return After_3_1_string;
   case EffectDefinitionInterface::RealtimeSince::Always:
      // A value that earlier Audacity interprets as true
      return "1";
   }
}

References EffectDefinitionInterface::After_3_1, After_3_1_string, EffectDefinitionInterface::Always, mEffectRealtime, and EffectDefinitionInterface::Never.

Referenced by WriteXML().

Here is the caller graph for this function:

◆ SetEffectAutomatable()

void PluginDescriptor::SetEffectAutomatable ( bool automatable )

Definition at line 241 of file PluginDescriptor.cpp.

{
   mEffectAutomatable = automatable;
}

References mEffectAutomatable.

Referenced by HandleXMLTag(), PluginManager::LoadGroup(), and PluginManager::RegisterPlugin().

Here is the caller graph for this function:

◆ SetEffectDefault()

void PluginDescriptor::SetEffectDefault ( bool dflt )

Definition at line 187 of file PluginDescriptor.cpp.

{
   mEffectDefault = dflt;
}

References mEffectDefault.

Referenced by HandleXMLTag(), PluginManager::LoadGroup(), and PluginManager::RegisterPlugin().

Here is the caller graph for this function:

◆ SetEffectFamily()

void PluginDescriptor::SetEffectFamily ( const wxString & family )

Definition at line 172 of file PluginDescriptor.cpp.

{
   mEffectFamily = family;
}

References mEffectFamily.

Referenced by HandleXMLTag(), PluginManager::LoadGroup(), and PluginManager::RegisterPlugin().

Here is the caller graph for this function:

◆ SetEffectInteractive()

void PluginDescriptor::SetEffectInteractive ( bool interactive )

Definition at line 182 of file PluginDescriptor.cpp.

{
   mEffectInteractive = interactive;
}

References mEffectInteractive.

Referenced by HandleXMLTag(), PluginManager::LoadGroup(), and PluginManager::RegisterPlugin().

Here is the caller graph for this function:

◆ SetEffectLegacy()

void PluginDescriptor::SetEffectLegacy ( bool legacy )

Definition at line 192 of file PluginDescriptor.cpp.

{
   mEffectLegacy = legacy;
}

References mEffectLegacy.

Referenced by PluginManager::RegisterPlugin().

Here is the caller graph for this function:

◆ SetEffectType()

void PluginDescriptor::SetEffectType ( EffectType type )

Definition at line 177 of file PluginDescriptor.cpp.

{
   mEffectType = type;
}

References mEffectType.

Referenced by HandleXMLTag(), PluginManager::LoadGroup(), and PluginManager::RegisterPlugin().

Here is the caller graph for this function:

◆ SetEnabled()

void PluginDescriptor::SetEnabled ( bool enable )

Definition at line 125 of file PluginDescriptor.cpp.

{
   mEnabled = enable;
}

References mEnabled.

Referenced by HandleXMLTag(), PluginManager::LoadGroup(), PluginStartupRegistration::OnPluginValidationFailed(), and PluginManager::RegisterPlugin().

Here is the caller graph for this function:

◆ SetID()

void PluginDescriptor::SetID ( const PluginID & ID )

Definition at line 95 of file PluginDescriptor.cpp.

{
   mID = ID;
}

References mID.

Referenced by PluginManager::CreatePlugin(), HandleXMLTag(), PluginManager::LoadGroup(), and PluginStartupRegistration::OnPluginValidationFailed().

Here is the caller graph for this function:

◆ SetImporterExtensions()

void PluginDescriptor::SetImporterExtensions ( FileExtensions extensions )

Definition at line 342 of file PluginDescriptor.cpp.

{
   mImporterExtensions = std::move( extensions );
}

References mImporterExtensions.

Referenced by PluginManager::LoadGroup().

Here is the caller graph for this function:

◆ SetImporterFilterDescription()

void PluginDescriptor::SetImporterFilterDescription ( const TranslatableString & filterDesc )

◆ SetImporterIdentifier()

void PluginDescriptor::SetImporterIdentifier ( const wxString & identifier )

Definition at line 253 of file PluginDescriptor.cpp.

{
   mImporterIdentifier = identifier;
}

References mImporterIdentifier.

Referenced by PluginManager::LoadGroup().

Here is the caller graph for this function:

◆ SetPath()

void PluginDescriptor::SetPath ( const PluginPath & path )

Definition at line 105 of file PluginDescriptor.cpp.

{
   mPath = path;
}

References mPath.

Referenced by PluginManager::CreatePlugin(), HandleXMLTag(), PluginManager::LoadGroup(), and PluginStartupRegistration::OnPluginValidationFailed().

Here is the caller graph for this function:

◆ SetPluginType()

void PluginDescriptor::SetPluginType ( PluginType type )

Definition at line 90 of file PluginDescriptor.cpp.

{
   mPluginType = type;
}

References mPluginType.

Referenced by PluginManager::CreatePlugin(), HandleXMLTag(), PluginManager::LoadGroup(), and PluginStartupRegistration::OnPluginValidationFailed().

Here is the caller graph for this function:

◆ SetProviderID()

void PluginDescriptor::SetProviderID ( const PluginID & providerID )

Definition at line 100 of file PluginDescriptor.cpp.

{
   mProviderID = providerID;
}

References mProviderID.

Referenced by HandleXMLTag(), PluginManager::LoadGroup(), PluginStartupRegistration::OnPluginValidationFailed(), and PluginManager::RegisterPlugin().

Here is the caller graph for this function:

◆ SetRealtimeSupport()

void PluginDescriptor::SetRealtimeSupport ( EffectDefinitionInterface::RealtimeSince realtime )

Definition at line 197 of file PluginDescriptor.cpp.

{
   mEffectRealtime = realtime;
}

References mEffectRealtime.

Referenced by PluginManager::RegisterPlugin().

Here is the caller graph for this function:

◆ SetSymbol()

void PluginDescriptor::SetSymbol ( const ComponentInterfaceSymbol & symbol )

Definition at line 110 of file PluginDescriptor.cpp.

{
   mSymbol = symbol;
}

References mSymbol.

Referenced by PluginManager::CreatePlugin(), HandleXMLTag(), and PluginManager::LoadGroup().

Here is the caller graph for this function:

◆ SetValid()

void PluginDescriptor::SetValid ( bool valid )

Definition at line 130 of file PluginDescriptor.cpp.

{
   mValid = valid;
}

References mValid.

Referenced by HandleXMLTag(), PluginManager::LoadGroup(), PluginStartupRegistration::OnPluginValidationFailed(), and PluginManager::RegisterPlugin().

Here is the caller graph for this function:

◆ SetVendor()

void PluginDescriptor::SetVendor ( const wxString & vendor )

Definition at line 120 of file PluginDescriptor.cpp.

{
   mVendor = vendor;
}

References mVendor.

Referenced by PluginManager::CreatePlugin(), HandleXMLTag(), and PluginManager::LoadGroup().

Here is the caller graph for this function:

◆ SetVersion()

void PluginDescriptor::SetVersion ( const wxString & version )

Definition at line 115 of file PluginDescriptor.cpp.

{
   mVersion = version;
}

References mVersion.

Referenced by PluginManager::CreatePlugin(), HandleXMLTag(), and PluginManager::LoadGroup().

Here is the caller graph for this function:

◆ WriteXML()

void PluginDescriptor::WriteXML ( XMLWriter & writer ) const

Definition at line 264 of file PluginDescriptor.cpp.

{
   writer.StartTag(XMLNodeName);
   writer.WriteAttr(AttrID, GetID());
   writer.WriteAttr(AttrType, static_cast<int>(GetPluginType()));
   writer.WriteAttr(AttrEnabled, IsEnabled());
   writer.WriteAttr(AttrValid, IsValid());
   writer.WriteAttr(AttrProviderID, GetProviderID());
   writer.WriteAttr(AttrPath, GetPath());
   writer.WriteAttr(AttrName, GetSymbol().Internal());
   writer.WriteAttr(AttrVendor, GetVendor());
   writer.WriteAttr(AttrVersion, GetUntranslatedVersion());
   if(GetPluginType() == PluginTypeEffect)
   {
      writer.WriteAttr(AttrEffectFamily, GetEffectFamily());
      writer.WriteAttr(AttrEffectType, GetEffectType());
      writer.WriteAttr(AttrEffectDefault, IsEffectDefault());
      writer.WriteAttr(AttrEffectRealtime, SerializeRealtimeSupport());
      writer.WriteAttr(AttrEffectAutomatable, IsEffectAutomatable());
      writer.WriteAttr(AttrEffectInteractive, IsEffectInteractive());
   }
   writer.EndTag(XMLNodeName);
}

Here is the call graph for this function:

Member Data Documentation

◆ mEffectAutomatable

bool PluginDescriptor::mEffectAutomatable {false}

private

Definition at line 152 of file PluginDescriptor.h.

Referenced by IsEffectAutomatable(), and SetEffectAutomatable().

◆ mEffectDefault

bool PluginDescriptor::mEffectDefault {false}

private

Definition at line 148 of file PluginDescriptor.h.

Referenced by IsEffectDefault(), and SetEffectDefault().

◆ mEffectFamily

wxString PluginDescriptor::mEffectFamily

private

Definition at line 145 of file PluginDescriptor.h.

Referenced by GetEffectFamily(), and SetEffectFamily().

◆ mEffectInteractive

bool PluginDescriptor::mEffectInteractive {false}

private

Definition at line 147 of file PluginDescriptor.h.

Referenced by IsEffectInteractive(), and SetEffectInteractive().

◆ mEffectLegacy

bool PluginDescriptor::mEffectLegacy {false}

private

Definition at line 149 of file PluginDescriptor.h.

Referenced by IsEffectLegacy(), and SetEffectLegacy().

◆ mEffectRealtime

EffectDefinitionInterface::RealtimeSince PluginDescriptor::mEffectRealtime

private

Initial value:

{

EffectDefinitionInterface::RealtimeSince::Never }

Definition at line 150 of file PluginDescriptor.h.

Referenced by DeserializeRealtimeSupport(), IsEffectRealtime(), SerializeRealtimeSupport(), and SetRealtimeSupport().

◆ mEffectType

EffectType PluginDescriptor::mEffectType {EffectTypeNone}

private

Definition at line 146 of file PluginDescriptor.h.

Referenced by GetEffectType(), and SetEffectType().

◆ mEnabled

bool PluginDescriptor::mEnabled {false}

private

Definition at line 140 of file PluginDescriptor.h.

Referenced by IsEnabled(), and SetEnabled().

◆ mID

wxString PluginDescriptor::mID

private

Definition at line 134 of file PluginDescriptor.h.

Referenced by GetID(), and SetID().

◆ mImporterExtensions

FileExtensions PluginDescriptor::mImporterExtensions

private

Definition at line 157 of file PluginDescriptor.h.

Referenced by GetImporterExtensions(), and SetImporterExtensions().

◆ mImporterIdentifier

wxString PluginDescriptor::mImporterIdentifier

private

Definition at line 156 of file PluginDescriptor.h.

Referenced by GetImporterIdentifier(), and SetImporterIdentifier().

◆ mPath

PluginPath PluginDescriptor::mPath

private

Definition at line 135 of file PluginDescriptor.h.

Referenced by GetPath(), and SetPath().

◆ mPluginType

PluginType PluginDescriptor::mPluginType { PluginTypeNone }

private

Definition at line 132 of file PluginDescriptor.h.

Referenced by GetPluginType(), and SetPluginType().

◆ mProviderID

wxString PluginDescriptor::mProviderID

private

Definition at line 139 of file PluginDescriptor.h.

Referenced by GetProviderID(), and SetProviderID().

◆ mSymbol

ComponentInterfaceSymbol PluginDescriptor::mSymbol

private

Definition at line 136 of file PluginDescriptor.h.

Referenced by GetSymbol(), and SetSymbol().

◆ mValid

bool PluginDescriptor::mValid {false}

private

Definition at line 141 of file PluginDescriptor.h.

Referenced by IsValid(), and SetValid().

◆ mVendor

wxString PluginDescriptor::mVendor

private

Definition at line 138 of file PluginDescriptor.h.

Referenced by GetVendor(), and SetVendor().

◆ mVersion

wxString PluginDescriptor::mVersion

private

Definition at line 137 of file PluginDescriptor.h.

Referenced by GetUntranslatedVersion(), and SetVersion().

◆ XMLNodeName

constexpr auto PluginDescriptor::XMLNodeName { "PluginDescriptor" }

staticconstexpr

Definition at line 46 of file PluginDescriptor.h.

Referenced by detail::PluginValidationResult::HandleXMLChild(), HandleXMLTag(), and WriteXML().

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

Public Member Functions

Static Public Attributes

Private Attributes

Detailed Description

Member Function Documentation

◆ DeserializeRealtimeSupport()

◆ GetEffectFamily()

◆ GetEffectType()

◆ GetID()

◆ GetImporterExtensions()

◆ GetImporterFilterDescription()

◆ GetImporterIdentifier()

◆ GetPath()

◆ GetPluginType()

◆ GetProviderID()

◆ GetSymbol()

◆ GetUntranslatedVersion()

◆ GetVendor()

◆ HandleXMLChild()

◆ HandleXMLEndTag()

◆ HandleXMLTag()

◆ IsEffectAutomatable()

◆ IsEffectDefault()

◆ IsEffectInteractive()

◆ IsEffectLegacy()

◆ IsEffectRealtime()

◆ IsEnabled()

◆ IsValid()

◆ SerializeRealtimeSupport()

◆ SetEffectAutomatable()

◆ SetEffectDefault()

◆ SetEffectFamily()

◆ SetEffectInteractive()

◆ SetEffectLegacy()

◆ SetEffectType()

◆ SetEnabled()

◆ SetID()

◆ SetImporterExtensions()

◆ SetImporterFilterDescription()

◆ SetImporterIdentifier()

◆ SetPath()

◆ SetPluginType()

◆ SetProviderID()

◆ SetRealtimeSupport()

◆ SetSymbol()

◆ SetValid()

◆ SetVendor()

◆ SetVersion()

◆ WriteXML()

Member Data Documentation

◆ mEffectAutomatable

◆ mEffectDefault

◆ mEffectFamily

◆ mEffectInteractive

◆ mEffectLegacy

◆ mEffectRealtime

◆ mEffectType

◆ mEnabled

◆ mID

◆ mImporterExtensions

◆ mImporterIdentifier

◆ mPath

◆ mPluginType

◆ mProviderID

◆ mSymbol

◆ mValid

◆ mVendor

◆ mVersion

◆ XMLNodeName