1// qxml.sip generated by MetaSIP
2//
3// This file is part of the QtXml Python extension module.
4//
5// Copyright (c) 2021 Riverbank Computing Limited <info@riverbankcomputing.com>
6//
7// This file is part of PyQt5.
8//
9// This file may be used under the terms of the GNU General Public License
10// version 3.0 as published by the Free Software Foundation and appearing in
11// the file LICENSE included in the packaging of this file.  Please review the
12// following information to ensure the GNU General Public License version 3.0
13// requirements will be met: http://www.gnu.org/copyleft/gpl.html.
14//
15// If you do not wish to use this file under the terms of the GPL version 3.0
16// then you may purchase a commercial license.  For more information contact
17// info@riverbankcomputing.com.
18//
19// This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
20// WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
21
22
23class QXmlNamespaceSupport
24{
25%TypeHeaderCode
26#include <qxml.h>
27%End
28
29public:
30    QXmlNamespaceSupport();
31    ~QXmlNamespaceSupport();
32    void setPrefix(const QString &, const QString &);
33    QString prefix(const QString &) const;
34    QString uri(const QString &) const;
35    void splitName(const QString &, QString &, QString &) const;
36    void processName(const QString &, bool, QString &, QString &) const;
37    QStringList prefixes() const;
38    QStringList prefixes(const QString &) const;
39    void pushContext();
40    void popContext();
41    void reset();
42
43private:
44    QXmlNamespaceSupport(const QXmlNamespaceSupport &);
45};
46
47class QXmlAttributes
48{
49%TypeHeaderCode
50#include <qxml.h>
51%End
52
53public:
54    QXmlAttributes();
55%If (Qt_5_8_0 -)
56    QXmlAttributes(const QXmlAttributes &);
57%End
58    virtual ~QXmlAttributes();
59    int index(const QString &qName) const;
60    int index(const QString &uri, const QString &localPart) const;
61    int length() const;
62    QString localName(int index) const;
63    QString qName(int index) const;
64    QString uri(int index) const;
65    QString type(int index) const;
66    QString type(const QString &qName) const;
67    QString type(const QString &uri, const QString &localName) const;
68    QString value(int index) const;
69    QString value(const QString &qName) const;
70    QString value(const QString &uri, const QString &localName) const;
71    void clear();
72    void append(const QString &qName, const QString &uri, const QString &localPart, const QString &value);
73    int count() const /__len__/;
74%If (Qt_5_8_0 -)
75    void swap(QXmlAttributes &other /Constrained/);
76%End
77};
78
79class QXmlInputSource
80{
81%TypeHeaderCode
82#include <qxml.h>
83%End
84
85public:
86    QXmlInputSource();
87    explicit QXmlInputSource(QIODevice *dev);
88    virtual ~QXmlInputSource();
89    virtual void setData(const QString &dat);
90    virtual void setData(const QByteArray &dat);
91    virtual void fetchData();
92    virtual QString data() const;
93    virtual QChar next();
94    virtual void reset();
95    static const ushort EndOfData;
96    static const ushort EndOfDocument;
97
98protected:
99    virtual QString fromRawData(const QByteArray &data, bool beginning = false);
100};
101
102class QXmlParseException
103{
104%TypeHeaderCode
105#include <qxml.h>
106%End
107
108public:
109    QXmlParseException(const QString &name = QString(), int column = -1, int line = -1, const QString &publicId = QString(), const QString &systemId = QString());
110    QXmlParseException(const QXmlParseException &other);
111    ~QXmlParseException();
112    int columnNumber() const;
113    int lineNumber() const;
114    QString publicId() const;
115    QString systemId() const;
116    QString message() const;
117
118private:
119    QXmlParseException &operator=(const QXmlParseException &);
120};
121
122class QXmlReader
123{
124%TypeHeaderCode
125#include <qxml.h>
126%End
127
128public:
129    virtual ~QXmlReader();
130    virtual bool feature(const QString &name, bool *ok = 0) const = 0;
131    virtual void setFeature(const QString &name, bool value) = 0;
132    virtual bool hasFeature(const QString &name) const = 0;
133    virtual void *property(const QString &name, bool *ok = 0) const = 0;
134    virtual void setProperty(const QString &name, void *value) = 0;
135    virtual bool hasProperty(const QString &name) const = 0;
136    virtual void setEntityResolver(QXmlEntityResolver *handler /KeepReference/) = 0;
137    virtual QXmlEntityResolver *entityResolver() const = 0;
138    virtual void setDTDHandler(QXmlDTDHandler *handler /KeepReference/) = 0;
139    virtual QXmlDTDHandler *DTDHandler() const = 0;
140    virtual void setContentHandler(QXmlContentHandler *handler /KeepReference/) = 0;
141    virtual QXmlContentHandler *contentHandler() const = 0;
142    virtual void setErrorHandler(QXmlErrorHandler *handler /KeepReference/) = 0;
143    virtual QXmlErrorHandler *errorHandler() const = 0;
144    virtual void setLexicalHandler(QXmlLexicalHandler *handler /KeepReference/) = 0;
145    virtual QXmlLexicalHandler *lexicalHandler() const = 0;
146    virtual void setDeclHandler(QXmlDeclHandler *handler /KeepReference/) = 0;
147    virtual QXmlDeclHandler *declHandler() const = 0;
148    virtual bool parse(const QXmlInputSource &input) = 0;
149    virtual bool parse(const QXmlInputSource *input) = 0;
150};
151
152class QXmlSimpleReader : QXmlReader
153{
154%TypeHeaderCode
155#include <qxml.h>
156%End
157
158public:
159    QXmlSimpleReader();
160    virtual ~QXmlSimpleReader();
161    virtual bool feature(const QString &name, bool *ok = 0) const;
162    virtual void setFeature(const QString &name, bool value);
163    virtual bool hasFeature(const QString &name) const;
164    virtual void *property(const QString &name, bool *ok = 0) const;
165    virtual void setProperty(const QString &name, void *value);
166    virtual bool hasProperty(const QString &name) const;
167    virtual void setEntityResolver(QXmlEntityResolver *handler /KeepReference/);
168    virtual QXmlEntityResolver *entityResolver() const;
169    virtual void setDTDHandler(QXmlDTDHandler *handler);
170    virtual QXmlDTDHandler *DTDHandler() const;
171    virtual void setContentHandler(QXmlContentHandler *handler /KeepReference/);
172    virtual QXmlContentHandler *contentHandler() const;
173    virtual void setErrorHandler(QXmlErrorHandler *handler /KeepReference/);
174    virtual QXmlErrorHandler *errorHandler() const;
175    virtual void setLexicalHandler(QXmlLexicalHandler *handler /KeepReference/);
176    virtual QXmlLexicalHandler *lexicalHandler() const;
177    virtual void setDeclHandler(QXmlDeclHandler *handler /KeepReference/);
178    virtual QXmlDeclHandler *declHandler() const;
179    virtual bool parse(const QXmlInputSource *input);
180    virtual bool parse(const QXmlInputSource *input, bool incremental);
181    virtual bool parseContinue();
182
183private:
184    QXmlSimpleReader(const QXmlSimpleReader &);
185};
186
187class QXmlLocator
188{
189%TypeHeaderCode
190#include <qxml.h>
191%End
192
193public:
194    QXmlLocator();
195    virtual ~QXmlLocator();
196    virtual int columnNumber() const = 0;
197    virtual int lineNumber() const = 0;
198};
199
200class QXmlContentHandler
201{
202%TypeHeaderCode
203#include <qxml.h>
204%End
205
206public:
207    virtual ~QXmlContentHandler();
208    virtual void setDocumentLocator(QXmlLocator *locator /KeepReference/) = 0;
209    virtual bool startDocument() = 0;
210    virtual bool endDocument() = 0;
211    virtual bool startPrefixMapping(const QString &prefix, const QString &uri) = 0;
212    virtual bool endPrefixMapping(const QString &prefix) = 0;
213    virtual bool startElement(const QString &namespaceURI, const QString &localName, const QString &qName, const QXmlAttributes &atts) = 0;
214    virtual bool endElement(const QString &namespaceURI, const QString &localName, const QString &qName) = 0;
215    virtual bool characters(const QString &ch) = 0;
216    virtual bool ignorableWhitespace(const QString &ch) = 0;
217    virtual bool processingInstruction(const QString &target, const QString &data) = 0;
218    virtual bool skippedEntity(const QString &name) = 0;
219    virtual QString errorString() const = 0;
220};
221
222class QXmlErrorHandler
223{
224%TypeHeaderCode
225#include <qxml.h>
226%End
227
228public:
229    virtual ~QXmlErrorHandler();
230    virtual bool warning(const QXmlParseException &exception) = 0;
231    virtual bool error(const QXmlParseException &exception) = 0;
232    virtual bool fatalError(const QXmlParseException &exception) = 0;
233    virtual QString errorString() const = 0;
234};
235
236class QXmlDTDHandler
237{
238%TypeHeaderCode
239#include <qxml.h>
240%End
241
242public:
243    virtual ~QXmlDTDHandler();
244    virtual bool notationDecl(const QString &name, const QString &publicId, const QString &systemId) = 0;
245    virtual bool unparsedEntityDecl(const QString &name, const QString &publicId, const QString &systemId, const QString &notationName) = 0;
246    virtual QString errorString() const = 0;
247};
248
249class QXmlEntityResolver
250{
251%TypeHeaderCode
252#include <qxml.h>
253%End
254
255public:
256    virtual ~QXmlEntityResolver();
257    virtual bool resolveEntity(const QString &publicId, const QString &systemId, QXmlInputSource *&ret) = 0;
258    virtual QString errorString() const = 0;
259};
260
261class QXmlLexicalHandler
262{
263%TypeHeaderCode
264#include <qxml.h>
265%End
266
267public:
268    virtual ~QXmlLexicalHandler();
269    virtual bool startDTD(const QString &name, const QString &publicId, const QString &systemId) = 0;
270    virtual bool endDTD() = 0;
271    virtual bool startEntity(const QString &name) = 0;
272    virtual bool endEntity(const QString &name) = 0;
273    virtual bool startCDATA() = 0;
274    virtual bool endCDATA() = 0;
275    virtual bool comment(const QString &ch) = 0;
276    virtual QString errorString() const = 0;
277};
278
279class QXmlDeclHandler
280{
281%TypeHeaderCode
282#include <qxml.h>
283%End
284
285public:
286    virtual ~QXmlDeclHandler();
287    virtual bool attributeDecl(const QString &eName, const QString &aName, const QString &type, const QString &valueDefault, const QString &value) = 0;
288    virtual bool internalEntityDecl(const QString &name, const QString &value) = 0;
289    virtual bool externalEntityDecl(const QString &name, const QString &publicId, const QString &systemId) = 0;
290    virtual QString errorString() const = 0;
291};
292
293class QXmlDefaultHandler : QXmlContentHandler, QXmlErrorHandler, QXmlDTDHandler, QXmlEntityResolver, QXmlLexicalHandler, QXmlDeclHandler
294{
295%TypeHeaderCode
296#include <qxml.h>
297%End
298
299public:
300    QXmlDefaultHandler();
301    virtual ~QXmlDefaultHandler();
302    virtual void setDocumentLocator(QXmlLocator *locator /KeepReference/);
303    virtual bool startDocument();
304    virtual bool endDocument();
305    virtual bool startPrefixMapping(const QString &prefix, const QString &uri);
306    virtual bool endPrefixMapping(const QString &prefix);
307    virtual bool startElement(const QString &namespaceURI, const QString &localName, const QString &qName, const QXmlAttributes &atts);
308    virtual bool endElement(const QString &namespaceURI, const QString &localName, const QString &qName);
309    virtual bool characters(const QString &ch);
310    virtual bool ignorableWhitespace(const QString &ch);
311    virtual bool processingInstruction(const QString &target, const QString &data);
312    virtual bool skippedEntity(const QString &name);
313    virtual bool warning(const QXmlParseException &exception);
314    virtual bool error(const QXmlParseException &exception);
315    virtual bool fatalError(const QXmlParseException &exception);
316    virtual bool notationDecl(const QString &name, const QString &publicId, const QString &systemId);
317    virtual bool unparsedEntityDecl(const QString &name, const QString &publicId, const QString &systemId, const QString &notationName);
318    virtual bool resolveEntity(const QString &publicId, const QString &systemId, QXmlInputSource *&ret);
319    virtual bool startDTD(const QString &name, const QString &publicId, const QString &systemId);
320    virtual bool endDTD();
321    virtual bool startEntity(const QString &name);
322    virtual bool endEntity(const QString &name);
323    virtual bool startCDATA();
324    virtual bool endCDATA();
325    virtual bool comment(const QString &ch);
326    virtual bool attributeDecl(const QString &eName, const QString &aName, const QString &type, const QString &valueDefault, const QString &value);
327    virtual bool internalEntityDecl(const QString &name, const QString &value);
328    virtual bool externalEntityDecl(const QString &name, const QString &publicId, const QString &systemId);
329    virtual QString errorString() const;
330
331private:
332    QXmlDefaultHandler(const QXmlDefaultHandler &);
333};
334