diff options
Diffstat (limited to 'src/location/landmarks/qlandmarksaverequest.cpp')
| -rw-r--r-- | src/location/landmarks/qlandmarksaverequest.cpp | 137 |
1 files changed, 137 insertions, 0 deletions
diff --git a/src/location/landmarks/qlandmarksaverequest.cpp b/src/location/landmarks/qlandmarksaverequest.cpp new file mode 100644 index 00000000..8c521495 --- /dev/null +++ b/src/location/landmarks/qlandmarksaverequest.cpp @@ -0,0 +1,137 @@ +/**************************************************************************** +** +** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the Qt Mobility Components. +** +** $QT_BEGIN_LICENSE:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the Technology Preview License Agreement accompanying +** this package. +** +** 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, 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. +** +** If you have questions regarding the use of this file, please contact +** Nokia at qt-info@nokia.com. +** +** +** +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#include "qlandmarksaverequest.h" +#include "qlandmarkrequests_p.h" +#include "qlandmark.h" + + +QTM_BEGIN_NAMESPACE + +/*! + \class QLandmarkSaveRequest + \brief The QLandmarkSaveRequest class allows a client to asynchronously + request that certain landmarks be saved by a landmark manager. + + \inmodule QtLocation + + \ingroup landmarks-request + \since 1.1 + + For a QLandmarkSaveRequest, the resultsAvailable() signal will be emitted + when either an individual items error out (individaul errors may be retrieved + by calling errorMap()), or when an overall operation error occurs(which may be + retrieved by calling error()). + + Please see the class documentation for QLandmarkAbstractRequest for more information about + the usage of request classes and ownership semantics. +*/ + +/*! + Constructs a landmark save request with the given \a manager and \a parent. +*/ +QLandmarkSaveRequest::QLandmarkSaveRequest(QLandmarkManager *manager, QObject *parent) + : QLandmarkAbstractRequest(new QLandmarkSaveRequestPrivate(manager), parent) +{ +} + +/*! + Destroys the request object. +*/ +QLandmarkSaveRequest::~QLandmarkSaveRequest() +{ +} + +/*! + Returns the list of landmarks to be saved. If called after the save operation has + finished, any new landmarks will have had their QLandmarkId set. + (Landmarks which were updated or failed to save will remain unchanged, use the + errorMap() function to determine which particular landmarks failed to save.) +*/ +QList<QLandmark> QLandmarkSaveRequest::landmarks() const +{ + Q_D(const QLandmarkSaveRequest); + QMutexLocker ml(&d->mutex); + return d->landmarks; +} + +/*! + Sets the list of \a landmarks to be saved. + + \sa setLandmark() +*/ +void QLandmarkSaveRequest::setLandmarks(const QList<QLandmark> &landmarks) +{ + Q_D(QLandmarkSaveRequest); + QMutexLocker ml(&d->mutex); + d->landmarks = landmarks; +} + +/*! + Convenience function to set a single \a landmark to be saved. This + function is the equivalent of calling setLandmarks() with a single + \a landmark. + + \sa setLandmarks() +*/ +void QLandmarkSaveRequest::setLandmark(const QLandmark &landmark) +{ + Q_D(QLandmarkSaveRequest); + QMutexLocker ml(&d->mutex); + d->landmarks.clear(); + d->landmarks.append(landmark); +} + +/*! + Returns the mapping of input landmark list indices to errors which occurred. +*/ +QMap<int, QLandmarkManager::Error> QLandmarkSaveRequest::errorMap() const +{ + Q_D(const QLandmarkSaveRequest); + QMutexLocker ml(&d->mutex); + return d->errorMap; +} + +#include "moc_qlandmarksaverequest.cpp" + +QTM_END_NAMESPACE + + |