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 QtContacts 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 QCONTACTABSTRACTREQUEST_H
35#define QCONTACTABSTRACTREQUEST_H
36
37#include <QtCore/qobject.h>
38
39#include <QtContacts/qcontactmanager.h>
40
41QT_BEGIN_NAMESPACE_CONTACTS
42
43class QContactManagerEngine;
44
45class QContactAbstractRequestPrivate;
46class Q_CONTACTS_EXPORT QContactAbstractRequest : public QObject
47{
48 Q_OBJECT
49
50public:
51 ~QContactAbstractRequest();
52
53 Q_ENUMS(State)
54 enum State {
55 InactiveState = 0, // operation not yet started
56 ActiveState, // operation started, not yet finished
57 CanceledState, // operation is finished due to cancellation
58 FinishedState // operation either completed successfully or failed. No further results will become available.
59 };
60
61 State state() const; // replaces status()
62 inline bool isInactive() const { return state() == QContactAbstractRequest::InactiveState; }
63 inline bool isActive() const { return state() == QContactAbstractRequest::ActiveState; }
64 inline bool isFinished() const { return state() == QContactAbstractRequest::FinishedState; }
65 inline bool isCanceled() const { return state() == QContactAbstractRequest::CanceledState; }
66
67 QContactManager::Error error() const;
68
69 Q_ENUMS(RequestType)
70 enum RequestType {
71 InvalidRequest = 0,
72 ContactFetchRequest,
73 ContactIdFetchRequest,
74 ContactRemoveRequest,
75 ContactSaveRequest,
76 RelationshipFetchRequest,
77 RelationshipRemoveRequest,
78 RelationshipSaveRequest,
79 ContactFetchByIdRequest,
80 CollectionFetchRequest,
81 CollectionRemoveRequest,
82 CollectionSaveRequest
83 };
84
85 RequestType type() const;
86
87 /* Which manager we want to perform the asynchronous request */
88 QContactManager* manager() const;
89 void setManager(QContactManager* manager);
90
91public Q_SLOTS:
92 /* Verbs */
93 bool start();
94 bool cancel();
95
96 /* waiting for stuff */
97 bool waitForFinished(int msecs = 0);
98
99Q_SIGNALS:
100 void stateChanged(QContactAbstractRequest::State newState);
101 void resultsAvailable();
102
103protected:
104 QContactAbstractRequest(QContactAbstractRequestPrivate* otherd, QObject* parent = Q_NULLPTR);
105 QContactAbstractRequestPrivate* d_ptr;
106
107private:
108 QContactAbstractRequest(QObject* parent_ = Q_NULLPTR) : QObject(parent_), d_ptr(Q_NULLPTR) {}
109 Q_DISABLE_COPY(QContactAbstractRequest)
110 friend class QContactManagerEngine;
111 friend class QContactAbstractRequestPrivate;
112
113#ifndef QT_NO_DEBUG_STREAM
114 Q_CONTACTS_EXPORT friend QDebug operator<<(QDebug dbg, const QContactAbstractRequest& request);
115#endif
116
117};
118
119#ifndef QT_NO_DEBUG_STREAM
120Q_CONTACTS_EXPORT QDebug operator<<(QDebug dbg, const QContactAbstractRequest& request);
121#endif
122
123QT_END_NAMESPACE_CONTACTS
124
125#endif // QCONTACTABSTRACTREQUEST_H
126

source code of qtpim/src/contacts/qcontactabstractrequest.h