comparison plugin/PluginInstance.h @ 55:6befca60ab4e

* added to- and from- XML methods to PluginInstance

 #define _PLUGIN_INSTANCE_H_
 
 #include <string>
 #include <vector>
 
+#include "base/XmlExportable.h"
+
+class QXmlAttributes;
+
 /**
  * A base class for plugins with optional configurable parameters,
  * programs, etc.
  *
  * This does not provide the necessary interfaces to instantiate or

  * plugin types may have quite different operating structures.  This
  * class just specifies the necessary interface to show editable
  * controls for the plugin to the user.
  */
 
-class PluginInstance
+class PluginInstance : public XmlExportable
 {
 public:
     /**
      * Get the computer-usable name of the plugin.  This should be
      * reasonably short and contain no whitespace or punctuation

 
     struct ParameterDescriptor
     {
 	/**
 	 * The name of the parameter, in computer-usable form.  Should
-	 * be reasonably short and without whitespace or punctuation.
+	 * be reasonably short, and may only contain the characters
+	 * [a-zA-Z0-9_].
 	 */
 	std::string name;
 
 	/**
 	 * The human-readable name of the parameter.

     /**
      * Select a program.  (If the given program name is not one of the
      * available programs, do nothing.)
      */
     virtual void selectProgram(std::string) { }
+
+    /**
+     * Export plugin settings to XML.
+     */
+    virtual QString toXmlString(QString indent = "",
+                                QString extraAttributes = "") const;
+
+    /**
+     * Set the parameters and program of a plugin from a set of XML
+     * attributes.  This is a partial inverse of toXmlString.
+     */
+    virtual void setParameters(const QXmlAttributes &);
+
+protected:
+    QString stripInvalidParameterNameCharacters(QString) const;
 };
 
 #endif