← Back to branch summary

~chris.gagnon/+junk/qtpim-coverage

« back to all changes in this revision

Viewing changes to src/contacts/qcontactabstractrequest.h

  • Committer: chris.gagnon
  • Date: 2013-12-10 23:09:37 UTC
  • Revision ID: chris.gagnon@canonical.com-20131210230937-2akf1ft1edcttk87
first post

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/contacts/qcontactabstractrequest.h
 
1
/****************************************************************************
 
2
**
 
3
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
 
4
** Contact: http://www.qt-project.org/legal
 
5
**
 
6
** This file is part of the QtContacts module of the Qt Toolkit.
 
7
**
 
8
** $QT_BEGIN_LICENSE:LGPL$
 
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 Digia.  For licensing terms and
 
14
** conditions see http://qt.digia.com/licensing.  For further information
 
15
** use the contact form at http://qt.digia.com/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 as published by the Free Software
 
20
** Foundation and appearing in the file LICENSE.LGPL included in the
 
21
** packaging of this file.  Please review the following information to
 
22
** ensure the GNU Lesser General Public License version 2.1 requirements
 
23
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
 
24
**
 
25
** In addition, as a special exception, Digia gives you certain additional
 
26
** rights.  These rights are described in the Digia Qt LGPL Exception
 
27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
 
28
**
 
29
** GNU General Public License Usage
 
30
** Alternatively, this file may be used under the terms of the GNU
 
31
** General Public License version 3.0 as published by the Free Software
 
32
** Foundation and appearing in the file LICENSE.GPL included in the
 
33
** packaging of this file.  Please review the following information to
 
34
** ensure the GNU General Public License version 3.0 requirements will be
 
35
** met: http://www.gnu.org/copyleft/gpl.html.
 
36
**
 
37
**
 
38
** $QT_END_LICENSE$
 
39
**
 
40
****************************************************************************/
 
41
 
 
42
#ifndef QCONTACTABSTRACTREQUEST_H
 
43
#define QCONTACTABSTRACTREQUEST_H
 
44
 
 
45
#include <qcontactmanager.h>
 
46
#include <QObject>
 
47
 
 
48
QT_BEGIN_NAMESPACE_CONTACTS
 
49
 
 
50
class QContactManagerEngine;
 
51
class QContactAbstractRequestPrivate;
 
52
class Q_CONTACTS_EXPORT QContactAbstractRequest : public QObject
 
53
{
 
54
    Q_OBJECT
 
55
 
 
56
public:
 
57
    ~QContactAbstractRequest();
 
58
 
 
59
    Q_ENUMS(State)
 
60
    enum State {
 
61
        InactiveState = 0,   // operation not yet started
 
62
        ActiveState,         // operation started, not yet finished
 
63
        CanceledState,       // operation is finished due to cancellation
 
64
        FinishedState        // operation either completed successfully or failed.  No further results will become available.
 
65
    };
 
66
 
 
67
    State state() const; // replaces status()
 
68
    bool isInactive() const;
 
69
    bool isActive() const;
 
70
    bool isFinished() const;
 
71
    bool isCanceled() const;
 
72
    QContactManager::Error error() const;
 
73
 
 
74
    Q_ENUMS(RequestType)
 
75
    enum RequestType {
 
76
        InvalidRequest = 0,
 
77
        ContactFetchRequest,
 
78
        ContactIdFetchRequest,
 
79
        ContactRemoveRequest,
 
80
        ContactSaveRequest,
 
81
        RelationshipFetchRequest,
 
82
        RelationshipRemoveRequest,
 
83
        RelationshipSaveRequest,
 
84
        ContactFetchByIdRequest
 
85
    };
 
86
 
 
87
    RequestType type() const;
 
88
 
 
89
    /* Which manager we want to perform the asynchronous request */
 
90
    QContactManager* manager() const;
 
91
    void setManager(QContactManager* manager);
 
92
 
 
93
    enum StorageLocation {
 
94
        UserDataStorage = 0x1,
 
95
        SystemStorage = 0x2
 
96
    };
 
97
    Q_DECLARE_FLAGS(StorageLocations, StorageLocation)
 
98
 
 
99
public Q_SLOTS:
 
100
    /* Verbs */
 
101
    bool start();
 
102
    bool cancel();
 
103
 
 
104
    /* waiting for stuff */
 
105
    bool waitForFinished(int msecs = 0);
 
106
 
 
107
Q_SIGNALS:
 
108
    void stateChanged(QContactAbstractRequest::State newState);
 
109
    void resultsAvailable();
 
110
 
 
111
protected:
 
112
    QContactAbstractRequest(QContactAbstractRequestPrivate* otherd, QObject* parent = 0);
 
113
    QContactAbstractRequestPrivate* d_ptr;
 
114
 
 
115
private:
 
116
    QContactAbstractRequest(QObject* parent_ = 0) : QObject(parent_), d_ptr(0) {}
 
117
    Q_DISABLE_COPY(QContactAbstractRequest)
 
118
    friend class QContactManagerEngine;
 
119
    friend class QContactAbstractRequestPrivate;
 
120
 
 
121
#ifndef QT_NO_DEBUG_STREAM
 
122
    Q_CONTACTS_EXPORT friend QDebug operator<<(QDebug dbg, const QContactAbstractRequest& request);
 
123
#endif
 
124
 
 
125
};
 
126
 
 
127
Q_DECLARE_OPERATORS_FOR_FLAGS(QContactAbstractRequest::StorageLocations)
 
128
 
 
129
QT_END_NAMESPACE_CONTACTS
 
130
 
 
131
#endif