QPlaceResult Class

The QPlaceResult class represents a search result containing a place. More...

Header: #include <QPlaceResult>
qmake: QT += location
Since: Qt 5.6
Inherits: QPlaceSearchResult

Public Functions

QPlaceResult(const QPlaceSearchResult &other)
virtual ~QPlaceResult()
qreal distance() const
bool isSponsored() const
QPlace place() const
void setDistance(qreal distance)
void setPlace(const QPlace &place)
void setSponsored(bool sponsored)

Detailed Description

The QPlaceResult class represents a search result containing a place.

The PlaceResult holds the distance to the place from the center of the search request, an instance of the place and an indication of whether the result is sponsored or organic.

The intended usage is that a QPlaceSearchResult can be converted into a QPlaceResult like so:

if (result.type() == QPlaceSearchResult::PlaceResult) {
    QPlaceResult placeResult = result;
    qDebug() << placeResult.place().name();
    qDebug() << placeResult.place().location().coordinate();
    qDebug() << placeResult.distance();

The implementation is handled in such a way that object slicing is not an issue.

See also QPlaceSearchResult.

Member Function Documentation


Constructs a new place result object.

QPlaceResult::QPlaceResult(const QPlaceSearchResult &other)

Constructs a copy of other if possible, otherwise constructs a default place result.

[virtual] QPlaceResult::~QPlaceResult()


qreal QPlaceResult::distance() const

Returns the distance of the place to the search center. This field is only relevant provided the search request contained a search area with a search center. Otherwise, the distance is NaN indicating an undefined distance. The default value for distance is NaN.

See also setDistance().

bool QPlaceResult::isSponsored() const

Returns true if the result is a sponsored result.

See also setSponsored().

QPlace QPlaceResult::place() const

Returns the place of the search result.

See also setPlace().

void QPlaceResult::setDistance(qreal distance)

Set the distance of the search result's place from a search center.

See also distance().

void QPlaceResult::setPlace(const QPlace &place)

Sets the place that this result refers to.

See also place().

void QPlaceResult::setSponsored(bool sponsored)

Sets whether the result is a sponsored result or not.

See also isSponsored().

© 2016 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.