svcore  1.9
PluginXml.h
Go to the documentation of this file.
00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
00002 
00003 /*
00004     Sonic Visualiser
00005     An audio file viewer and annotation editor.
00006     Centre for Digital Music, Queen Mary, University of London.
00007     This file copyright 2006 Chris Cannam.
00008     
00009     This program is free software; you can redistribute it and/or
00010     modify it under the terms of the GNU General Public License as
00011     published by the Free Software Foundation; either version 2 of the
00012     License, or (at your option) any later version.  See the file
00013     COPYING included with this distribution for more information.
00014 */
00015 
00016 #ifndef _PLUGIN_XML_H_
00017 #define _PLUGIN_XML_H_
00018 
00019 #include "base/XmlExportable.h"
00020 #include <vamp-hostsdk/PluginBase.h>
00021 
00022 class QXmlAttributes;
00023 
00024 class PluginXml : public XmlExportable
00025 {
00026 public:
00027     PluginXml(Vamp::PluginBase *plugin);
00028     virtual ~PluginXml();
00029 
00033     virtual void toXml(QTextStream &stream,
00034                        QString indent = "",
00035                        QString extraAttributes = "") const;
00036 
00041     virtual void setParameters(const QXmlAttributes &);
00042 
00048     virtual void setParametersFromXml(QString xml);
00049 
00050     static QString encodeConfigurationChars(QString text);
00051     static QString decodeConfigurationChars(QString text);
00052 
00053 protected:
00054     QString stripInvalidParameterNameCharacters(QString) const;
00055 
00056     Vamp::PluginBase *m_plugin;
00057 };
00058 
00059 #endif