lbajardsilogic@0: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
lbajardsilogic@0: 
lbajardsilogic@0: /*
lbajardsilogic@0:     Sonic Visualiser
lbajardsilogic@0:     An audio file viewer and annotation editor.
lbajardsilogic@0:     Centre for Digital Music, Queen Mary, University of London.
lbajardsilogic@0:     This file copyright 2006 Chris Cannam.
lbajardsilogic@0:     
lbajardsilogic@0:     This program is free software; you can redistribute it and/or
lbajardsilogic@0:     modify it under the terms of the GNU General Public License as
lbajardsilogic@0:     published by the Free Software Foundation; either version 2 of the
lbajardsilogic@0:     License, or (at your option) any later version.  See the file
lbajardsilogic@0:     COPYING included with this distribution for more information.
lbajardsilogic@0: */
lbajardsilogic@0: 
lbajardsilogic@0: #ifndef _XML_EXPORTABLE_H_
lbajardsilogic@0: #define _XML_EXPORTABLE_H_
lbajardsilogic@0: 
lbajardsilogic@0: #include <QString>
lbajardsilogic@0: #include <QColor>
lbajardsilogic@0: 
lbajardsilogic@0: class QTextStream;
lbajardsilogic@0: 
lbajardsilogic@0: class XmlExportable
lbajardsilogic@0: {
lbajardsilogic@0: public:
lbajardsilogic@0:     virtual ~XmlExportable() { }
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Stream this exportable object out to XML on a text stream.
lbajardsilogic@0:      * 
lbajardsilogic@0:      * The default implementation calls toXmlString and streams the
lbajardsilogic@0:      * resulting string.  This is only appropriate for objects with
lbajardsilogic@0:      * short representations.  Bigger objects should override this
lbajardsilogic@0:      * method so as to write to the stream directly and override
lbajardsilogic@0:      * toXmlString with a method that calls this one, so that the
lbajardsilogic@0:      * direct streaming method can be used when appropriate.
lbajardsilogic@0:      */
lbajardsilogic@0:     virtual void toXml(QTextStream &stream,
lbajardsilogic@0:                        QString indent = "",
lbajardsilogic@0:                        QString extraAttributes = "") const;
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Convert this exportable object to XML in a string.
lbajardsilogic@0:      */
lbajardsilogic@0:     virtual QString toXmlString(QString indent = "",
lbajardsilogic@0: 				QString extraAttributes = "") const = 0;
lbajardsilogic@0: 
lbajardsilogic@0:     static QString encodeEntities(QString);
lbajardsilogic@0: 
lbajardsilogic@0:     static QString encodeColour(QColor);
lbajardsilogic@0: 
lbajardsilogic@0:     static int getObjectExportId(const void *); // thread-safe
lbajardsilogic@0: };
lbajardsilogic@0: 
lbajardsilogic@0: #endif