From a54ecd3d19c871461b77f8e0a01bb5c13fd9fca6 Mon Sep 17 00:00:00 2001 From: Jerome Pasion Date: Wed, 25 Sep 2013 13:14:40 +0200 Subject: Doc: Fixed broken Location links due to version number. -Documentation should not have the version number. -Links and documentation with type version number no longer recommended because it is a maintainability and consistency issue. Use :: to link to a QML type. Change-Id: I830407e68f0a91f3fb9a5deb3fb5a9a02a100a34 Reviewed-by: Alex Blasche --- .../qdeclarativecontactdetail.cpp | 12 ++--- .../qdeclarativeplaceeditorialmodel.cpp | 2 +- .../qdeclarativeplaceimagemodel.cpp | 2 +- .../declarativeplaces/qdeclarativeplaceuser.cpp | 6 +-- .../declarativeplaces/qdeclarativereviewmodel.cpp | 8 +-- .../qdeclarativesearchsuggestionmodel.cpp | 2 +- .../qdeclarativesupportedcategoriesmodel.cpp | 4 +- src/imports/location/qdeclarativegeocodemodel.cpp | 28 +++++------ src/imports/location/qdeclarativegeomap.cpp | 34 ++++++------- .../location/qdeclarativegeomapgesturearea.cpp | 40 +++++++-------- .../location/qdeclarativegeomapitemview.cpp | 6 +-- .../location/qdeclarativegeomapmousearea.cpp | 32 ++++++------ .../location/qdeclarativegeomapmouseevent.cpp | 16 +++--- src/imports/location/qdeclarativegeoroute.cpp | 10 ++-- src/imports/location/qdeclarativegeoroutemodel.cpp | 42 ++++++++-------- .../location/qdeclarativegeoroutesegment.cpp | 8 +-- .../doc/src/examples/declarative-mapviewer.qdoc | 20 ++++---- .../doc/src/examples/declarative-places.qdoc | 4 +- src/location/doc/src/maps.qdoc | 58 +++++++++++----------- src/location/doc/src/qml-maps.qdoc | 2 +- src/location/doc/src/qtlocation-qml.qdoc | 6 +-- 21 files changed, 171 insertions(+), 171 deletions(-) diff --git a/src/imports/location/declarativeplaces/qdeclarativecontactdetail.cpp b/src/imports/location/declarativeplaces/qdeclarativecontactdetail.cpp index ef30c5d9..6ea87435 100644 --- a/src/imports/location/declarativeplaces/qdeclarativecontactdetail.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativecontactdetail.cpp @@ -51,10 +51,10 @@ \brief The ContactDetails type holds contact details for a \l Place. - The ContactDetails type is a map of \l {QtLocation5::ContactDetail}{ContactDetail} objects. + The ContactDetails type is a map of \l {QtLocation::ContactDetail}{ContactDetail} objects. To access contact details in the map use the \l keys() method to get the list of keys stored in the map and then use the \c {[]} operator to access the - \l {QtLocation5::ContactDetail}{ContactDetail} items. + \l {QtLocation::ContactDetail}{ContactDetail} items. The following keys are defined in the API. \l Plugin implementations are free to define additional keys. @@ -72,7 +72,7 @@ \section1 Examples - The following example shows how to access all \l {QtLocation5::ContactDetail}{ContactDetails} + The following example shows how to access all \l {QtLocation::ContactDetail}{ContactDetails} and print them to the console: \snippet declarative/places.qml QtLocation import @@ -161,7 +161,7 @@ QDeclarativeContactDetail::~QDeclarativeContactDetail() } /*! - \qmlproperty QPlaceContactDetail QtLocation5::ContactDetail::contactDetail + \qmlproperty QPlaceContactDetail QtLocation::ContactDetail::contactDetail For details on how to use this property to interface between C++ and QML see "\l {location-cpp-qml.html#contact_detail} {Interfaces between C++ and QML Code}". @@ -183,7 +183,7 @@ QPlaceContactDetail QDeclarativeContactDetail::contactDetail() const } /*! - \qmlproperty string QtLocation5::ContactDetail::label + \qmlproperty string QtLocation::ContactDetail::label This property holds a label describing the contact detail. @@ -205,7 +205,7 @@ void QDeclarativeContactDetail::setLabel(const QString &label) } /*! - \qmlproperty string QtLocation5::ContactDetail::value + \qmlproperty string QtLocation::ContactDetail::value This property holds the value of the contact detail which may be a phone number, an email address, a website url and so on. diff --git a/src/imports/location/declarativeplaces/qdeclarativeplaceeditorialmodel.cpp b/src/imports/location/declarativeplaces/qdeclarativeplaceeditorialmodel.cpp index 2578fe6a..e2dbcdc5 100644 --- a/src/imports/location/declarativeplaces/qdeclarativeplaceeditorialmodel.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativeplaceeditorialmodel.cpp @@ -91,7 +91,7 @@ QT_BEGIN_NAMESPACE \li The supplier of the editorial. \row \li user - \li \l {QtLocation5::User}{User} + \li \l {QtLocation::User}{User} \li The user who contributed the editorial. \row \li attribution diff --git a/src/imports/location/declarativeplaces/qdeclarativeplaceimagemodel.cpp b/src/imports/location/declarativeplaces/qdeclarativeplaceimagemodel.cpp index 780887b8..5505ef53 100644 --- a/src/imports/location/declarativeplaces/qdeclarativeplaceimagemodel.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativeplaceimagemodel.cpp @@ -91,7 +91,7 @@ QT_BEGIN_NAMESPACE \li The supplier of the image. \row \li user - \li \l {QtLocation5::User}{User} + \li \l {QtLocation::User}{User} \li The user who contributed the image. \row \li attribution diff --git a/src/imports/location/declarativeplaces/qdeclarativeplaceuser.cpp b/src/imports/location/declarativeplaces/qdeclarativeplaceuser.cpp index 2f77c45b..dc1b61e4 100644 --- a/src/imports/location/declarativeplaces/qdeclarativeplaceuser.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativeplaceuser.cpp @@ -80,7 +80,7 @@ QDeclarativePlaceUser::QDeclarativePlaceUser(const QPlaceUser &user, QDeclarativePlaceUser::~QDeclarativePlaceUser() {} /*! - \qmlproperty QPlaceUser QtLocation5::User::user + \qmlproperty QPlaceUser QtLocation::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}". @@ -103,7 +103,7 @@ QPlaceUser QDeclarativePlaceUser::user() const } /*! - \qmlproperty string QtLocation5::User::userId + \qmlproperty string QtLocation::User::userId This property holds the unique identifier of the user. */ @@ -123,7 +123,7 @@ QString QDeclarativePlaceUser::userId() const } /*! - \qmlproperty string QtLocation5::User::name + \qmlproperty string QtLocation::User::name This property holds the name of a user. */ diff --git a/src/imports/location/declarativeplaces/qdeclarativereviewmodel.cpp b/src/imports/location/declarativeplaces/qdeclarativereviewmodel.cpp index d21fa56d..113fbde7 100644 --- a/src/imports/location/declarativeplaces/qdeclarativereviewmodel.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativereviewmodel.cpp @@ -105,7 +105,7 @@ QT_BEGIN_NAMESPACE \li The supplier of the review. \row \li user - \li \l {QtLocation5::User}{User} + \li \l {QtLocation::User}{User} \li The user who contributed the review. \row \li attribution @@ -115,19 +115,19 @@ QT_BEGIN_NAMESPACE */ /*! - \qmlproperty Place QtLocation5::ReviewModel::place + \qmlproperty Place QtLocation::ReviewModel::place This property holds the Place that the reviews are for. */ /*! - \qmlproperty int QtLocation5::ReviewModel::batchSize + \qmlproperty int QtLocation::ReviewModel::batchSize This property holds the batch size to use when fetching more reviews. */ /*! - \qmlproperty int QtLocation5::ReviewModel::totalCount + \qmlproperty int QtLocation::ReviewModel::totalCount This property holds the total number of reviews for the place. */ diff --git a/src/imports/location/declarativeplaces/qdeclarativesearchsuggestionmodel.cpp b/src/imports/location/declarativeplaces/qdeclarativesearchsuggestionmodel.cpp index 237f4fae..cfff8d2e 100644 --- a/src/imports/location/declarativeplaces/qdeclarativesearchsuggestionmodel.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativesearchsuggestionmodel.cpp @@ -214,7 +214,7 @@ QT_USE_NAMESPACE /*! - \qmlmethod string QtLocation5::PlaceSearchSuggestionModel::errorString() const + \qmlmethod string QtLocation::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 c562bc71..38a73f2e 100644 --- a/src/imports/location/declarativeplaces/qdeclarativesupportedcategoriesmodel.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativesupportedcategoriesmodel.cpp @@ -108,14 +108,14 @@ QT_USE_NAMESPACE */ /*! - \qmlmethod string QtLocation5::CategoryModel::data(ModelIndex index, int role) + \qmlmethod string QtLocation::CategoryModel::data(ModelIndex index, int role) \internal This method retrieves the the model's data per \a index and \a role. */ /*! - \qmlmethod string QtLocation5::CategoryModel::errorString() const + \qmlmethod string QtLocation::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/qdeclarativegeocodemodel.cpp b/src/imports/location/qdeclarativegeocodemodel.cpp index ecd8c749..797f7ee8 100644 --- a/src/imports/location/qdeclarativegeocodemodel.cpp +++ b/src/imports/location/qdeclarativegeocodemodel.cpp @@ -133,7 +133,7 @@ void QDeclarativeGeocodeModel::componentComplete() } /*! - \qmlmethod QtLocation5::GeocodeModel::update() + \qmlmethod QtLocation::GeocodeModel::update() Instructs the GeocodeModel to update its data. This is most useful when \l autoUpdate is disabled, to force a refresh when the query @@ -297,7 +297,7 @@ void QDeclarativeGeocodeModel::pluginReady() } /*! - \qmlproperty Plugin QtLocation5::GeocodeModel::plugin + \qmlproperty Plugin QtLocation::GeocodeModel::plugin This property holds the plugin that provides the actual geocoding service. Note that all plugins do not necessarily provide geocoding (could for example provide @@ -331,7 +331,7 @@ void QDeclarativeGeocodeModel::setBounds(const QVariant &boundingArea) } /*! - \qmlproperty geoshape QtLocation5::GeocodeModel::bounds + \qmlproperty geoshape QtLocation::GeocodeModel::bounds This property holds the bounding area used to limit the results to those within the area. This is particularly useful if query is only partially filled out, @@ -391,7 +391,7 @@ void QDeclarativeGeocodeModel::geocodeError(QGeoCodeReply *reply, } /*! - \qmlproperty enumeration QtLocation5::GeocodeModel::status + \qmlproperty enumeration QtLocation::GeocodeModel::status This read-only property holds the current status of the model. @@ -417,7 +417,7 @@ void QDeclarativeGeocodeModel::setStatus(QDeclarativeGeocodeModel::Status status } /*! - \qmlproperty enumeration QtLocation5::GeocodeModel::error + \qmlproperty enumeration QtLocation::GeocodeModel::error This read-only property holds the latest error value of the geocoding request. @@ -446,7 +446,7 @@ void QDeclarativeGeocodeModel::setError(GeocodeError error) } /*! - \qmlproperty string QtLocation5::GeocodeModel::errorString + \qmlproperty string QtLocation::GeocodeModel::errorString This read-only property holds the textual presentation of latest geocoding error. If no error has occurred or the model has been reset, an empty string is returned. @@ -484,7 +484,7 @@ void QDeclarativeGeocodeModel::setLocations(const QList &locations } /*! - \qmlproperty int QtLocation5::GeocodeModel::count + \qmlproperty int QtLocation::GeocodeModel::count This property holds how many locations the model currently has. Amongst other uses, you can use this value when accessing locations @@ -497,7 +497,7 @@ int QDeclarativeGeocodeModel::count() const } /*! - \qmlmethod Location QtLocation5::GeocodeModel::get(int) + \qmlmethod Location QtLocation::GeocodeModel::get(int) Returns the Location at given index. Use \l count property to check the amount of locations available. The locations are indexed from zero, so the accessible range @@ -516,7 +516,7 @@ QDeclarativeGeoLocation *QDeclarativeGeocodeModel::get(int index) } /*! - \qmlproperty int QtLocation5::GeocodeModel::limit + \qmlproperty int QtLocation::GeocodeModel::limit This property holds the maximum number of results. The limit and \l offset values are only applicable with free string geocoding (that is they are not considered when using addresses @@ -543,7 +543,7 @@ void QDeclarativeGeocodeModel::setLimit(int limit) } /*! - \qmlproperty int QtLocation5::GeocodeModel::offset + \qmlproperty int QtLocation::GeocodeModel::offset This property tells not to return the first 'offset' number of the results. The \l limit and offset values are only applicable with free string geocoding (that is they are not considered @@ -569,7 +569,7 @@ void QDeclarativeGeocodeModel::setOffset(int offset) } /*! - \qmlmethod QtLocation5::GeocodeModel::reset() + \qmlmethod QtLocation::GeocodeModel::reset() Resets the model. All location data is cleared, any outstanding requests are aborted and possible errors are cleared. Model status will be set @@ -592,7 +592,7 @@ void QDeclarativeGeocodeModel::reset() } /*! - \qmlmethod QtLocation5::GeocodeModel::cancel() + \qmlmethod QtLocation::GeocodeModel::cancel() Cancels any outstanding requests and clears errors. Model status will be set to either GeocodeModel.Null or GeocodeModel.Ready. @@ -606,7 +606,7 @@ void QDeclarativeGeocodeModel::cancel() } /*! - \qmlproperty QVariant QtLocation5::GeocodeModel::query + \qmlproperty QVariant QtLocation::GeocodeModel::query This property holds the data of the geocoding request. The property accepts three types of queries which determine both the data and @@ -676,7 +676,7 @@ void QDeclarativeGeocodeModel::setQuery(const QVariant &query) } /*! - \qmlproperty bool QtLocation5::GeocodeModel::autoUpdate + \qmlproperty bool QtLocation::GeocodeModel::autoUpdate This property controls whether the Model automatically updates in response to changes in its attached query. The default value of this property diff --git a/src/imports/location/qdeclarativegeomap.cpp b/src/imports/location/qdeclarativegeomap.cpp index 5bf9a1ac..9ce48afe 100644 --- a/src/imports/location/qdeclarativegeomap.cpp +++ b/src/imports/location/qdeclarativegeomap.cpp @@ -357,7 +357,7 @@ bool QDeclarativeGeoMap::mouseEvent(QMouseEvent *event) /*! - \qmlproperty MapGestureArea QtLocation5::Map::gesture + \qmlproperty MapGestureArea QtLocation::Map::gesture Contains the MapGestureArea created with the Map. This covers pan, flick and pinch gestures. Use \c{gesture.enabled: true} to enable basic gestures, or see \l{MapGestureArea} for @@ -438,7 +438,7 @@ QSGNode *QDeclarativeGeoMap::updatePaintNode(QSGNode *oldNode, UpdatePaintNodeDa /*! - \qmlproperty Plugin QtLocation5::Map::plugin + \qmlproperty Plugin QtLocation::Map::plugin This property holds the plugin which provides the mapping functionality. @@ -567,7 +567,7 @@ QDeclarativeGeoServiceProvider *QDeclarativeGeoMap::plugin() const } /*! - \qmlproperty real QtLocation5::Map::minimumZoomLevel + \qmlproperty real QtLocation::Map::minimumZoomLevel This property holds the minimum valid zoom level for the map. @@ -584,7 +584,7 @@ qreal QDeclarativeGeoMap::minimumZoomLevel() const } /*! -\qmlproperty real QtLocation5::Map::maximumZoomLevel +\qmlproperty real QtLocation::Map::maximumZoomLevel This property holds the maximum valid zoom level for the map. @@ -676,7 +676,7 @@ void QDeclarativeGeoMap::setTilt(qreal tilt) } /*! - \qmlproperty real QtLocation5::Map::zoomLevel + \qmlproperty real QtLocation::Map::zoomLevel This property holds the zoom level for the map. @@ -711,7 +711,7 @@ qreal QDeclarativeGeoMap::zoomLevel() const } /*! -\qmlproperty coordinate QtLocation5::Map::center +\qmlproperty coordinate QtLocation::Map::center This property holds the coordinate which occupies the center of the mapping viewport. @@ -785,7 +785,7 @@ void QDeclarativeGeoMap::mapCenterChanged(AnimatableCoordinate center) } /*! - \qmlproperty list QtLocation5::Map::supportedMapTypes + \qmlproperty list QtLocation::Map::supportedMapTypes This read-only property holds the set of \l{MapType}{map types} supported by this map. @@ -797,7 +797,7 @@ QQmlListProperty QDeclarativeGeoMap::supportedMapTypes() } /*! - \qmlmethod QtLocation5::Map::toCoordinate(QPointF screenPosition) + \qmlmethod QtLocation::Map::toCoordinate(QPointF screenPosition) Returns the coordinate which corresponds to the screen position \a screenPosition. @@ -815,7 +815,7 @@ QGeoCoordinate QDeclarativeGeoMap::toCoordinate(const QPointF &screenPosition) c } /*! -\qmlmethod QtLocation5::Map::toScreenPosition(coordinate coordinate) +\qmlmethod QtLocation::Map::toScreenPosition(coordinate coordinate) Returns the screen position which corresponds to the coordinate \a coordinate. @@ -833,7 +833,7 @@ QPointF QDeclarativeGeoMap::toScreenPosition(const QGeoCoordinate &coordinate) c } /*! - \qmlmethod void QtLocation5::Map::pan(int dx, int dy) + \qmlmethod void QtLocation::Map::pan(int dx, int dy) Starts panning the map by \a dx pixels along the x-axis and by \a dy pixels along the y-axis. @@ -852,7 +852,7 @@ void QDeclarativeGeoMap::pan(int dx, int dy) /*! - \qmlmethod void QtLocation5::Map::cameraStopped() + \qmlmethod void QtLocation::Map::cameraStopped() Optional hint that allows the map to prefetch during this idle period */ @@ -910,7 +910,7 @@ bool QDeclarativeGeoMap::childMouseEventFilter(QQuickItem *item, QEvent *event) } /*! - \qmlmethod QtLocation5::Map::addMapItem(MapItem item) + \qmlmethod QtLocation::Map::addMapItem(MapItem item) Adds the given \a item to the Map (for example MapQuickItem, MapCircle). If the object already is on the Map, it will not be added again. @@ -942,7 +942,7 @@ void QDeclarativeGeoMap::addMapItem(QDeclarativeGeoMapItemBase *item) } /*! - \qmlproperty list QtLocation5::Map::mapItems + \qmlproperty list QtLocation::Map::mapItems Returns the list of all map items in no particular order. These items include items that were declared statically as part of @@ -963,7 +963,7 @@ QList QDeclarativeGeoMap::mapItems() } /*! - \qmlmethod void QtLocation5::Map::removeMapItem(MapItem item) + \qmlmethod void QtLocation::Map::removeMapItem(MapItem item) Removes the given \a item from the Map (for example MapQuickItem, MapCircle). If the MapItem does not exist or was not previously added to the map, the @@ -989,7 +989,7 @@ void QDeclarativeGeoMap::removeMapItem(QDeclarativeGeoMapItemBase *ptr) } /*! - \qmlmethod void QtLocation5::Map::clearMapItems() + \qmlmethod void QtLocation::Map::clearMapItems() Removes all items from the map. @@ -1013,7 +1013,7 @@ void QDeclarativeGeoMap::clearMapItems() } /*! - \qmlproperty MapType QtLocation5::Map::activeMapType + \qmlproperty MapType QtLocation::Map::activeMapType \brief Access to the currently active \l{MapType}{map type}. @@ -1047,7 +1047,7 @@ void QDeclarativeGeoMap::geometryChanged(const QRectF &newGeometry, const QRectF } /*! - \qmlmethod QtLocation5::Map::fitViewportToMapItems() + \qmlmethod QtLocation::Map::fitViewportToMapItems() Fits the current viewport to the boundary of all map items. The camera is positioned in the center of the map items, and at the largest integral zoom level possible which diff --git a/src/imports/location/qdeclarativegeomapgesturearea.cpp b/src/imports/location/qdeclarativegeomapgesturearea.cpp index 271b40cc..80b484b7 100644 --- a/src/imports/location/qdeclarativegeomapgesturearea.cpp +++ b/src/imports/location/qdeclarativegeomapgesturearea.cpp @@ -104,13 +104,13 @@ QT_BEGIN_NAMESPACE */ /*! - \qmlproperty QPoint QtLocation5::MapPinchEvent::center + \qmlproperty QPoint QtLocation::MapPinchEvent::center This read-only property holds the current center point. */ /*! - \qmlproperty real QtLocation5::MapPinchEvent::angle + \qmlproperty real QtLocation::MapPinchEvent::angle This read-only property holds the current angle between the two points in the range -180 to 180. Positive values for the angles mean counter-clockwise @@ -119,15 +119,15 @@ QT_BEGIN_NAMESPACE */ /*! - \qmlproperty QPoint QtLocation5::MapPinchEvent::point1 - \qmlproperty QPoint QtLocation5::MapPinchEvent::point2 + \qmlproperty QPoint QtLocation::MapPinchEvent::point1 + \qmlproperty QPoint QtLocation::MapPinchEvent::point2 These read-only properties hold the actual touch points generating the pinch. The points are not in any particular order. */ /*! - \qmlproperty int QtLocation5::MapPinchEvent::pointCount + \qmlproperty int QtLocation::MapPinchEvent::pointCount This read-only property holds the number of points currently touched. The MapPinch will not react until two touch points have initiated a gesture, @@ -135,7 +135,7 @@ QT_BEGIN_NAMESPACE */ /*! - \qmlproperty bool QtLocation5::MapPinchEvent::accepted + \qmlproperty bool QtLocation::MapPinchEvent::accepted Setting this property to false in the \c MapPinch::onPinchStarted handler will result in no further pinch events being generated, and the gesture @@ -187,7 +187,7 @@ QT_BEGIN_NAMESPACE */ /*! - \qmlproperty bool QtLocation5::MapGestureArea::enabled + \qmlproperty bool QtLocation::MapGestureArea::enabled This property holds whether the gestures are enabled. Note: disabling gestures during an active gesture does not have effect on @@ -196,7 +196,7 @@ QT_BEGIN_NAMESPACE /*! - \qmlproperty bool QtLocation5::MapGestureArea::panEnabled + \qmlproperty bool QtLocation::MapGestureArea::panEnabled This property holds whether the pan gestures are enabled. Note: disabling gestures during an active gesture does not have effect on @@ -204,7 +204,7 @@ QT_BEGIN_NAMESPACE */ /*! - \qmlproperty bool QtLocation5::MapGestureArea::pinchEnabled + \qmlproperty bool QtLocation::MapGestureArea::pinchEnabled This property holds whether the pinch gestures are enabled. Note: disabling gestures during an active gesture does not have effect on @@ -212,19 +212,19 @@ QT_BEGIN_NAMESPACE */ /*! - \qmlproperty bool QtLocation5::MapGestureArea::isPinchActive + \qmlproperty bool QtLocation::MapGestureArea::isPinchActive This read-only property holds whether any pinch gesture is active. */ /*! - \qmlproperty bool QtLocation5::MapGestureArea::isPanActive + \qmlproperty bool QtLocation::MapGestureArea::isPanActive This read-only property holds whether any pan gesture (panning or flicking) is active. */ /*! - \qmlproperty enumeration QtLocation5::MapGestureArea::activeGestures + \qmlproperty enumeration QtLocation::MapGestureArea::activeGestures This property holds the gestures that will be active. By default the zoom, pan and flick gestures are enabled. @@ -246,7 +246,7 @@ QT_BEGIN_NAMESPACE */ /*! - \qmlproperty real QtLocation5::MapGestureArea::maximumZoomLevelChange + \qmlproperty real QtLocation::MapGestureArea::maximumZoomLevelChange This property holds the maximum zoom level change per pinch, essentially meant to be used for setting the zoom sensitivity. @@ -275,7 +275,7 @@ QT_BEGIN_NAMESPACE */ /*! - \qmlsignal QtLocation5::MapGestureArea::pinchStarted(PinchEvent event) + \qmlsignal QtLocation::MapGestureArea::pinchStarted(PinchEvent event) Raised when a pinch gesture is started. @@ -283,7 +283,7 @@ QT_BEGIN_NAMESPACE */ /*! - \qmlsignal QtLocation5::MapGestureArea::pinchUpdated(PinchEvent event) + \qmlsignal QtLocation::MapGestureArea::pinchUpdated(PinchEvent event) Once a pinch has begun this event gets raised as the user moves her fingers across the map. @@ -292,7 +292,7 @@ QT_BEGIN_NAMESPACE */ /*! - \qmlsignal QtLocation5::MapGestureArea::pinchFinished(PinchEvent event) + \qmlsignal QtLocation::MapGestureArea::pinchFinished(PinchEvent event) The end of a pinch gesture is signaled by this event. @@ -300,7 +300,7 @@ QT_BEGIN_NAMESPACE */ /*! - \qmlsignal QtLocation5::MapGestureArea::panStarted() + \qmlsignal QtLocation::MapGestureArea::panStarted() This handler is called when the view begins moving due to user interaction. Typically this means that the user is dragging a finger - @@ -308,7 +308,7 @@ QT_BEGIN_NAMESPACE */ /*! - \qmlsignal QtLocation5::MapGestureArea::panFinished() + \qmlsignal QtLocation::MapGestureArea::panFinished() This handler is called when the view stops moving due to user interaction. If a flick was generated, this handler will @@ -319,7 +319,7 @@ QT_BEGIN_NAMESPACE */ /*! - \qmlsignal QtLocation5::MapGestureArea::flickStarted() + \qmlsignal QtLocation::MapGestureArea::flickStarted() This handler is called when the view is flicked. A flick starts from the point that the mouse or touch is released, @@ -327,7 +327,7 @@ QT_BEGIN_NAMESPACE */ /*! - \qmlsignal QtLocation5::MapGestureArea::flickFinished() + \qmlsignal QtLocation::MapGestureArea::flickFinished() This handler is called when the view stops moving due to a flick. The order of panFinished() and flickFinished() is not specified. diff --git a/src/imports/location/qdeclarativegeomapitemview.cpp b/src/imports/location/qdeclarativegeomapitemview.cpp index b87312d0..1ae8cb68 100644 --- a/src/imports/location/qdeclarativegeomapitemview.cpp +++ b/src/imports/location/qdeclarativegeomapitemview.cpp @@ -97,7 +97,7 @@ void QDeclarativeGeoMapItemView::componentComplete() } /*! - \qmlproperty model QtLocation5::MapItemView::model + \qmlproperty model QtLocation::MapItemView::model This property holds the model that provides data used for creating the map item defined by the delegate. @@ -180,7 +180,7 @@ void QDeclarativeGeoMapItemView::itemModelRowsRemoved(QModelIndex, int start, in } /*! - \qmlproperty Component QtLocation5::MapItemView::delegate + \qmlproperty Component QtLocation::MapItemView::delegate This property holds the delegate which defines how each item in the model should be displayed. The Component must contain exactly one @@ -203,7 +203,7 @@ void QDeclarativeGeoMapItemView::setDelegate(QQmlComponent *delegate) } /*! - \qmlproperty Component QtLocation5::MapItemView::autoFitViewport + \qmlproperty Component QtLocation::MapItemView::autoFitViewport This property controls whether to automatically pan and zoom the viewport to display all map items when items are added or removed. diff --git a/src/imports/location/qdeclarativegeomapmousearea.cpp b/src/imports/location/qdeclarativegeomapmousearea.cpp index 2466b0df..8146ecc3 100644 --- a/src/imports/location/qdeclarativegeomapmousearea.cpp +++ b/src/imports/location/qdeclarativegeomapmousearea.cpp @@ -140,7 +140,7 @@ QDeclarativeGeoMapMouseArea::~QDeclarativeGeoMapMouseArea() } /*! - \qmlmethod coordinate QtLocation5::MapMouseArea::mouseToCoordinate(MouseEvent event) + \qmlmethod coordinate QtLocation::MapMouseArea::mouseToCoordinate(MouseEvent event) Converts the \a event's coordinates to geo coordinates. */ @@ -320,8 +320,8 @@ QQuickItem *QDeclarativeGeoMapMouseArea::parentMapItem() } /*! - \qmlproperty real QtLocation5::MapMouseArea::mouseX - \qmlproperty real QtLocation5::MapMouseArea::mouseY + \qmlproperty real QtLocation::MapMouseArea::mouseX + \qmlproperty real QtLocation::MapMouseArea::mouseY These properties hold the screen coordinates of the mouse cursor. @@ -332,7 +332,7 @@ QQuickItem *QDeclarativeGeoMapMouseArea::parentMapItem() */ /*! - \qmlproperty bool QtLocation5::MapMouseArea::containsMouse + \qmlproperty bool QtLocation::MapMouseArea::containsMouse This property holds whether the mouse is currently inside the mouse area. \warning This property is not updated if the area moves under the mouse: \e containsMouse will not change. @@ -340,19 +340,19 @@ QQuickItem *QDeclarativeGeoMapMouseArea::parentMapItem() */ /*! - \qmlproperty bool QtLocation5::MapMouseArea::pressed + \qmlproperty bool QtLocation::MapMouseArea::pressed This property holds whether the mouse area is currently pressed. */ /*! - \qmlproperty bool QtLocation5::MapMouseArea::enabled + \qmlproperty bool QtLocation::MapMouseArea::enabled This property holds whether the item accepts mouse events. By default, this property is true. */ /*! - \qmlproperty MouseButton QtLocation5::MapMouseArea::pressedButtons + \qmlproperty MouseButton QtLocation::MapMouseArea::pressedButtons This property holds the mouse buttons currently pressed. It contains a bitwise combination of: @@ -366,7 +366,7 @@ QQuickItem *QDeclarativeGeoMapMouseArea::parentMapItem() */ /*! - \qmlproperty Qt::MouseButtons QtLocation5::MapMouseArea::acceptedButtons + \qmlproperty Qt::MouseButtons QtLocation::MapMouseArea::acceptedButtons This property holds the mouse buttons that the mouse area reacts to. The available buttons are: @@ -387,7 +387,7 @@ QQuickItem *QDeclarativeGeoMapMouseArea::parentMapItem() */ /*! - \qmlsignal QtLocation5::MapMouseArea::onPressed(MapMouseEvent mouse) + \qmlsignal QtLocation::MapMouseArea::onPressed(MapMouseEvent mouse) This handler is called when there is a press. @@ -403,7 +403,7 @@ QQuickItem *QDeclarativeGeoMapMouseArea::parentMapItem() */ /*! - \qmlsignal QtLocation5::MapMouseArea::onReleased(MapMouseEvent mouse) + \qmlsignal QtLocation::MapMouseArea::onReleased(MapMouseEvent mouse) This handler is called when there is a release. The \l {MapMouseEvent}{mouse} parameter provides information about the @@ -414,7 +414,7 @@ QQuickItem *QDeclarativeGeoMapMouseArea::parentMapItem() */ /*! - \qmlsignal QtLocation5::MapMouseArea::onClicked(MapMouseEvent mouse) + \qmlsignal QtLocation::MapMouseArea::onClicked(MapMouseEvent mouse) This handler is called when there is a click. A click is defined as a press followed by a release, both inside the MapMouseArea (pressing, @@ -429,7 +429,7 @@ QQuickItem *QDeclarativeGeoMapMouseArea::parentMapItem() */ /*! - \qmlsignal QtLocation5::MapMouseArea::onDoubleClicked(MapMouseEvent mouse) + \qmlsignal QtLocation::MapMouseArea::onDoubleClicked(MapMouseEvent mouse) This handler is called when there is a double-click (a press followed by a release followed by a press). @@ -444,7 +444,7 @@ QQuickItem *QDeclarativeGeoMapMouseArea::parentMapItem() */ /*! - \qmlsignal QtLocation5::MapMouseArea::onEntered() + \qmlsignal QtLocation::MapMouseArea::onEntered() This handler is called when the mouse enters the mouse area. @@ -455,7 +455,7 @@ QQuickItem *QDeclarativeGeoMapMouseArea::parentMapItem() */ /*! - \qmlsignal QtLocation5::MapMouseArea::onPositionChanged(MapMouseEvent mouse) + \qmlsignal QtLocation::MapMouseArea::onPositionChanged(MapMouseEvent mouse) This handler is called when the mouse position changes. @@ -468,7 +468,7 @@ QQuickItem *QDeclarativeGeoMapMouseArea::parentMapItem() */ /*! - \qmlsignal QtLocation5::MapMouseArea::onPressAndHold(MapMouseEvent mouse) + \qmlsignal QtLocation::MapMouseArea::onPressAndHold(MapMouseEvent mouse) This handler is called when there is a long press (currently 800ms). The \l {MapMouseEvent}{mouse} parameter provides information about the press, including the x and y @@ -478,7 +478,7 @@ QQuickItem *QDeclarativeGeoMapMouseArea::parentMapItem() */ /*! - \qmlsignal QtLocation5::MapMouseArea::onExited() + \qmlsignal QtLocation::MapMouseArea::onExited() This handler is called when the mouse exits the mouse area. diff --git a/src/imports/location/qdeclarativegeomapmouseevent.cpp b/src/imports/location/qdeclarativegeomapmouseevent.cpp index b1e730cb..23e245b9 100644 --- a/src/imports/location/qdeclarativegeomapmouseevent.cpp +++ b/src/imports/location/qdeclarativegeomapmouseevent.cpp @@ -77,7 +77,7 @@ QDeclarativeGeoMapMouseEvent::~QDeclarativeGeoMapMouseEvent() } /*! - \qmlproperty bool QtLocation5::MapMouseEvent::accepted + \qmlproperty bool QtLocation::MapMouseEvent::accepted Setting \a accepted to true prevents the mouse event from being propagated to items below the item currently handling the event. @@ -97,7 +97,7 @@ bool QDeclarativeGeoMapMouseEvent::accepted() const } /*! - \qmlproperty enumeration QtLocation5::MapMouseEvent::button + \qmlproperty enumeration QtLocation::MapMouseEvent::button This property holds the button that caused the event. It can be one of: @@ -121,7 +121,7 @@ int QDeclarativeGeoMapMouseEvent::button() const } /*! - \qmlproperty enumeration QtLocation5::MapMouseEvent::buttons + \qmlproperty enumeration QtLocation::MapMouseEvent::buttons This property holds the mouse buttons pressed when the event was generated. For mouse move events, this is all buttons that are pressed @@ -151,7 +151,7 @@ int QDeclarativeGeoMapMouseEvent::buttons() const } /*! - \qmlproperty int QtLocation5::MapMouseEvent::modifiers + \qmlproperty int QtLocation::MapMouseEvent::modifiers This property holds the keyboard modifier flags that existed immediately before the event occurred. @@ -178,7 +178,7 @@ int QDeclarativeGeoMapMouseEvent::modifiers() const } /*! - \qmlproperty bool QtLocation5::MapMouseEvent::wasHeld + \qmlproperty bool QtLocation::MapMouseEvent::wasHeld This property is true if the mouse button has been held pressed longer the threshold (800ms). */ @@ -194,7 +194,7 @@ bool QDeclarativeGeoMapMouseEvent::wasHeld() const } /*! - \qmlproperty int QtLocation5::MapMouseEvent::x + \qmlproperty int QtLocation::MapMouseEvent::x This property holds the x-screen coordinate of the position supplied by the mouse event. @@ -211,7 +211,7 @@ int QDeclarativeGeoMapMouseEvent::x() const } /*! - \qmlproperty int QtLocation5::MapMouseEvent::y + \qmlproperty int QtLocation::MapMouseEvent::y This property holds the y-screen coordinate of the position supplied by the mouse event. @@ -228,7 +228,7 @@ int QDeclarativeGeoMapMouseEvent::y() const } /*! - \qmlproperty coordinate QtLocation5::MapMouseEvent::coordinate + \qmlproperty coordinate QtLocation::MapMouseEvent::coordinate This property holds the coordinate corresponding to the latitude and longitude of the position on the map at which the mouse event diff --git a/src/imports/location/qdeclarativegeoroute.cpp b/src/imports/location/qdeclarativegeoroute.cpp index b814a862..db5c508f 100644 --- a/src/imports/location/qdeclarativegeoroute.cpp +++ b/src/imports/location/qdeclarativegeoroute.cpp @@ -114,7 +114,7 @@ QList QDeclarativeGeoRoute::routePath() } /*! - \qmlproperty georectangle QtLocation5::Route::bounds + \qmlproperty georectangle QtLocation::Route::bounds Read-only property which holds a bounding box which encompasses the entire route. @@ -126,7 +126,7 @@ QGeoRectangle QDeclarativeGeoRoute::bounds() const } /*! - \qmlproperty int QtLocation5::Route::travelTime + \qmlproperty int QtLocation::Route::travelTime Read-only property which holds the estimated amount of time it will take to traverse this route, in seconds. @@ -139,7 +139,7 @@ int QDeclarativeGeoRoute::travelTime() const } /*! - \qmlproperty real QtLocation5::Route::distance + \qmlproperty real QtLocation::Route::distance Read-only property which holds distance covered by this route, in meters. */ @@ -150,7 +150,7 @@ qreal QDeclarativeGeoRoute::distance() const } /*! - \qmlproperty QJSValue QtLocation5::Route::path + \qmlproperty QJSValue QtLocation::Route::path Read-only property which holds the geographical coordinates of this route. Coordinates are listed in the order in which they would be traversed by someone @@ -212,7 +212,7 @@ void QDeclarativeGeoRoute::setPath(const QJSValue &value) } /*! - \qmlproperty list QtLocation5::Route::segments + \qmlproperty list QtLocation::Route::segments Read-only property which holds the list of \l RouteSegment objects of this route. diff --git a/src/imports/location/qdeclarativegeoroutemodel.cpp b/src/imports/location/qdeclarativegeoroutemodel.cpp index d382767b..0b3ff80a 100644 --- a/src/imports/location/qdeclarativegeoroutemodel.cpp +++ b/src/imports/location/qdeclarativegeoroutemodel.cpp @@ -145,11 +145,11 @@ QDeclarativeGeoRouteModel::~QDeclarativeGeoRouteModel() } /*! - \qmlproperty int QtLocation5::RouteModel::count + \qmlproperty int QtLocation::RouteModel::count This property holds how many routes the model currently has. Amongst other uses, you can use this value when accessing routes - via the QtLocation5::RouteModel::get -method. + via the QtLocation::RouteModel::get -method. */ int QDeclarativeGeoRouteModel::count() const @@ -158,7 +158,7 @@ int QDeclarativeGeoRouteModel::count() const } /*! - \qmlmethod QtLocation5::RouteModel::reset() + \qmlmethod QtLocation::RouteModel::reset() Resets the model. All route data is cleared, any outstanding requests are aborted and possible errors are cleared. Model status will be set @@ -183,7 +183,7 @@ void QDeclarativeGeoRouteModel::reset() } /*! - \qmlmethod QtLocation5::RouteModel::cancel() + \qmlmethod QtLocation::RouteModel::cancel() Cancels any outstanding requests and clears errors. Model status will be set to either RouteModel.Null or RouteModel.Ready. @@ -210,7 +210,7 @@ void QDeclarativeGeoRouteModel::abortRequest() /*! - \qmlmethod QtLocation5::RouteModel::get(int) + \qmlmethod QtLocation::RouteModel::get(int) Returns the Route at given index. Use \l count property to check the amount of routes available. The routes are indexed from zero, so the accessible range @@ -328,7 +328,7 @@ void QDeclarativeGeoRouteModel::queryDetailsChanged() } /*! - \qmlproperty Plugin QtLocation5::RouteModel::plugin + \qmlproperty Plugin QtLocation::RouteModel::plugin This property holds the plugin that providers the actual routing service. Note that all plugins do not necessarily @@ -364,7 +364,7 @@ void QDeclarativeGeoRouteModel::setQuery(QDeclarativeGeoRouteQuery *query) } /*! - \qmlproperty RouteQuery QtLocation5::RouteModel::query + \qmlproperty RouteQuery QtLocation::RouteModel::query This property holds the data of the route request. The primary data are the waypoint coordinates and possible further @@ -389,7 +389,7 @@ void QDeclarativeGeoRouteModel::setAutoUpdate(bool autoUpdate) } /*! - \qmlproperty bool QtLocation5::RouteModel::autoUpdate + \qmlproperty bool QtLocation::RouteModel::autoUpdate This property controls whether the Model automatically updates in response to changes in its attached RouteQuery. The default value of this property @@ -422,7 +422,7 @@ void QDeclarativeGeoRouteModel::setStatus(QDeclarativeGeoRouteModel::Status stat } /*! - \qmlproperty enumeration QtLocation5::RouteModel::status + \qmlproperty enumeration QtLocation::RouteModel::status This read-only property holds the current status of the model. @@ -454,7 +454,7 @@ void QDeclarativeGeoRouteModel::setErrorString(const QString &error) } /*! - \qmlproperty string QtLocation5::RouteModel::errorString + \qmlproperty string QtLocation::RouteModel::errorString This read-only property holds the textual presentation of latest routing error. If no error has occurred or the model has been reset, an empty string is returned. @@ -469,7 +469,7 @@ QString QDeclarativeGeoRouteModel::errorString() const } /*! - \qmlproperty enumeration QtLocation5::RouteModel::error + \qmlproperty enumeration QtLocation::RouteModel::error This read-only property holds the latest error value of the routing request. @@ -497,7 +497,7 @@ void QDeclarativeGeoRouteModel::setError(RouteError error) } /*! - \qmlmethod QtLocation5::RouteModel::update() + \qmlmethod QtLocation::RouteModel::update() Instructs the RouteModel to update its data. This is most useful when \l autoUpdate is disabled, to force a refresh when the query @@ -837,7 +837,7 @@ void QDeclarativeGeoRouteQuery::setExcludedAreas(const QJSValue &value) } /*! - \qmlmethod QtLocation5::RouteQuery::addExcludedArea(georectangle) + \qmlmethod QtLocation::RouteQuery::addExcludedArea(georectangle) Adds the given area to excluded areas (areas that the route must not cross). Same area can only be added once. @@ -867,7 +867,7 @@ void QDeclarativeGeoRouteQuery::addExcludedArea(const QGeoRectangle &area) } /*! - \qmlmethod QtLocation5::RouteQuery::removeExcludedArea(georectangle) + \qmlmethod QtLocation::RouteQuery::removeExcludedArea(georectangle) Removes the given area to excluded areas (areas that the route must not cross). @@ -894,7 +894,7 @@ void QDeclarativeGeoRouteQuery::removeExcludedArea(const QGeoRectangle &area) } /*! - \qmlmethod QtLocation5::RouteQuery::clearExcludedAreas() + \qmlmethod QtLocation::RouteQuery::clearExcludedAreas() Clears all excluded areas (areas that the route must not cross). @@ -913,7 +913,7 @@ void QDeclarativeGeoRouteQuery::clearExcludedAreas() } /*! - \qmlmethod QtLocation5::RouteQuery::addWaypoint(coordinate) + \qmlmethod QtLocation::RouteQuery::addWaypoint(coordinate) Appends a coordinate to the list of waypoints. Same coordinate can be set multiple times. @@ -938,7 +938,7 @@ void QDeclarativeGeoRouteQuery::addWaypoint(const QGeoCoordinate &waypoint) } /*! - \qmlmethod QtLocation5::RouteQuery::removeWaypoint(coordinate) + \qmlmethod QtLocation::RouteQuery::removeWaypoint(coordinate) Removes the given from the list of waypoints. In case same coordinate appears multiple times, the most recently added coordinate instance is @@ -965,7 +965,7 @@ void QDeclarativeGeoRouteQuery::removeWaypoint(const QGeoCoordinate &waypoint) } /*! - \qmlmethod QtLocation5::RouteQuery::clearWaypoints() + \qmlmethod QtLocation::RouteQuery::clearWaypoints() Clears all waypoints. @@ -983,7 +983,7 @@ void QDeclarativeGeoRouteQuery::clearWaypoints() } /*! - \qmlmethod QtLocation5::RouteQuery::setFeatureWeight(FeatureType, FeatureWeight) + \qmlmethod QtLocation::RouteQuery::setFeatureWeight(FeatureType, FeatureWeight) Defines the weight to associate with a feature during the planning of a route. @@ -1025,7 +1025,7 @@ void QDeclarativeGeoRouteQuery::setFeatureWeight(FeatureType featureType, Featur } /*! - \qmlmethod QtLocation5::RouteQuery::resetFeatureWeights() + \qmlmethod QtLocation::RouteQuery::resetFeatureWeights() Resets all feature weights to their default state (NeutralFeatureWeight). @@ -1045,7 +1045,7 @@ void QDeclarativeGeoRouteQuery::resetFeatureWeights() } /*! - \qmlmethod FeatureWeight QtLocation5::RouteQuery::featureWeight(FeatureType featureType) + \qmlmethod FeatureWeight QtLocation::RouteQuery::featureWeight(FeatureType featureType) Gets the weight for the \a featureType. diff --git a/src/imports/location/qdeclarativegeoroutesegment.cpp b/src/imports/location/qdeclarativegeoroutesegment.cpp index 07d80dff..d1f19751 100644 --- a/src/imports/location/qdeclarativegeoroutesegment.cpp +++ b/src/imports/location/qdeclarativegeoroutesegment.cpp @@ -97,7 +97,7 @@ QDeclarativeGeoRouteSegment::QDeclarativeGeoRouteSegment(const QGeoRouteSegment QDeclarativeGeoRouteSegment::~QDeclarativeGeoRouteSegment() {} /*! - \qmlproperty int QtLocation5::RouteSegment::travelTime + \qmlproperty int QtLocation::RouteSegment::travelTime Read-only property which holds the estimated amount of time it will take to traverse this segment, in seconds. @@ -110,7 +110,7 @@ int QDeclarativeGeoRouteSegment::travelTime() const } /*! - \qmlproperty real QtLocation5::RouteSegment::distance + \qmlproperty real QtLocation::RouteSegment::distance Read-only property which holds the distance covered by this segment of the route, in meters. @@ -122,7 +122,7 @@ qreal QDeclarativeGeoRouteSegment::distance() const } /*! - \qmlproperty RouteManeuver QtLocation5::RouteSegment::maneuver + \qmlproperty RouteManeuver QtLocation::RouteSegment::maneuver Read-only property which holds the maneuver for this route segment. @@ -136,7 +136,7 @@ QDeclarativeGeoManeuver *QDeclarativeGeoRouteSegment::maneuver() const } /*! - \qmlproperty QJSValue QtLocation5::RouteSegment::path + \qmlproperty QJSValue QtLocation::RouteSegment::path Read-only property which holds the geographical coordinates of this segment. Coordinates are listed in the order in which they would be traversed by someone diff --git a/src/location/doc/src/examples/declarative-mapviewer.qdoc b/src/location/doc/src/examples/declarative-mapviewer.qdoc index 6fbec0e9..ff7ff7db 100644 --- a/src/location/doc/src/examples/declarative-mapviewer.qdoc +++ b/src/location/doc/src/examples/declarative-mapviewer.qdoc @@ -38,8 +38,8 @@ covering each of these areas of functionality with snippets from the code. The Map Viewer example can work with any of the available geo services plugins. However, some - plugins may require additional \l {QtLocation5::PluginParameter}{plugin parameters} in order to - function correctly. \l {QtLocation5::PluginParameter}{Plugin parameters} can be passed on the + plugins may require additional \l {QtLocation::PluginParameter}{plugin parameters} in order to + function correctly. \l {QtLocation::PluginParameter}{Plugin parameters} can be passed on the command line using the \c {--plugin} argument, which takes the form: \code @@ -55,20 +55,20 @@ \list \li Displaying a map \list - \li \l{QtLocation5::Map}{Map} - \li \l{QtLocation5::MapGestureArea}{MapGestureArea} + \li \l{QtLocation::Map}{Map} + \li \l{QtLocation::MapGestureArea}{MapGestureArea} \li \l{coordinate} \endlist \li Finding an address \list - \li \l{QtLocation5::GeocodeModel}{GeocodeModel} - \li \l{QtLocation5::MapItemView}{MapItemView} - \li \l{QtLocation5::MapCircle}{MapCircle} + \li \l{QtLocation::GeocodeModel}{GeocodeModel} + \li \l{QtLocation::MapItemView}{MapItemView} + \li \l{QtLocation::MapCircle}{MapCircle} \endlist \li Directions and travel routes \list - \li \l{QtLocation5::RouteModel}{RouteModel} - \li \l{QtLocation5::MapRoute}{MapRoute} + \li \l{QtLocation::RouteModel}{RouteModel} + \li \l{QtLocation::MapRoute}{MapRoute} \endlist \endlist @@ -186,7 +186,7 @@ \snippet mapviewer/content/map/MapComponent.qml routeinfomodel Inside the RouteModel, we add an - \l{QtLocation5::RouteModel::status}{onStatusChanged} handler, which + \l{QtLocation::RouteModel::status}{onStatusChanged} handler, which calls the \c{update()} function we defined on the model: \snippet mapviewer/content/map/MapComponent.qml routemodel1 diff --git a/src/location/doc/src/examples/declarative-places.qdoc b/src/location/doc/src/examples/declarative-places.qdoc index 30848740..f73d2bee 100644 --- a/src/location/doc/src/examples/declarative-places.qdoc +++ b/src/location/doc/src/examples/declarative-places.qdoc @@ -61,8 +61,8 @@ from the "New" menu and fill in the fields. Click "Go!" to save the category. The Places example can work with any of the available geo services plugins. However, some - plugins may require additional \l {QtLocation5::PluginParameter}{plugin parameters} in order to - function correctly. \l {QtLocation5::PluginParameter}{Plugin parameters} can be passed on the + plugins may require additional \l {QtLocation::PluginParameter}{plugin parameters} in order to + function correctly. \l {QtLocation::PluginParameter}{Plugin parameters} can be passed on the command line using the \c {--plugin} argument, which takes the form: \code diff --git a/src/location/doc/src/maps.qdoc b/src/location/doc/src/maps.qdoc index acd5cefb..a9816f52 100644 --- a/src/location/doc/src/maps.qdoc +++ b/src/location/doc/src/maps.qdoc @@ -47,26 +47,26 @@ A more hands-on introduction of the Maps and Navigation types can be found in th \section2 Displaying Maps -Displaying a map is done using the \l{QtLocation5::Map}{Map} QML types. The Map type supports -user interaction through the \l{QtLocation5::MapGestureArea}{MapGestureArea} QML type. The Map +Displaying a map is done using the \l{QtLocation::Map}{Map} QML types. The Map type supports +user interaction through the \l{QtLocation::MapGestureArea}{MapGestureArea} QML type. The Map object draws the map on-screen using OpenGL (ES), allowing for hardware-accelerated rendering where available. \b{Key Types} \table \row - \li \l{QtLocation5::Plugin}{Plugin} + \li \l{QtLocation::Plugin}{Plugin} \li A location-based services plugin provides data including map data which is then displayed in a Map object. \row - \li \l{QtLocation5::Map}{Map} + \li \l{QtLocation::Map}{Map} \li QtQuick item to display a map on-screen. \row - \li \l{QtLocation5::MapGestureArea}{MapGestureArea} + \li \l{QtLocation::MapGestureArea}{MapGestureArea} \li Interaction helper for panning, flicking and pinch-to-zoom gesture on a Map. \endtable -Note that the client must create a \l{QtLocation5::Plugin}{Plugin} object -prior to using a \l{QtLocation5::Map}{Map} type in order to have access +Note that the client must create a \l{QtLocation::Plugin}{Plugin} object +prior to using a \l{QtLocation::Map}{Map} type in order to have access to map data to display. \section2 Putting Objects on a Map (Map Overlay Objects) @@ -74,47 +74,47 @@ to map data to display. Maps can also contain map overlay objects, which are used to display information on its surface. There is a set of basic pre-defined map overlay objects, as well as the ability to implement custom map overlay objects using the -\l{QtLocation5::MapQuickItem}{MapQuickItem} type, which can contain any +\l{QtLocation::MapQuickItem}{MapQuickItem} type, which can contain any standard QtQuick item. \b{Key Types} \table \row - \li \l{QtLocation5::MapCircle}{MapCircle} + \li \l{QtLocation::MapCircle}{MapCircle} \li A geographic circle (all points at a set distance from a center), optionally with a border. \row - \li \l{QtLocation5::MapRectangle}{MapRectangle} + \li \l{QtLocation::MapRectangle}{MapRectangle} \li A rectangle whose top left and bottom right points are specified as \l {coordinate} types, optionally with a border. \row - \li \l{QtLocation5::MapPolygon}{MapPolygon} + \li \l{QtLocation::MapPolygon}{MapPolygon} \li A polygon made of an arbitrary list of \l {coordinate}{coordinates}. \row - \li \l{QtLocation5::MapPolyline}{MapPolyline} + \li \l{QtLocation::MapPolyline}{MapPolyline} \li A polyline made of an arbitrary list of \l {coordinate}{coordinates}. \row - \li \l{QtLocation5::MapQuickItem}{MapQuickItem} + \li \l{QtLocation::MapQuickItem}{MapQuickItem} \li Turns any arbitrary QtQuick Item into a map overlay object. MapQuickItem is an enabler for specifying custom map overlay objects. \endtable \section2 Model-View Design with Map Overlay Objects To automatically generate map overlay objects based on the contents of a QtQuick -model (for example a ListModel item), the \l{QtLocation5::MapItemView}{MapItemView} +model (for example a ListModel item), the \l{QtLocation::MapItemView}{MapItemView} type is available. It accepts any map overlay object as its delegate, and can -only be created within a \l{QtLocation5::Map}{Map}. +only be created within a \l{QtLocation::Map}{Map}. \b{Key Types} \table \row - \li \l{QtLocation5::MapItemView}{MapItemView} + \li \l{QtLocation::MapItemView}{MapItemView} \li Populates a Map with map overlay objects based on the data provided by a model. \endtable \section2 Interaction with Map Overlay Objects Interaction with the pre-defined map overlay object types is done using the -\l{QtLocation5::MapMouseArea}{MapMouseArea} type, which behaves much like a +\l{QtLocation::MapMouseArea}{MapMouseArea} type, which behaves much like a normal QtQuick MouseArea. MapQuickItems can also contain MapMouseArea objects, but can additionally use normal QtQuick MouseAreas to provide interaction. @@ -126,10 +126,10 @@ available. \b{Key Types} \table \row - \li \l{QtLocation5::MapMouseArea}{MapMouseArea} + \li \l{QtLocation::MapMouseArea}{MapMouseArea} \li Accepts mouse events for a pre-defined map overlay object (for example MapCircle). \row - \li \l{QtLocation5::MapMouseEvent}{MapMouseEvent} + \li \l{QtLocation::MapMouseEvent}{MapMouseEvent} \li Provides additional information unique to mouse events on a Map. \endtable @@ -138,14 +138,14 @@ available. Geocoding is the translation of geographic coordinates into addresses, or vice versa. Such a translation usually involves sending the source data to a server which then performs the translation and returns the results, although some -location-based service provider \l{QtLocation5::Plugin}{plugins} may be able to +location-based service provider \l{QtLocation::Plugin}{plugins} may be able to provide some geocoding functionality without sending data to a remote server. The availability and accuracy of the translation usually depends on the location or address being translated, as different areas of the Earth are mapped to varying degrees of accuracy. A geocoding query in QML is performed using the -\l{QtLocation5::GeocodeModel}{GeocodeModel} type. For an address-to-coordinate +\l{QtLocation::GeocodeModel}{GeocodeModel} type. For an address-to-coordinate query, its \c{query} property may be set to either an \l{QtPositioning::Address}{Address} object or a string containing the textual form of the address to search for. To perform the reverse, the same property @@ -155,18 +155,18 @@ contents of the model. \b{Key Types} \table \row - \li \l{QtLocation5::Plugin}{Plugin} + \li \l{QtLocation::Plugin}{Plugin} \li A location-based services plugin provides data including geocoding translation results which are exposed to clients via a GeocodeModel. \row - \li \l{QtLocation5::GeocodeModel}{GeocodeModel} + \li \l{QtLocation::GeocodeModel}{GeocodeModel} \li Queries the Plugin for geocoding translations and provides access to results via indexes in the model. \row \li \l{QtPositioning::Address}{Address} \li Structured address for use in queries and results of geocoding. \endtable -Note that the client must create a \l{QtLocation5::Plugin}{Plugin} object -prior to using a \l{QtLocation5::GeocodeModel}{GeocodeModel} object. This +Note that the client must create a \l{QtLocation::Plugin}{Plugin} object +prior to using a \l{QtLocation::GeocodeModel}{GeocodeModel} object. This will enable access to geocoding translation services and thus data to display. \section1 Routing and Navigation @@ -181,16 +181,16 @@ between the segments. \b{Key Types} \table \row - \li \l{QtLocation5::Route}{Route} + \li \l{QtLocation::Route}{Route} \li The entire path to be navigated. \row - \li \l{QtLocation5::RouteSegment}{RouteSegment} + \li \l{QtLocation::RouteSegment}{RouteSegment} \li The individual components of a route. \row - \li \l{QtLocation5::RouteManeuver}{RouteManeuver} + \li \l{QtLocation::RouteManeuver}{RouteManeuver} \li The navigation information that joins segments. \row - \li \l{QtLocation5::RouteModel}{RouteModel} + \li \l{QtLocation::RouteModel}{RouteModel} \li The means of making requests on the backend to supply route information. \endtable diff --git a/src/location/doc/src/qml-maps.qdoc b/src/location/doc/src/qml-maps.qdoc index 78e11a04..7460802c 100644 --- a/src/location/doc/src/qml-maps.qdoc +++ b/src/location/doc/src/qml-maps.qdoc @@ -216,7 +216,7 @@ Enabling and configuring pinch and flickable is easy within the \l Map type. Zoom can also be controlled by other objects like sliders, as shown in the example, by implementing the \c onValueChanged handler to update the Map -\l {QtLocation5::Map::}{zoomLevel}. +\l {QtLocation::Map::}{zoomLevel}. \section1 Types diff --git a/src/location/doc/src/qtlocation-qml.qdoc b/src/location/doc/src/qtlocation-qml.qdoc index a24820bd..ed280dfb 100644 --- a/src/location/doc/src/qtlocation-qml.qdoc +++ b/src/location/doc/src/qtlocation-qml.qdoc @@ -41,14 +41,14 @@ statement in the QML file. \section2 Location QML Concepts Provided that a position has been obtained this module can -add a \l {QtLocation5::Map}{Map} with positions of interest and -\l {QtLocation5::Place}{Places}. The user can be made aware of nearby features and related +add a \l {QtLocation::Map}{Map} with positions of interest and +\l {QtLocation::Place}{Places}. The user can be made aware of nearby features and related information, displayed graphically. Features on the \l Map may be places of business, entertainment and so on. They may include paths, roads, or forms of transport leading so that navigation optimization and assistance are possible. To perform navigation we need \l {Route}s from start to destination. These routes -are made up of segments. Each \l {QtLocation5::RouteSegment}{RouteSegment} +are made up of segments. Each \l {QtLocation::RouteSegment}{RouteSegment} can be considered a navigation sub-task: drive 100 meters, turn left. The beginning and end of each segment is a \e waypoint, that is, one part of our journey. -- cgit v1.2.3