diff options
Diffstat (limited to 'src/location/landmarks/qlandmarkidfetchrequest.cpp')
| -rw-r--r-- | src/location/landmarks/qlandmarkidfetchrequest.cpp | 218 |
1 files changed, 218 insertions, 0 deletions
diff --git a/src/location/landmarks/qlandmarkidfetchrequest.cpp b/src/location/landmarks/qlandmarkidfetchrequest.cpp new file mode 100644 index 00000000..5353d403 --- /dev/null +++ b/src/location/landmarks/qlandmarkidfetchrequest.cpp @@ -0,0 +1,218 @@ +/**************************************************************************** +** +** 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 "qlandmarkidfetchrequest.h" +#include "qlandmarkfilter.h" +#include "qlandmarksortorder.h" +#include "qlandmarkrequests_p.h" + + +QTM_BEGIN_NAMESPACE + +/*! + \class QLandmarkIdFetchRequest + \brief The QLandmarkIdFetchRequest class allows a client to asynchronously + request a list of landmark identifiers from a landmark manager. + + For a QLandmarkIdFetchRequest, the resultsAvailable() signal will be emitted when the resultant + identifiers (which may be retrieved by calling landmarkIds()), are updated, as well as if + the overall operation error (which may be retrieved by calling error()) is updated. + + Please see the class documentation for QLandmarkAbstractRequest for more information about + the usage of request classes and ownership semantics. + + \inmodule QtLocation + \since 1.1 + + \ingroup landmarks-request +*/ + +/*! + Creates a new landmark id fetch request object with the given \a manager and \a parent. +*/ +QLandmarkIdFetchRequest::QLandmarkIdFetchRequest(QLandmarkManager *manager, QObject *parent) + : QLandmarkAbstractRequest(new QLandmarkIdFetchRequestPrivate(manager), parent) +{ +} + +/*! + Destroys the request object. +*/ +QLandmarkIdFetchRequest::~QLandmarkIdFetchRequest() +{ +} + +/*! + Returns the filter which will be used to select the landmarks whose identifiers + will be returned. + + By default, the filter's type will be a QLandmarkFilter::DefaultFilter + and thus match all landmarks. +*/ +QLandmarkFilter QLandmarkIdFetchRequest::filter() const +{ + Q_D(const QLandmarkIdFetchRequest); + QMutexLocker ml(&d->mutex); + return d->filter; +} + +/*! + Sets the \a filter which will be used to select landmark identifiers. + +*/ +void QLandmarkIdFetchRequest::setFilter(const QLandmarkFilter &filter) +{ + Q_D(QLandmarkIdFetchRequest); + QMutexLocker ml(&d->mutex); + d->filter = filter; +} + +/*! + Returns the sort ordering which is used to sort the result. By default the + sort order list is empty, thus no sorting will take place. +*/ +QList<QLandmarkSortOrder> QLandmarkIdFetchRequest::sorting() const +{ + Q_D(const QLandmarkIdFetchRequest); + QMutexLocker ml(&d->mutex); + return d->sorting; +} + +/*! + Sets the sort ordering of the request to \a sorting. This + function will only have an effect on the results if invoked + prior to calling QLandmarkAbstractRequest::start(). +*/ +void QLandmarkIdFetchRequest::setSorting(const QList<QLandmarkSortOrder> &sorting) +{ + Q_D(QLandmarkIdFetchRequest); + QMutexLocker ml(&d->mutex); + d->sorting = sorting; +} + +/*! + Convenience function to set the sort ordering of the request to a single \a sorting. This + function will only have an effect on the results if invoked + prior to calling QLandmarkAbstractRequest::start(). +*/ +void QLandmarkIdFetchRequest::setSorting(const QLandmarkSortOrder &sorting) +{ + Q_D(QLandmarkIdFetchRequest); + QMutexLocker ml(&d->mutex); + d->sorting.clear(); + d->sorting.append(sorting); +} + +/*! + Returns the maximum number of landmark IDs to be returned. By default + the limit is set to -1 indicating that IDs of all landmarks are to be retrieved. +*/ +int QLandmarkIdFetchRequest::limit() const +{ + Q_D(const QLandmarkIdFetchRequest); + QMutexLocker ml(&d->mutex); + return d->limit; +} + +/*! + Sets the maximum number of landmarks to be returned to \a limit. + + A limit of -1 indicates that IDs of all landmarks are to be retrieved. + + (A limit of 0 will retrieve no landmark IDs.) + */ +void QLandmarkIdFetchRequest::setLimit(int limit) +{ + Q_D(QLandmarkIdFetchRequest); + QMutexLocker ml(&d->mutex); + d->limit = limit; +} + +/*! + Returns the index offset for the request. By default the offset is set to 0. + The offset determines the first index which is retrieved, it is generally used + in conjunction with limit() to facilitate paging. + + For example, if there are 10 landmarks in the landmark store, setting the offset + to 2 and limit to 5 will retrieve the 3rd and 7th landmark ids inclusively. (The order + of the landmark ids is sepecified by the sorting field). +*/ +int QLandmarkIdFetchRequest::offset() const +{ + Q_D(const QLandmarkIdFetchRequest); + QMutexLocker ml(&d->mutex); + return d->offset; +} + +/*! + Sets the index \a offset for the request. +*/ +void QLandmarkIdFetchRequest::setOffset(int offset) { + Q_D(QLandmarkIdFetchRequest); + QMutexLocker ml(&d->mutex); + d->offset = offset; +} + +/*! + Returns the list of identifiers of landmarks which matched the + filter. +*/ +QList<QLandmarkId> QLandmarkIdFetchRequest::landmarkIds() const +{ + Q_D(const QLandmarkIdFetchRequest); + QMutexLocker ml(&d->mutex); + return d->landmarkIds; +} + +#include "moc_qlandmarkidfetchrequest.cpp" + +QTM_END_NAMESPACE + + + + + + + + + + + |