Audacity 3.2.0
Public Member Functions | Static Public Attributes | Private Attributes | List of all members
PluginDescriptor Class Referencefinal

#include <PluginDescriptor.h>

Inheritance diagram for PluginDescriptor:
[legend]
Collaboration diagram for PluginDescriptor:
[legend]

Public Member Functions

PluginType GetPluginType () const
 
const wxString & GetID () const
 
const wxString & GetProviderID () const
 
const PluginPathGetPath () const
 
const ComponentInterfaceSymbolGetSymbol () 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 TranslatableStringGetImporterFilterDescription () const
 
const FileExtensionsGetImporterExtensions () const
 
void WriteXML (XMLWriter &writer) const
 
bool HandleXMLTag (const std::string_view &tag, const AttributesList &attrs) override
 
XMLTagHandlerHandleXMLChild (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 XMLTagHandlerHandleXMLChild (const std::string_view &tag)=0
 
void ReadXMLEndTag (const char *tag)
 
void ReadXMLContent (const char *s, int len)
 
XMLTagHandlerReadXMLChild (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.

224{
225 // Interpret the values stored by SerializeRealtimeSupport, or by previous
226 // versions of Audacity
227 if (value == Since_3_2_string)
229 else {
230 // This leaves some open-endedness for future versions of Audacity to
231 // define other string values they interpret one way, but we interpret
232 // otherwise
233 long number;
234 value.ToLong(&number);
235 mEffectRealtime = number
238 }
239}
static constexpr auto Since_3_2_string
EffectDefinitionInterface::RealtimeSince mEffectRealtime

References EffectDefinitionInterface::Always, mEffectRealtime, EffectDefinitionInterface::Never, EffectDefinitionInterface::Since_3_2, and Since_3_2_string.

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.

138{
139 return mEffectFamily;
140}

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.

143{
144 return mEffectType;
145}
EffectType mEffectType

References mEffectType.

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

Here is the caller graph for this function:

◆ GetID()

const PluginID & PluginDescriptor::GetID ( ) const

◆ GetImporterExtensions()

const FileExtensions & PluginDescriptor::GetImporterExtensions ( ) const

Definition at line 258 of file PluginDescriptor.cpp.

260{
261 return mImporterExtensions;
262}
FileExtensions mImporterExtensions

References mImporterExtensions.

◆ GetImporterFilterDescription()

const TranslatableString & PluginDescriptor::GetImporterFilterDescription ( ) const

◆ GetImporterIdentifier()

const wxString & PluginDescriptor::GetImporterIdentifier ( ) const

Definition at line 248 of file PluginDescriptor.cpp.

249{
250 return mImporterIdentifier;
251}
wxString mImporterIdentifier

References mImporterIdentifier.

◆ GetPath()

const PluginPath & PluginDescriptor::GetPath ( ) const

◆ GetPluginType()

PluginType PluginDescriptor::GetPluginType ( ) const

Definition at line 45 of file PluginDescriptor.cpp.

46{
47 return mPluginType;
48}
PluginType mPluginType

References mPluginType.

Referenced by anonymous_namespace{PluginMenus.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.

56{
57 return mProviderID;
58}

References mProviderID.

Referenced by WriteXML().

Here is the caller graph for this function:

◆ GetSymbol()

const ComponentInterfaceSymbol & PluginDescriptor::GetSymbol ( ) const

◆ GetUntranslatedVersion()

const wxString & PluginDescriptor::GetUntranslatedVersion ( ) const

Definition at line 70 of file PluginDescriptor.cpp.

71{
72 return mVersion;
73}

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.

76{
77 return mVendor;
78}

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.

333{
334 return nullptr;
335}

◆ HandleXMLEndTag()

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

Definition at line 337 of file PluginDescriptor.cpp.

338{
339
340}

◆ HandleXMLTag()

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

Implements XMLTagHandler.

Definition at line 288 of file PluginDescriptor.cpp.

289{
290 if(tag == XMLNodeName)
291 {
292 for(auto& p : attrs)
293 {
294 auto key = wxString(p.first.data(), p.first.length());
295 auto& attr = p.second;
296 if(key == AttrType)
297 SetPluginType(static_cast<PluginType>(attr.Get<int>()));
298 else if(key == AttrEffectType)
299 SetEffectType(static_cast<EffectType>(attr.Get<int>()));
300 else if(key == AttrEffectDefault)
301 SetEffectDefault(attr.Get<bool>());
302 else if(key == AttrEffectRealtime)
303 DeserializeRealtimeSupport(attr.ToWString());
304 else if(key == AttrEffectAutomatable)
305 SetEffectAutomatable(attr.Get<bool>());
306 else if(key == AttrEffectInteractive)
307 SetEffectInteractive(attr.Get<bool>());
308 else if(key == AttrEnabled)
309 SetEnabled(attr.Get<bool>());
310 else if(key == AttrValid)
311 SetValid(attr.Get<bool>());
312 else if(key == AttrID)
313 SetID(attr.ToWString());
314 else if(key == AttrPath)
315 SetPath(attr.ToWString());
316 else if(key == AttrName)
317 SetSymbol(attr.ToWString());
318 else if(key == AttrVendor)
319 SetVendor(attr.ToWString());
320 else if(key == AttrVersion)
321 SetVersion(attr.ToWString());
322 else if(key == AttrEffectFamily)
323 SetEffectFamily(attr.ToWString());
324 else if(key == AttrProviderID)
325 SetProviderID(attr.ToWString());
326 }
327 return true;
328 }
329 return false;
330}
static const AudacityProject::AttachedObjects::RegisteredFactory key
EffectType
PluginType
void SetEnabled(bool enable)
void SetVendor(const wxString &vendor)
void SetPath(const PluginPath &path)
void SetValid(bool valid)
static constexpr auto XMLNodeName
void SetSymbol(const ComponentInterfaceSymbol &symbol)
void SetProviderID(const PluginID &providerID)
void SetID(const PluginID &ID)
void SetEffectType(EffectType type)
void SetEffectFamily(const wxString &family)
void SetPluginType(PluginType type)
void SetEffectAutomatable(bool automatable)
void SetEffectDefault(bool dflt)
void SetEffectInteractive(bool interactive)
void SetVersion(const wxString &version)
void DeserializeRealtimeSupport(const wxString &value)
for deserialization

References anonymous_namespace{PluginDescriptor.cpp}::AttrEffectAutomatable, anonymous_namespace{PluginDescriptor.cpp}::AttrEffectDefault, anonymous_namespace{PluginDescriptor.cpp}::AttrEffectFamily, anonymous_namespace{PluginDescriptor.cpp}::AttrEffectInteractive, anonymous_namespace{PluginDescriptor.cpp}::AttrEffectRealtime, anonymous_namespace{PluginDescriptor.cpp}::AttrEffectType, anonymous_namespace{PluginDescriptor.cpp}::AttrEnabled, anonymous_namespace{PluginDescriptor.cpp}::AttrID, anonymous_namespace{PluginDescriptor.cpp}::AttrName, anonymous_namespace{PluginDescriptor.cpp}::AttrPath, anonymous_namespace{PluginDescriptor.cpp}::AttrProviderID, anonymous_namespace{PluginDescriptor.cpp}::AttrType, anonymous_namespace{PluginDescriptor.cpp}::AttrValid, anonymous_namespace{PluginDescriptor.cpp}::AttrVendor, anonymous_namespace{PluginDescriptor.cpp}::AttrVersion, DeserializeRealtimeSupport(), key, SetEffectAutomatable(), SetEffectDefault(), SetEffectFamily(), SetEffectInteractive(), SetEffectType(), SetEnabled(), SetID(), SetPath(), SetPluginType(), SetProviderID(), SetSymbol(), SetValid(), SetVendor(), SetVersion(), and XMLNodeName.

Here is the call graph for this function:

◆ IsEffectAutomatable()

bool PluginDescriptor::IsEffectAutomatable ( ) const

Definition at line 167 of file PluginDescriptor.cpp.

168{
169 return mEffectAutomatable;
170}

References mEffectAutomatable.

Referenced by EffectManager::SupportsAutomation(), and WriteXML().

Here is the caller graph for this function:

◆ IsEffectDefault()

bool PluginDescriptor::IsEffectDefault ( ) const

Definition at line 152 of file PluginDescriptor.cpp.

153{
154 return mEffectDefault;
155}

References mEffectDefault.

Referenced by anonymous_namespace{PluginMenus.cpp}::AddSortedEffectMenuItems(), anonymous_namespace{PluginMenus.cpp}::CompareEffectsByPublisherAndName(), anonymous_namespace{PluginMenus.cpp}::CompareEffectsByTypeAndName(), anonymous_namespace{PluginMenus.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.

148{
149 return mEffectInteractive;
150}

References mEffectInteractive.

Referenced by anonymous_namespace{PluginMenus.cpp}::AddGroupedEffectMenuItems(), anonymous_namespace{PluginMenus.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.

158{
159 return mEffectLegacy;
160}

References mEffectLegacy.

◆ IsEffectRealtime()

bool PluginDescriptor::IsEffectRealtime ( ) const

◆ IsEnabled()

bool PluginDescriptor::IsEnabled ( ) const

Definition at line 80 of file PluginDescriptor.cpp.

81{
82 return mEnabled;
83}

References mEnabled.

Referenced by anonymous_namespace{PluginMenus.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.

86{
87 return mValid;
88}

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.

206{
207 // Write a string value that converts to 0 or 1, therefore to a boolean,
208 // when read as a boolean from a config file by Audacity 3.1 or earlier
209 switch (mEffectRealtime) {
211 default:
212 // A value that earlier Audacity interprets as false
213 return "0";
215 // A different value that earlier Audacity interprets as false
216 return Since_3_2_string;
218 // A value that earlier Audacity interprets as true
219 return "1";
220 }
221}

References EffectDefinitionInterface::Always, mEffectRealtime, EffectDefinitionInterface::Never, EffectDefinitionInterface::Since_3_2, and Since_3_2_string.

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.

242{
243 mEffectAutomatable = automatable;
244}

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.

188{
189 mEffectDefault = dflt;
190}

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.

173{
174 mEffectFamily = family;
175}

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.

183{
184 mEffectInteractive = interactive;
185}

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.

193{
194 mEffectLegacy = legacy;
195}

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.

178{
179 mEffectType = type;
180}

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.

126{
127 mEnabled = enable;
128}

References mEnabled.

Referenced by AsyncPluginValidator::Impl::HandleResult(), HandleXMLTag(), PluginManager::LoadGroup(), 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.

96{
97 mID = ID;
98}

References mID.

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

Here is the caller graph for this function:

◆ SetImporterExtensions()

void PluginDescriptor::SetImporterExtensions ( FileExtensions  extensions)

Definition at line 342 of file PluginDescriptor.cpp.

343{
344 mImporterExtensions = std::move( extensions );
345}

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.

254{
255 mImporterIdentifier = identifier;
256}

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.

106{
107 mPath = path;
108}

References mPath.

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

Here is the caller graph for this function:

◆ SetPluginType()

void PluginDescriptor::SetPluginType ( PluginType  type)

Definition at line 90 of file PluginDescriptor.cpp.

91{
92 mPluginType = type;
93}

References mPluginType.

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

Here is the caller graph for this function:

◆ SetProviderID()

void PluginDescriptor::SetProviderID ( const PluginID providerID)

Definition at line 100 of file PluginDescriptor.cpp.

101{
102 mProviderID = providerID;
103}

References mProviderID.

Referenced by AsyncPluginValidator::Impl::HandleResult(), HandleXMLTag(), PluginManager::LoadGroup(), 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.

199{
200 mEffectRealtime = realtime;
201}

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.

111{
112 mSymbol = symbol;
113}

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.

131{
132 mValid = valid;
133}

References mValid.

Referenced by AsyncPluginValidator::Impl::HandleResult(), HandleXMLTag(), PluginManager::LoadGroup(), 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.

121{
122 mVendor = vendor;
123}

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.

116{
117 mVersion = version;
118}

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.

265{
266 writer.StartTag(XMLNodeName);
267 writer.WriteAttr(AttrID, GetID());
268 writer.WriteAttr(AttrType, static_cast<int>(GetPluginType()));
270 writer.WriteAttr(AttrValid, IsValid());
272 writer.WriteAttr(AttrPath, GetPath());
274 writer.WriteAttr(AttrVendor, GetVendor());
277 {
284 }
285 writer.EndTag(XMLNodeName);
286}
@ Internal
Indicates internal failure from Audacity.
@ PluginTypeEffect
const ComponentInterfaceSymbol & GetSymbol() const
bool IsEffectAutomatable() const
PluginType GetPluginType() const
wxString GetEffectFamily() const
bool IsEffectDefault() const
wxString SerializeRealtimeSupport() const
for serialization
bool IsEffectInteractive() const
const wxString & GetID() const
bool IsEnabled() const
bool IsValid() const
const wxString & GetVendor() const
const PluginPath & GetPath() const
EffectType GetEffectType() const
const wxString & GetProviderID() const
const wxString & GetUntranslatedVersion() const
virtual void StartTag(const wxString &name)
Definition: XMLWriter.cpp:80
void WriteAttr(const wxString &name, const Identifier &value)
Definition: XMLWriter.h:37
virtual void EndTag(const wxString &name)
Definition: XMLWriter.cpp:103

References anonymous_namespace{PluginDescriptor.cpp}::AttrEffectAutomatable, anonymous_namespace{PluginDescriptor.cpp}::AttrEffectDefault, anonymous_namespace{PluginDescriptor.cpp}::AttrEffectFamily, anonymous_namespace{PluginDescriptor.cpp}::AttrEffectInteractive, anonymous_namespace{PluginDescriptor.cpp}::AttrEffectRealtime, anonymous_namespace{PluginDescriptor.cpp}::AttrEffectType, anonymous_namespace{PluginDescriptor.cpp}::AttrEnabled, anonymous_namespace{PluginDescriptor.cpp}::AttrID, anonymous_namespace{PluginDescriptor.cpp}::AttrName, anonymous_namespace{PluginDescriptor.cpp}::AttrPath, anonymous_namespace{PluginDescriptor.cpp}::AttrProviderID, anonymous_namespace{PluginDescriptor.cpp}::AttrType, anonymous_namespace{PluginDescriptor.cpp}::AttrValid, anonymous_namespace{PluginDescriptor.cpp}::AttrVendor, anonymous_namespace{PluginDescriptor.cpp}::AttrVersion, XMLWriter::EndTag(), GetEffectFamily(), GetEffectType(), GetID(), GetPath(), GetPluginType(), GetProviderID(), GetSymbol(), GetUntranslatedVersion(), GetVendor(), Internal, IsEffectAutomatable(), IsEffectDefault(), IsEffectInteractive(), IsEnabled(), IsValid(), PluginTypeEffect, SerializeRealtimeSupport(), XMLWriter::StartTag(), XMLWriter::WriteAttr(), and 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

◆ 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

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