diff options
Diffstat (limited to 'src/location/doc/src/maps.qdoc')
| -rw-r--r-- | src/location/doc/src/maps.qdoc | 58 |
1 files changed, 29 insertions, 29 deletions
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 |