QPlaceSearchResult Class
The QPlaceSearchResult class is the base class for search results. More...
| Header: | #include <QPlaceSearchResult> |
| qmake: | QT += location |
| Since: | Qt 5.6 |
| Inherited By: |
This class was introduced in Qt 5.6.
Public Types
| enum | SearchResultType { UnknownSearchResult, PlaceResult, ProposedSearchResult } |
Public Functions
| QPlaceSearchResult(const QPlaceSearchResult &other) | |
| QPlaceSearchResult() | |
| QPlaceSearchResult & | operator=(const QPlaceSearchResult &other) |
| virtual | ~QPlaceSearchResult() |
| QPlaceIcon | icon() const |
| void | setIcon(const QPlaceIcon &icon) |
| void | setTitle(const QString &title) |
| QString | title() const |
| QPlaceSearchResult::SearchResultType | type() const |
| bool | operator!=(const QPlaceSearchResult &other) const |
| bool | operator==(const QPlaceSearchResult &other) const |
Detailed Description
A list of search results can be retrieved from the QPlaceSearchReply after it has successfully completed the request. Common to all search results are the title and icon, which can be used to present the search result to the user.
The intended usage is that depending on the type, the search result can be converted to a more detailed subclass 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. It is not expected that client applications or backend plugins instantiate a QPlaceSearchResult directly, but rather client applications simply convert to search result subclasses and backend plugins only instantiate subclasses.
See also QPlaceResult.
Member Type Documentation
enum QPlaceSearchResult::SearchResultType
Defines the type of search result
| Constant | Value | Description |
|---|---|---|
QPlaceSearchResult::UnknownSearchResult | 0 | The contents of the search result are unknown. |
QPlaceSearchResult::PlaceResult | 1 | The search result contains a place. |
QPlaceSearchResult::ProposedSearchResult | 2 | The search result contains a proposed search which may be relevant. |
Member Function Documentation
QPlaceSearchResult::QPlaceSearchResult(const QPlaceSearchResult &other)
Constructs a copy of other
QPlaceSearchResult::QPlaceSearchResult()
Constructs a new search result.
QPlaceSearchResult &QPlaceSearchResult::operator=(const QPlaceSearchResult &other)
Assigns other to this search result and returns a reference to this search result.
[virtual] QPlaceSearchResult::~QPlaceSearchResult()
Destroys the search result.
QPlaceIcon QPlaceSearchResult::icon() const
Returns an icon that can be used to represent the search result.
See also setIcon().
void QPlaceSearchResult::setIcon(const QPlaceIcon &icon)
Sets the icon of the search result to icon.
See also icon().
void QPlaceSearchResult::setTitle(const QString &title)
Sets the title of the search result to title.
See also title().
QString QPlaceSearchResult::title() const
Returns the title of the search result. This string can be used to display the search result to the user.
See also setTitle().
QPlaceSearchResult::SearchResultType QPlaceSearchResult::type() const
Returns the result type.
bool QPlaceSearchResult::operator!=(const QPlaceSearchResult &other) const
Returns true if other not equal to this search result, otherwise returns false.
bool QPlaceSearchResult::operator==(const QPlaceSearchResult &other) const
Returns true if other is equal to this search result, otherwise returns false.
© 2020 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.