PluginXml Class Reference

#include <PluginXml.h>

Inherits XmlExportable.

Inheritance diagram for PluginXml:

[legend]Collaboration diagram for PluginXml:

[legend]List of all members.

---

Detailed Description

Definition at line 25 of file PluginXml.h.

Public Member Functions
	PluginXml (Vamp::PluginBase *plugin)
virtual	~PluginXml ()
virtual void	toXml (QTextStream &stream, QString indent="", QString extraAttributes="") const
	Export plugin settings to XML.
virtual void	setParameters (const QXmlAttributes &)
	Set the parameters and program of a plugin from a set of XML attributes.
virtual void	setParametersFromXml (QString xml)
	Set the parameters and program of a plugin from an XML plugin element as returned by toXml.
virtual QString	toXmlString (QString indent="", QString extraAttributes="") const
	Convert this exportable object to XML in a string.
Static Public Member Functions
static QString	encodeConfigurationChars (QString text)
static QString	decodeConfigurationChars (QString text)
static QString	encodeEntities (QString)
static QString	encodeColour (QColor)
static int	getObjectExportId (const void *)
Protected Member Functions
QString	stripInvalidParameterNameCharacters (QString) const
Protected Attributes
Vamp::PluginBase *	m_plugin

---

Constructor & Destructor Documentation

PluginXml::PluginXml

(

Vamp::PluginBase *

plugin

)

Definition at line 33 of file PluginXml.cpp.

PluginXml::~PluginXml

(

)

[virtual]

Definition at line 38 of file PluginXml.cpp.

---

Member Function Documentation

void PluginXml::toXml	(	QTextStream &	stream,
		QString	indent = "",
		QString	extraAttributes = ""
	)			const [virtual]

Export plugin settings to XML.

Implements XmlExportable.

Definition at line 59 of file PluginXml.cpp.

References encodeConfigurationChars(), XmlExportable::encodeEntities(), RealTimePluginInstance::getConfigurePairs(), m_plugin, and stripInvalidParameterNameCharacters().

void PluginXml::setParameters

(

const QXmlAttributes &

)

[virtual]

Set the parameters and program of a plugin from a set of XML attributes.

This is a partial inverse of toXml.

Definition at line 127 of file PluginXml.cpp.

References CHECK_ATTRIBUTE, RealTimePluginInstance::configure(), decodeConfigurationChars(), m_plugin, and stripInvalidParameterNameCharacters().

Referenced by setParametersFromXml().

void PluginXml::setParametersFromXml

(

QString

xml

)

[virtual]

Set the parameters and program of a plugin from an XML plugin element as returned by toXml.

This is a partial inverse of toXml.

Definition at line 194 of file PluginXml.cpp.

References setParameters().

QString PluginXml::encodeConfigurationChars

(

QString

text

)

[static]

Definition at line 41 of file PluginXml.cpp.

Referenced by AudioGenerator::getDefaultPlayPluginConfiguration(), and toXml().

QString PluginXml::decodeConfigurationChars

(

QString

text

)

[static]

Definition at line 50 of file PluginXml.cpp.

Referenced by setParameters().

QString PluginXml::stripInvalidParameterNameCharacters

(

QString

)

const [protected]

Definition at line 229 of file PluginXml.cpp.

Referenced by setParameters(), and toXml().

QString XmlExportable::toXmlString	(	QString	indent = "",
		QString	extraAttributes = ""
	)			const [virtual, inherited]

Convert this exportable object to XML in a string.

The default implementation calls toXml and returns the result as a string. Do not override this unless you really know what you're doing.

Definition at line 25 of file XmlExportable.cpp.

References XmlExportable::toXml().

Referenced by LayerFactory::setLayerDefaultProperties().

QString XmlExportable::encodeEntities

(

QString

)

[static, inherited]

Definition at line 41 of file XmlExportable.cpp.

Referenced by AudioGenerator::getDefaultPlayPluginConfiguration(), SVFileReader::readPlugin(), Layer::toBriefXml(), WaveFileModel::toXml(), Transform::toXml(), TextPoint::toXml(), toXml(), Model::toXml(), Layer::toXml(), ImagePoint::toXml(), and Document::writeBackwardCompatibleDerivation().

QString XmlExportable::encodeColour

(

QColor

)

[static, inherited]

Definition at line 54 of file XmlExportable.cpp.

Referenced by ColourDatabase::getStringValues().

int XmlExportable::getObjectExportId

(

const void *

)

[static, inherited]

Definition at line 71 of file XmlExportable.cpp.

Referenced by FFTDataServer::generateFileBasename(), View::getTextLabelHeight(), Layer::toBriefXml(), SparseModel< PointType >::toXml(), Model::toXml(), Layer::toXml(), EditableDenseThreeDimensionalModel::toXml(), Document::toXml(), and Document::writeBackwardCompatibleDerivation().

---

Member Data Documentation

Vamp::PluginBase* PluginXml::m_plugin [protected]

Definition at line 57 of file PluginXml.h.

Referenced by setParameters(), and toXml().

---

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

• PluginXml.h
• PluginXml.cpp

---