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 QtOrganizer 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 QORGANIZERABSTRACTREQUEST_H
35#define QORGANIZERABSTRACTREQUEST_H
36
37#include <QtOrganizer/qorganizermanager.h>
38
39QT_BEGIN_NAMESPACE_ORGANIZER
40
41class QOrganizerManagerEngine;
42
43class QOrganizerAbstractRequestPrivate;
44class Q_ORGANIZER_EXPORT QOrganizerAbstractRequest : public QObject
45{
46 Q_OBJECT
47
48public:
49 ~QOrganizerAbstractRequest();
50
51 enum State {
52 InactiveState = 0,
53 ActiveState,
54 CanceledState,
55 FinishedState
56 };
57
58 State state() const;
59 inline bool isInactive() const { return state() == QOrganizerAbstractRequest::InactiveState; }
60 inline bool isActive() const { return state() == QOrganizerAbstractRequest::ActiveState; }
61 inline bool isCanceled() const { return state() == QOrganizerAbstractRequest::CanceledState; }
62 inline bool isFinished() const { return state() == QOrganizerAbstractRequest::FinishedState; }
63
64 QOrganizerManager::Error error() const;
65
66 enum RequestType {
67 InvalidRequest = 0,
68 ItemOccurrenceFetchRequest,
69 ItemFetchRequest,
70 ItemFetchForExportRequest,
71 ItemIdFetchRequest,
72 ItemFetchByIdRequest,
73 ItemRemoveRequest,
74 ItemRemoveByIdRequest,
75 ItemSaveRequest,
76 CollectionFetchRequest,
77 CollectionRemoveRequest,
78 CollectionSaveRequest
79 };
80
81 RequestType type() const;
82
83 QOrganizerManager* manager() const;
84 void setManager(QOrganizerManager *manager);
85
86public Q_SLOTS:
87 bool start();
88 bool cancel();
89 bool waitForFinished(int msecs = 0);
90
91Q_SIGNALS:
92 void stateChanged(QOrganizerAbstractRequest::State newState);
93 void resultsAvailable();
94
95protected:
96 QOrganizerAbstractRequest(QOrganizerAbstractRequestPrivate *other, QObject *parent = Q_NULLPTR);
97 QOrganizerAbstractRequestPrivate *d_ptr;
98
99private:
100 QOrganizerAbstractRequest(QObject *_parent = Q_NULLPTR) : QObject(_parent), d_ptr(Q_NULLPTR) {}
101 Q_DISABLE_COPY(QOrganizerAbstractRequest)
102 friend class QOrganizerManagerEngine;
103 friend class QOrganizerAbstractRequestPrivate;
104
105#ifndef QT_NO_DEBUG_STREAM
106 friend Q_ORGANIZER_EXPORT QDebug operator<<(QDebug dbg, const QOrganizerAbstractRequest &request);
107#endif
108};
109
110#ifndef QT_NO_DEBUG_STREAM
111Q_ORGANIZER_EXPORT QDebug operator<<(QDebug dbg, const QOrganizerAbstractRequest &request);
112#endif
113
114QT_END_NAMESPACE_ORGANIZER
115
116#endif // QORGANIZERABSTRACTREQUEST_H
117

source code of qtpim/src/organizer/qorganizerabstractrequest.h