1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
|
/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
/*
Sonic Visualiser
An audio file viewer and annotation editor.
Centre for Digital Music, Queen Mary, University of London.
This file copyright 2006 Chris Cannam.
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of the
License, or (at your option) any later version. See the file
COPYING included with this distribution for more information.
*/
#ifndef SV_XML_EXPORTABLE_H
#define SV_XML_EXPORTABLE_H
#include <QString>
#include "Debug.h"
class QTextStream;
namespace sv {
class XmlExportable
{
public:
enum {
// The value NO_ID (-1) is never allocated as an export id
NO_ID = -1
};
typedef int ExportId;
XmlExportable() : m_exportId(NO_ID) { }
virtual ~XmlExportable() { }
/**
* Return the numerical export identifier for this object. It's
* allocated the first time this is called, so objects on which
* this is never called do not get allocated one.
*/
ExportId getExportId() const;
/**
* Stream this exportable object out to XML on a text stream.
*/
virtual void toXml(QTextStream &stream,
QString indent = "",
QString extraAttributes = "") const = 0;
/**
* 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.
*/
virtual QString toXmlString(QString indent = "",
QString extraAttributes = "") const;
static QString encodeEntities(QString);
static QString encodeColour(int r, int g, int b);
private:
mutable int m_exportId;
};
} // end namespace sv
#endif
|
