1/****************************************************************************
2**
3** Copyright (C) 2015 The Qt Company Ltd.
4** Contact: http://www.qt.io/licensing/
5**
6** This file is part of the QtVersit module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL21$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see http://www.qt.io/terms-conditions. For further
15** information use the contact form at http://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 2.1 or version 3 as published by the Free
20** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22** following information to ensure the GNU Lesser General Public License
23** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25**
26** As a special exception, The Qt Company gives you certain additional
27** rights. These rights are described in The Qt Company LGPL Exception
28** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29**
30** $QT_END_LICENSE$
31**
32****************************************************************************/
33
34#ifndef QVERSITREADER_H
35#define QVERSITREADER_H
36
37#include <QtCore/qlist.h>
38#include <QtCore/qobject.h>
39
40#include <QtVersit/qversitdocument.h>
41
42QT_FORWARD_DECLARE_CLASS(QByteArray)
43QT_FORWARD_DECLARE_CLASS(QIODevice)
44QT_FORWARD_DECLARE_CLASS(QTextCodec)
45
46QT_BEGIN_NAMESPACE_VERSIT
47
48class QVersitReaderPrivate;
49
50// reads a QVersitDocument from i/o device
51class Q_VERSIT_EXPORT QVersitReader : public QObject
52{
53 Q_OBJECT
54public:
55 enum Error {
56 NoError = 0,
57 UnspecifiedError,
58 IOError,
59 OutOfMemoryError,
60 NotReadyError,
61 ParseError
62 };
63
64 enum State {
65 InactiveState = 0,
66 ActiveState,
67 CanceledState,
68 FinishedState
69 };
70
71 QVersitReader();
72 QVersitReader(QIODevice* inputDevice);
73 QVersitReader(const QByteArray& inputData);
74 ~QVersitReader();
75
76 // input:
77 void setDevice(QIODevice* inputDevice);
78 QIODevice* device() const;
79 void setData(const QByteArray& inputData);
80
81 void setDefaultCodec(QTextCodec* codec);
82 QTextCodec* defaultCodec() const;
83
84 // output:
85 QList<QVersitDocument> results() const;
86
87 State state() const;
88 Error error() const;
89
90 // reading:
91public Q_SLOTS:
92 bool startReading();
93 void cancel();
94public:
95 Q_INVOKABLE bool waitForFinished(int msec = -1);
96
97Q_SIGNALS:
98 void stateChanged(QVersitReader::State state);
99 void resultsAvailable();
100
101private: // data
102 QVersitReaderPrivate* d;
103};
104
105QT_END_NAMESPACE_VERSIT
106
107Q_DECLARE_METATYPE(QTVERSIT_PREPEND_NAMESPACE(QVersitReader::State))
108
109#endif // QVERSITREADER_H
110

source code of qtpim/src/versit/qversitreader.h