1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Mobility Components.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qorganizeritemfetchhint.h"
#include "qorganizeritemfetchhint_p.h"
#include <QStringList>
#ifndef QT_NO_DEBUG_STREAM
#include <QDebug>
#endif
QTM_BEGIN_NAMESPACE
/*!
\class QOrganizerItemFetchHint
\brief The QOrganizerItemFetchHint class provides hints to the manager about which organizer item
information needs to be retrieved in an asynchronous fetch request or a synchronous
function call.
\since 1.1
\inmodule QtOrganizer
All of the hints may be ignored at the discretion of the manager, however if a manager
is able to optimize retrieval of organizer items due to hints, it may do so. If a manager
ignores a hint, it must retrieve the full set of data that the hint refers to.
The fetch hint contains:
\list
\o a list of detail definition names which the client is interested
in (empty if interested in all detail definitions)
\o some optimization flags which allow the client to tell the backend if they are
not interested in binary blobs (images etc).
\endlist
Important note: a client should not make changes to an organizer item which has been retrieved
using a fetch hint other than the default fetch hint. Doing so will result in information
loss when saving the organizer item back to the manager (as the "new" restricted organizer item will
replace the previously saved organizer item in the backend).
*/
/*!
\enum QOrganizerItemFetchHint::OptimizationHint
This enum defines flags which may be set to inform the backend that the client does
not require certain information. The backend may safely ignore the hint, but then
must return the full set of information relating to the optimization hint.
\value AllRequired Tells the backend that all information is required
\omitvalue NoActionPreferences Tells the backend that the client does not require retrieved organizer items to include a cache of action preferences
\value NoBinaryBlobs Tells the backend that the client does not require retrieved organizer items to include binary blobs such as thumbnail images
*/
/*!
Constructs a new organizer item fetch hint which requests that the backend fetch all information
*/
QOrganizerItemFetchHint::QOrganizerItemFetchHint()
: d(new QOrganizerItemFetchHintPrivate)
{
}
/*!
Constructs a new organizer item fetch hint as a copy of \a other
\since 1.1
*/
QOrganizerItemFetchHint::QOrganizerItemFetchHint(const QOrganizerItemFetchHint &other)
: d(other.d)
{
}
/*!
Frees any memory in use by the fetch hint
*/
QOrganizerItemFetchHint::~QOrganizerItemFetchHint()
{
}
/*!
Assigns this fetch hint to be equal to the \a other fetch hint
\since 1.1
*/
QOrganizerItemFetchHint& QOrganizerItemFetchHint::operator=(const QOrganizerItemFetchHint& other)
{
d = other.d;
return *this;
}
/*!
Returns the list of definition names that identify detail definitions of which details
the manager should (at a minimum) retrieve when fetching organizer items.
This hint may be ignored by the backend, in which case it will return the full set of details for
each organizer item retrieved.
\since 1.1
\sa setDetailDefinitionsHint()
*/
QStringList QOrganizerItemFetchHint::detailDefinitionsHint() const
{
return d->m_definitionsHint;
}
/*!
Sets the list of definition names that identify detail definitions of which details
the manager should (at a minimum) retrieve when fetching organizer items to \a definitionNames.
This hint may be ignored by the backend, in which case it will return the full set of details for
each organizer item retrieved.
\since 1.1
\sa detailDefinitionsHint()
*/
void QOrganizerItemFetchHint::setDetailDefinitionsHint(const QStringList& definitionNames)
{
d->m_definitionsHint = definitionNames;
}
/*!
Returns the optimization hint flags specified by the client.
These hints may be ignored by the backend, in which case it will return
the full set of information accessible in an organizer item.
\since 1.1
\sa setOptimizationHints()
*/
QOrganizerItemFetchHint::OptimizationHints QOrganizerItemFetchHint::optimizationHints() const
{
return d->m_optimizationHints;
}
/*!
Sets the optimization hint flags specified by the client to \a hints.
These hints may be ignored by the backend, in which case it will return
the full set of information accessible in an organizer item.
\since 1.1
\sa optimizationHints()
*/
void QOrganizerItemFetchHint::setOptimizationHints(OptimizationHints hints)
{
d->m_optimizationHints = hints;
}
#ifndef QT_NO_DATASTREAM
QDataStream& operator<<(QDataStream& out, const QOrganizerItemFetchHint& hint)
{
quint8 formatVersion = 1; // Version of QDataStream format for QOrganizerItemFetchHint
return out << formatVersion
<< hint.detailDefinitionsHint()
<< static_cast<quint32>(hint.optimizationHints());
}
QDataStream& operator>>(QDataStream& in, QOrganizerItemFetchHint& hint)
{
quint8 formatVersion;
in >> formatVersion;
if (formatVersion == 1) {
QStringList detailDefinitionHints;
quint32 optimizations;
in >> detailDefinitionHints >> optimizations;
hint.setDetailDefinitionsHint(detailDefinitionHints);
hint.setOptimizationHints(static_cast<QOrganizerItemFetchHint::OptimizationHints>(optimizations));
} else {
in.setStatus(QDataStream::ReadCorruptData);
}
return in;
}
#endif
#ifndef QT_NO_DEBUG_STREAM
/*!
Outputs \a hint to the debug stream \a dbg
\since 1.2
*/
QDebug operator<<(QDebug dbg, const QOrganizerItemFetchHint& hint)
{
dbg.nospace() << "QOrganizerItemFetchHint(";
dbg.nospace() << "detailDefinitionsHint=";
dbg.nospace() << hint.detailDefinitionsHint();
dbg.nospace() << ",";
dbg.nospace() << "optimizationHints=";
dbg.nospace() << static_cast<quint32>(hint.optimizationHints());
dbg.nospace() << ")";
return dbg.maybeSpace();
}
#endif
QTM_END_NAMESPACE
|
