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
|
/****************************************************************************
**
** 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$
** GNU Lesser General Public License Usage
** 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, Nokia gives you certain additional
** rights. These rights are described in the Nokia 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.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "xqcentralrepositoryutils_p.h"
/*
\class XQCentralRepositoryUtils
\internal
\brief The XQCentralRepositoryUtils implements Central Repository related special
features in SettingsManager. This class is just a Qt-like wrapper to
Symbian OS' CRepository class.
See Symbian documentation for more detailed information about e.g. the use of transactions.
This class co-operates with XQSettingsManager so central repositories accessed via this class
share the same CRepository instances.
*/
/*!
\enum XQCentralRepositoryUtils::TransactionMode
This enum defines the possible transaction modes.
*/
/* \var XQCentralRepositoryUtils::ConcurrentReadWriteTransaction XQCentralRepositoryUtils::ConcurrentReadWriteTransaction
See Symbian documentation for CRepository transactions.
*/
/* \var XQCentralRepositoryUtils::ReadTransaction XQCentralRepositoryUtils::ReadTransaction
See Symbian documentation for CRepository transactions.
*/
/* \var XQCentralRepositoryUtils::ReadWriteTransaction XQCentralRepositoryUtils::ReadWriteTransaction
See Symbian documentation for CRepository transactions.
*/
/*
\enum XQCentralRepositoryUtils::TransactionState
This enum defines the possible transaction states.
*/
/* \var XQCentralRepositoryUtils::NotInTransaction XQCentralRepositoryUtils::NotInTransaction
See Symbian documentation for CRepository transactions.
*/
/* \var XQCentralRepositoryUtils::ActiveTransaction XQCentralRepositoryUtils::ActiveTransaction
See Symbian documentation for CRepository transactions.
*/
/* \var XQCentralRepositoryUtils::FailedTransaction XQCentralRepositoryUtils::FailedTransaction
See Symbian documentation for CRepository transactions.
*/
/* \var XQCentralRepositoryUtils::UnknownTransaction XQCentralRepositoryUtils::UnknownTransaction
Transaction state is not known.
*/
/*
Constructs an XQCentralRepositoryUtils object.
\param settingsManager Reference to XQSettingsManager instance
*/
XQCentralRepositoryUtils::XQCentralRepositoryUtils(XQSettingsManager& settingsManager, QObject* parent)
: QObject(parent), d(new XQCentralRepositoryUtilsPrivate(settingsManager))
{
}
/*
Destructs an XQCentralRepositoryUtils.
*/
XQCentralRepositoryUtils::~XQCentralRepositoryUtils()
{
}
/*
Creates a key to central repository. (NOTE: This function is not enabled in public
releases by default.)
\param key XQCentralRepositorySettingsKey which defines the key details
\param value Initial value to be written into central repository. The type is determined with
QVariant.type() and it must be either QVariant::Int, QVariant::Double, QVariant::String or
QVariant::ByteArray.
\return True if the key was successfully created, otherwise return false.
*/
bool XQCentralRepositoryUtils::createKey(const XQCentralRepositorySettingsKey& key, const QVariant& value)
{
return d->createKey(key, value);
}
/*
Deletes a key from central repository. (NOTE: This function is not enabled in public
releases by default.)
\param key XQCentralRepositorySettingsKey which defines the key details
\return True if the key was successfully deleted, otherwise return false.
*/
bool XQCentralRepositoryUtils::deleteKey(const XQCentralRepositorySettingsKey& key)
{
return d->deleteKey(key);
}
/*
Resets a key in central repository to it's initial value defined in .ini file.
\param key XQCentralRepositorySettingsKey which defines the key details
\return True if the key was successfully reset, otherwise return false.
*/
bool XQCentralRepositoryUtils::resetKey(const XQCentralRepositorySettingsKey& key)
{
return d->resetKey(key);
}
/*
Resets the whole central repository file to it's initial state defined in .ini file.
\param repositoryUid Repository UID
\return True if the repository was successfully reset, otherwise return false.
*/
bool XQCentralRepositoryUtils::resetRepository(long int repositoryUid)
{
return d->resetRepository(repositoryUid);
}
/*
Finds keys in central repository.
\param criteria Search criteria
\return List of XQCentralRepositorySettingsKey objects that match with criteria
*/
QList<XQCentralRepositorySettingsKey> XQCentralRepositoryUtils::findKeys(const XQCentralRepositorySearchCriteria& criteria)
{
return d->findKeys(criteria);
}
/*
Starts transaction. See Symbian documentation for more info.
\param repositoryUid Repository UID
\param transactionMode Transaction mode.
\return True if the transaction was successfully started, otherwise return false.
*/
bool XQCentralRepositoryUtils::startTransaction(long int repositoryUid, TransactionMode transactionMode)
{
return d->startTransaction(repositoryUid, transactionMode);
}
/*
Commits transaction. See Symbian documentation for more info.
\param repositoryUid Repository UID
\return True if the transaction was successfully committed, otherwise return false.
*/
bool XQCentralRepositoryUtils::commitTransaction(long int repositoryUid)
{
return d->commitTransaction(repositoryUid);
}
/*
Cancels transaction. See Symbian documentation for more info.
\param repositoryUid Repository UID
*/
void XQCentralRepositoryUtils::cancelTransaction(long int repositoryUid)
{
d->cancelTransaction(repositoryUid);
}
/*
Fails transaction. See Symbian documentation for more info.
\param repositoryUid Repository UID
*/
void XQCentralRepositoryUtils::failTransaction(long int repositoryUid)
{
d->failTransaction(repositoryUid);
}
/*
\return Current transaction state.
*/
XQCentralRepositoryUtils::TransactionState XQCentralRepositoryUtils::transactionState(long int repositoryUid) const
{
return d->transactionState(repositoryUid);
}
|
