diff options
18 files changed, 186 insertions, 103 deletions
diff --git a/doc/src/cpp-qml.qdoc b/doc/src/cpp-qml.qdoc index 66045c8d..637221d5 100644 --- a/doc/src/cpp-qml.qdoc +++ b/doc/src/cpp-qml.qdoc @@ -145,18 +145,19 @@ The following sets the properties of this object based on a QGeoAddress object f \section2 GeoRectangle - QGeoRectangle -\target boundingbox -The \l {GeoRectangle::box} {GeoRectangle.box} property is used to provide an interface between C++ and QML code. First a pointer to a -GeoRectangle object must be obtained from C++, then use the \l {QObject::property()}{property()} -and \l {QObject::setProperty()}{setProperty()} functions to get and set the \c box property. -The following gets the QGeoRectangle representing this object from C++: +\target georectangle +The \l {GeoRectangle::rectangle}{GeoRectangle.rectangle} property is used to provide an interface +between C++ and QML code. First a pointer to a GeoRectangle object must be obtained from C++, then +use the \l {QObject::property()}{property()} and \l {QObject::setProperty()}{setProperty()} +functions to get and set the \c rectangle property. The following gets the QGeoRectangle +representing this object from C++: \snippet snippets/cpp/cppqml.cpp GeoRectangle get The following sets the properties of this object based on a QGeoRectangle object from C++: \snippet snippets/cpp/cppqml.cpp GeoRectangle set \section2 GeoCircle - QGeoCircle -\target boundingcircle +\target geocircle The \l {GeoCircle::circle} {GeoCircle.circle} property is used to provide an interface between C++ and QML code. First a pointer to a GeoCircle object must be obtained from C++, then use the \l {QObject::property()}{property()} and \l {QObject::setProperty()}{setProperty()} functions diff --git a/doc/src/qtlocation.qdoc b/doc/src/qtlocation.qdoc index 3d08ef44..dc261861 100644 --- a/doc/src/qtlocation.qdoc +++ b/doc/src/qtlocation.qdoc @@ -182,9 +182,8 @@ directions). \section1 New Since Qt4 -In Qt4 QtMobility provided some location functionality for positioning and Maps. -The new Qt Location API has had an extensive reworking of \l {Map}s and -now provides \l Places. +In Qt4 QtMobility provided some location functionality for positioning and Maps. The new +Qt Location API has had an extensive reworking of Maps and now provides the Places API. New features of Qt Location includes \list diff --git a/src/imports/location/declarativeplaces/qdeclarativeplace.cpp b/src/imports/location/declarativeplaces/qdeclarativeplace.cpp index 7ff5ced4..d228dbd6 100644 --- a/src/imports/location/declarativeplaces/qdeclarativeplace.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativeplace.cpp @@ -176,12 +176,12 @@ QT_USE_NAMESPACE \dots \snippet snippets/declarative/places.qml Place removeFavorite 2 - The PlaceSearchModel and PlaceRecommendationModel have a favoritesPlugin property. - If the property is set, any places found during a search are checked against the favoritesPlugin - to see if there is a matching/corresponding favorite place. If so, the favorite property of the Place - is set, otherwise the favorite property is remains null. + The PlaceSearchModel has a favoritesPlugin property. If the property is set, any places found + during a search are checked against the favoritesPlugin to see if there is a corresponding + favorite place. If so, the favorite property of the Place is set, otherwise the favorite + property is remains null. - \sa PlaceSearchModel, PlaceRecommendationModel + \sa PlaceSearchModel */ QDeclarativePlace::QDeclarativePlace(QObject *parent) diff --git a/src/imports/location/declarativeplaces/qdeclarativeplaceuser.cpp b/src/imports/location/declarativeplaces/qdeclarativeplaceuser.cpp index 3fe66c69..a2f0127a 100644 --- a/src/imports/location/declarativeplaces/qdeclarativeplaceuser.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativeplaceuser.cpp @@ -79,7 +79,7 @@ QDeclarativePlaceUser::QDeclarativePlaceUser(const QPlaceUser &user, QDeclarativePlaceUser::~QDeclarativePlaceUser() {} /*! - \qmlproperty QPlaceUser User::user + \qmlproperty QPlaceUser QtLocation5::User::user For details on how to use this property to interface between C++ and QML see "\l {location-cpp-qml.html#placeuser} {Interfaces between C++ and QML Code}". @@ -102,7 +102,7 @@ QPlaceUser QDeclarativePlaceUser::user() const } /*! - \qmlproperty string User::userId + \qmlproperty string QtLocation5::User::userId This property holds the unique identifier of the user. */ @@ -122,7 +122,7 @@ QString QDeclarativePlaceUser::userId() const } /*! - \qmlproperty string User::name + \qmlproperty string QtLocation5::User::name This property holds the name of a user. */ diff --git a/src/imports/location/declarativeplaces/qdeclarativeplaceuser_p.h b/src/imports/location/declarativeplaces/qdeclarativeplaceuser_p.h index ee9cb46e..fcb959fb 100644 --- a/src/imports/location/declarativeplaces/qdeclarativeplaceuser_p.h +++ b/src/imports/location/declarativeplaces/qdeclarativeplaceuser_p.h @@ -53,8 +53,8 @@ class QDeclarativePlaceUser : public QObject Q_OBJECT Q_PROPERTY(QPlaceUser user READ user WRITE setUser) - Q_PROPERTY(QString userId READ userId WRITE setUserId NOTIFY userIdChanged()) - Q_PROPERTY(QString name READ name WRITE setName NOTIFY nameChanged()) + Q_PROPERTY(QString userId READ userId WRITE setUserId NOTIFY userIdChanged) + Q_PROPERTY(QString name READ name WRITE setName NOTIFY nameChanged) public: explicit QDeclarativePlaceUser(QObject *parent = 0); @@ -80,6 +80,6 @@ private: QT_END_NAMESPACE -QML_DECLARE_TYPE(QT_PREPEND_NAMESPACE(QDeclarativePlaceUser)); +QML_DECLARE_TYPE(QT_PREPEND_NAMESPACE(QDeclarativePlaceUser)) #endif diff --git a/src/imports/location/declarativeplaces/qdeclarativesearchresultmodel.cpp b/src/imports/location/declarativeplaces/qdeclarativesearchresultmodel.cpp index a4fbe6e1..f5b31242 100644 --- a/src/imports/location/declarativeplaces/qdeclarativesearchresultmodel.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativesearchresultmodel.cpp @@ -142,7 +142,7 @@ QT_USE_NAMESPACE \codeline \snippet snippets/declarative/places.qml PlaceSearchModel - \sa PlaceRecommendationModel, CategoryModel, {QPlaceManager} + \sa CategoryModel, {QPlaceManager} \section1 Paging The PlaceSearchModel API has some limited support @@ -309,7 +309,7 @@ QT_USE_NAMESPACE */ /*! - \qmlproperty string QtLocation5::PlaceSearchModel::errorString + \qmlmethod string PlaceSearchModel::errorString() const This read-only property holds the textual presentation of latest place search model error. If no error has occurred or if the model was cleared an empty string is returned. diff --git a/src/imports/location/declarativeplaces/qdeclarativesearchsuggestionmodel.cpp b/src/imports/location/declarativeplaces/qdeclarativesearchsuggestionmodel.cpp index e3755269..481d33a0 100644 --- a/src/imports/location/declarativeplaces/qdeclarativesearchsuggestionmodel.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativesearchsuggestionmodel.cpp @@ -217,7 +217,7 @@ QT_USE_NAMESPACE /*! - \qmlproperty string QtLocation5::PlaceSearchSuggestionModel::errorString + \qmlmethod string QtLocation5::PlaceSearchSuggestionModel::errorString() const This read-only property holds the textual presentation of latest search suggestion model error. If no error has occurred, or if the model was cleared, an empty string is returned. diff --git a/src/imports/location/declarativeplaces/qdeclarativesupportedcategoriesmodel.cpp b/src/imports/location/declarativeplaces/qdeclarativesupportedcategoriesmodel.cpp index 3606a793..04c7f03f 100644 --- a/src/imports/location/declarativeplaces/qdeclarativesupportedcategoriesmodel.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativesupportedcategoriesmodel.cpp @@ -114,7 +114,7 @@ QT_USE_NAMESPACE */ /*! - \qmlproperty string QtLocation5::CategoryModel::errorString + \qmlmethod string QtLocation5::CategoryModel::errorString() const This read-only property holds the textual presentation of latest category model error. If no error has occurred, an empty string is returned. diff --git a/src/imports/location/qdeclarativegeocircle.cpp b/src/imports/location/qdeclarativegeocircle.cpp index 8b3276af..6b6bff10 100644 --- a/src/imports/location/qdeclarativegeocircle.cpp +++ b/src/imports/location/qdeclarativegeocircle.cpp @@ -94,7 +94,7 @@ QDeclarativeGeoCircle::QDeclarativeGeoCircle(const QGeoCircle &circle, \qmlproperty QGeoCircle GeoCircle::circle For details on how to use this property to interface between C++ and QML see - "\l {location-cpp-qml.html#boundingcircle} {Interfaces between C++ and QML Code}". + "\l {location-cpp-qml.html#geocircle}{Interfaces between C++ and QML Code}". */ void QDeclarativeGeoCircle::setCircle(const QGeoCircle &circle) { diff --git a/src/imports/location/qdeclarativegeomapgesturearea.cpp b/src/imports/location/qdeclarativegeomapgesturearea.cpp index 57da1d70..84d9399a 100644 --- a/src/imports/location/qdeclarativegeomapgesturearea.cpp +++ b/src/imports/location/qdeclarativegeomapgesturearea.cpp @@ -274,7 +274,7 @@ QT_BEGIN_NAMESPACE */ /*! - \qmlsignal void QtLocation5::MapGestureArea::pinchStarted(PinchEvent event) + \qmlsignal QtLocation5::MapGestureArea::pinchStarted(PinchEvent event) Raised when a pinch gesture is started. @@ -282,7 +282,7 @@ QT_BEGIN_NAMESPACE */ /*! - \qmlsignal void QtLocation5::MapGestureArea::pinchUpdated(PinchEvent event) + \qmlsignal QtLocation5::MapGestureArea::pinchUpdated(PinchEvent event) Once a pinch has begun this event gets raised as the user moves her fingers across the map. @@ -291,11 +291,11 @@ QT_BEGIN_NAMESPACE */ /*! - \qmlsignal void QtLocation5::MapGestureArea::pinchUpdated(PinchEvent event) + \qmlsignal QtLocation5::MapGestureArea::pinchFinished(PinchEvent event) The end of a pinch gesture is signaled by this event. - \sa pinchUpdated, pinchFinished + \sa pinchStarted, pinchUpdated */ /*! diff --git a/src/imports/location/qdeclarativegeomapmousearea.cpp b/src/imports/location/qdeclarativegeomapmousearea.cpp index 262e18f8..73368975 100644 --- a/src/imports/location/qdeclarativegeomapmousearea.cpp +++ b/src/imports/location/qdeclarativegeomapmousearea.cpp @@ -458,7 +458,7 @@ QQuickItem *QDeclarativeGeoMapMouseArea::parentMapItem() The onEntered handler is only called while a button is pressed. - \sa onExited() + \sa onExited */ /*! @@ -491,7 +491,7 @@ QQuickItem *QDeclarativeGeoMapMouseArea::parentMapItem() The onExited handler is only called while a button is pressed. - \sa onEntered() + \sa onEntered */ #include "moc_qdeclarativegeomapmousearea_p.cpp" diff --git a/src/imports/location/qdeclarativegeomappincharea.cpp b/src/imports/location/qdeclarativegeomappincharea.cpp index bea5802d..6ccafe0d 100644 --- a/src/imports/location/qdeclarativegeomappincharea.cpp +++ b/src/imports/location/qdeclarativegeomappincharea.cpp @@ -178,21 +178,21 @@ QT_BEGIN_NAMESPACE \qmlproperty enumeration QtLocation5::MapPinchArea::activeGestures This property holds the gestures that the pinch should control. By default - the ZoomGesture is enabled. + the MapPinchArea.ZoomGesture is enabled. \list - \li PinchArea.NoGesture - Don't support any additional gestures (value: 0x0000). - \li PinchArea.ZoomGesture - Support the map zoom gesture (value: 0x0001). - \li PinchArea.RotationGesture - Support the map rotation gesture (value: 0x0002). - \li PinchArea.TiltGesture - Support the map tilt gesture (value: 0x0004). - \li PinchArea.PanGesture - Support the map pan gesture while pinching (value: 0x0008). + \li MapPinchArea.NoGesture - Don't support any additional gestures (value: 0x0000). + \li MapPinchArea.ZoomGesture - Support the map zoom gesture (value: 0x0001). + \li MapPinchArea.RotationGesture - Support the map rotation gesture (value: 0x0002). + \li MapPinchArea.TiltGesture - Support the map tilt gesture (value: 0x0004). + \li MapPinchArea.PanGesture - Support the map pan gesture while pinching (value: 0x0008). \endlist For the extremist, one may OR flag the RotationGesture or TiltGesture but these come with absolutely no warranty or guarantees at the moment (may be removed, changed, moved around) - \note For the time being, only \l PinchArea.ZoomGesture is supported. + \note For the time being, only MapPinchArea.ZoomGesture is supported. */ /*! @@ -217,7 +217,7 @@ QT_BEGIN_NAMESPACE */ /*! - \qmlsignal void QtLocation5::MapPinchArea::pinchStarted(PinchEvent event) + \qmlsignal QtLocation5::MapPinchArea::pinchStarted(PinchEvent event) Raised when a pinch gesture is started. @@ -225,7 +225,7 @@ QT_BEGIN_NAMESPACE */ /*! - \qmlsignal void QtLocation5::MapPinchArea::pinchUpdated(PinchEvent event) + \qmlsignal QtLocation5::MapPinchArea::pinchUpdated(PinchEvent event) Once a pinch has begun this event gets raised as the user moves her fingers across the map. @@ -234,11 +234,11 @@ QT_BEGIN_NAMESPACE */ /*! - \qmlsignal void QtLocation5::MapPinchArea::pinchUpdated(PinchEvent event) + \qmlsignal QtLocation5::MapPinchArea::pinchFinished(PinchEvent event) The end of a pinch gesture is signaled by this event. - \sa pinchUpdated, pinchFinished + \sa pinchStarted, pinchUpdated */ /*! diff --git a/src/imports/location/qdeclarativegeorectangle.cpp b/src/imports/location/qdeclarativegeorectangle.cpp index 15ceb4a7..ba2924bb 100644 --- a/src/imports/location/qdeclarativegeorectangle.cpp +++ b/src/imports/location/qdeclarativegeorectangle.cpp @@ -52,21 +52,19 @@ QT_BEGIN_NAMESPACE \brief The GeoRectangle element represents a rectangular geographic area. - A GeoRectangle is described by a \l{QDeclarativeCoordinate}{Coordinate} which - represents the top-left of the GeoRectangle and a second - \l{QDeclarativeCoordinate}{Coordinate} which represents the bottom-right of - GeoRectangle. + A GeoRectangle is described by a \l {Coordinate} which represents the top-left of the + GeoRectangle and a second \l {Coordinate} which represents the bottom-right of GeoRectangle. A GeoRectangle is considered invalid if the top-left or bottom-right coordinates are invalid or if the top-left coordinate is South of the bottom-right coordinate. - Bounding boxes can never cross the poles. + GeoRectangles can never cross the poles. - If the height or center of a bounding box is adjusted such that it would - cross one of the poles the height is modified such that the bounding box + If the height or center of a geo rectangle is adjusted such that it would + cross one of the poles the height is modified such that the geo rectangle touches but does not cross the pole and that the center coordinate is still - in the center of the bounding box. + in the center of the geo rectangle. \section2 Example Usage @@ -85,10 +83,9 @@ QT_BEGIN_NAMESPACE } \endcode - This could then be used, for example, as a region to scan for landmarks, - or refining searches. + This could then be used, for example, as a region to search for places. - \sa QGeoRectangle. + \sa QGeoRectangle */ QDeclarativeGeoRectangle::QDeclarativeGeoRectangle(QObject *parent) @@ -105,10 +102,10 @@ QDeclarativeGeoRectangle::QDeclarativeGeoRectangle(const QGeoRectangle &box, QOb } /*! - \qmlproperty QGeoRectangle GeoRectangle::box + \qmlproperty QGeoRectangle GeoRectangle::rectangle For details on how to use this property to interface between C++ and QML see - "\l {location-cpp-qml.html#georectangle} {Interfaces between C++ and QML Code}". + "\l {location-cpp-qml.html#georectangle}{Interfaces between C++ and QML Code}". */ void QDeclarativeGeoRectangle::setRectangle(const QGeoRectangle &box) { @@ -130,7 +127,7 @@ QGeoShape QDeclarativeGeoRectangle::shape() const /*! \qmlmethod bool QDeclarativeGeoRectangle::contains(Coordinate coordinate) - Returns the true if \a coordinate is within the bounding box; otherwise returns false. + Returns the true if \a coordinate is within the geo rectangle; otherwise returns false. */ bool QDeclarativeGeoRectangle::contains(QDeclarativeCoordinate *coordinate) { @@ -154,7 +151,7 @@ QDeclarativeCoordinate *QDeclarativeGeoRectangle::bottomLeft() /*! \qmlproperty Coordinate GeoRectangle::bottomLeft - This property holds the bottom left coordinate of this bounding box. + This property holds the bottom left coordinate of this geo rectangle. Note: this property's changed() signal is currently emitted only if the whole element changes, not if only the contents of the element change. diff --git a/src/imports/location/qdeclarativegeoroutemodel.cpp b/src/imports/location/qdeclarativegeoroutemodel.cpp index 696bf5cc..3e9252f2 100644 --- a/src/imports/location/qdeclarativegeoroutemodel.cpp +++ b/src/imports/location/qdeclarativegeoroutemodel.cpp @@ -70,7 +70,7 @@ QT_BEGIN_NAMESPACE this must be set before the RouteModel can do any useful work. Once the plugin is set, create a \l RouteQuery with the appropriate - waypoints and other settings, and set the \l{RouteModel}'s \l{query} + waypoints and other settings, and set the RouteModel's \l{query} property. If \l autoUpdate is enabled, the update will being automatically. Otherwise, the \l{update} method may be used. By default, autoUpdate is disabled. @@ -881,7 +881,7 @@ void QDeclarativeGeoRouteQuery::removeExcludedArea(QDeclarativeGeoRectangle *are Clears all excluded areas (areas that the route must not cross). - \sa addExcludedArea, removeExcludedAreas + \sa addExcludedArea, removeExcludedArea */ void QDeclarativeGeoRouteQuery::clearExcludedAreas() @@ -962,7 +962,7 @@ void QDeclarativeGeoRouteQuery::removeWaypoint(QDeclarativeCoordinate *waypoint) Clears all waypoints. - \sa removeWaypoint, addWaypoints + \sa removeWaypoint, addWaypoint */ void QDeclarativeGeoRouteQuery::clearWaypoints() @@ -1023,7 +1023,7 @@ void QDeclarativeGeoRouteQuery::setFeatureWeight(FeatureType featureType, Featur Resets all feature weights to their default state (NeutralFeatureWeight). - \sa featureTypes, setFeatureWeights, featureWeight + \sa featureTypes, setFeatureWeight, featureWeight */ void QDeclarativeGeoRouteQuery::resetFeatureWeights() { diff --git a/src/imports/location/qdeclarativegeoserviceprovider.cpp b/src/imports/location/qdeclarativegeoserviceprovider.cpp index 5c6eb9b1..79e18f60 100644 --- a/src/imports/location/qdeclarativegeoserviceprovider.cpp +++ b/src/imports/location/qdeclarativegeoserviceprovider.cpp @@ -60,8 +60,9 @@ QT_BEGIN_NAMESPACE Plugins recognized by the system have a \l name property, a simple string normally indicating the name of the service that the Plugin retrieves - data from. They also have a variety of features, which can be enumerated - using the \l supported property. + data from. They also have a variety of features, which can be test for using the + \l {supportsRouting()}, \l {supportsGeocoding()}, \l {supportsMapping()} and + \l {supportsPlaces()} methods. When a Plugin element is created, it is "detached" and not associated with any actual service plugin. Once it has received information via setting @@ -80,7 +81,7 @@ QT_BEGIN_NAMESPACE Plugin { id: plugin preferred: ["nokia", "foo"] - required: Plugin.MappingFeature | Plugin.GeocodingFeature + required: Plugin.AnyMappingFeatures | Plugin.AnyGeocodingFeatures } \endcode */ @@ -190,7 +191,36 @@ void QDeclarativeGeoServiceProvider::componentComplete() } /*! - \internal + \qmlmethod bool Plugin::supportsGeocoding(GeocodingFeatures features) + + This method returns a boolean indicating whether the specified set of \a features are supported + by the geo service provider plugin. True is returned if all specified \a features are + supported; otherwise false is returned. + + The \a features parameter can be any flag combination of: + \table + \header + \li Feature + \li Description + \row + \li Plugin.NoGeocodingFeatures + \li No geocoding features are supported. + \row + \li Plugin.OnlineGeocodingFeature + \li Online geocoding is supported. + \row + \li Plugin.OfflineGeocodingFeature + \li Offline geocoding is supported. + \row + \li Plugin.ReverseGeocodingFeature + \li Reverse geocoding is supported. + \row + \li Plugin.LocalizedGeocodingFeature + \li Supports returning geocoding results with localized addresses. + \row + \li Plugin.AnyGeocodingFeatures + \li Matches a geo service provider that provides any geocoding features. + \endtable */ bool QDeclarativeGeoServiceProvider::supportsGeocoding(const GeocodingFeatures &feature) const { @@ -204,7 +234,33 @@ bool QDeclarativeGeoServiceProvider::supportsGeocoding(const GeocodingFeatures & } /*! - \internal + \qmlmethod bool Plugin::supportsMapping(MappingFeatures features) + + This method returns a boolean indicating whether the specified set of \a features are supported + by the geo service provider plugin. True is returned if all specified \a features are + supported; otherwise false is returned. + + The \a features parameter can be any flag combination of: + \table + \header + \li Feature + \li Description + \row + \li Plugin.NoMappingFeatures + \li No mapping features are supported. + \row + \li Plugin.OnlineMappingFeature + \li Online mapping is supported. + \row + \li Plugin.OfflineMappingFeature + \li Offline mapping is supported. + \row + \li Plugin.LocalizedMappingFeature + \li Supports returning localized map data. + \row + \li Plugin.AnyMappingFeatures + \li Matches a geo service provider that provides any mapping features. + \endtable */ bool QDeclarativeGeoServiceProvider::supportsMapping(const MappingFeatures &feature) const { @@ -218,7 +274,42 @@ bool QDeclarativeGeoServiceProvider::supportsMapping(const MappingFeatures &feat } /*! - \internal + \qmlmethod bool Plugin::supportsRouting(RoutingFeatures features) + + This method returns a boolean indicating whether the specified set of \a features are supported + by the geo service provider plugin. True is returned if all specified \a features are + supported; otherwise false is returned. + + The \a features parameter can be any flag combination of: + \table + \header + \li Feature + \li Description + \row + \li Plugin.NoRoutingFeatures + \li No routing features are supported. + \row + \li Plugin.OnlineRoutingFeature + \li Online routing is supported. + \row + \li Plugin.OfflineRoutingFeature + \li Offline routing is supported. + \row + \li Plugin.LocalizedRoutingFeature + \li Supports returning routes with localized addresses and instructions. + \row + \li Plugin.RouteUpdatesFeature + \li Updating an existing route based on the current position is supported. + \row + \li Plugin.AlternativeRoutesFeature + \li Supports returning alternative routes. + \row + \li Plugin.ExcludeAreasRoutingFeature + \li Supports specifying a areas which the returned route must not cross. + \row + \li Plugin.AnyRoutingFeatures + \li Matches a geo service provider that provides any routing features. + \endtable */ bool QDeclarativeGeoServiceProvider::supportsRouting(const RoutingFeatures &feature) const { @@ -232,55 +323,52 @@ bool QDeclarativeGeoServiceProvider::supportsRouting(const RoutingFeatures &feat } /*! + \qmlmethod bool Plugin::supportsPlaces(PlacesFeatures features) - \qmlmethod Plugin::supportsPlaces(PlacesFeatures features) - - This method returns a boolean indicating whether the specified set of - \a features flags is supported or not. True is returned if it is supported, - otherwise false is returned. + This method returns a boolean indicating whether the specified set of \a features are supported + by the geo service provider plugin. True is returned if all specified \a features are + supported; otherwise false is returned. - \target PluginPlacesFeatures - The \a features parameter can be any flag combination of: + The \a features parameter can be any flag combination of: \table \header \li Feature \li Description \row \li Plugin.NoPlacesFeatures - \li No features supported + \li No places features are supported. \row \li Plugin.OnlinePlacesFeature - \li Place data online + \li Online places is supported. \row \li Plugin.OfflinePlacesFeature - \li Supports offline data for places + \li Offline places is supported. \row \li Plugin.SavePlaceFeature - \li Can save place data + \li Saving categories is supported. \row \li Plugin.RemovePlaceFeature - \li Supports removal of a place + \li Removing or deleting places is supported. \row \li Plugin.PlaceRecommendationsFeature - \li Supports user recommendations + \li Searching for recommended places similar to another place is supported. \row \li Plugin.SearchSuggestionsFeature - \li Supports suggestions to user query + \li Search suggestions is supported. \row \li Plugin.LocalizedPlacesFeature - \li Local places + \li Supports returning localized place data. \row \li Plugin.NotificationsFeature - \li Notify user of place event + \li Notifications of place and category changes is supported. \row \li Plugin.PlaceMatchingFeature - \li Find places + \li Supports matching places from two different geo service providers. \row \li Plugin.AnyPlacesFeatures - \li Are any features supported + \li Matches a geo service provider that provides any places features. \endtable - - */ +*/ bool QDeclarativeGeoServiceProvider::supportsPlaces(const PlacesFeatures &features) const { QGeoServiceProvider *sp = sharedGeoServiceProvider(); @@ -666,19 +754,19 @@ bool QDeclarativeGeoServiceProviderRequirements::matches(const QGeoServiceProvid To set such a parameter, declare a PluginParameter inside a \l Plugin element, and give it \l{name} and \l{value} properties. A list of valid - parameter names for each plugin is available from the plugin reference - page (linked from \l{qtlocation-module}{the QtLocation module page}). + parameter names for each plugin is available from the + \l {Qt Location Module#Plugin References and Parameters}{plugin reference pages}. \section2 Example Usage - The following example shows an instantiation of the - \l{location-plugin-nokia}{Nokia} plugin with a mapping API token specific - to the application. + The following example shows an instantiation of the \l {Qt Location Nokia Plugin}{Nokia} plugin + with a mapping API \e app_id and \e token pair specific to the application. \code Plugin { name: "nokia" - PluginParameter { name: "token"; value: "SOMETOKEN123" } + PluginParameter { name: "app_id"; value: "EXAMPLE_API_ID" } + PluginParameter { name: "token"; value: "EXAMPLE_TOKEN_123" } } \endcode */ diff --git a/src/imports/location/qdeclarativepolygonmapitem.cpp b/src/imports/location/qdeclarativepolygonmapitem.cpp index 1b7c7cb0..a50c2aab 100644 --- a/src/imports/location/qdeclarativepolygonmapitem.cpp +++ b/src/imports/location/qdeclarativepolygonmapitem.cpp @@ -97,9 +97,8 @@ QT_BEGIN_NAMESPACE or removing points. Like the other map objects, MapPolygon is normally drawn without a smooth - appearance. Setting the \l opacity property will force the object to be - blended, which decreases performance considerably depending on the hardware - in use. + appearance. Setting the \l {QtQuick2::Item::opacity}{opacity} property will force the object to + be blended, which decreases performance considerably depending on the hardware in use. \section2 Example Usage diff --git a/src/imports/location/qdeclarativepolylinemapitem.cpp b/src/imports/location/qdeclarativepolylinemapitem.cpp index be7c351a..ffbab100 100644 --- a/src/imports/location/qdeclarativepolylinemapitem.cpp +++ b/src/imports/location/qdeclarativepolylinemapitem.cpp @@ -81,11 +81,10 @@ QT_BEGIN_NAMESPACE the Map grows in direct proportion to the number of points in the polyline. Like the other map objects, MapPolyline is normally drawn without a smooth - appearance. Setting the \l opacity property will force the object to be - blended, which decreases performance considerably depending on the hardware - in use. + appearance. Setting the \l {QtQuick2::Item::opacity}{opacity} property will force the object to + be blended, which decreases performance considerably depending on the hardware in use. - \b{NOTE:} MapPolylines are implemented using the OpenGL GL_LINES + \note MapPolylines are implemented using the OpenGL GL_LINES primitive. There have been occasional reports of issues and rendering inconsistencies on some (particularly quite old) platforms. No workaround is yet available for these issues. diff --git a/src/imports/location/qdeclarativepositionsource.cpp b/src/imports/location/qdeclarativepositionsource.cpp index fe2439f0..55ba9c0a 100644 --- a/src/imports/location/qdeclarativepositionsource.cpp +++ b/src/imports/location/qdeclarativepositionsource.cpp @@ -85,7 +85,7 @@ QT_BEGIN_NAMESPACE When the PositionSource is active, position updates can be retrieved either by simply using the \l{position} property in a binding (as the value of another item's property), or by providing an implementation of - the \l{onPositionChanged} signal-handler. + the \c {onPositionChanged} signal-handler. \section2 Example Usage @@ -143,7 +143,7 @@ QDeclarativePositionSource::~QDeclarativePositionSource() /*! - \qmlproperty string PositionSource::plugin + \qmlproperty string PositionSource::name This property holds the unique internal name for the plugin currently providing position information. @@ -493,7 +493,7 @@ bool QDeclarativePositionSource::isActive() const whose validity can be checked with appropriate validity functions (for example sometimes an update does not have speed or altitude data). - However, whenever a \l positionChanged signal has been received, at least + However, whenever a \c {positionChanged} signal has been received, at least position::coordinate::latitude, position::coordinate::longitude, and position::timestamp can be assumed to be valid. |