diff options
| author | Wolfgang Beck <wolfgang.beck@nokia.com> | 2012-03-27 13:49:25 +1000 |
|---|---|---|
| committer | Qt by Nokia <qt-info@nokia.com> | 2012-03-29 06:53:38 +0200 |
| commit | 04921a0ff8c3a6878a77eb6e119ba6a870b2798a (patch) | |
| tree | 0c1f262499bb90374cfff1d1bc0e7233d490bcee /src | |
| parent | 2106a31b66afc25917935046d2e3be14488d4dc5 (diff) | |
General documentation issues
Change-Id: I021ab70e1cbb973817aecbf53b7af0760c5e36c4
Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
Diffstat (limited to 'src')
109 files changed, 1446 insertions, 625 deletions
diff --git a/src/imports/location/declarativeplaces/qdeclarativecategory.cpp b/src/imports/location/declarativeplaces/qdeclarativecategory.cpp index e1f0b7f5..5c7defd5 100644 --- a/src/imports/location/declarativeplaces/qdeclarativecategory.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativecategory.cpp @@ -55,7 +55,7 @@ QT_USE_NAMESPACE \ingroup qml-QtLocation5-places \ingroup qml-QtLocation5-places-data - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The Category element represents a category that a \l Place can be associated with. @@ -110,7 +110,7 @@ void QDeclarativeCategory::componentComplete() /*! \qmlproperty Plugin Category::plugin - This property holds the plugin to which the category belongs. + This property holds the location based service to which the category belongs. */ void QDeclarativeCategory::setPlugin(QDeclarativeGeoServiceProvider *plugin) { @@ -135,6 +135,14 @@ void QDeclarativeCategory::setPlugin(QDeclarativeGeoServiceProvider *plugin) } } +QDeclarativeGeoServiceProvider* QDeclarativeCategory::plugin() const +{ + return m_plugin; +} + +/*! + \internal +*/ void QDeclarativeCategory::pluginReady() { QGeoServiceProvider *serviceProvider = m_plugin->sharedGeoServiceProvider(); @@ -146,25 +154,13 @@ void QDeclarativeCategory::pluginReady() } } -QDeclarativeGeoServiceProvider* QDeclarativeCategory::plugin() const -{ - return m_plugin; -} /*! \qmlproperty QPlaceCategory Category::category + \target Category::category - This property is used to provide an interface between C++ and QML code. First a pointer to a - Category 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 category property. - - The following gets the QPlaceCategory representing this object from C++: - - \snippet snippets/cpp/cppqml.cpp Category get - - The following sets the properties of this object based on a QPlaceCategory object from C++: - - \snippet snippets/cpp/cppqml.cpp Category set + For details on how to use this property to interface between C++ and QML see + "\l {location-cpp-qml.html#category} {Interfaces between C++ and QML Code}". */ void QDeclarativeCategory::setCategory(const QPlaceCategory &category) { @@ -195,7 +191,7 @@ QPlaceCategory QDeclarativeCategory::category() /*! \qmlproperty string Category::categoryId - This property holds the id of the category. The categoryId is a string which uniquely + This property holds the identifier of the category. The categoryId is a string which uniquely identifies this category within the categories \l plugin. */ void QDeclarativeCategory::setCategoryId(const QString &id) @@ -214,7 +210,7 @@ QString QDeclarativeCategory::categoryId() const /*! \qmlproperty string Category::name - This property holds name of the category. + This property holds string based name of the category. */ void QDeclarativeCategory::setName(const QString &name) { @@ -275,7 +271,7 @@ void QDeclarativeCategory::setVisibility(Visibility visibility) /*! \qmlproperty PlaceIcon Category::icon - This property holds the icon associated with the category. + This property holds the image source associated with the category. To display the icon you can use the \l Image element. */ QDeclarativePlaceIcon *QDeclarativeCategory::icon() const { @@ -377,6 +373,9 @@ void QDeclarativeCategory::remove() setStatus(QDeclarativeCategory::Removing); } +/*! + \internal +*/ void QDeclarativeCategory::replyFinished() { if (!m_reply) @@ -421,7 +420,8 @@ void QDeclarativeCategory::replyFinished() } } -/* +/*! + \internal Helper function to return the manager, this manager is intended to be used to perform the next operation. Sets status to Error and an appropriate m_errorString if the manager cannot be obtained. diff --git a/src/imports/location/declarativeplaces/qdeclarativecontactdetail.cpp b/src/imports/location/declarativeplaces/qdeclarativecontactdetail.cpp index b2a91388..196e6d83 100644 --- a/src/imports/location/declarativeplaces/qdeclarativecontactdetail.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativecontactdetail.cpp @@ -46,7 +46,7 @@ \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-places \ingroup qml-QtLocation5-places-data - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The ContactDetails element holds contact details for a \l Place. @@ -104,7 +104,7 @@ \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-places \ingroup qml-QtLocation5-places-data - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The ContactDetail element holds a contact detail such as a phone number or a website address. @@ -142,19 +142,8 @@ QDeclarativeContactDetail::~QDeclarativeContactDetail() /*! \qmlproperty QPlaceContactDetail QtLocation5::ContactDetail::contactDetail - This property is used to provide an interface between C++ and QML code. First a pointer to a - ContactDetail 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 contactDetail property. - - The following gets the QPlaceContactDetail representing this object from C++: - - \snippet snippets/cpp/cppqml.cpp ContactDetail get - - The following sets the properties of this object based on a QPlaceContactDetail object from - C++: - - \snippet snippets/cpp/cppqml.cpp ContactDetail set + 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}". */ void QDeclarativeContactDetail::setContactDetail(const QPlaceContactDetail &src) { diff --git a/src/imports/location/declarativeplaces/qdeclarativeplace.cpp b/src/imports/location/declarativeplaces/qdeclarativeplace.cpp index 1d450b39..7756da43 100644 --- a/src/imports/location/declarativeplaces/qdeclarativeplace.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativeplace.cpp @@ -61,7 +61,7 @@ QT_USE_NAMESPACE \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-places \ingroup qml-QtLocation5-places-data - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The Place element represents a place. @@ -105,7 +105,7 @@ QT_USE_NAMESPACE possible to call \l save(), \l remove() or \l getDetails(). The \l reviewModel, \l imageModel and \l editorialModel are only valid then the \l plugin property is set. - \section2 Saving a place + \section2 Saving a Place If the \l Plugin supports it, the Place element can be used to save a place. First create a new Place and set its properties: @@ -120,15 +120,15 @@ QT_USE_NAMESPACE successful or to Place.Error if an error occurs. If the \l placeId property is set, the backend will update an existing place otherwise it will - create a new place. On success the \l placeId property will be updated with the id of the newly + create a new place. On success the \l placeId property will be updated with the identifier of the newly saved place. \section3 Caveats \input place-caveats.qdocinc - \section3 Saving between plugins + \section3 Saving Between Plugins When saving places between plugins, there are a few things to be aware of. - Some fields of a place such as the id, categories and icons are plugin specific entities e.g. + Some fields of a place such as the id, categories and icons are plugin specific entities. For example the categories in one manager may not be recognised in another. Therefore trying to save a place directly from one plugin to another is not possible. @@ -136,7 +136,7 @@ QT_USE_NAMESPACE as explained in the Favorites section. However there is another approach which is to create a new place, set its (destination) plugin and then use the \l copyFrom() method to copy the details of the original place. Using \l copyFrom() only copies data that is supported by the destination plugin, - plugin specific data such as the place id is not copied over. Once the copy is done, + plugin specific data such as the place identifier is not copied over. Once the copy is done, the place is in a suitable state to be saved. The following snippet provides an example of saving a place to a different plugin @@ -144,7 +144,7 @@ QT_USE_NAMESPACE \snippet snippets/declarative/places.qml Place save to different plugin - \section2 Removing a place + \section2 Removing a Place To remove a place, ensure that a Place object with a valid \l placeId property exists and call its \l remove() method. The \l status property will change to Place.Removing and then to @@ -158,7 +158,7 @@ QT_USE_NAMESPACE Each Place has a favorite property which is intended to contain the corresponding place from the destination plugin (the place itself is sourced from the origin plugin). Because both the original place and favorite instances are available, the developer can choose which - properties to show to the user. e.g. the favorite may have a modified name which should + properties to show to the user. For example the favorite may have a modified name which should be displayed rather than the original name. \snippet snippets/declarative/places.qml Place favorite @@ -223,7 +223,7 @@ void QDeclarativePlace::componentComplete() /*! \qmlproperty Plugin Place::plugin - This property holds the \l Plugin that provided this place. + This property holds the \l Plugin that provided this place which can be used to retrieve more information about the service. */ void QDeclarativePlace::setPlugin(QDeclarativeGeoServiceProvider *plugin) { @@ -305,17 +305,8 @@ QDeclarativePlaceEditorialModel *QDeclarativePlace::editorialModel() /*! \qmlproperty QPlace Place::place - This property is used to provide an interface between C++ and QML code. First a pointer to a - Place 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 place property. - - The following gets the QPlace representing this object from C++: - - \snippet snippets/cpp/cppqml.cpp Place get - - The following sets the properties of this object based on a QPlace object from C++: - - \snippet snippets/cpp/cppqml.cpp Place set + For details on how to use this property to interface between C++ and QML see + "\l {location-cpp-qml.html#place} {Interfaces between C++ and QML Code}". */ void QDeclarativePlace::setPlace(const QPlace &src) { @@ -448,7 +439,7 @@ QPlace QDeclarativePlace::place() /*! \qmlproperty QtLocation5::Location Place::location - This property holds the location of the place. + This property holds the location of the place which can be used to retrieve the coordinate, address and the BoundingBox. */ void QDeclarativePlace::setLocation(QDeclarativeGeoLocation *location) { @@ -495,6 +486,7 @@ QDeclarativeRatings *QDeclarativePlace::ratings() \qmlproperty Supplier Place::supplier This property holds the supplier of the place data. + The supplier is typically a business or organization that collected the data about the place. */ void QDeclarativePlace::setSupplier(QDeclarativeSupplier *supplier) { @@ -538,7 +530,7 @@ void QDeclarativePlace::setIcon(QDeclarativePlaceIcon *icon) /*! \qmlproperty string Place::name - This property holds the name of the place. + This property holds the name of the place which can be used to represent the place. */ void QDeclarativePlace::setName(const QString &name) { @@ -556,11 +548,11 @@ QString QDeclarativePlace::name() const /*! \qmlproperty string Place::placeId - This property holds the unique identifier of the place. The place id is only meaningful to the + This property holds the unique identifier of the place. The place identifier is only meaningful to the \l Plugin that generated it and is not transferable between \l {Plugin}{Plugins}. The place id is not guaranteed to be universally unique, but unique within the \l Plugin that generated it. - If only the place id is known, all other place data can fetched from the \l Plugin. + If only the place identifier is known, all other place data can fetched from the \l Plugin. \snippet snippets/declarative/places.qml Place placeId */ @@ -661,6 +653,9 @@ QDeclarativePlace::Status QDeclarativePlace::status() const return m_status; } +/*! + \internal +*/ void QDeclarativePlace::finished() { if (!m_reply) @@ -709,6 +704,9 @@ void QDeclarativePlace::finished() } } +/*! + \internal +*/ void QDeclarativePlace::contactsModified(const QString &key, const QVariant &value) { //TODO: This is a workaround to allow an assignment of a single contact detail @@ -728,6 +726,9 @@ void QDeclarativePlace::contactsModified(const QString &key, const QVariant &val primarySignalsEmission(key); } +/*! + \internal +*/ void QDeclarativePlace::cleanupDeletedCategories() { foreach (QDeclarativeCategory * category, m_categoriesToBeDeleted) { @@ -910,6 +911,9 @@ QQmlListProperty<QDeclarativeCategory> QDeclarativePlace::categories() category_clear); } +/*! + \internal +*/ void QDeclarativePlace::category_append(QQmlListProperty<QDeclarativeCategory> *prop, QDeclarativeCategory *value) { @@ -928,11 +932,17 @@ void QDeclarativePlace::category_append(QQmlListProperty<QDeclarativeCategory> * } } +/*! + \internal +*/ int QDeclarativePlace::category_count(QQmlListProperty<QDeclarativeCategory> *prop) { return static_cast<QDeclarativePlace*>(prop->object)->m_categories.count(); } +/*! + \internal +*/ QDeclarativeCategory* QDeclarativePlace::category_at(QQmlListProperty<QDeclarativeCategory> *prop, int index) { @@ -944,6 +954,9 @@ QDeclarativeCategory* QDeclarativePlace::category_at(QQmlListProperty<QDeclarati return res; } +/*! + \internal +*/ void QDeclarativePlace::category_clear(QQmlListProperty<QDeclarativeCategory> *prop) { QDeclarativePlace* object = static_cast<QDeclarativePlace*>(prop->object); @@ -961,6 +974,9 @@ void QDeclarativePlace::category_clear(QQmlListProperty<QDeclarativeCategory> *p QTimer::singleShot(0, object, SLOT(cleanupDeletedCategories())); } +/*! + \internal +*/ void QDeclarativePlace::synchronizeCategories() { qDeleteAll(m_categories); @@ -1039,7 +1055,7 @@ void QDeclarativePlace::setFavorite(QDeclarativePlace *favorite) \qmlmethod Place::copyFrom(Place original) Copies data from an \a original place into this place. Only data that is supported by this - place's plugin is copied over and plugin specific data such as place id is not copied over. + place's plugin is copied over and plugin specific data such as place identifier is not copied over. */ void QDeclarativePlace::copyFrom(QDeclarativePlace *original) { @@ -1067,6 +1083,9 @@ void QDeclarativePlace::initializeFavorite(QDeclarativeGeoServiceProvider *plugi } } +/*! + \internal +*/ void QDeclarativePlace::synchronizeExtendedAttributes() { QStringList keys = m_extendedAttributes->keys(); @@ -1082,6 +1101,9 @@ void QDeclarativePlace::synchronizeExtendedAttributes() emit extendedAttributesChanged(); } +/*! + \internal +*/ void QDeclarativePlace::synchronizeContacts() { //clear out contact data @@ -1109,7 +1131,8 @@ void QDeclarativePlace::synchronizeContacts() primarySignalsEmission(); } -/* +/*! + \internal Helper function to emit the signals for the primary___() fields. It is expected that the values of the primary___() functions have already been modified to new values. @@ -1151,7 +1174,8 @@ void QDeclarativePlace::primarySignalsEmission(const QString &type) } } -/* +/*! + \internal Helper function to return the manager, this manager is intended to be used to perform the next operation. If a an operation is currently underway then return a null pointer. @@ -1186,6 +1210,9 @@ QPlaceManager *QDeclarativePlace::manager() return placeManager; } +/*! + \internal +*/ QString QDeclarativePlace::primaryValue(const QString &contactType) const { if (m_contactDetails->value(contactType).userType() == QVariant::List) { diff --git a/src/imports/location/declarativeplaces/qdeclarativeplaceattribute.cpp b/src/imports/location/declarativeplaces/qdeclarativeplaceattribute.cpp index ca761c56..f0031b02 100644 --- a/src/imports/location/declarativeplaces/qdeclarativeplaceattribute.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativeplaceattribute.cpp @@ -46,7 +46,7 @@ \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-places \ingroup qml-QtLocation5-places-data - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The ExtendedAttributes element holds additional data about a \l Place. @@ -72,7 +72,7 @@ \li The name of the provider that a place is sourced from \row \li x_id_<provider> (for example x_id_nokia) - \li An alternative id which identifies the place from the + \li An alternative identifier which identifies the place from the perspective of the specified provider. \endtable @@ -107,7 +107,7 @@ \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-places \ingroup qml-QtLocation5-places-data - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The PlaceAttribute element holds generic place attribute information. @@ -142,18 +142,8 @@ QDeclarativePlaceAttribute::~QDeclarativePlaceAttribute() /*! \qmlproperty QPlaceAttribute PlaceAttribute::attribute - This property is used to provide an interface between C++ and QML code. First a pointer to a - PlaceAttribute 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 attribute property. - - The following gets the QPlaceAttribute representing this object from C++: - - \snippet snippets/cpp/cppqml.cpp PlaceAttribute get - - The following sets the properties of this object based on a QPlaceAttribute object from C++: - - \snippet snippets/cpp/cppqml.cpp PlaceAttribute set + For details on how to use this property to interface between C++ and QML see + "\l {location-cpp-qml.html#placeattribute} {Interfaces between C++ and QML Code}". */ void QDeclarativePlaceAttribute::setAttribute(const QPlaceAttribute &src) { @@ -193,7 +183,7 @@ QString QDeclarativePlaceAttribute::label() const /*! \qmlproperty string PlaceAttribute::text - This property holds the attribute text. + This property holds the attribute text which can be used to show additional information about the place. */ void QDeclarativePlaceAttribute::setText(const QString &text) { diff --git a/src/imports/location/declarativeplaces/qdeclarativeplacecontentmodel.cpp b/src/imports/location/declarativeplaces/qdeclarativeplacecontentmodel.cpp index 657445b5..6281d3ce 100644 --- a/src/imports/location/declarativeplaces/qdeclarativeplacecontentmodel.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativeplacecontentmodel.cpp @@ -67,12 +67,17 @@ QDeclarativePlaceContentModel::~QDeclarativePlaceContentModel() { } - +/*! + \internal +*/ QDeclarativePlace *QDeclarativePlaceContentModel::place() const { return m_place; } +/*! + \internal +*/ void QDeclarativePlaceContentModel::setPlace(QDeclarativePlace *place) { if (m_place != place) { @@ -101,11 +106,17 @@ void QDeclarativePlaceContentModel::setPlace(QDeclarativePlace *place) } } +/*! + \internal +*/ int QDeclarativePlaceContentModel::batchSize() const { return m_batchSize; } +/*! + \internal +*/ void QDeclarativePlaceContentModel::setBatchSize(int batchSize) { if (m_batchSize != batchSize) { @@ -114,11 +125,17 @@ void QDeclarativePlaceContentModel::setBatchSize(int batchSize) } } +/*! + \internal +*/ int QDeclarativePlaceContentModel::totalCount() const { return m_contentCount; } +/*! + \internal +*/ static QPair<int, int> findMissingKey(const QMap<int, QPlaceContent> &map) { int start = 0; @@ -136,6 +153,9 @@ static QPair<int, int> findMissingKey(const QMap<int, QPlaceContent> &map) return qMakePair(start, end - 1); } +/*! + \internal +*/ void QDeclarativePlaceContentModel::clear() { beginResetModel(); @@ -143,6 +163,9 @@ void QDeclarativePlaceContentModel::clear() endResetModel(); } +/*! + \internal +*/ void QDeclarativePlaceContentModel::clearData() { qDeleteAll(m_users); @@ -158,6 +181,9 @@ void QDeclarativePlaceContentModel::clearData() m_reply = 0; } +/*! + \internal +*/ void QDeclarativePlaceContentModel::initializeCollection(int totalCount, const QPlaceContent::Collection &collection) { beginResetModel(); @@ -191,6 +217,9 @@ void QDeclarativePlaceContentModel::initializeCollection(int totalCount, const Q endResetModel(); } +/*! + \internal +*/ int QDeclarativePlaceContentModel::rowCount(const QModelIndex &parent) const { if (parent.isValid()) @@ -199,6 +228,9 @@ int QDeclarativePlaceContentModel::rowCount(const QModelIndex &parent) const return m_content.count(); } +/*! + \internal +*/ QVariant QDeclarativePlaceContentModel::data(const QModelIndex &index, int role) const { if (!index.isValid()) @@ -221,6 +253,9 @@ QVariant QDeclarativePlaceContentModel::data(const QModelIndex &index, int role) } } +/*! + \internal +*/ bool QDeclarativePlaceContentModel::canFetchMore(const QModelIndex &parent) const { if (parent.isValid()) @@ -235,6 +270,9 @@ bool QDeclarativePlaceContentModel::canFetchMore(const QModelIndex &parent) cons return m_content.count() != m_contentCount; } +/*! + \internal +*/ void QDeclarativePlaceContentModel::fetchMore(const QModelIndex &parent) { if (parent.isValid()) @@ -280,16 +318,25 @@ void QDeclarativePlaceContentModel::fetchMore(const QModelIndex &parent) connect(m_reply, SIGNAL(finished()), this, SLOT(fetchFinished()), Qt::QueuedConnection); } +/*! + \internal +*/ void QDeclarativePlaceContentModel::classBegin() { } +/*! + \internal +*/ void QDeclarativePlaceContentModel::componentComplete() { m_complete = true; fetchMore(QModelIndex()); } +/*! + \internal +*/ void QDeclarativePlaceContentModel::fetchFinished() { if (!m_reply) diff --git a/src/imports/location/declarativeplaces/qdeclarativeplaceeditorialmodel.cpp b/src/imports/location/declarativeplaces/qdeclarativeplaceeditorialmodel.cpp index 39c1cf6b..a42e60d5 100644 --- a/src/imports/location/declarativeplaces/qdeclarativeplaceeditorialmodel.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativeplaceeditorialmodel.cpp @@ -51,7 +51,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-places \ingroup qml-QtLocation5-places-models - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The EditorialModel element provides a model of place editorials. @@ -142,6 +142,9 @@ QDeclarativePlaceEditorialModel::~QDeclarativePlaceEditorialModel() { } +/*! + \internal +*/ QVariant QDeclarativePlaceEditorialModel::data(const QModelIndex &index, int role) const { if (!index.isValid()) diff --git a/src/imports/location/declarativeplaces/qdeclarativeplaceicon.cpp b/src/imports/location/declarativeplaces/qdeclarativeplaceicon.cpp index 95d405b2..5ddcd3fa 100644 --- a/src/imports/location/declarativeplaces/qdeclarativeplaceicon.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativeplaceicon.cpp @@ -52,7 +52,7 @@ QT_USE_NAMESPACE \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-places \ingroup qml-QtLocation5-places-data - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The Icon element represents an icon image source which can have multiple sizes. @@ -100,6 +100,12 @@ QDeclarativePlaceIcon::~QDeclarativePlaceIcon() { } +/*! + \qmlproperty QPlaceIcon Icon::icon + + For details on how to use this property to interface between C++ and QML see + "\l {location-cpp-qml.html#placeicon} {Interfaces between C++ and QML Code}". +*/ QPlaceIcon QDeclarativePlaceIcon::icon() const { QPlaceIcon result; @@ -123,21 +129,6 @@ QPlaceIcon QDeclarativePlaceIcon::icon() const return result; } -/*! - \qmlproperty QPlaceIcon Icon::icon - - This property is used to provide an interface between C++ and QML code. First a pointer to a - Icon 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 icon property. - - The following gets the QPlaceIcon representing this object from C++: - - \snippet snippets/cpp/cppqml.cpp Icon get - - The following sets the properties of this object based on a QPlaceIcon object from C++: - - \snippet snippets/cpp/cppqml.cpp Icon set -*/ void QDeclarativePlaceIcon::setIcon(const QPlaceIcon &src) { initParameters(src.parameters()); @@ -206,6 +197,9 @@ void QDeclarativePlaceIcon::setPlugin(QDeclarativeGeoServiceProvider *plugin) } } +/*! + \internal +*/ void QDeclarativePlaceIcon::pluginReady() { QGeoServiceProvider *serviceProvider = m_plugin->sharedGeoServiceProvider(); @@ -216,7 +210,8 @@ void QDeclarativePlaceIcon::pluginReady() } } -/* +/*! + \internal Helper function to return the manager from the plugin */ QPlaceManager *QDeclarativePlaceIcon::manager() const @@ -240,6 +235,9 @@ QPlaceManager *QDeclarativePlaceIcon::manager() const return placeManager; } +/*! + \internal +*/ void QDeclarativePlaceIcon::initParameters(const QVariantMap ¶meterMap) { //clear out old parameters diff --git a/src/imports/location/declarativeplaces/qdeclarativeplaceimagemodel.cpp b/src/imports/location/declarativeplaces/qdeclarativeplaceimagemodel.cpp index 6d5aa4c1..9c0fbf5e 100644 --- a/src/imports/location/declarativeplaces/qdeclarativeplaceimagemodel.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativeplaceimagemodel.cpp @@ -52,7 +52,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-places \ingroup qml-QtLocation5-places-models - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The ImageModel element provides a model of place images. @@ -79,7 +79,7 @@ QT_BEGIN_NAMESPACE \row \li imageId \li string - \li The id of the image. + \li The identifier of the image. \row \li mimeType \li string @@ -142,6 +142,9 @@ QDeclarativePlaceImageModel::~QDeclarativePlaceImageModel() qDeleteAll(m_suppliers); } +/*! + \internal +*/ QVariant QDeclarativePlaceImageModel::data(const QModelIndex &index, int role) const { if (!index.isValid()) diff --git a/src/imports/location/declarativeplaces/qdeclarativeplaceuser.cpp b/src/imports/location/declarativeplaces/qdeclarativeplaceuser.cpp index 5ef304f8..e268346a 100644 --- a/src/imports/location/declarativeplaces/qdeclarativeplaceuser.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativeplaceuser.cpp @@ -48,7 +48,7 @@ QT_USE_NAMESPACE \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-places \ingroup qml-QtLocation5-places-data - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The User element identifies a user who contributed a particular \l Place content item. @@ -81,17 +81,8 @@ QDeclarativePlaceUser::~QDeclarativePlaceUser() {} /*! \qmlproperty QPlaceUser User::user - This property is used to provide an interface between C++ and QML code. First a pointer to a - User 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 user property. - - The following gets the QPlaceUser representing this object from C++: - - \snippet snippets/cpp/cppqml.cpp User get - - The following sets the properties of this object based on a QPlaceUser object from C++: - - \snippet snippets/cpp/cppqml.cpp User set + 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}". */ void QDeclarativePlaceUser::setUser(const QPlaceUser &user) { @@ -113,7 +104,7 @@ QPlaceUser QDeclarativePlaceUser::user() const /*! \qmlproperty string User::userId - This property holds the id of the user. + This property holds the unique identifier of the user. */ void QDeclarativePlaceUser::setUserId(const QString &id) diff --git a/src/imports/location/declarativeplaces/qdeclarativeratings.cpp b/src/imports/location/declarativeplaces/qdeclarativeratings.cpp index 0cc27881..9732e885 100644 --- a/src/imports/location/declarativeplaces/qdeclarativeratings.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativeratings.cpp @@ -48,7 +48,7 @@ QT_USE_NAMESPACE \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-places \ingroup qml-QtLocation5-places-data - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The Ratings element holds place rating information. @@ -75,17 +75,8 @@ QDeclarativeRatings::~QDeclarativeRatings() {} /*! \qmlproperty QPlaceRatings Ratings::ratings - This property is used to provide an interface between C++ and QML code. First a pointer to a - Ratings 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 ratings property. - - The following gets the QPlaceRating representing this object from C++: - - \snippet snippets/cpp/cppqml.cpp Ratings get - - The following sets the properties of this object based on a QPlaceRatings object from C++: - - \snippet snippets/cpp/cppqml.cpp Ratings set + For details on how to use this property to interface between C++ and QML see + "\l {location-cpp-qml.html#placeratings} {Interfaces between C++ and QML Code}". */ void QDeclarativeRatings::setRatings(const QPlaceRatings &ratings) { diff --git a/src/imports/location/declarativeplaces/qdeclarativerecommendationmodel.cpp b/src/imports/location/declarativeplaces/qdeclarativerecommendationmodel.cpp index f1005f6a..422f0c8f 100644 --- a/src/imports/location/declarativeplaces/qdeclarativerecommendationmodel.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativerecommendationmodel.cpp @@ -58,7 +58,7 @@ QT_USE_NAMESPACE \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-places \ingroup qml-QtLocation5-places-models - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The PlaceRecommendationModel element provides a model of place recommendations. @@ -124,10 +124,10 @@ QT_USE_NAMESPACE are matched to favorites in the favoritesPlugin. By default the parameter map is empty and implies that the favorites plugin - matches by \l {Alternative Id cross-referencing}{alternative ids}. Generally, + matches by \l {Alternative Identifier Cross-Referencing}{alternative identifiers}. Generally, an application developer will not need to set this property. - In cases where the favorites plugin does not support matching by alternative ids, + In cases where the favorites plugin does not support matching by alternative identifiers, then the \l {Information about plugins} {backend plugin documentation} should be consulted to see precisely what key-value parameters to set. */ @@ -223,7 +223,7 @@ QDeclarativeRecommendationModel::~QDeclarativeRecommendationModel() /*! \qmlproperty string PlaceRecommendationModel::placeId - This property holds place id used in the recommendation search query. + This property holds place identifier used in the recommendation search query. */ QString QDeclarativeRecommendationModel::placeId() const { diff --git a/src/imports/location/declarativeplaces/qdeclarativeresultmodelbase.cpp b/src/imports/location/declarativeplaces/qdeclarativeresultmodelbase.cpp index c90294fe..9d46df45 100644 --- a/src/imports/location/declarativeplaces/qdeclarativeresultmodelbase.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativeresultmodelbase.cpp @@ -50,11 +50,17 @@ QDeclarativeResultModelBase::QDeclarativeResultModelBase(QObject *parent) setRoleNames(roles); } +/*! + \internal +*/ QDeclarativeGeoServiceProvider* QDeclarativeResultModelBase::favoritesPlugin() const { return m_favoritesPlugin; } +/*! + \internal +*/ void QDeclarativeResultModelBase::setFavoritesPlugin(QDeclarativeGeoServiceProvider *plugin) { @@ -65,11 +71,17 @@ void QDeclarativeResultModelBase::setFavoritesPlugin(QDeclarativeGeoServiceProvi emit favoritesPluginChanged(); } +/*! + \internal +*/ QVariantMap QDeclarativeResultModelBase::favoritesMatchParameters() const { return m_matchParameters; } +/*! + \internal +*/ void QDeclarativeResultModelBase::setFavoritesMatchParameters(const QVariantMap ¶meters) { if (m_matchParameters == parameters) @@ -79,6 +91,9 @@ void QDeclarativeResultModelBase::setFavoritesMatchParameters(const QVariantMap emit favoritesMatchParametersChanged(); } +/*! + \internal +*/ void QDeclarativeResultModelBase::clearData() { QDeclarativeSearchModelBase::clearData(); @@ -88,6 +103,9 @@ void QDeclarativeResultModelBase::clearData() m_results.clear(); } +/*! + \internal +*/ int QDeclarativeResultModelBase::rowCount(const QModelIndex &parent) const { Q_UNUSED(parent); @@ -95,12 +113,18 @@ int QDeclarativeResultModelBase::rowCount(const QModelIndex &parent) const return m_results.count(); } +/*! + \internal +*/ QVariant QDeclarativeResultModelBase::data(int index, const QString &role) const { QModelIndex modelIndex = createIndex(index, 0); return data(modelIndex, roleNames().key(role.toLatin1())); } +/*! + \internal +*/ QVariant QDeclarativeResultModelBase::data(const QModelIndex &index, int role) const { if (index.row() > m_results.count()) @@ -123,6 +147,9 @@ QVariant QDeclarativeResultModelBase::data(const QModelIndex &index, int role) c } } +/*! + \internal +*/ void QDeclarativeResultModelBase::queryFinished() { if (!m_reply) @@ -192,9 +219,11 @@ void QDeclarativeResultModelBase::queryFinished() } } - -//Note: m_results buffer should be correctly populated before -//calling this function +/*! + \internal + Note: m_results buffer should be correctly populated before + calling this function +*/ void QDeclarativeResultModelBase::updateLayout(const QList<QPlace> &favoritePlaces) { int oldRowCount = rowCount(); diff --git a/src/imports/location/declarativeplaces/qdeclarativereviewmodel.cpp b/src/imports/location/declarativeplaces/qdeclarativereviewmodel.cpp index c3de65bf..3b65c418 100644 --- a/src/imports/location/declarativeplaces/qdeclarativereviewmodel.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativereviewmodel.cpp @@ -52,7 +52,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-places \ingroup qml-QtLocation5-places-models - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The ReviewModel element provides access to reviews of a \l Place. @@ -88,7 +88,7 @@ QT_BEGIN_NAMESPACE \row \li reviewId \li string - \li The id of the review. + \li The identifier of the review. \row \li title \li string @@ -144,6 +144,9 @@ QDeclarativeReviewModel::~QDeclarativeReviewModel() qDeleteAll(m_suppliers); } +/*! + \internal +*/ QVariant QDeclarativeReviewModel::data(const QModelIndex &index, int role) const { if (!index.isValid()) diff --git a/src/imports/location/declarativeplaces/qdeclarativesearchmodelbase.cpp b/src/imports/location/declarativeplaces/qdeclarativesearchmodelbase.cpp index 4523ae47..4f6fc076 100644 --- a/src/imports/location/declarativeplaces/qdeclarativesearchmodelbase.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativesearchmodelbase.cpp @@ -58,11 +58,17 @@ QDeclarativeSearchModelBase::~QDeclarativeSearchModelBase() { } +/*! + \internal +*/ QDeclarativeGeoServiceProvider* QDeclarativeSearchModelBase::plugin() const { return m_plugin; } +/*! + \internal +*/ void QDeclarativeSearchModelBase::setPlugin(QDeclarativeGeoServiceProvider *plugin) { if (m_plugin == plugin) @@ -74,11 +80,17 @@ void QDeclarativeSearchModelBase::setPlugin(QDeclarativeGeoServiceProvider *plug emit pluginChanged(); } +/*! + \internal +*/ QDeclarativeGeoBoundingArea *QDeclarativeSearchModelBase::searchArea() const { return m_searchArea; } +/*! + \internal +*/ void QDeclarativeSearchModelBase::setSearchArea(QDeclarativeGeoBoundingArea *searchArea) { if (m_searchArea == searchArea) @@ -88,11 +100,17 @@ void QDeclarativeSearchModelBase::setSearchArea(QDeclarativeGeoBoundingArea *sea emit searchAreaChanged(); } +/*! + \internal +*/ int QDeclarativeSearchModelBase::offset() const { return m_request.offset(); } +/*! + \internal +*/ void QDeclarativeSearchModelBase::setOffset(int offset) { if (m_request.offset() == offset) @@ -102,11 +120,17 @@ void QDeclarativeSearchModelBase::setOffset(int offset) emit offsetChanged(); } +/*! + \internal +*/ int QDeclarativeSearchModelBase::limit() const { return m_request.limit(); } +/*! + \internal +*/ void QDeclarativeSearchModelBase::setLimit(int limit) { if (m_request.limit() == limit) @@ -116,11 +140,17 @@ void QDeclarativeSearchModelBase::setLimit(int limit) emit limitChanged(); } +/*! + \internal +*/ QDeclarativeSearchModelBase::Status QDeclarativeSearchModelBase::status() const { return m_status; } +/*! + \internal +*/ void QDeclarativeSearchModelBase::setStatus(Status status, const QString &errorString) { if (m_status == status) @@ -131,6 +161,9 @@ void QDeclarativeSearchModelBase::setStatus(Status status, const QString &errorS emit statusChanged(); } +/*! + \internal +*/ void QDeclarativeSearchModelBase::execute() { if (!m_plugin) { @@ -163,6 +196,9 @@ void QDeclarativeSearchModelBase::execute() setStatus(Executing); } +/*! + \internal +*/ void QDeclarativeSearchModelBase::cancel() { if (!m_reply) @@ -178,6 +214,9 @@ void QDeclarativeSearchModelBase::cancel() setStatus(Ready); } +/*! + \internal +*/ void QDeclarativeSearchModelBase::clear() { beginResetModel(); @@ -185,30 +224,48 @@ void QDeclarativeSearchModelBase::clear() endResetModel(); } +/*! + \internal +*/ QString QDeclarativeSearchModelBase::errorString() const { return m_errorString; } +/*! + \internal +*/ void QDeclarativeSearchModelBase::clearData() { } +/*! + \internal +*/ void QDeclarativeSearchModelBase::updateSearchRequest() { if (m_searchArea) m_request.setSearchArea(m_searchArea->area()); } +/*! + \internal +*/ void QDeclarativeSearchModelBase::classBegin() { } +/*! + \internal +*/ void QDeclarativeSearchModelBase::componentComplete() { m_complete = true; } +/*! + \internal +*/ void QDeclarativeSearchModelBase::initializePlugin(QDeclarativeGeoServiceProvider *plugin) { if (plugin != m_plugin) { @@ -235,6 +292,9 @@ void QDeclarativeSearchModelBase::initializePlugin(QDeclarativeGeoServiceProvide reset(); // reset the model } +/*! + \internal +*/ void QDeclarativeSearchModelBase::pluginNameChanged() { initializePlugin(m_plugin); diff --git a/src/imports/location/declarativeplaces/qdeclarativesearchresultmodel.cpp b/src/imports/location/declarativeplaces/qdeclarativesearchresultmodel.cpp index 5e55b570..68590aac 100644 --- a/src/imports/location/declarativeplaces/qdeclarativesearchresultmodel.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativesearchresultmodel.cpp @@ -58,7 +58,7 @@ QT_USE_NAMESPACE \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-places \ingroup qml-QtLocation5-places-models - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The PlaceSearchModel element provides access to place search results. @@ -110,23 +110,23 @@ QT_USE_NAMESPACE the search term. \endtable - \section2 Search result types + \section2 Search Result Types The \c type role can take on the following values: \table \row - \o PlaceSearchModel.PlaceResult - \o The search result contains a place. + \li PlaceSearchModel.PlaceResult + \li The search result contains a place. \row - \o PlaceSearchModel.CorrectionResult - \o The search result contains a search term correction. + \li PlaceSearchModel.CorrectionResult + \li The search result contains a search term correction. \row - \o PlaceSearchModel.UnknownSearchResult - \o The contents of the search result are unknown. + \li PlaceSearchModel.UnknownSearchResult + \li The contents of the search result are unknown. \endtable - \section1 Detection of updated/removed places + \section1 Detection of Updated and Removed Places The PlaceSearchModel listens for places that have been updated or removed from its plugin's backend. If it detects that a place has been updated and that place is currently present in the model, then @@ -174,10 +174,10 @@ QT_USE_NAMESPACE are matched to favorites in the favoritesPlugin. By default the parameter map is empty and implies that the favorites plugin - matches by \l {Alternative Id cross-referencing}{alternative ids}. Generally, + matches by \l {Alternative Identifier Cross-Referencing}{alternative identifiers}. Generally, an application developer will not need to set this property. - In cases where the favorites plugin does not support matching by alternative ids, + In cases where the favorites plugin does not support matching by alternative identifiers, then the \l {Information about plugins} {backend plugin documentation} should be consulted to see precisely what key-value parameters to set. */ @@ -471,6 +471,9 @@ QPlaceReply *QDeclarativeSearchResultModel::sendQuery(QPlaceManager *manager, return manager->search(request); } +/*! + \internal +*/ void QDeclarativeSearchResultModel::initializePlugin(QDeclarativeGeoServiceProvider *plugin) { //disconnect the manager of the old plugin if we have one @@ -511,6 +514,9 @@ void QDeclarativeSearchResultModel::initializePlugin(QDeclarativeGeoServiceProvi This property holds the number of results the model has. */ +/*! + \internal +*/ void QDeclarativeSearchResultModel::placeUpdated(const QString &placeId) { int row = getRow(placeId); @@ -521,6 +527,9 @@ void QDeclarativeSearchResultModel::placeUpdated(const QString &placeId) m_places.at(row)->getDetails(); } +/*! + \internal +*/ void QDeclarativeSearchResultModel::placeRemoved(const QString &placeId) { int row = getRow(placeId); @@ -536,6 +545,9 @@ void QDeclarativeSearchResultModel::placeRemoved(const QString &placeId) emit rowCountChanged(); } +/*! + \internal +*/ int QDeclarativeSearchResultModel::getRow(const QString &placeId) const { for (int i = 0; i < m_places.count(); ++i) { diff --git a/src/imports/location/declarativeplaces/qdeclarativesearchsuggestionmodel.cpp b/src/imports/location/declarativeplaces/qdeclarativesearchsuggestionmodel.cpp index 5a903688..29ac82a0 100644 --- a/src/imports/location/declarativeplaces/qdeclarativesearchsuggestionmodel.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativesearchsuggestionmodel.cpp @@ -55,7 +55,7 @@ QT_USE_NAMESPACE \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-places \ingroup qml-QtLocation5-places-models - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The PlaceSearchSuggestionModel element provides access to search term suggestions. @@ -216,7 +216,7 @@ void QDeclarativeSearchSuggestionModel::setSearchTerm(const QString &searchTerm) } /*! - \qmlproperty list<string> PlaceSearchSuggestionModel::suggestions + \qmlproperty stringlist PlaceSearchSuggestionModel::suggestions This property holds the list of predicted search terms that the model currently has. */ @@ -225,6 +225,9 @@ QStringList QDeclarativeSearchSuggestionModel::suggestions() const return m_suggestions; } +/*! + \internal +*/ void QDeclarativeSearchSuggestionModel::clearData() { QDeclarativeSearchModelBase::clearData(); @@ -232,11 +235,17 @@ void QDeclarativeSearchSuggestionModel::clearData() m_suggestions.clear(); } +/*! + \internal +*/ void QDeclarativeSearchSuggestionModel::updateSearchRequest() { QDeclarativeSearchModelBase::updateSearchRequest(); } +/*! + \internal +*/ int QDeclarativeSearchSuggestionModel::rowCount(const QModelIndex& parent) const { Q_UNUSED(parent) @@ -244,6 +253,9 @@ int QDeclarativeSearchSuggestionModel::rowCount(const QModelIndex& parent) const return m_suggestions.count(); } +/*! + \internal +*/ QVariant QDeclarativeSearchSuggestionModel::data(const QModelIndex& index, int role) const { if (!index.isValid()) @@ -261,6 +273,9 @@ QVariant QDeclarativeSearchSuggestionModel::data(const QModelIndex& index, int r return QVariant(); } +/*! + \internal +*/ void QDeclarativeSearchSuggestionModel::queryFinished() { if (!m_reply) @@ -288,6 +303,9 @@ void QDeclarativeSearchSuggestionModel::queryFinished() reply->deleteLater(); } +/*! + \internal +*/ QPlaceReply *QDeclarativeSearchSuggestionModel::sendQuery(QPlaceManager *manager, const QPlaceSearchRequest &request) { diff --git a/src/imports/location/declarativeplaces/qdeclarativesupplier.cpp b/src/imports/location/declarativeplaces/qdeclarativesupplier.cpp index 1be36967..f6415087 100644 --- a/src/imports/location/declarativeplaces/qdeclarativesupplier.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativesupplier.cpp @@ -50,7 +50,7 @@ QT_USE_NAMESPACE \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-places \ingroup qml-QtLocation5-places-data - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The Supplier element holds data regarding the supplier of a place, a place's image, review, or editorial. @@ -92,6 +92,9 @@ QDeclarativeSupplier::~QDeclarativeSupplier() { } +/*! + \internal +*/ void QDeclarativeSupplier::componentComplete() { // delayed instantiation of QObject based properties. @@ -102,17 +105,8 @@ void QDeclarativeSupplier::componentComplete() /*! \qmlproperty QPlaceSupplier Supplier::supplier - This property is used to provide an interface between C++ and QML code. First a pointer to a - Supplier 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 supplier property. - - The following gets the QPlaceSupplier representing this object from C++: - - \snippet snippets/cpp/cppqml.cpp Supplier get - - The following sets the properties of this object based on a QPlaceSupplier object from C++: - - \snippet snippets/cpp/cppqml.cpp Supplier set + For details on how to use this property to interface between C++ and QML see + "\l {location-cpp-qml.html#placesupplier} {Interfaces between C++ and QML Code}". */ void QDeclarativeSupplier::setSupplier(const QPlaceSupplier &src, QDeclarativeGeoServiceProvider *plugin) { @@ -146,7 +140,7 @@ QPlaceSupplier QDeclarativeSupplier::supplier() /*! \qmlproperty string Supplier::supplierId - This property holds the id of the supplier. The id is unique + This property holds the identifier of the supplier. The identifier is unique to the Plugin backend which provided the supplier and is generally not suitable for displaying to the user. */ diff --git a/src/imports/location/declarativeplaces/qdeclarativesupportedcategoriesmodel.cpp b/src/imports/location/declarativeplaces/qdeclarativesupportedcategoriesmodel.cpp index 1480a948..a18f5c16 100644 --- a/src/imports/location/declarativeplaces/qdeclarativesupportedcategoriesmodel.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativesupportedcategoriesmodel.cpp @@ -54,7 +54,7 @@ QT_USE_NAMESPACE \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-places \ingroup qml-QtLocation5-places-models - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The CategoryModel element provides a model of the categories supported by a \l Plugin. @@ -122,9 +122,9 @@ QT_USE_NAMESPACE This read-only property holds the current status of the model. \list - \o CategoryModel.Ready - Category request(s) have finished successfully. - \o CategoryModel.Updating - Category request has been issued but not yet finished - \o CategoryModel.Error - An error has occurred, details are in \l errorString + \li CategoryModel.Ready - Category request(s) have finished successfully. + \li CategoryModel.Updating - Category request has been issued but not yet finished + \li CategoryModel.Error - An error has occurred, details are in \l errorString \endlist */ @@ -147,12 +147,18 @@ QDeclarativeSupportedCategoriesModel::~QDeclarativeSupportedCategoriesModel() qDeleteAll(m_categoriesTree); } +/*! + \internal +*/ // From QQmlParserStatus void QDeclarativeSupportedCategoriesModel::componentComplete() { m_complete = true; } +/*! + \internal +*/ int QDeclarativeSupportedCategoriesModel::rowCount(const QModelIndex& parent) const { if (m_categoriesTree.keys().isEmpty()) @@ -167,6 +173,9 @@ int QDeclarativeSupportedCategoriesModel::rowCount(const QModelIndex& parent) co return node->childIds.count(); } +/*! + \internal +*/ int QDeclarativeSupportedCategoriesModel::columnCount(const QModelIndex &parent) const { Q_UNUSED(parent) @@ -174,6 +183,9 @@ int QDeclarativeSupportedCategoriesModel::columnCount(const QModelIndex &parent) return 1; } +/*! + \internal +*/ QModelIndex QDeclarativeSupportedCategoriesModel::index(int row, int column, const QModelIndex &parent) const { if (column != 0 || row < 0) @@ -195,6 +207,9 @@ QModelIndex QDeclarativeSupportedCategoriesModel::index(int row, int column, con return createIndex(row, 0, m_categoriesTree.value(id)); } +/*! + \internal +*/ QModelIndex QDeclarativeSupportedCategoriesModel::parent(const QModelIndex &child) const { PlaceCategoryNode *childNode = static_cast<PlaceCategoryNode *>(child.internalPointer()); @@ -227,6 +242,9 @@ QVariant QDeclarativeSupportedCategoriesModel::data(const QModelIndex &index, in } } +/*! + \internal +*/ void QDeclarativeSupportedCategoriesModel::setPlugin(QDeclarativeGeoServiceProvider *plugin) { if (m_plugin == plugin) @@ -264,11 +282,17 @@ void QDeclarativeSupportedCategoriesModel::setPlugin(QDeclarativeGeoServiceProvi update(); } +/*! + \internal +*/ QDeclarativeGeoServiceProvider* QDeclarativeSupportedCategoriesModel::plugin() const { return m_plugin; } +/*! + \internal +*/ void QDeclarativeSupportedCategoriesModel::setHierarchical(bool hierarchical) { if (m_hierarchical == hierarchical) @@ -280,11 +304,17 @@ void QDeclarativeSupportedCategoriesModel::setHierarchical(bool hierarchical) updateLayout(); } +/*! + \internal +*/ bool QDeclarativeSupportedCategoriesModel::hierarchical() const { return m_hierarchical; } +/*! + \internal +*/ void QDeclarativeSupportedCategoriesModel::replyFinished() { if (!m_response) @@ -308,6 +338,9 @@ void QDeclarativeSupportedCategoriesModel::replyFinished() } } +/*! + \internal +*/ void QDeclarativeSupportedCategoriesModel::addedCategory(const QPlaceCategory &category, const QString &parentId) { @@ -337,6 +370,9 @@ void QDeclarativeSupportedCategoriesModel::addedCategory(const QPlaceCategory &c reset(); } +/*! + \internal +*/ void QDeclarativeSupportedCategoriesModel::updatedCategory(const QPlaceCategory &category, const QString &parentId) { @@ -399,6 +435,9 @@ void QDeclarativeSupportedCategoriesModel::updatedCategory(const QPlaceCategory } } +/*! + \internal +*/ void QDeclarativeSupportedCategoriesModel::removedCategory(const QString &categoryId, const QString &parentId) { if (!m_categoriesTree.contains(categoryId) || !m_categoriesTree.contains(parentId)) @@ -414,6 +453,9 @@ void QDeclarativeSupportedCategoriesModel::removedCategory(const QString &catego endRemoveRows(); } +/*! + \internal +*/ void QDeclarativeSupportedCategoriesModel::connectNotificationSignals() { if (!m_plugin) @@ -439,6 +481,9 @@ void QDeclarativeSupportedCategoriesModel::connectNotificationSignals() this, SLOT(removedCategory(QString, QString))); } +/*! + \internal +*/ void QDeclarativeSupportedCategoriesModel::update() { beginResetModel(); @@ -471,6 +516,9 @@ void QDeclarativeSupportedCategoriesModel::update() } } +/*! + \internal +*/ void QDeclarativeSupportedCategoriesModel::updateLayout() { if (!m_plugin) @@ -534,6 +582,9 @@ QDeclarativeSupportedCategoriesModel::Status QDeclarativeSupportedCategoriesMode return m_status; } +/*! + \internal +*/ QStringList QDeclarativeSupportedCategoriesModel::populateCategories(QPlaceManager *manager, const QPlaceCategory &parent) { Q_ASSERT(manager); @@ -565,6 +616,9 @@ QStringList QDeclarativeSupportedCategoriesModel::populateCategories(QPlaceManag return childIds; } +/*! + \internal +*/ QModelIndex QDeclarativeSupportedCategoriesModel::index(const QString &categoryId) const { if (categoryId.isEmpty()) @@ -584,6 +638,9 @@ QModelIndex QDeclarativeSupportedCategoriesModel::index(const QString &categoryI return createIndex(parentNode->childIds.indexOf(categoryId), 0, categoryNode); } +/*! + \internal +*/ int QDeclarativeSupportedCategoriesModel::rowToAddChild(PlaceCategoryNode *node, const QPlaceCategory &category) { Q_ASSERT(node); @@ -594,7 +651,8 @@ int QDeclarativeSupportedCategoriesModel::rowToAddChild(PlaceCategoryNode *node, return node->childIds.count(); } -/* +/*! + \internal Helper function to return the manager, this manager is intended to be used to perform the next operation. If the checkState parameter is true, the model is checked to see if an operation is underway and if so diff --git a/src/imports/location/qdeclarativecirclemapitem.cpp b/src/imports/location/qdeclarativecirclemapitem.cpp index 4f7135c3..eaeec5d9 100644 --- a/src/imports/location/qdeclarativecirclemapitem.cpp +++ b/src/imports/location/qdeclarativecirclemapitem.cpp @@ -54,7 +54,7 @@ QT_BEGIN_NAMESPACE \qmlclass MapCircle QDeclarativeCircleMapItem \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-maps - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The MapCircle element displays a geographic circle on a Map. @@ -316,7 +316,9 @@ qreal QDeclarativeCircleMapItem::radius() const events. Similarly, setting the visible property to false stops mouse events. */ - +/*! + \internal +*/ QSGNode* QDeclarativeCircleMapItem::updatePaintNode(QSGNode* oldNode, UpdatePaintNodeData* data) { Q_UNUSED(data); @@ -336,6 +338,9 @@ QSGNode* QDeclarativeCircleMapItem::updatePaintNode(QSGNode* oldNode, UpdatePain return node; } +/*! + \internal +*/ void QDeclarativeCircleMapItem::updateMapItem() { if (!map() || !center() || !center()->coordinate().isValid()) @@ -373,6 +378,9 @@ void QDeclarativeCircleMapItem::updateMapItem() update(); } +/*! + \internal +*/ void QDeclarativeCircleMapItem::afterViewportChanged(const QGeoMapViewportChangeEvent &event) { // if the scene is tilted, we must regenerate our geometry every frame @@ -402,6 +410,9 @@ void QDeclarativeCircleMapItem::afterViewportChanged(const QGeoMapViewportChange updateMapItem(); } +/*! + \internal +*/ void QDeclarativeCircleMapItem::dragEnded() { QPointF newPoint = QPointF(x(),y()) + QPointF(width(), height()) / 2; @@ -412,6 +423,9 @@ void QDeclarativeCircleMapItem::dragEnded() } } +/*! + \internal +*/ bool QDeclarativeCircleMapItem::contains(QPointF point) { return (geometry_.contains(point) || borderGeometry_.contains(point)); diff --git a/src/imports/location/qdeclarativecoordinate.cpp b/src/imports/location/qdeclarativecoordinate.cpp index e860e6ea..deec3693 100644 --- a/src/imports/location/qdeclarativecoordinate.cpp +++ b/src/imports/location/qdeclarativecoordinate.cpp @@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE \qmlclass Coordinate QDeclarativeCoordinate \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-positioning - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The Coordinate element represents and stores a geographic position. @@ -116,18 +116,8 @@ QDeclarativeCoordinate::~QDeclarativeCoordinate() {} /*! \qmlproperty QGeoCoordinate Coordinate::coordinate - This property is used to provide an interface between C++ and QML code. First a pointer to a - Coordinate 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 coordinate - property. - - The following gets the QGeoCoordinate representing this object from C++: - - \snippet snippets/cpp/cppqml.cpp Coordinate get - - The following sets the properties of this object based on a QGeoCoordinate object from C++: - - \snippet snippets/cpp/cppqml.cpp Coordinate set + For details on how to use this property to interface between C++ and QML see + "\l {location-cpp-qml.html#geocoordinate} {Interfaces between C++ and QML Code}". */ void QDeclarativeCoordinate::setCoordinate(const QGeoCoordinate &coordinate) { diff --git a/src/imports/location/qdeclarativegeoaddress.cpp b/src/imports/location/qdeclarativegeoaddress.cpp index 483bd4ee..9fe615c9 100644 --- a/src/imports/location/qdeclarativegeoaddress.cpp +++ b/src/imports/location/qdeclarativegeoaddress.cpp @@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE \qmlclass Address QDeclarativeGeoAddress \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-positioning - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The Address QML element represents a specific location as a street address. @@ -91,26 +91,17 @@ QDeclarativeGeoAddress::QDeclarativeGeoAddress(const QGeoAddress& address, QObje { } +/*! + \qmlproperty QGeoAddress QtLocation5::Address::address + + For details on how to use this property to interface between C++ and QML see + "\l {location-cpp-qml.html#geoaddress} {Interfaces between C++ and QML Code}". +*/ QGeoAddress QDeclarativeGeoAddress::address() const { return m_address; } -/*! - \qmlproperty QGeoAddress QtLocation5::Address::address - - This property is used to provide an interface between C++ and QML code. First a pointer to an - Address 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 address property. - - The following gets the QGeoAddress representing this object from C++: - - \snippet snippets/cpp/cppqml.cpp Address get - - The following sets the properties of this object based on a QGeoAddress object from C++: - - \snippet snippets/cpp/cppqml.cpp Address set -*/ void QDeclarativeGeoAddress::setAddress(const QGeoAddress& address) { // Elaborate but takes care of emiting needed signals @@ -150,18 +141,16 @@ void QDeclarativeGeoAddress::setText(const QString &address) emit textChanged(); } +/*! + \qmlproperty string QtLocation5::Address::country + + This property holds the country of the address as a single formatted string. +*/ QString QDeclarativeGeoAddress::country() const { return m_address.country(); } -/*! - \qmlproperty string QtLocation5::Address::country - - This property holds the country of the address. - - */ - void QDeclarativeGeoAddress::setCountry(const QString& country) { if (m_address.country() == country) @@ -170,18 +159,16 @@ void QDeclarativeGeoAddress::setCountry(const QString& country) emit countryChanged(); } +/*! + \qmlproperty string QtLocation5::Address::countryCode + + This property holds the country code of the address as a single formatted string. +*/ QString QDeclarativeGeoAddress::countryCode() const { return m_address.countryCode(); } -/*! - \qmlproperty string QtLocation5::Address::countryCode - - This property holds the country code of the address. - - */ - void QDeclarativeGeoAddress::setCountryCode(const QString& countryCode) { if (m_address.countryCode() == countryCode) @@ -190,18 +177,16 @@ void QDeclarativeGeoAddress::setCountryCode(const QString& countryCode) emit countryCodeChanged(); } +/*! + \qmlproperty string QtLocation5::Address::state + + This property holds the state of the address as a single formatted string. +*/ QString QDeclarativeGeoAddress::state() const { return m_address.state(); } -/*! - \qmlproperty string QtLocation5::Address::state - - This property holds the state of the address. - - */ - void QDeclarativeGeoAddress::setState(const QString& state) { if (m_address.state() == state) @@ -210,18 +195,16 @@ void QDeclarativeGeoAddress::setState(const QString& state) emit stateChanged(); } +/*! + \qmlproperty string QtLocation5::Address::county + + This property holds the county of the address as a single formatted string. +*/ QString QDeclarativeGeoAddress::county() const { return m_address.county(); } -/*! - \qmlproperty string QtLocation5::Address::county - - This property holds the county of the address. - - */ - void QDeclarativeGeoAddress::setCounty(const QString& county) { if (m_address.county() == county) @@ -230,18 +213,16 @@ void QDeclarativeGeoAddress::setCounty(const QString& county) emit countyChanged(); } +/*! + \qmlproperty string QtLocation5::Address::city + + This property holds the city of the address as a single formatted string. +*/ QString QDeclarativeGeoAddress::city() const { return m_address.city(); } -/*! - \qmlproperty string QtLocation5::Address::city - - This property holds the city of the address. - - */ - void QDeclarativeGeoAddress::setCity(const QString& city) { if (m_address.city() == city) @@ -250,18 +231,16 @@ void QDeclarativeGeoAddress::setCity(const QString& city) emit cityChanged(); } +/*! + \qmlproperty string QtLocation5::Address::district + + This property holds the district of the address as a single formatted string. +*/ QString QDeclarativeGeoAddress::district() const { return m_address.district(); } -/*! - \qmlproperty string QtLocation5::Address::district - - This property holds the district of the address. - - */ - void QDeclarativeGeoAddress::setDistrict(const QString& district) { if (m_address.district() == district) @@ -270,11 +249,6 @@ void QDeclarativeGeoAddress::setDistrict(const QString& district) emit districtChanged(); } -QString QDeclarativeGeoAddress::street() const -{ - return m_address.street(); -} - /*! \qmlproperty string QtLocation5::Address::street @@ -282,8 +256,11 @@ QString QDeclarativeGeoAddress::street() const may also contain things like a unit number, a building name, or anything else that might be used to distinguish one address from another. - - */ +*/ +QString QDeclarativeGeoAddress::street() const +{ + return m_address.street(); +} void QDeclarativeGeoAddress::setStreet(const QString& street) { @@ -293,17 +270,16 @@ void QDeclarativeGeoAddress::setStreet(const QString& street) emit streetChanged(); } +/*! + \qmlproperty string QtLocation5::Address::postalCode + + This property holds the postal code of the address as a single formatted string. +*/ QString QDeclarativeGeoAddress::postalCode() const { return m_address.postalCode(); } -/*! - \qmlproperty string QtLocation5::Address::postalCode - - This property holds the postal code of the address. - -*/ void QDeclarativeGeoAddress::setPostalCode(const QString& postalCode) { if (m_address.postalCode() == postalCode) diff --git a/src/imports/location/qdeclarativegeoboundingarea.cpp b/src/imports/location/qdeclarativegeoboundingarea.cpp index d28a2c2e..851a04ce 100644 --- a/src/imports/location/qdeclarativegeoboundingarea.cpp +++ b/src/imports/location/qdeclarativegeoboundingarea.cpp @@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE \qmlclass BoundingArea QDeclarativeGeoBoundingArea \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-positioning - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The BoundingArea element represents an abstract geographic area. diff --git a/src/imports/location/qdeclarativegeoboundingbox.cpp b/src/imports/location/qdeclarativegeoboundingbox.cpp index 1f7528e2..a9f7c02c 100644 --- a/src/imports/location/qdeclarativegeoboundingbox.cpp +++ b/src/imports/location/qdeclarativegeoboundingbox.cpp @@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE \qmlclass BoundingBox QDeclarativeGeoBoundingBox \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-positioning - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The BoundingBox element represents a rectangular geographic area. @@ -107,17 +107,8 @@ QDeclarativeGeoBoundingBox::QDeclarativeGeoBoundingBox(const QGeoBoundingBox &bo /*! \qmlproperty QGeoBoundingBox BoundingBox::box - This property is used to provide an interface between C++ and QML code. First a pointer to a - BoundingBox 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 QGeoBoundingBox representing this object from C++: - - \snippet snippets/cpp/cppqml.cpp BoundingBox get - - The following sets the properties of this object based on a QGeoBoundingBox object from C++: - - \snippet snippets/cpp/cppqml.cpp BoundingBox set + For details on how to use this property to interface between C++ and QML see + "\l {location-cpp-qml.html#boundingbox} {Interfaces between C++ and QML Code}". */ void QDeclarativeGeoBoundingBox::setBox(const QGeoBoundingBox& box) { diff --git a/src/imports/location/qdeclarativegeoboundingcircle.cpp b/src/imports/location/qdeclarativegeoboundingcircle.cpp index 2c56ac53..7d9c2c4e 100644 --- a/src/imports/location/qdeclarativegeoboundingcircle.cpp +++ b/src/imports/location/qdeclarativegeoboundingcircle.cpp @@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE \qmlclass BoundingCircle QDeclarativeGeoBoundingCircle \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-positioning - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The BoundingCircle element represents a circular geographic area. @@ -94,18 +94,8 @@ QDeclarativeGeoBoundingCircle::QDeclarativeGeoBoundingCircle(const QGeoBoundingC /*! \qmlproperty QGeoBoundingCircle BoundingCircle::circle - This property is used to provide an interface between C++ and QML code. First a pointer to a - BoundingCircle 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 circle property. - - The following gets the QGeoBoundingCircle representing this object from C++: - - \snippet snippets/cpp/cppqml.cpp BoundingCircle get - - The following sets the properties of this object based on a QGeoBoundingCircle object from C++: - - \snippet snippets/cpp/cppqml.cpp BoundingCircle set + 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}". */ void QDeclarativeGeoBoundingCircle::setCircle(const QGeoBoundingCircle& circle) { @@ -119,6 +109,9 @@ QGeoBoundingCircle QDeclarativeGeoBoundingCircle::circle() const return m_circle; } +/*! + \internal +*/ QGeoBoundingArea QDeclarativeGeoBoundingCircle::area() const { return circle(); @@ -202,6 +195,9 @@ void QDeclarativeGeoBoundingCircle::setRadius(qreal radius) synchronizeDeclarative(oldCircle, false); } +/*! + \internal +*/ void QDeclarativeGeoBoundingCircle::coordinateChanged() { QDeclarativeCoordinate *c = qobject_cast<QDeclarativeCoordinate *>(sender()); @@ -216,6 +212,9 @@ void QDeclarativeGeoBoundingCircle::coordinateChanged() } } +/*! + \internal +*/ void QDeclarativeGeoBoundingCircle::synchronizeDeclarative(const QGeoBoundingCircle &old, bool skipCenter) { if (!skipCenter && m_center && old.center() != m_circle.center()) diff --git a/src/imports/location/qdeclarativegeocodemodel.cpp b/src/imports/location/qdeclarativegeocodemodel.cpp index 5fac7d6c..b89feab1 100644 --- a/src/imports/location/qdeclarativegeocodemodel.cpp +++ b/src/imports/location/qdeclarativegeocodemodel.cpp @@ -53,7 +53,7 @@ QT_BEGIN_NAMESPACE \qmlclass GeocodeModel QDeclarativeGeocodeModel \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-geocoding - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The GeocodeModel element provides support for searching operations related to geographic information. @@ -61,7 +61,7 @@ QT_BEGIN_NAMESPACE The GeocodeModel element is used as part of a model/view grouping to match addresses or search strings with geographic locations. How the geographic locations generated are used or displayed is decided by any - Views attached to the GeocodeModel (eg. a \l MapItemView or \l{ListView}). + Views attached to the GeocodeModel (for example a \l MapItemView or \l{ListView}). Like \l Map and \l RouteModel, all the data for a GeocodeModel to work comes from a services plugin. This is contained in the \l{plugin} property, @@ -133,7 +133,10 @@ QDeclarativeGeocodeModel::~QDeclarativeGeocodeModel() delete reply_; } -// From QQmlParserStatus +/*! + \internal + From QQmlParserStatus +*/ void QDeclarativeGeocodeModel::componentComplete() { complete_ = true; @@ -141,6 +144,9 @@ void QDeclarativeGeocodeModel::componentComplete() update(); } +/*! + \internal +*/ QGeoBoundingArea QDeclarativeGeocodeModel::boundingArea() { if (qobject_cast<QDeclarativeGeoBoundingBox*>(boundingArea_) && boundingBox_.isValid()) { @@ -220,6 +226,9 @@ void QDeclarativeGeocodeModel::update() } } +/*! + \internal +*/ void QDeclarativeGeocodeModel::abortRequest() { if (reply_) { @@ -229,19 +238,28 @@ void QDeclarativeGeocodeModel::abortRequest() } } +/*! + \internal +*/ void QDeclarativeGeocodeModel::queryContentChanged() { if (autoUpdate_) update(); } -// From QAbstractListModel +/*! + \internal + From QAbstractListModel +*/ int QDeclarativeGeocodeModel::rowCount(const QModelIndex &parent) const { Q_UNUSED(parent) return declarativeLocations_.count(); } +/*! + \internal +*/ QVariant QDeclarativeGeocodeModel::data(const QModelIndex &index, int role) const { if (!index.isValid()) @@ -256,6 +274,9 @@ QVariant QDeclarativeGeocodeModel::data(const QModelIndex &index, int role) cons return QVariant(); } +/*! + \internal +*/ void QDeclarativeGeocodeModel::setPlugin(QDeclarativeGeoServiceProvider *plugin) { if (plugin_ == plugin) @@ -277,6 +298,9 @@ void QDeclarativeGeocodeModel::setPlugin(QDeclarativeGeoServiceProvider *plugin) } } +/*! + \internal +*/ void QDeclarativeGeocodeModel::pluginReady() { QGeoServiceProvider *serviceProvider = plugin_->sharedGeoServiceProvider(); @@ -295,7 +319,7 @@ void QDeclarativeGeocodeModel::pluginReady() \qmlproperty Plugin QtLocation5::GeocodeModel::plugin This property holds the plugin that provides the actual geocoding service. - Note that all plugins do not necessarily provide geocoding (could e.g. provide + Note that all plugins do not necessarily provide geocoding (could for example provide only routing or maps). \sa Plugin @@ -355,6 +379,9 @@ void QDeclarativeGeocodeModel::geocodeFinished(QGeocodeReply *reply) emit countChanged(); } +/*! + \internal +*/ void QDeclarativeGeocodeModel::geocodeError(QGeocodeReply *reply, QGeocodeReply::Error error, const QString &errorString) @@ -452,6 +479,9 @@ void QDeclarativeGeocodeModel::setErrorString(const QString &error) emit errorStringChanged(); } +/*! + \internal +*/ void QDeclarativeGeocodeModel::setLocations(const QList<QGeoLocation> &locations) { beginResetModel(); diff --git a/src/imports/location/qdeclarativegeolocation.cpp b/src/imports/location/qdeclarativegeolocation.cpp index 79776434..c2f0db5e 100644 --- a/src/imports/location/qdeclarativegeolocation.cpp +++ b/src/imports/location/qdeclarativegeolocation.cpp @@ -47,7 +47,7 @@ QT_USE_NAMESPACE \qmlclass Location QDeclarativeGeoLocation \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-positioning - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The Location element holds location data. @@ -107,17 +107,8 @@ QDeclarativeGeoLocation::~QDeclarativeGeoLocation() /*! \qmlproperty QGeoLocation QtLocation5::Location::location - This property is used to provide an interface between C++ and QML code. First a pointer to a - Location 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 location property. - - The following gets the QGeoLocation representing this object from C++: - - \snippet snippets/cpp/cppqml.cpp Location get - - The following sets the properties of this object based on a QGeoLocation object from C++: - - \snippet snippets/cpp/cppqml.cpp Location set + For details on how to use this property to interface between C++ and QML see + "\l {location-cpp-qml.html#location} {Interfaces between C++ and QML Code}". */ void QDeclarativeGeoLocation::setLocation(const QGeoLocation &src) { @@ -155,7 +146,7 @@ QGeoLocation QDeclarativeGeoLocation::location() /*! \qmlproperty Address QtLocation5::Location::address - This property holds address of the location. + This property holds the address of the location which can be use to retrieve address details of the location. */ void QDeclarativeGeoLocation::setAddress(QDeclarativeGeoAddress *address) { @@ -177,7 +168,7 @@ QDeclarativeGeoAddress *QDeclarativeGeoLocation::address() /*! \qmlproperty Coordinate QtLocation5::Location::coordinate - This property holds the exact geographical coordinate of the location. + This property holds the exact geographical coordinate of the location which can be used to retrieve the latitude, longitude and altitude of the location. 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/qdeclarativegeomaneuver.cpp b/src/imports/location/qdeclarativegeomaneuver.cpp index 43609b22..4b05c536 100644 --- a/src/imports/location/qdeclarativegeomaneuver.cpp +++ b/src/imports/location/qdeclarativegeomaneuver.cpp @@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE \qmlclass RouteManeuver QDeclarativeGeoManeuver \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-routing - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The RouteManeuver element represents the information relevant to the point at which two RouteSegments meet. diff --git a/src/imports/location/qdeclarativegeomap.cpp b/src/imports/location/qdeclarativegeomap.cpp index 3ca2e971..63d57366 100644 --- a/src/imports/location/qdeclarativegeomap.cpp +++ b/src/imports/location/qdeclarativegeomap.cpp @@ -72,7 +72,7 @@ QT_BEGIN_NAMESPACE \qmlclass Map QDeclarativeGeoMap \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-maps - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The Map element displays a map. @@ -110,7 +110,7 @@ QT_BEGIN_NAMESPACE Map objects can be declared within the body of a Map element in QML and will automatically appear on the Map. To add objects programmatically, first be - sure they are created with the Map as their parent (e.g. in an argument to + sure they are created with the Map as their parent (for example in an argument to Component::createObject), and then call the \l addMapItem method on the Map. A corresponding \l removeMapItem method also exists to do the opposite and remove an object from the Map. @@ -225,6 +225,9 @@ QDeclarativeGeoMap::~QDeclarativeGeoMap() } } +/*! + \internal +*/ void QDeclarativeGeoMap::onMapChildrenChanged() { if (!componentCompleted_) @@ -269,6 +272,9 @@ void QDeclarativeGeoMap::onMapChildrenChanged() copyrights->setCopyrightsZ(maxChildZ + 1); } +/*! + \internal +*/ void QDeclarativeGeoMap::pluginReady() { serviceProvider_ = plugin_->sharedGeoServiceProvider(); @@ -288,6 +294,9 @@ void QDeclarativeGeoMap::pluginReady() disconnect(this, SLOT(pluginReady())); } +/*! + \internal +*/ void QDeclarativeGeoMap::componentComplete() { QLOC_TRACE0; @@ -297,25 +306,37 @@ void QDeclarativeGeoMap::componentComplete() QQuickItem::componentComplete(); } +/*! + \internal +*/ void QDeclarativeGeoMap::mousePressEvent(QMouseEvent *event) { if (!mouseEvent(event)) event->ignore(); } +/*! + \internal +*/ void QDeclarativeGeoMap::mouseMoveEvent(QMouseEvent *event) { if (!mouseEvent(event)) event->ignore(); } +/*! + \internal +*/ void QDeclarativeGeoMap::mouseReleaseEvent(QMouseEvent *event) { if (!mouseEvent(event)) event->ignore(); } -// returns whether flickable used the event +/*! + \internal + returns whether flickable used the event +*/ bool QDeclarativeGeoMap::mouseEvent(QMouseEvent* event) { if (!mappingManagerInitialized_) @@ -356,6 +377,9 @@ QDeclarativeGeoMapFlickable* QDeclarativeGeoMap::flick() return flickable_; } +/*! + \internal +*/ void QDeclarativeGeoMap::itemChange(ItemChange change, const ItemChangeData & data) { QLOC_TRACE0; @@ -363,6 +387,9 @@ void QDeclarativeGeoMap::itemChange(ItemChange change, const ItemChangeData & da canvas_ = data.canvas; } +/*! + \internal +*/ void QDeclarativeGeoMap::populateMap() { QObjectList kids = children(); @@ -381,6 +408,9 @@ void QDeclarativeGeoMap::populateMap() } } +/*! + \internal +*/ void QDeclarativeGeoMap::setupMapView(QDeclarativeGeoMapItemView *view) { Q_UNUSED(view) @@ -388,6 +418,9 @@ void QDeclarativeGeoMap::setupMapView(QDeclarativeGeoMapItemView *view) view->repopulate(); } +/*! + \internal +*/ QSGNode* QDeclarativeGeoMap::updatePaintNode(QSGNode* oldNode, UpdatePaintNodeData* data) { Q_UNUSED(data) @@ -438,7 +471,10 @@ void QDeclarativeGeoMap::setPlugin(QDeclarativeGeoServiceProvider *plugin) } } -// this function will only be ever called once +/*! + \internal + this function will only be ever called once +*/ void QDeclarativeGeoMap::mappingManagerInitialized() { mappingManagerInitialized_ = true; @@ -512,12 +548,19 @@ void QDeclarativeGeoMap::mappingManagerInitialized() emit activeMapTypeChanged(); } +/*! + \internal +*/ void QDeclarativeGeoMap::updateMapDisplay(const QRectF &target) { Q_UNUSED(target); QQuickItem::update(); } + +/*! + \internal +*/ QDeclarativeGeoServiceProvider* QDeclarativeGeoMap::plugin() const { return plugin_; @@ -557,6 +600,9 @@ qreal QDeclarativeGeoMap::maximumZoomLevel() const return -1.0; } +/*! + \internal +*/ void QDeclarativeGeoMap::setBearing(qreal bearing) { if (bearing_ == bearing) @@ -582,9 +628,9 @@ void QDeclarativeGeoMap::setBearing(qreal bearing) visually looks like rotating the map counter-clockwise. You can also assign negative values, which will internally get - translated into positive bearing (e.g. -10 equals 350). This is primarily for - convenience (e.g. you can decrement bearing without worrying about it). - Assigning values greater than abs(360) will be mod'd (e.g. 365 will result + translated into positive bearing (for example -10 equals 350). This is primarily for + convenience (for example you can decrement bearing without worrying about it). + Assigning values greater than abs(360) will be mod'd (for example 365 will result in 5). The default value is 0 corresponding North pointing up. @@ -602,16 +648,6 @@ qreal QDeclarativeGeoMap::bearing() const } } -void QDeclarativeGeoMap::setTilt(qreal tilt) -{ - if (tilt_ == tilt || tilt > 85.0 || tilt < 0) - return; - tilt_ = tilt; - if (mappingManagerInitialized_) - map_->mapController()->setTilt(tilt); - emit tiltChanged(tilt); -} - /*! \qmlproperty real Map::tilt @@ -629,6 +665,16 @@ qreal QDeclarativeGeoMap::tilt() const return map_->mapController()->tilt(); } +void QDeclarativeGeoMap::setTilt(qreal tilt) +{ + if (tilt_ == tilt || tilt > 85.0 || tilt < 0) + return; + tilt_ = tilt; + if (mappingManagerInitialized_) + map_->mapController()->setTilt(tilt); + emit tiltChanged(tilt); +} + /*! \qmlproperty real QtLocation5::Map::zoomLevel @@ -725,6 +771,9 @@ QDeclarativeCoordinate* QDeclarativeGeoMap::center() return center_; } +/*! + \internal +*/ void QDeclarativeGeoMap::mapZoomLevelChanged(qreal zoom) { if (zoom == zoomLevel_) @@ -733,6 +782,9 @@ void QDeclarativeGeoMap::mapZoomLevelChanged(qreal zoom) emit zoomLevelChanged(zoomLevel_); } +/*! + \internal +*/ void QDeclarativeGeoMap::mapTiltChanged(qreal tilt) { if (tilt == zoomLevel_) @@ -741,6 +793,9 @@ void QDeclarativeGeoMap::mapTiltChanged(qreal tilt) emit tiltChanged(tilt_); } +/*! + \internal +*/ void QDeclarativeGeoMap::mapBearingChanged(qreal bearing) { if (bearing == bearing_) @@ -749,6 +804,9 @@ void QDeclarativeGeoMap::mapBearingChanged(qreal bearing) emit bearingChanged(bearing_); } +/*! + \internal +*/ void QDeclarativeGeoMap::mapCenterChanged(AnimatableCoordinate center) { if (center.coordinate() != this->center()->coordinate()) { @@ -758,6 +816,9 @@ void QDeclarativeGeoMap::mapCenterChanged(AnimatableCoordinate center) } } +/*! + \internal +*/ void QDeclarativeGeoMap::centerLatitudeChanged(double latitude) { if (qIsNaN(latitude)) @@ -777,6 +838,9 @@ void QDeclarativeGeoMap::centerLatitudeChanged(double latitude) } } +/*! + \internal +*/ void QDeclarativeGeoMap::centerLongitudeChanged(double longitude) { if (qIsNaN(longitude)) @@ -796,6 +860,9 @@ void QDeclarativeGeoMap::centerLongitudeChanged(double longitude) } } +/*! + \internal +*/ void QDeclarativeGeoMap::centerAltitudeChanged(double altitude) { if (qIsNaN(altitude)) @@ -865,6 +932,9 @@ QPointF QDeclarativeGeoMap::toScreenPosition(QDeclarativeCoordinate* coordinate) return point; } +/*! + \internal +*/ void QDeclarativeGeoMap::pan(int dx, int dy) { if (!mappingManagerInitialized_) @@ -872,6 +942,9 @@ void QDeclarativeGeoMap::pan(int dx, int dy) map_->mapController()->pan(dx, dy); } +/*! + \internal +*/ void QDeclarativeGeoMap::touchEvent(QTouchEvent *event) { if (!mappingManagerInitialized_) { @@ -883,6 +956,9 @@ void QDeclarativeGeoMap::touchEvent(QTouchEvent *event) pinchArea_->touchEvent(event); } +/*! + \internal +*/ void QDeclarativeGeoMap::wheelEvent(QWheelEvent *event) { QLOC_TRACE0; @@ -893,7 +969,7 @@ void QDeclarativeGeoMap::wheelEvent(QWheelEvent *event) /*! \qmlmethod QtLocation5::Map::addMapItem(MapItem item) - Adds the given \a item to the Map (e.g. MapQuickItem, MapCircle). If the object + 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. As an example, consider the case where you have a MapCircle representing your current position: @@ -940,7 +1016,7 @@ QList<QObject*> QDeclarativeGeoMap::mapItems() /*! \qmlmethod void QtLocation5::Map::removeMapItem(MapItem item) - Removes the given \a item from the Map (e.g. MapQuickItem, MapCircle). If + 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 method does nothing. @@ -984,14 +1060,6 @@ void QDeclarativeGeoMap::clearMapItems() updateMutex_.unlock(); } -void QDeclarativeGeoMap::setActiveMapType(QDeclarativeGeoMapType *mapType) -{ - activeMapType_ = mapType; - map_->setActiveMapType(mapType->mapType()); - emit activeMapTypeChanged(); -} - - /*! \qmlproperty MapType QtLocation5::Map::activeMapType @@ -1002,6 +1070,12 @@ void QDeclarativeGeoMap::setActiveMapType(QDeclarativeGeoMapType *mapType) \sa MapType */ +void QDeclarativeGeoMap::setActiveMapType(QDeclarativeGeoMapType *mapType) +{ + activeMapType_ = mapType; + map_->setActiveMapType(mapType->mapType()); + emit activeMapTypeChanged(); +} QDeclarativeGeoMapType * QDeclarativeGeoMap::activeMapType() const { @@ -1009,12 +1083,8 @@ QDeclarativeGeoMapType * QDeclarativeGeoMap::activeMapType() const } /*! - \qmlmethod QtLocation5::Map::removeMapItem(MapItem) - - Removes the given MapItem from the Map. If the MapItem does not - exist, function does nothing. + \internal */ - void QDeclarativeGeoMap::geometryChanged(const QRectF &newGeometry, const QRectF &oldGeometry) { if (!mappingManagerInitialized_) diff --git a/src/imports/location/qdeclarativegeomapcopyrightsnotice.cpp b/src/imports/location/qdeclarativegeomapcopyrightsnotice.cpp index 450229c3..c0548d0a 100644 --- a/src/imports/location/qdeclarativegeomapcopyrightsnotice.cpp +++ b/src/imports/location/qdeclarativegeomapcopyrightsnotice.cpp @@ -53,17 +53,26 @@ QDeclarativeGeoMapCopyrightNotice::~QDeclarativeGeoMapCopyrightNotice() { } +/*! + \internal +*/ void QDeclarativeGeoMapCopyrightNotice::paint(QPainter *painter) { painter->drawImage(0, 0, copyrightsImage_); } +/*! + \internal +*/ void QDeclarativeGeoMapCopyrightNotice::setCopyrightsZ(int copyrightsZ) { setZ(copyrightsZ); update(); } +/*! + \internal +*/ void QDeclarativeGeoMapCopyrightNotice::copyrightsChanged(const QImage ©rightsImage, const QPoint ©rightsPos) { setX(copyrightsPos.x()); diff --git a/src/imports/location/qdeclarativegeomapflickable.cpp b/src/imports/location/qdeclarativegeomapflickable.cpp index 06ab7871..78e6a3b0 100644 --- a/src/imports/location/qdeclarativegeomapflickable.cpp +++ b/src/imports/location/qdeclarativegeomapflickable.cpp @@ -118,7 +118,7 @@ QT_BEGIN_NAMESPACE \endcode \ingroup qml-QtLocation5-maps - \since QtLocation 5.0 + \since Qt Location 5.0 */ /*! @@ -193,6 +193,9 @@ QDeclarativeGeoMapFlickable::~QDeclarativeGeoMapFlickable() { } +/*! + \internal +*/ void QDeclarativeGeoMapFlickable::setMap(QGeoMap* map) { if (map_ || !map) @@ -203,11 +206,17 @@ void QDeclarativeGeoMapFlickable::setMap(QGeoMap* map) connect(animation_, SIGNAL(finished()), this, SLOT(flickAnimationFinished())); } +/*! + \internal +*/ qreal QDeclarativeGeoMapFlickable::deceleration() const { return deceleration_; } +/*! + \internal +*/ void QDeclarativeGeoMapFlickable::setDeceleration(qreal deceleration) { if (deceleration < QML_MAP_FLICK_MINIMUMDECELERATION) @@ -220,6 +229,9 @@ void QDeclarativeGeoMapFlickable::setDeceleration(qreal deceleration) emit decelerationChanged(); } +/*! + \internal +*/ bool QDeclarativeGeoMapFlickable::mousePressEvent(QMouseEvent *event) { if (!enabled_) @@ -234,6 +246,9 @@ bool QDeclarativeGeoMapFlickable::mousePressEvent(QMouseEvent *event) return true; } +/*! + \internal +*/ void QDeclarativeGeoMapFlickable::stop() { velocityBufferX_.clear(); @@ -255,6 +270,9 @@ void QDeclarativeGeoMapFlickable::stop() velocityTime_.invalidate(); } +/*! + \internal +*/ bool QDeclarativeGeoMapFlickable::mouseMoveEvent(QMouseEvent *event) { if (!enabled_ || !pressed_ || !lastPosTime_.isValid()) @@ -298,6 +316,9 @@ bool QDeclarativeGeoMapFlickable::mouseMoveEvent(QMouseEvent *event) return true; } +/*! + \internal +*/ // FIXME: // - not left right / up down flicking, so if map is rotated, will act unintuitively void QDeclarativeGeoMapFlickable::updateCamera(int dx, int dy, int timeMs) @@ -333,8 +354,11 @@ void QDeclarativeGeoMapFlickable::updateCamera(int dx, int dy, int timeMs) } } -// Adds velocity sample to sample buffer. Data is later used to calculate -// flick speed. By default 3 latest samples are considered. +/*! + \internal + Adds velocity sample to sample buffer. Data is later used to calculate + flick speed. By default 3 latest samples are considered. +*/ void QDeclarativeGeoMapFlickable::addVelocitySample(QVector<qreal>& buffer, qreal sample) { if (sample > maxVelocity_) @@ -346,6 +370,9 @@ void QDeclarativeGeoMapFlickable::addVelocitySample(QVector<qreal>& buffer, qrea buffer.remove(0); } +/*! + \internal +*/ void QDeclarativeGeoMapFlickable::updateVelocity(QVector<qreal>& buffer, qreal& velocity) { if (buffer.count() > QML_MAP_FLICK_DISCARDSAMPLES) { @@ -359,7 +386,9 @@ void QDeclarativeGeoMapFlickable::updateVelocity(QVector<qreal>& buffer, qreal& } } - +/*! + \internal +*/ void QDeclarativeGeoMapFlickable::setEnabled(bool enabled) { if (enabled_ == enabled) @@ -370,11 +399,17 @@ void QDeclarativeGeoMapFlickable::setEnabled(bool enabled) emit enabledChanged(); } +/*! + \internal +*/ bool QDeclarativeGeoMapFlickable::enabled() const { return enabled_; } +/*! + \internal +*/ bool QDeclarativeGeoMapFlickable::mouseReleaseEvent(QMouseEvent *event) { if (!pressed_ || !enabled_) @@ -434,6 +469,9 @@ bool QDeclarativeGeoMapFlickable::mouseReleaseEvent(QMouseEvent *event) return true; } +/*! + \internal +*/ void QDeclarativeGeoMapFlickable::flickAnimationFinished() { //qDebug() << metaObject()->className() << __FUNCTION__; @@ -452,6 +490,9 @@ void QDeclarativeGeoMapFlickable::flickAnimationValueChanged(const QVariant& val } */ +/*! + \internal +*/ void QDeclarativeGeoMapFlickable::timerEvent(QTimerEvent *event) { Q_UNUSED(event); // TODO press delay handling diff --git a/src/imports/location/qdeclarativegeomapitembase.cpp b/src/imports/location/qdeclarativegeomapitembase.cpp index 9fe7766c..ee264e78 100644 --- a/src/imports/location/qdeclarativegeomapitembase.cpp +++ b/src/imports/location/qdeclarativegeomapitembase.cpp @@ -84,6 +84,9 @@ QDeclarativeGeoMapItemBase::~QDeclarativeGeoMapItemBase() quickMap_->removeMapItem(this); } +/*! + \internal +*/ void QDeclarativeGeoMapItemBase::afterChildrenChanged() { QList<QQuickItem*> kids = childItems(); @@ -104,20 +107,32 @@ void QDeclarativeGeoMapItemBase::afterChildrenChanged() } } +/*! + \internal +*/ bool QDeclarativeGeoMapItemBase::contains(QPointF point) { Q_UNUSED(point); return true; } +/*! + \internal +*/ void QDeclarativeGeoMapItemBase::dragStarted() { } +/*! + \internal +*/ void QDeclarativeGeoMapItemBase::dragEnded() { } +/*! + \internal +*/ void QDeclarativeGeoMapItemBase::setMap(QDeclarativeGeoMap *quickMap, QGeoMap *map) { if (quickMap == quickMap_) return; @@ -139,6 +154,9 @@ void QDeclarativeGeoMapItemBase::setMap(QDeclarativeGeoMap *quickMap, QGeoMap *m } } +/*! + \internal +*/ void QDeclarativeGeoMapItemBase::baseCameraDataChanged(const QGeoCameraData &cameraData) { QGeoMapViewportChangeEvent evt; @@ -165,6 +183,9 @@ void QDeclarativeGeoMapItemBase::baseCameraDataChanged(const QGeoCameraData &cam afterViewportChanged(evt); } +/*! + \internal +*/ void QDeclarativeGeoMapItemBase::setPositionOnMap(const QGeoCoordinate& coordinate, const QPointF& offset) { if (!map_ || !quickMap_) diff --git a/src/imports/location/qdeclarativegeomapitemview.cpp b/src/imports/location/qdeclarativegeomapitemview.cpp index be4662ae..649638c7 100644 --- a/src/imports/location/qdeclarativegeomapitemview.cpp +++ b/src/imports/location/qdeclarativegeomapitemview.cpp @@ -55,7 +55,7 @@ QT_BEGIN_NAMESPACE \qmlclass MapItemView QDeclarativeGeoMapItemView \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-maps - \since QtLocation 5.0 + \since Qt Location 5.0 \inherits QQuickItem \brief The MapItemView is used to populate Map from a model. @@ -87,22 +87,24 @@ QDeclarativeGeoMapItemView::~QDeclarativeGeoMapItemView() removeInstantiatedItems(); } +/*! + \internal +*/ void QDeclarativeGeoMapItemView::componentComplete() { componentCompleted_ = true; } -QVariant QDeclarativeGeoMapItemView::model() const -{ - return modelVariant_; -} - /*! \qmlproperty model QtLocation5::MapItemView::model This property holds the model that provides data for populating data with delegates. */ +QVariant QDeclarativeGeoMapItemView::model() const +{ + return modelVariant_; +} void QDeclarativeGeoMapItemView::setModel(const QVariant &model) { @@ -124,11 +126,17 @@ void QDeclarativeGeoMapItemView::setModel(const QVariant &model) emit modelChanged(); } +/*! + \internal +*/ void QDeclarativeGeoMapItemView::modelReset() { repopulate(); } +/*! + \internal +*/ void QDeclarativeGeoMapItemView::modelRowsInserted(QModelIndex, int start, int end) { if (!componentCompleted_ || !map_ || !delegate_ || !model_) { @@ -144,6 +152,9 @@ void QDeclarativeGeoMapItemView::modelRowsInserted(QModelIndex, int start, int e } } +/*! + \internal +*/ void QDeclarativeGeoMapItemView::modelRowsRemoved(QModelIndex, int start, int end) { if (!componentCompleted_ || !map_ || !delegate_ || !model_) @@ -158,11 +169,6 @@ void QDeclarativeGeoMapItemView::modelRowsRemoved(QModelIndex, int start, int en } } -QQmlComponent* QDeclarativeGeoMapItemView::delegate() const -{ - return delegate_; -} - /*! \qmlproperty Component QtLocation5::MapItemView::delegate @@ -171,6 +177,10 @@ QQmlComponent* QDeclarativeGeoMapItemView::delegate() const MapItem -derived element as the root element. */ +QQmlComponent* QDeclarativeGeoMapItemView::delegate() const +{ + return delegate_; +} void QDeclarativeGeoMapItemView::setDelegate(QQmlComponent *delegate) { @@ -182,7 +192,9 @@ void QDeclarativeGeoMapItemView::setDelegate(QQmlComponent *delegate) emit delegateChanged(); } -//void QDeclarativeGeoMapItemView::setMapData(QDeclarativeGraphicsGeoMap* map) +/*! + \internal +*/ void QDeclarativeGeoMapItemView::setMapData(QDeclarativeGeoMap* map) { if (!map || map_) // changing map on the fly not supported @@ -190,6 +202,9 @@ void QDeclarativeGeoMapItemView::setMapData(QDeclarativeGeoMap* map) map_ = map; } +/*! + \internal +*/ void QDeclarativeGeoMapItemView::removeInstantiatedItems() { if (!map_) @@ -201,7 +216,10 @@ void QDeclarativeGeoMapItemView::removeInstantiatedItems() mapItemList_.clear(); } -// Removes and repopulates all items. +/*! + \internal + Removes and repopulates all items. +*/ void QDeclarativeGeoMapItemView::repopulate() { if (!componentCompleted_ || !map_ || !delegate_ || !model_) @@ -224,10 +242,12 @@ void QDeclarativeGeoMapItemView::repopulate() } } -// Currently item creation is tightly bound to models providing -// QObject* as data. Some day this may be leveraged to any user defined -// model or e.g. XML model. -//QDeclarativeGeoMapItem* QDeclarativeGeoMapItemView::createItem(int modelRow) +/*! + \internal + Currently item creation is tightly bound to models providing + QObject* as data. Some day this may be leveraged to any user defined + model or for example XML model. +*/ QDeclarativeGeoMapItemBase* QDeclarativeGeoMapItemView::createItem(int modelRow) { if (!delegate_ || !model_) @@ -279,7 +299,6 @@ QDeclarativeGeoMapItemBase* QDeclarativeGeoMapItemView::createItem(int modelRow) This property holds whether the delegate objects created from the model are visible or not. Default value is true. - */ void QDeclarativeGeoMapItemView::setVisible(bool visible) @@ -303,7 +322,6 @@ bool QDeclarativeGeoMapItemView::isVisible() const drawn in insertion order. */ - void QDeclarativeGeoMapItemView::setZValue(qreal zValue) { // TODO z values diff --git a/src/imports/location/qdeclarativegeomapmousearea.cpp b/src/imports/location/qdeclarativegeomapmousearea.cpp index 015c8cbd..c881159b 100644 --- a/src/imports/location/qdeclarativegeomapmousearea.cpp +++ b/src/imports/location/qdeclarativegeomapmousearea.cpp @@ -60,7 +60,7 @@ QT_BEGIN_NAMESPACE Like a standard Qt Quick \l{MouseArea}, the MapMouseArea provides mouse handling for an item. Creating a normal Qt Quick MouseArea inside a - map object element (eg. MapPolygon) will result in undefined behaviour + map object element (for example MapPolygon) will result in undefined behaviour due to the way in which Map objects are rendered, so MapMouseArea exists to provide this functionality instead. @@ -108,12 +108,12 @@ QT_BEGIN_NAMESPACE Some important limitations apply to the use of a MapMouseArea: \list \li The mouse event is guaranteed only to be valid for the - duration of the signal handler (e.g. onPositionChanged, onClicked). Consequently + duration of the signal handler (for example onPositionChanged, onClicked). Consequently the mouse event itself should not be stored. The main reason for this is to optimize memory usage; we do not want to allocate heap memory every time the mouse moves. \li Nested mouse areas are not supported (MapMouseArea { MapMouseArea {} }. - \li If two or more MapMouseAreas overlap, the declaration order is significant (not e.g. 'z' value). + \li If two or more MapMouseAreas overlap, the declaration order is significant (not for example 'z' value). \li Only one MapMouseArea per MapItem is supported, and it always fills the whole MapItem. \endlist @@ -145,6 +145,9 @@ QDeclarativeCoordinate* QDeclarativeGeoMapMouseArea::mouseToCoordinate(QQuickMou return new QDeclarativeCoordinate; // return invalid coordinate } +/*! + \internal +*/ // TODO: cache the map association and hook up to parent change -signals QDeclarativeGeoMap* QDeclarativeGeoMapMouseArea::map() { @@ -161,12 +164,18 @@ QDeclarativeGeoMap* QDeclarativeGeoMapMouseArea::map() return map; } +/*! + \internal +*/ void QDeclarativeGeoMapMouseArea::dragActiveChanged() { if (drag() && drag()->property("active").toBool()) dragActive_ = true; } +/*! + \internal +*/ void QDeclarativeGeoMapMouseArea::componentComplete() { componentCompleted_ = true; @@ -174,6 +183,9 @@ void QDeclarativeGeoMapMouseArea::componentComplete() QQuickMouseArea::componentComplete(); } +/*! + \internal +*/ void QDeclarativeGeoMapMouseArea::mousePressEvent(QMouseEvent *event) { // map element's flickable may use the event @@ -192,6 +204,9 @@ void QDeclarativeGeoMapMouseArea::mousePressEvent(QMouseEvent *event) event->ignore(); } +/*! + \internal +*/ void QDeclarativeGeoMapMouseArea::mouseReleaseEvent(QMouseEvent *event) { // map element's flickable may use the event @@ -209,11 +224,17 @@ void QDeclarativeGeoMapMouseArea::mouseReleaseEvent(QMouseEvent *event) QQuickMouseArea::mouseReleaseEvent(event); } +/*! + \internal +*/ void QDeclarativeGeoMapMouseArea::mouseDoubleClickEvent(QMouseEvent *event) { QQuickMouseArea::mouseDoubleClickEvent(event); } +/*! + \internal +*/ void QDeclarativeGeoMapMouseArea::mouseMoveEvent(QMouseEvent *event) { // map element's flickable may use the event @@ -224,6 +245,9 @@ void QDeclarativeGeoMapMouseArea::mouseMoveEvent(QMouseEvent *event) QQuickMouseArea::mouseMoveEvent(event); } +/*! + \internal +*/ void QDeclarativeGeoMapMouseArea::hoverEnterEvent(QHoverEvent *event) { QQuickItem* pmi = parentMapItem(); @@ -238,6 +262,9 @@ void QDeclarativeGeoMapMouseArea::hoverEnterEvent(QHoverEvent *event) event->ignore(); } +/*! + \internal +*/ void QDeclarativeGeoMapMouseArea::hoverMoveEvent(QHoverEvent *event) { QQuickItem* pmi = parentMapItem(); @@ -258,6 +285,9 @@ void QDeclarativeGeoMapMouseArea::hoverMoveEvent(QHoverEvent *event) event->ignore(); } +/*! + \internal +*/ void QDeclarativeGeoMapMouseArea::hoverLeaveEvent(QHoverEvent *event) { QQuickItem* pmi = parentMapItem(); @@ -274,6 +304,9 @@ void QDeclarativeGeoMapMouseArea::hoverLeaveEvent(QHoverEvent *event) event->ignore(); } +/*! + \internal +*/ QQuickItem* QDeclarativeGeoMapMouseArea::parentMapItem() { QQuickItem* item = this; diff --git a/src/imports/location/qdeclarativegeomapmouseevent.cpp b/src/imports/location/qdeclarativegeomapmouseevent.cpp index 9bf646e8..c97b0b1e 100644 --- a/src/imports/location/qdeclarativegeomapmouseevent.cpp +++ b/src/imports/location/qdeclarativegeomapmouseevent.cpp @@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE \qmlclass MapMouseEvent QDeclarativeGeoMapMouseEvent \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-maps - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The MapMouseEvent object provides information about a mouse event. @@ -194,9 +194,8 @@ bool QDeclarativeGeoMapMouseEvent::wasHeld() const /*! \qmlproperty int QtLocation5::MapMouseEvent::x - \qmlproperty int QtLocation5::MapMouseEvent::y - These properties hold the screen coordinates of the position supplied + This property holds the x-screen coordinate of the position supplied by the mouse event. */ @@ -210,6 +209,13 @@ int QDeclarativeGeoMapMouseEvent::x() const return x_; } +/*! + \qmlproperty int QtLocation5::MapMouseEvent::y + + This property holds the y-screen coordinate of the position supplied + by the mouse event. +*/ + void QDeclarativeGeoMapMouseEvent::setY(int y) { y_ = y; diff --git a/src/imports/location/qdeclarativegeomappincharea.cpp b/src/imports/location/qdeclarativegeomappincharea.cpp index 0fe52271..fa5aa25a 100644 --- a/src/imports/location/qdeclarativegeomappincharea.cpp +++ b/src/imports/location/qdeclarativegeomappincharea.cpp @@ -58,7 +58,7 @@ QT_BEGIN_NAMESPACE \brief MapPinchEvent element provides basic information about pinch event. MapPinchEvent element provides basic information about pinch event. They are - present in handlers of MapPinch (e.g. pinchStarted/pinchUpdated). Events are only + present in handlers of MapPinch (for example pinchStarted/pinchUpdated). Events are only guaranteed to be valid for the duration of the handler. Except for the \l accepted property, all properties are read-only. @@ -83,7 +83,7 @@ QT_BEGIN_NAMESPACE \endcode \ingroup qml-QtLocation5-maps - \since QtLocation 5.0 + \since Qt Location 5.0 */ /*! @@ -163,7 +163,7 @@ QT_BEGIN_NAMESPACE \endcode \ingroup qml-QtLocation5-maps - \since QtLocation 5.0 + \since Qt Location 5.0 */ /*! @@ -289,11 +289,17 @@ QDeclarativeGeoMapPinchArea::~QDeclarativeGeoMapPinchArea() { } +/*! + \internal +*/ QDeclarativeGeoMapPinchArea::ActiveGestures QDeclarativeGeoMapPinchArea::activeGestures() const { return activeGestures_; } +/*! + \internal +*/ void QDeclarativeGeoMapPinchArea::setActiveGestures(ActiveGestures activeGestures) { if (activeGestures == activeGestures_) @@ -306,11 +312,17 @@ void QDeclarativeGeoMapPinchArea::setActiveGestures(ActiveGestures activeGesture emit activeGesturesChanged(); } +/*! + \internal +*/ bool QDeclarativeGeoMapPinchArea::active() const { return active_; } +/*! + \internal +*/ void QDeclarativeGeoMapPinchArea::setActive(bool active) { if (active == active_) @@ -319,11 +331,17 @@ void QDeclarativeGeoMapPinchArea::setActive(bool active) emit activeChanged(); } +/*! + \internal +*/ bool QDeclarativeGeoMapPinchArea::enabled() const { return enabled_; } +/*! + \internal +*/ void QDeclarativeGeoMapPinchArea::setEnabled(bool enabled) { if (enabled == enabled_) @@ -332,11 +350,17 @@ void QDeclarativeGeoMapPinchArea::setEnabled(bool enabled) emit enabledChanged(); } +/*! + \internal +*/ qreal QDeclarativeGeoMapPinchArea::minimumZoomLevel() const { return minimumZoomLevel_; } +/*! + \internal +*/ void QDeclarativeGeoMapPinchArea::setMinimumZoomLevel(qreal zoomLevel) { if (zoomLevel == minimumZoomLevel_ || @@ -347,11 +371,17 @@ void QDeclarativeGeoMapPinchArea::setMinimumZoomLevel(qreal zoomLevel) emit minimumZoomLevelChanged(); } +/*! + \internal +*/ qreal QDeclarativeGeoMapPinchArea::maximumZoomLevel() const { return maximumZoomLevel_; } +/*! + \internal +*/ void QDeclarativeGeoMapPinchArea::setMaximumZoomLevel(qreal zoomLevel) { if (zoomLevel == maximumZoomLevel_ || @@ -362,9 +392,12 @@ void QDeclarativeGeoMapPinchArea::setMaximumZoomLevel(qreal zoomLevel) emit maximumZoomLevelChanged(); } -// called internally when plugin's limits change. somewhat dodgy but -// initialization order complicates the zoom limit settings a bit (e.g. when is -// it possible to check against mapping plugins' limits) +/*! + \internal + called internally when plugin's limits change. somewhat dodgy but + initialization order complicates the zoom limit settings a bit (for example when is + it possible to check against mapping plugins' limits) +*/ void QDeclarativeGeoMapPinchArea::zoomLevelLimits(qreal min, qreal max) { if (minimumZoomLevel_ == -1.0 || min > minimumZoomLevel_) @@ -373,11 +406,17 @@ void QDeclarativeGeoMapPinchArea::zoomLevelLimits(qreal min, qreal max) setMaximumZoomLevel(max); } +/*! + \internal +*/ qreal QDeclarativeGeoMapPinchArea::maximumZoomLevelChange() const { return maximumZoomLevelChange_; } +/*! + \internal +*/ void QDeclarativeGeoMapPinchArea::setMaximumZoomLevelChange(qreal maxChange) { if (maxChange == maximumZoomLevelChange_ || maxChange < 0.1 || maxChange > 10.0) @@ -386,11 +425,17 @@ void QDeclarativeGeoMapPinchArea::setMaximumZoomLevelChange(qreal maxChange) emit maximumZoomLevelChangeChanged(); } +/*! + \internal +*/ qreal QDeclarativeGeoMapPinchArea::minimumRotation() const { return minimumRotation_; } +/*! + \internal +*/ void QDeclarativeGeoMapPinchArea::setMinimumRotation(qreal rotation) { if (rotation == minimumRotation_ || @@ -401,11 +446,17 @@ void QDeclarativeGeoMapPinchArea::setMinimumRotation(qreal rotation) emit minimumRotationChanged(); } +/*! + \internal +*/ qreal QDeclarativeGeoMapPinchArea::maximumRotation() const { return maximumRotation_; } +/*! + \internal +*/ void QDeclarativeGeoMapPinchArea::setMaximumRotation(qreal rotation) { if (rotation == maximumRotation_ || @@ -416,11 +467,17 @@ void QDeclarativeGeoMapPinchArea::setMaximumRotation(qreal rotation) emit maximumRotationChanged(); } +/*! + \internal +*/ qreal QDeclarativeGeoMapPinchArea::rotationFactor() const { return rotationFactor_; } +/*! + \internal +*/ void QDeclarativeGeoMapPinchArea::setRotationFactor(qreal factor) { if (rotationFactor_ == factor || @@ -431,11 +488,17 @@ void QDeclarativeGeoMapPinchArea::setRotationFactor(qreal factor) emit rotationFactorChanged(); } +/*! + \internal +*/ qreal QDeclarativeGeoMapPinchArea::maximumTilt() const { return maximumTilt_; } +/*! + \internal +*/ void QDeclarativeGeoMapPinchArea::setMaximumTilt(qreal tilt) { if (maximumTilt_ == tilt) @@ -444,11 +507,17 @@ void QDeclarativeGeoMapPinchArea::setMaximumTilt(qreal tilt) emit maximumTiltChanged(); } +/*! + \internal +*/ qreal QDeclarativeGeoMapPinchArea::minimumTilt() const { return minimumTilt_; } +/*! + \internal +*/ void QDeclarativeGeoMapPinchArea::setMinimumTilt(qreal tilt) { if (minimumTilt_ == tilt || tilt < 0.1) @@ -457,11 +526,17 @@ void QDeclarativeGeoMapPinchArea::setMinimumTilt(qreal tilt) emit minimumTiltChanged(); } +/*! + \internal +*/ qreal QDeclarativeGeoMapPinchArea::maximumTiltChange() const { return maximumTiltChange_; } +/*! + \internal +*/ void QDeclarativeGeoMapPinchArea::setMaximumTiltChange(qreal tilt) { if (maximumTiltChange_ == tilt || tilt < 0.1) @@ -470,6 +545,9 @@ void QDeclarativeGeoMapPinchArea::setMaximumTiltChange(qreal tilt) emit maximumTiltChangeChanged(); } +/*! + \internal +*/ void QDeclarativeGeoMapPinchArea::touchEvent(QTouchEvent *event) { // Keep processing if gesture(s) are in progress. Otherwise we might @@ -497,6 +575,9 @@ void QDeclarativeGeoMapPinchArea::touchEvent(QTouchEvent *event) } } +/*! + \internal +*/ void QDeclarativeGeoMapPinchArea::updatePinch() { if (touchPoints_.count() == 0) { diff --git a/src/imports/location/qdeclarativegeomapquickitem.cpp b/src/imports/location/qdeclarativegeomapquickitem.cpp index 121badf3..d0b4524a 100644 --- a/src/imports/location/qdeclarativegeomapquickitem.cpp +++ b/src/imports/location/qdeclarativegeomapquickitem.cpp @@ -53,7 +53,7 @@ QT_BEGIN_NAMESPACE \qmlclass MapQuickItem QDeclarativeGeoMapQuickItem \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-maps - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The MapQuickItem element displays an arbitrary Qt Quick element on a Map. @@ -201,6 +201,9 @@ void QDeclarativeGeoMapQuickItem::setCoordinate(QDeclarativeCoordinate *coordina emit coordinateChanged(); } +/*! + \internal +*/ void QDeclarativeGeoMapQuickItem::setMap(QDeclarativeGeoMap* quickMap, QGeoMap *map) { QDeclarativeGeoMapItemBase::setMap(quickMap,map); @@ -212,6 +215,9 @@ void QDeclarativeGeoMapQuickItem::setMap(QDeclarativeGeoMap* quickMap, QGeoMap * } } +/*! + \internal +*/ void QDeclarativeGeoMapQuickItem::dragEnded() { if (!mapAndSourceItemSet_) @@ -223,6 +229,9 @@ void QDeclarativeGeoMapQuickItem::dragEnded() } } +/*! + \internal +*/ QDeclarativeCoordinate* QDeclarativeGeoMapQuickItem::coordinate() { return coordinate_; @@ -249,6 +258,9 @@ QQuickItem* QDeclarativeGeoMapQuickItem::sourceItem() return sourceItem_.data(); } +/*! + \internal +*/ void QDeclarativeGeoMapQuickItem::afterChildrenChanged() { QList<QQuickItem*> kids = childItems(); @@ -322,6 +334,9 @@ qreal QDeclarativeGeoMapQuickItem::zoomLevel() const return zoomLevel_; } +/*! + \internal +*/ void QDeclarativeGeoMapQuickItem::updateMapItem() { if (!quickMap() && sourceItem_) { @@ -357,11 +372,17 @@ void QDeclarativeGeoMapQuickItem::updateMapItem() update(); } +/*! + \internal +*/ void QDeclarativeGeoMapQuickItem::afterViewportChanged(const QGeoMapViewportChangeEvent &event) { // do nothing } +/*! + \internal +*/ qreal QDeclarativeGeoMapQuickItem::scaleFactor() { qreal scale = 1.0; diff --git a/src/imports/location/qdeclarativegeomaptype.cpp b/src/imports/location/qdeclarativegeomaptype.cpp index a2256672..6ece1148 100644 --- a/src/imports/location/qdeclarativegeomaptype.cpp +++ b/src/imports/location/qdeclarativegeomaptype.cpp @@ -51,7 +51,7 @@ QT_BEGIN_NAMESPACE \inherits QObject \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-maps - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The MapType element holds information about a map type. @@ -71,14 +71,14 @@ QDeclarativeGeoMapType::~QDeclarativeGeoMapType() {} This read-only property gives access to the style of the map type. \list - \o MapType.NoMap - No map. - \o MapType.StreetMap - A street map. - \o MapType.SatelliteMapDay - A map with day-time satellite imagery. - \o MapType.SatelliteMapNight - A map with night-time satellite imagery. - \o MapType.TerrainMap - A terrain map. - \o MapType.HybridMap - A map with satellite imagery and streen information. - \o MapType.GrayStreetMap - A gray-shaded street map. - \o MapType.CustomMap - A custom map type. + \li MapType.NoMap - No map. + \li MapType.StreetMap - A street map. + \li MapType.SatelliteMapDay - A map with day-time satellite imagery. + \li MapType.SatelliteMapNight - A map with night-time satellite imagery. + \li MapType.TerrainMap - A terrain map. + \li MapType.HybridMap - A map with satellite imagery and streen information. + \li MapType.GrayStreetMap - A gray-shaded street map. + \li MapType.CustomMap - A custom map type. \endlist */ QDeclarativeGeoMapType::MapStyle QDeclarativeGeoMapType::style() const @@ -89,7 +89,7 @@ QDeclarativeGeoMapType::MapStyle QDeclarativeGeoMapType::style() const /*! \qmlproperty string MapType::name - This read-only property holds the name of the map type. + This read-only property holds the name of the map type as a single formatted string. */ QString QDeclarativeGeoMapType::name() const { @@ -99,7 +99,7 @@ QString QDeclarativeGeoMapType::name() const /*! \qmlproperty string MapType::description - This read-only property holds the description of the map type. + This read-only property holds the description of the map type as a single formatted string. */ QString QDeclarativeGeoMapType::description() const { diff --git a/src/imports/location/qdeclarativegeoroute.cpp b/src/imports/location/qdeclarativegeoroute.cpp index 2056cd87..88a70b79 100644 --- a/src/imports/location/qdeclarativegeoroute.cpp +++ b/src/imports/location/qdeclarativegeoroute.cpp @@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE \qmlclass Route QDeclarativeGeoRoute \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-routing - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The Route element represents one geographical route. @@ -100,6 +100,9 @@ void QDeclarativeGeoRoute::init() } } +/*! + \internal +*/ QList<QGeoCoordinate> QDeclarativeGeoRoute::routePath() { if (!route_.path().isEmpty()) { @@ -171,32 +174,50 @@ QQmlListProperty<QDeclarativeCoordinate> QDeclarativeGeoRoute::path() path_at, path_clear); } +/*! + \internal +*/ void QDeclarativeGeoRoute::path_append(QQmlListProperty<QDeclarativeCoordinate> *prop, QDeclarativeCoordinate *coordinate) { static_cast<QDeclarativeGeoRoute*>(prop->object)->appendPath(coordinate); } +/*! + \internal +*/ int QDeclarativeGeoRoute::path_count(QQmlListProperty<QDeclarativeCoordinate> *prop) { return static_cast<QDeclarativeGeoRoute*>(prop->object)->path_.count(); } +/*! + \internal +*/ QDeclarativeCoordinate* QDeclarativeGeoRoute::path_at(QQmlListProperty<QDeclarativeCoordinate> *prop, int index) { return static_cast<QDeclarativeGeoRoute*>(prop->object)->path_.at(index); } +/*! + \internal +*/ void QDeclarativeGeoRoute::path_clear(QQmlListProperty<QDeclarativeCoordinate> *prop) { static_cast<QDeclarativeGeoRoute*>(prop->object)->clearPath(); } +/*! + \internal +*/ void QDeclarativeGeoRoute::appendPath(QDeclarativeCoordinate* coordinate) { path_.append(coordinate); } +/*! + \internal +*/ void QDeclarativeGeoRoute::clearPath() { path_.clear(); @@ -220,32 +241,50 @@ QQmlListProperty<QDeclarativeGeoRouteSegment> QDeclarativeGeoRoute::segments() segments_at, segments_clear); } +/*! + \internal +*/ void QDeclarativeGeoRoute::segments_append(QQmlListProperty<QDeclarativeGeoRouteSegment> *prop, QDeclarativeGeoRouteSegment *segment) { static_cast<QDeclarativeGeoRoute*>(prop->object)->appendSegment(segment); } +/*! + \internal +*/ int QDeclarativeGeoRoute::segments_count(QQmlListProperty<QDeclarativeGeoRouteSegment> *prop) { return static_cast<QDeclarativeGeoRoute*>(prop->object)->segments_.count(); } +/*! + \internal +*/ QDeclarativeGeoRouteSegment* QDeclarativeGeoRoute::segments_at(QQmlListProperty<QDeclarativeGeoRouteSegment> *prop, int index) { return static_cast<QDeclarativeGeoRoute*>(prop->object)->segments_.at(index); } +/*! + \internal +*/ void QDeclarativeGeoRoute::segments_clear(QQmlListProperty<QDeclarativeGeoRouteSegment> *prop) { static_cast<QDeclarativeGeoRoute*>(prop->object)->clearSegments(); } +/*! + \internal +*/ void QDeclarativeGeoRoute::appendSegment(QDeclarativeGeoRouteSegment* segment) { segments_.append(segment); } +/*! + \internal +*/ void QDeclarativeGeoRoute::clearSegments() { segments_.clear(); diff --git a/src/imports/location/qdeclarativegeoroutemodel.cpp b/src/imports/location/qdeclarativegeoroutemodel.cpp index 062ad2cf..fbc5bbd3 100644 --- a/src/imports/location/qdeclarativegeoroutemodel.cpp +++ b/src/imports/location/qdeclarativegeoroutemodel.cpp @@ -52,7 +52,7 @@ QT_BEGIN_NAMESPACE \qmlclass RouteModel QDeclarativeGeoRouteModel \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-routing - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The RouteModel element provides access to routes. @@ -60,7 +60,7 @@ QT_BEGIN_NAMESPACE geographic routes from a backend provider. Routes include data about driving directions between two points, walking directions with multiple waypoints, and various other similar concepts. It functions much like other Model - elements in QML (see eg. \l ListModel and \l XmlListModel), and interacts + elements in QML (see for example \l ListModel and \l XmlListModel), and interacts with views such as \l MapItemView, and \l{ListView}. Like \l Map and \l GeocodeModel, all the data for a RouteModel to work comes @@ -190,6 +190,9 @@ void QDeclarativeGeoRouteModel::reset() setStatus(QDeclarativeGeoRouteModel::Null); } +/*! + \internal +*/ void QDeclarativeGeoRouteModel::abortRequest() { if (reply_) { @@ -219,6 +222,9 @@ QDeclarativeGeoRoute* QDeclarativeGeoRouteModel::get(int index) return routes_.at(index); } +/*! + \internal +*/ void QDeclarativeGeoRouteModel::componentComplete() { complete_ = true; @@ -227,12 +233,18 @@ void QDeclarativeGeoRouteModel::componentComplete() } } +/*! + \internal +*/ int QDeclarativeGeoRouteModel::rowCount(const QModelIndex &parent) const { Q_UNUSED(parent) return routes_.count(); } +/*! + \internal +*/ QVariant QDeclarativeGeoRouteModel::data(const QModelIndex &index, int role) const { if (!index.isValid()) { @@ -252,6 +264,9 @@ QVariant QDeclarativeGeoRouteModel::data(const QModelIndex &index, int role) con return QVariant(); } +/*! + \internal +*/ void QDeclarativeGeoRouteModel::setPlugin(QDeclarativeGeoServiceProvider *plugin) { if (plugin_ == plugin) @@ -273,6 +288,9 @@ void QDeclarativeGeoRouteModel::setPlugin(QDeclarativeGeoServiceProvider *plugin } } +/*! + \internal +*/ void QDeclarativeGeoRouteModel::pluginReady() { QGeoServiceProvider *serviceProvider = plugin_->sharedGeoServiceProvider(); @@ -287,6 +305,9 @@ void QDeclarativeGeoRouteModel::pluginReady() this, SLOT(routingError(QGeoRouteReply*,QGeoRouteReply::Error,QString))); } +/*! + \internal +*/ void QDeclarativeGeoRouteModel::queryDetailsChanged() { if (autoUpdate_ && complete_) @@ -298,7 +319,7 @@ void QDeclarativeGeoRouteModel::queryDetailsChanged() This property holds the plugin that providers the actual routing service. Note that all plugins do not necessarily - provide routing (could e.g. provide only geocoding or maps). + provide routing (could for example provide only geocoding or maps). A valid plugin must be set before the RouteModel can perform any useful operations. @@ -311,6 +332,9 @@ QDeclarativeGeoServiceProvider* QDeclarativeGeoRouteModel::plugin() const return plugin_; } +/*! + \internal +*/ void QDeclarativeGeoRouteModel::setQuery(QDeclarativeGeoRouteQuery* query) { if (!query || query == routeQuery_) @@ -339,6 +363,9 @@ QDeclarativeGeoRouteQuery* QDeclarativeGeoRouteModel::query() const return routeQuery_; } +/*! + \internal +*/ void QDeclarativeGeoRouteModel::setAutoUpdate(bool autoUpdate) { if (autoUpdate_ == autoUpdate) @@ -367,6 +394,9 @@ bool QDeclarativeGeoRouteModel::autoUpdate() const return autoUpdate_; } +/*! + \internal +*/ void QDeclarativeGeoRouteModel::setStatus(QDeclarativeGeoRouteModel::Status status) { if (status_ == status) @@ -396,6 +426,9 @@ QDeclarativeGeoRouteModel::Status QDeclarativeGeoRouteModel::status() const return status_; } +/*! + \internal +*/ void QDeclarativeGeoRouteModel::setErrorString(const QString &error) { if (errorString_ == error) @@ -501,6 +534,9 @@ void QDeclarativeGeoRouteModel::update() } } +/*! + \internal +*/ void QDeclarativeGeoRouteModel::routingFinished(QGeoRouteReply *reply) { if (reply->error() != QGeoRouteReply::NoError) { @@ -528,6 +564,9 @@ void QDeclarativeGeoRouteModel::routingFinished(QGeoRouteReply *reply) emit countChanged(); } +/*! + \internal +*/ void QDeclarativeGeoRouteModel::routingError(QGeoRouteReply *reply, QGeoRouteReply::Error error, const QString &errorString) @@ -544,7 +583,7 @@ void QDeclarativeGeoRouteModel::routingError(QGeoRouteReply *reply, \qmlclass RouteQuery QDeclarativeGeoRouteQuery \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-routing - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The RouteQuery element is used to provide query parameters to a RouteModel. @@ -599,6 +638,9 @@ QDeclarativeGeoRouteQuery::~QDeclarativeGeoRouteQuery() exclusions_.clear(); } +/*! + \internal +*/ void QDeclarativeGeoRouteQuery::componentComplete() { complete_ = true; @@ -635,19 +677,6 @@ QList<int> QDeclarativeGeoRouteQuery::featureTypes() return list; } -void QDeclarativeGeoRouteQuery::setNumberAlternativeRoutes(int numberAlternativeRoutes) -{ - if (numberAlternativeRoutes == request_.numberAlternativeRoutes()) - return; - - request_.setNumberAlternativeRoutes(numberAlternativeRoutes); - - if (complete_) { - emit numberAlternativeRoutesChanged(); - emit queryDetailsChanged(); - } -} - /*! \qmlproperty int RouteQuery::numberAlternativeRoutes @@ -661,6 +690,19 @@ int QDeclarativeGeoRouteQuery::numberAlternativeRoutes() const return request_.numberAlternativeRoutes(); } +void QDeclarativeGeoRouteQuery::setNumberAlternativeRoutes(int numberAlternativeRoutes) +{ + if (numberAlternativeRoutes == request_.numberAlternativeRoutes()) + return; + + request_.setNumberAlternativeRoutes(numberAlternativeRoutes); + + if (complete_) { + emit numberAlternativeRoutesChanged(); + emit queryDetailsChanged(); + } +} + /*! \qmlproperty QQmlListProperty<Coordinate> RouteQuery::waypoints @@ -681,6 +723,9 @@ QQmlListProperty<QDeclarativeCoordinate> QDeclarativeGeoRouteQuery::waypoints() waypoints_at, waypoints_clear); } +/*! + \internal +*/ void QDeclarativeGeoRouteQuery::waypoints_append(QQmlListProperty<QDeclarativeCoordinate> *prop, QDeclarativeCoordinate *waypoint) { @@ -688,12 +733,18 @@ void QDeclarativeGeoRouteQuery::waypoints_append(QQmlListProperty<QDeclarativeCo model->addWaypoint(waypoint); } +/*! + \internal +*/ int QDeclarativeGeoRouteQuery::waypoints_count(QQmlListProperty<QDeclarativeCoordinate> *prop) { QDeclarativeGeoRouteQuery* model = static_cast<QDeclarativeGeoRouteQuery*>(prop->object); return model->waypoints_.count(); } +/*! + \internal +*/ QDeclarativeCoordinate* QDeclarativeGeoRouteQuery::waypoints_at(QQmlListProperty<QDeclarativeCoordinate> *prop, int index) { QDeclarativeGeoRouteQuery* model = static_cast<QDeclarativeGeoRouteQuery*>(prop->object); @@ -701,6 +752,9 @@ QDeclarativeCoordinate* QDeclarativeGeoRouteQuery::waypoints_at(QQmlListProperty return model->waypoints_.at(index); } +/*! + \internal +*/ void QDeclarativeGeoRouteQuery::waypoints_clear(QQmlListProperty<QDeclarativeCoordinate> *prop) { QDeclarativeGeoRouteQuery* model = static_cast<QDeclarativeGeoRouteQuery*>(prop->object); @@ -725,18 +779,27 @@ QQmlListProperty<QDeclarativeGeoBoundingBox> QDeclarativeGeoRouteQuery::excluded exclusions_clear); } +/*! + \internal +*/ void QDeclarativeGeoRouteQuery::exclusions_append(QQmlListProperty<QDeclarativeGeoBoundingBox> *prop, QDeclarativeGeoBoundingBox *area) { QDeclarativeGeoRouteQuery* model = static_cast<QDeclarativeGeoRouteQuery*>(prop->object); model->addExcludedArea(area); } +/*! + \internal +*/ int QDeclarativeGeoRouteQuery::exclusions_count(QQmlListProperty<QDeclarativeGeoBoundingBox> *prop) { QDeclarativeGeoRouteQuery* model = static_cast<QDeclarativeGeoRouteQuery*>(prop->object); return model->exclusions_.count(); } +/*! + \internal +*/ QDeclarativeGeoBoundingBox* QDeclarativeGeoRouteQuery::exclusions_at(QQmlListProperty<QDeclarativeGeoBoundingBox> *prop, int index) { QDeclarativeGeoRouteQuery* model = static_cast<QDeclarativeGeoRouteQuery*>(prop->object); @@ -744,6 +807,9 @@ QDeclarativeGeoBoundingBox* QDeclarativeGeoRouteQuery::exclusions_at(QQmlListPro return model->exclusions_.at(index); } +/*! + \internal +*/ void QDeclarativeGeoRouteQuery::exclusions_clear(QQmlListProperty<QDeclarativeGeoBoundingBox> *prop) { QDeclarativeGeoRouteQuery* model = static_cast<QDeclarativeGeoRouteQuery*>(prop->object); @@ -979,6 +1045,9 @@ int QDeclarativeGeoRouteQuery::featureWeight(FeatureType featureType) return request_.featureWeight(static_cast<QGeoRouteRequest::FeatureType>(featureType)); } +/*! + \internal +*/ void QDeclarativeGeoRouteQuery::setTravelModes(QDeclarativeGeoRouteQuery::TravelModes travelModes) { QGeoRouteRequest::TravelModes reqTravelModes; @@ -1102,30 +1171,6 @@ QDeclarativeGeoRouteQuery::TravelModes QDeclarativeGeoRouteQuery::travelModes() return travelModes; } -void QDeclarativeGeoRouteQuery::setRouteOptimizations(QDeclarativeGeoRouteQuery::RouteOptimizations optimization) -{ - QGeoRouteRequest::RouteOptimizations reqOptimizations; - - if (optimization & QDeclarativeGeoRouteQuery::ShortestRoute) - reqOptimizations |= QGeoRouteRequest::ShortestRoute; - if (optimization & QDeclarativeGeoRouteQuery::FastestRoute) - reqOptimizations |= QGeoRouteRequest::FastestRoute; - if (optimization & QDeclarativeGeoRouteQuery::MostEconomicRoute) - reqOptimizations |= QGeoRouteRequest::MostEconomicRoute; - if (optimization & QDeclarativeGeoRouteQuery::MostScenicRoute) - reqOptimizations |= QGeoRouteRequest::MostScenicRoute; - - if (reqOptimizations == request_.routeOptimization()) - return; - - request_.setRouteOptimization(reqOptimizations); - - if (complete_) { - emit routeOptimizationsChanged(); - emit queryDetailsChanged(); - } -} - /*! \qmlproperty RouteOptimizations RouteQuery::routeOptimizations @@ -1159,6 +1204,33 @@ QDeclarativeGeoRouteQuery::RouteOptimizations QDeclarativeGeoRouteQuery::routeOp return optimization; } +void QDeclarativeGeoRouteQuery::setRouteOptimizations(QDeclarativeGeoRouteQuery::RouteOptimizations optimization) +{ + QGeoRouteRequest::RouteOptimizations reqOptimizations; + + if (optimization & QDeclarativeGeoRouteQuery::ShortestRoute) + reqOptimizations |= QGeoRouteRequest::ShortestRoute; + if (optimization & QDeclarativeGeoRouteQuery::FastestRoute) + reqOptimizations |= QGeoRouteRequest::FastestRoute; + if (optimization & QDeclarativeGeoRouteQuery::MostEconomicRoute) + reqOptimizations |= QGeoRouteRequest::MostEconomicRoute; + if (optimization & QDeclarativeGeoRouteQuery::MostScenicRoute) + reqOptimizations |= QGeoRouteRequest::MostScenicRoute; + + if (reqOptimizations == request_.routeOptimization()) + return; + + request_.setRouteOptimization(reqOptimizations); + + if (complete_) { + emit routeOptimizationsChanged(); + emit queryDetailsChanged(); + } +} + +/*! + \internal +*/ QGeoRouteRequest& QDeclarativeGeoRouteQuery::routeRequest() { // Bit inefficient, but waypoint and excludearea count is not big @@ -1174,6 +1246,9 @@ QGeoRouteRequest& QDeclarativeGeoRouteQuery::routeRequest() return request_; } +/*! + \internal +*/ void QDeclarativeGeoRouteQuery::waypointDestroyed(QObject* object) { const int index = waypoints_.indexOf(static_cast<QDeclarativeCoordinate*>(object)); diff --git a/src/imports/location/qdeclarativegeoroutesegment.cpp b/src/imports/location/qdeclarativegeoroutesegment.cpp index 067e0ddc..0d262761 100644 --- a/src/imports/location/qdeclarativegeoroutesegment.cpp +++ b/src/imports/location/qdeclarativegeoroutesegment.cpp @@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE \qmlclass RouteSegment QDeclarativeGeoRouteSegment \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-routing - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The RouteSegment element represents a segment of a Route. diff --git a/src/imports/location/qdeclarativegeoserviceprovider.cpp b/src/imports/location/qdeclarativegeoserviceprovider.cpp index 0ad84c78..ae3aea53 100644 --- a/src/imports/location/qdeclarativegeoserviceprovider.cpp +++ b/src/imports/location/qdeclarativegeoserviceprovider.cpp @@ -56,7 +56,7 @@ QT_BEGIN_NAMESPACE \qmlclass Plugin QDeclarativeGeoServiceProvider \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-common - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The Plugin element describes a Location based services plugin. @@ -130,8 +130,14 @@ void QDeclarativeGeoServiceProvider::setName(const QString &name) emit attached(); } +QString QDeclarativeGeoServiceProvider::name() const +{ + return name_; +} + + /*! - \qmlproperty list<string> Plugin::availableServiceProviders + \qmlproperty stringlist Plugin::availableServiceProviders This property holds a list of all available service plugins' names. This can be used to manually enumerate the available plugins if the @@ -143,6 +149,9 @@ QStringList QDeclarativeGeoServiceProvider::availableServiceProviders() return QGeoServiceProvider::availableServiceProviders(); } +/*! + \internal +*/ void QDeclarativeGeoServiceProvider::componentComplete() { complete_ = true; @@ -185,11 +194,9 @@ void QDeclarativeGeoServiceProvider::componentComplete() } } -QString QDeclarativeGeoServiceProvider::name() const -{ - return name_; -} - +/*! + \internal +*/ bool QDeclarativeGeoServiceProvider::supportsGeocoding(const GeocodingFeatures &feature) const { QGeoServiceProvider *sp = sharedGeoServiceProvider(); @@ -201,6 +208,9 @@ bool QDeclarativeGeoServiceProvider::supportsGeocoding(const GeocodingFeatures & return (sp && (sp->geocodingFeatures() & f) == f); } +/*! + \internal +*/ bool QDeclarativeGeoServiceProvider::supportsMapping(const MappingFeatures &feature) const { QGeoServiceProvider *sp = sharedGeoServiceProvider(); @@ -212,6 +222,9 @@ bool QDeclarativeGeoServiceProvider::supportsMapping(const MappingFeatures &feat return (sp && (sp->mappingFeatures() & f) == f); } +/*! + \internal +*/ bool QDeclarativeGeoServiceProvider::supportsRouting(const RoutingFeatures &feature) const { QGeoServiceProvider *sp = sharedGeoServiceProvider(); @@ -223,6 +236,9 @@ bool QDeclarativeGeoServiceProvider::supportsRouting(const RoutingFeatures &feat return (sp && (sp->routingFeatures() & f) == f); } +/*! + \internal +*/ bool QDeclarativeGeoServiceProvider::supportsPlaces(const PlacesFeatures &feature) const { QGeoServiceProvider *sp = sharedGeoServiceProvider(); @@ -259,7 +275,7 @@ QDeclarativeGeoServiceProviderRequirements *QDeclarativeGeoServiceProvider::requ } /*! - \qmlproperty list<string> Plugin::preferred + \qmlproperty stringlist Plugin::preferred This property contains an ordered list of preferred plugin names, which will be checked for the required features set in \l{Plugin::required}{required} @@ -278,6 +294,8 @@ void QDeclarativeGeoServiceProvider::setPreferred(const QStringList &val) /*! \qmlproperty bool Plugin::isAttached + + This property indicates if the Plugin is attached to another Plugin. */ bool QDeclarativeGeoServiceProvider::isAttached() const { @@ -286,6 +304,8 @@ bool QDeclarativeGeoServiceProvider::isAttached() const /*! \qmlproperty bool Plugin::allowExperimental + + This property indicates if experimental plugins can be used. */ bool QDeclarativeGeoServiceProvider::allowExperimental() const { @@ -304,13 +324,16 @@ void QDeclarativeGeoServiceProvider::setAllowExperimental(bool allow) emit allowExperimentalChanged(allow); } +/*! + \internal +*/ QGeoServiceProvider *QDeclarativeGeoServiceProvider::sharedGeoServiceProvider() const { return sharedProvider_; } /*! - \qmlproperty list<string> Plugin::locales + \qmlproperty stringlist Plugin::locales This property contains an ordered list of preferred plugin locales. If the first locale cannot be accommodated, then the backend falls back to using the second, and so on. By default the locales property contains the system locale. @@ -376,6 +399,9 @@ QQmlListProperty<QDeclarativeGeoServiceProviderParameter> QDeclarativeGeoService parameter_clear); } +/*! + \internal +*/ void QDeclarativeGeoServiceProvider::parameter_append(QQmlListProperty<QDeclarativeGeoServiceProviderParameter> *prop, QDeclarativeGeoServiceProviderParameter *parameter) { QDeclarativeGeoServiceProvider *p = static_cast<QDeclarativeGeoServiceProvider*>(prop->object); @@ -384,16 +410,25 @@ void QDeclarativeGeoServiceProvider::parameter_append(QQmlListProperty<QDeclarat p->sharedProvider_->setParameters(p->parameterMap()); } +/*! + \internal +*/ int QDeclarativeGeoServiceProvider::parameter_count(QQmlListProperty<QDeclarativeGeoServiceProviderParameter> *prop) { return static_cast<QDeclarativeGeoServiceProvider*>(prop->object)->parameters_.count(); } +/*! + \internal +*/ QDeclarativeGeoServiceProviderParameter* QDeclarativeGeoServiceProvider::parameter_at(QQmlListProperty<QDeclarativeGeoServiceProviderParameter> *prop, int index) { return static_cast<QDeclarativeGeoServiceProvider*>(prop->object)->parameters_[index]; } +/*! + \internal +*/ void QDeclarativeGeoServiceProvider::parameter_clear(QQmlListProperty<QDeclarativeGeoServiceProviderParameter> *prop) { QDeclarativeGeoServiceProvider *p = static_cast<QDeclarativeGeoServiceProvider*>(prop->object); @@ -402,6 +437,9 @@ void QDeclarativeGeoServiceProvider::parameter_clear(QQmlListProperty<QDeclarati p->sharedProvider_->setParameters(p->parameterMap()); } +/*! + \internal +*/ QMap<QString, QVariant> QDeclarativeGeoServiceProvider::parameterMap() const { QMap<QString, QVariant> map; @@ -430,11 +468,17 @@ QDeclarativeGeoServiceProviderRequirements::~QDeclarativeGeoServiceProviderRequi { } +/*! + \internal +*/ QDeclarativeGeoServiceProvider::MappingFeatures QDeclarativeGeoServiceProviderRequirements::mappingRequirements() const { return mapping_; } +/*! + \internal +*/ void QDeclarativeGeoServiceProviderRequirements::setMappingRequirements(const QDeclarativeGeoServiceProvider::MappingFeatures &features) { if (mapping_ == features) @@ -445,11 +489,17 @@ void QDeclarativeGeoServiceProviderRequirements::setMappingRequirements(const QD emit requirementsChanged(); } +/*! + \internal +*/ QDeclarativeGeoServiceProvider::RoutingFeatures QDeclarativeGeoServiceProviderRequirements::routingRequirements() const { return routing_; } +/*! + \internal +*/ void QDeclarativeGeoServiceProviderRequirements::setRoutingRequirements(const QDeclarativeGeoServiceProvider::RoutingFeatures &features) { if (routing_ == features) @@ -460,11 +510,17 @@ void QDeclarativeGeoServiceProviderRequirements::setRoutingRequirements(const QD emit requirementsChanged(); } +/*! + \internal +*/ QDeclarativeGeoServiceProvider::GeocodingFeatures QDeclarativeGeoServiceProviderRequirements::geocodingRequirements() const { return geocoding_; } +/*! + \internal +*/ void QDeclarativeGeoServiceProviderRequirements::setGeocodingRequirements(const QDeclarativeGeoServiceProvider::GeocodingFeatures &features) { if (geocoding_ == features) @@ -475,11 +531,17 @@ void QDeclarativeGeoServiceProviderRequirements::setGeocodingRequirements(const emit requirementsChanged(); } +/*! + \internal +*/ QDeclarativeGeoServiceProvider::PlacesFeatures QDeclarativeGeoServiceProviderRequirements::placesRequirements() const { return places_; } +/*! + \internal +*/ void QDeclarativeGeoServiceProviderRequirements::setPlacesRequirements(const QDeclarativeGeoServiceProvider::PlacesFeatures &features) { if (places_ == features) @@ -490,6 +552,9 @@ void QDeclarativeGeoServiceProviderRequirements::setPlacesRequirements(const QDe emit requirementsChanged(); } +/*! + \internal +*/ bool QDeclarativeGeoServiceProviderRequirements::matches(const QGeoServiceProvider *provider) const { QGeoServiceProvider::MappingFeatures mapping = @@ -548,7 +613,7 @@ bool QDeclarativeGeoServiceProviderRequirements::matches(const QGeoServiceProvid \qmlclass PluginParameter QDeclarativeGeoServiceProviderParameter \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-common - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The PluginParameter element describes a parameter to a \l Plugin. @@ -583,7 +648,7 @@ QDeclarativeGeoServiceProviderParameter::~QDeclarativeGeoServiceProviderParamete /*! \qmlproperty string PluginParameter::name - This property holds the name of the plugin parameter. + This property holds the name of the plugin parameter as a single formatted string. */ void QDeclarativeGeoServiceProviderParameter::setName(const QString &name) { @@ -603,7 +668,7 @@ QString QDeclarativeGeoServiceProviderParameter::name() const /*! \qmlproperty QVariant PluginParameter::value - This property holds the value of the plugin parameter. + This property holds the value of the plugin parameter which support different types of values (variant). */ void QDeclarativeGeoServiceProviderParameter::setValue(const QVariant &value) { diff --git a/src/imports/location/qdeclarativepolygonmapitem.cpp b/src/imports/location/qdeclarativepolygonmapitem.cpp index 2ee0cc91..60e647da 100644 --- a/src/imports/location/qdeclarativepolygonmapitem.cpp +++ b/src/imports/location/qdeclarativepolygonmapitem.cpp @@ -53,7 +53,7 @@ QT_BEGIN_NAMESPACE \qmlclass MapPolygon QDeclarativePolygonMapItem \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-maps - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The MapPolygon element displays a polygon on a Map @@ -120,6 +120,9 @@ QGeoMapPolygonGeometry::QGeoMapPolygonGeometry(QObject *parent) : { } +/*! + \internal +*/ void QGeoMapPolygonGeometry::updateSourcePoints(const QGeoMap &map, const QList<QGeoCoordinate> &path) { @@ -155,6 +158,9 @@ void QGeoMapPolygonGeometry::updateSourcePoints(const QGeoMap &map, sourceBounds_ = srcPath_.boundingRect(); } +/*! + \internal +*/ void QGeoMapPolygonGeometry::updateScreenPoints(const QGeoMap &map) { if (!screenDirty_) @@ -217,12 +223,18 @@ QDeclarativePolygonMapItem::QDeclarativePolygonMapItem(QQuickItem *parent) : this, SLOT(handleBorderUpdated())); } +/*! + \internal +*/ void QDeclarativePolygonMapItem::handleBorderUpdated() { borderGeometry_.markSourceDirty(); updateMapItem(); } +/*! + \internal +*/ void QDeclarativePolygonMapItem::updateAfterCoordinateChanged() { QDeclarativeCoordinate *coord = qobject_cast<QDeclarativeCoordinate*>(QObject::sender()); @@ -256,6 +268,9 @@ QDeclarativeMapLineProperties *QDeclarativePolygonMapItem::border() return &border_; } +/*! + \internal +*/ void QDeclarativePolygonMapItem::setMap(QDeclarativeGeoMap* quickMap, QGeoMap *map) { QDeclarativeGeoMapItemBase::setMap(quickMap,map); @@ -266,12 +281,6 @@ void QDeclarativePolygonMapItem::setMap(QDeclarativeGeoMap* quickMap, QGeoMap *m } } -QQmlListProperty<QDeclarativeCoordinate> QDeclarativePolygonMapItem::declarativePath() -{ - return QQmlListProperty<QDeclarativeCoordinate>(this, 0, path_append, path_count, - path_at, path_clear); -} - /*! \qmlproperty list<Coordinate> MapPolygon::path @@ -280,7 +289,15 @@ QQmlListProperty<QDeclarativeCoordinate> QDeclarativePolygonMapItem::declarative \sa addCoordinate removeCoordinate */ +QQmlListProperty<QDeclarativeCoordinate> QDeclarativePolygonMapItem::declarativePath() +{ + return QQmlListProperty<QDeclarativeCoordinate>(this, 0, path_append, path_count, + path_at, path_clear); +} +/*! + \internal +*/ void QDeclarativePolygonMapItem::path_append( QQmlListProperty<QDeclarativeCoordinate> *property, QDeclarativeCoordinate *coordinate) { @@ -297,18 +314,27 @@ void QDeclarativePolygonMapItem::path_append( emit item->pathChanged(); } +/*! + \internal +*/ int QDeclarativePolygonMapItem::path_count( QQmlListProperty<QDeclarativeCoordinate> *property) { return qobject_cast<QDeclarativePolygonMapItem*>(property->object)->coordPath_.count(); } +/*! + \internal +*/ QDeclarativeCoordinate* QDeclarativePolygonMapItem::path_at( QQmlListProperty<QDeclarativeCoordinate> *property, int index) { return qobject_cast<QDeclarativePolygonMapItem*>(property->object)->coordPath_.at(index); } +/*! + \internal +*/ void QDeclarativePolygonMapItem::path_clear( QQmlListProperty<QDeclarativeCoordinate> *property) { @@ -404,15 +430,8 @@ void QDeclarativePolygonMapItem::setColor(const QColor &color) emit colorChanged(color_); } - /*! - \qmlproperty real MapPolygon::opacity - - This property holds the opacity of the item. Opacity is specified as a - number between 0 (fully transparent) and 1 (fully opaque). The default is 1. - - If an item's opacity is set to 0, the item will no longer receive mouse - events. Similarly, setting the visible property to false stops mouse events. + \internal */ QSGNode* QDeclarativePolygonMapItem::updatePaintNode(QSGNode* oldNode, UpdatePaintNodeData* data) { @@ -432,6 +451,9 @@ QSGNode* QDeclarativePolygonMapItem::updatePaintNode(QSGNode* oldNode, UpdatePai return node; } +/*! + \internal +*/ void QDeclarativePolygonMapItem::updateMapItem() { if (!map() || path_.count() == 0) @@ -463,6 +485,9 @@ void QDeclarativePolygonMapItem::updateMapItem() update(); } +/*! + \internal +*/ void QDeclarativePolygonMapItem::afterViewportChanged(const QGeoMapViewportChangeEvent &event) { // if the scene is tilted, we must regenerate our geometry every frame @@ -492,6 +517,9 @@ void QDeclarativePolygonMapItem::afterViewportChanged(const QGeoMapViewportChang updateMapItem(); } +/*! + \internal +*/ bool QDeclarativePolygonMapItem::contains(QPointF point) { return (geometry_.contains(point) || borderGeometry_.contains(point)); @@ -514,6 +542,9 @@ MapPolygonNode::~MapPolygonNode() { } +/*! + \internal +*/ void MapPolygonNode::update(const QColor& fillColor, const QColor& borderColor, const QGeoMapItemGeometry *fillShape, const QGeoMapItemGeometry *borderShape) diff --git a/src/imports/location/qdeclarativepolylinemapitem.cpp b/src/imports/location/qdeclarativepolylinemapitem.cpp index 1f90a228..ac720133 100644 --- a/src/imports/location/qdeclarativepolylinemapitem.cpp +++ b/src/imports/location/qdeclarativepolylinemapitem.cpp @@ -57,7 +57,7 @@ QT_BEGIN_NAMESPACE \qmlclass MapPolyline QDeclarativePolylineMapItem \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-maps - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The MapPolyline element displays a polyline on a map. @@ -118,11 +118,17 @@ QDeclarativeMapLineProperties::QDeclarativeMapLineProperties(QObject *parent) : { } +/*! + \internal +*/ QColor QDeclarativeMapLineProperties::color() const { return color_; } +/*! + \internal +*/ void QDeclarativeMapLineProperties::setColor(const QColor &color) { if (color_ == color) @@ -132,11 +138,17 @@ void QDeclarativeMapLineProperties::setColor(const QColor &color) emit colorChanged(color_); } +/*! + \internal +*/ qreal QDeclarativeMapLineProperties::width() const { return width_; } +/*! + \internal +*/ void QDeclarativeMapLineProperties::setWidth(qreal width) { if (width_ == width) @@ -156,6 +168,9 @@ QGeoMapPolylineGeometry::QGeoMapPolylineGeometry(QObject *parent) : { } +/*! + \internal +*/ void QGeoMapPolylineGeometry::updateSourcePoints(const QGeoMap &map, const QList<QGeoCoordinate> &path) { @@ -339,6 +354,9 @@ static void clipPathToRect(const QVector<qreal> &points, } } +/*! + \internal +*/ void QGeoMapPolylineGeometry::updateScreenPoints(const QGeoMap &map, qreal strokeWidth) { @@ -412,6 +430,9 @@ QDeclarativePolylineMapItem::~QDeclarativePolylineMapItem() { } +/*! + \internal +*/ void QDeclarativePolylineMapItem::updateAfterLinePropertiesChanged() { // mark dirty just in case we're a width change @@ -419,6 +440,9 @@ void QDeclarativePolylineMapItem::updateAfterLinePropertiesChanged() updateMapItem(); } +/*! + \internal +*/ void QDeclarativePolylineMapItem::updateAfterCoordinateChanged() { QDeclarativeCoordinate *coord = qobject_cast<QDeclarativeCoordinate*>(QObject::sender()); @@ -431,6 +455,9 @@ void QDeclarativePolylineMapItem::updateAfterCoordinateChanged() } } +/*! + \internal +*/ void QDeclarativePolylineMapItem::setMap(QDeclarativeGeoMap* quickMap, QGeoMap *map) { QDeclarativeGeoMapItemBase::setMap(quickMap,map); @@ -453,6 +480,9 @@ QQmlListProperty<QDeclarativeCoordinate> QDeclarativePolylineMapItem::declarativ path_at, path_clear); } +/*! + \internal +*/ void QDeclarativePolylineMapItem::path_append(QQmlListProperty<QDeclarativeCoordinate> *property, QDeclarativeCoordinate *coordinate) { @@ -469,18 +499,27 @@ void QDeclarativePolylineMapItem::path_append(QQmlListProperty<QDeclarativeCoord emit item->pathChanged(); } +/*! + \internal +*/ int QDeclarativePolylineMapItem::path_count( QQmlListProperty<QDeclarativeCoordinate> *property) { return qobject_cast<QDeclarativePolylineMapItem*>(property->object)->coordPath_.count(); } +/*! + \internal +*/ QDeclarativeCoordinate* QDeclarativePolylineMapItem::path_at( QQmlListProperty<QDeclarativeCoordinate> *property, int index) { return qobject_cast<QDeclarativePolylineMapItem*>(property->object)->coordPath_.at(index); } +/*! + \internal +*/ void QDeclarativePolylineMapItem::path_clear( QQmlListProperty<QDeclarativeCoordinate> *property) { @@ -565,6 +604,9 @@ QDeclarativeMapLineProperties *QDeclarativePolylineMapItem::line() return &line_; } +/*! + \internal +*/ void QDeclarativePolylineMapItem::afterViewportChanged(const QGeoMapViewportChangeEvent &event) { // if the scene is tilted, we must regenerate our geometry every frame @@ -590,6 +632,9 @@ void QDeclarativePolylineMapItem::afterViewportChanged(const QGeoMapViewportChan updateMapItem(); } +/*! + \internal +*/ void QDeclarativePolylineMapItem::updateMapItem() { if (!map() || path_.count() == 0) @@ -605,13 +650,7 @@ void QDeclarativePolylineMapItem::updateMapItem() } /*! - \qmlproperty real MapPolyline::opacity - - This property holds the opacity of the item. Opacity is specified as a - number between 0 (fully transparent) and 1 (fully opaque). The default is 1. - - If an item's opacity is set to 0, the item will no longer receive mouse - events. Similarly, setting the visible property to false stops mouse events. + \internal */ QSGNode* QDeclarativePolylineMapItem::updatePaintNode(QSGNode* oldNode, UpdatePaintNodeData* data) { @@ -638,6 +677,9 @@ bool QDeclarativePolylineMapItem::contains(QPointF point) ////////////////////////////////////////////////////////////////////// +/*! + \internal +*/ MapPolylineNode::MapPolylineNode() : geometry_(QSGGeometry::defaultAttributes_Point2D(),0) { @@ -647,10 +689,16 @@ MapPolylineNode::MapPolylineNode() : } +/*! + \internal +*/ MapPolylineNode::~MapPolylineNode() { } +/*! + \internal +*/ void MapPolylineNode::update(const QColor& fillColor, const QGeoMapItemGeometry* shape) { diff --git a/src/imports/location/qdeclarativeposition.cpp b/src/imports/location/qdeclarativeposition.cpp index c0a1d4da..019ed9ca 100644 --- a/src/imports/location/qdeclarativeposition.cpp +++ b/src/imports/location/qdeclarativeposition.cpp @@ -50,7 +50,7 @@ QT_BEGIN_NAMESPACE \qmlclass Position QDeclarativePosition \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-positioning - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The Position element holds positional data at a particular point in time, such as coordinate (longitude, latitude, altitude) and speed. @@ -65,9 +65,9 @@ QT_BEGIN_NAMESPACE location data source. Not all properties of a Position object are necessarily valid or available - (e.g. latitude and longitude may be valid, but speed update has not been + (for example latitude and longitude may be valid, but speed update has not been received or set manually). As a result, corresponding "valid" properties - are available (eg. \l{coordinate} and \l{longitudeValid}, \l{latitudeValid} + are available (for example \l{coordinate} and \l{longitudeValid}, \l{latitudeValid} etc) to discern whether the data is available and valid in this position update. @@ -104,7 +104,7 @@ QDeclarativePosition::~QDeclarativePosition() Note: due to its inherent changing nature, the coordinateChanged() signal is emitted also when the values of the coordinate change, which enables easier data binding to Coordinate element instead of - directly connecting to e.g. its latitude and longitude. + directly connecting to for example its latitude and longitude. \sa longitudeValid latitudeValid altitudeValid diff --git a/src/imports/location/qdeclarativepositionsource.cpp b/src/imports/location/qdeclarativepositionsource.cpp index 155430cf..c0534f34 100644 --- a/src/imports/location/qdeclarativepositionsource.cpp +++ b/src/imports/location/qdeclarativepositionsource.cpp @@ -54,7 +54,7 @@ QT_BEGIN_NAMESPACE \qmlclass PositionSource QDeclarativePositionSource \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-positioning - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The PositionSource element provides the device's current position. @@ -138,6 +138,9 @@ QDeclarativePositionSource::~QDeclarativePositionSource() delete m_positionSource; } +/*! + \internal +*/ void QDeclarativePositionSource::setNmeaSource(const QUrl& nmeaSource) { // Strip the filename. This is clumsy but the file may be prefixed in several @@ -202,6 +205,9 @@ void QDeclarativePositionSource::setNmeaSource(const QUrl& nmeaSource) emit this->nmeaSourceChanged(); } +/*! + \internal +*/ void QDeclarativePositionSource::setUpdateInterval(int updateInterval) { if (m_updateInterval == updateInterval) @@ -249,12 +255,6 @@ int QDeclarativePositionSource::updateInterval() const return m_updateInterval; } -void QDeclarativePositionSource::setPreferredPositioningMethods(QGeoPositionInfoSource::PositioningMethods methods) -{ - m_positionSource->setPreferredPositioningMethods(methods); - emit preferredPositioningMethodsChanged(); -} - /*! \qmlproperty enumeration PositionSource::supportedPositioningMethods @@ -299,6 +299,12 @@ QDeclarativePositionSource::PositioningMethods QDeclarativePositionSource::suppo */ +void QDeclarativePositionSource::setPreferredPositioningMethods(QGeoPositionInfoSource::PositioningMethods methods) +{ + m_positionSource->setPreferredPositioningMethods(methods); + emit preferredPositioningMethodsChanged(); +} + QDeclarativePositionSource::PositioningMethods QDeclarativePositionSource::preferredPositioningMethods() const { if (m_positionSource) { @@ -444,7 +450,7 @@ bool QDeclarativePositionSource::isActive() const The Position element has different positional member variables, whose validity can be checked with appropriate validity functions - (e.g. sometimes an update does not have speed or altitude data). + (for example sometimes an update does not have speed or altitude data). However, whenever a \l positionChanged signal has been received, at least position::coordinate::latitude, position::coordinate::longitude, and position::timestamp can @@ -483,10 +489,6 @@ void QDeclarativePositionSource::positionUpdateReceived(const QGeoPositionInfo& } } -QDeclarativePositionSource::SourceError QDeclarativePositionSource::sourceError() const -{ - return m_sourceError; -} /*! \qmlproperty enumeration PositionSource::sourceError @@ -496,7 +498,7 @@ QDeclarativePositionSource::SourceError QDeclarativePositionSource::sourceError( \list \li PositionSource.AccessError - The connection setup to the remote positioning backend failed because the application lacked the required privileges. - \li PositionSource.ClosedError - The remote positioning backend closed the connection, which happens e.g. in case + \li PositionSource.ClosedError - The remote positioning backend closed the connection, which happens for example in case the user is switching location services to off. This object becomes invalid and should be deleted. A new source can be declared later on to check whether the positioning backend is up again. \li PositionSource.UnknownSourceError - An unidentified error occurred. @@ -504,6 +506,14 @@ QDeclarativePositionSource::SourceError QDeclarativePositionSource::sourceError( */ +QDeclarativePositionSource::SourceError QDeclarativePositionSource::sourceError() const +{ + return m_sourceError; +} + +/*! + \internal +*/ void QDeclarativePositionSource::sourceErrorReceived(const QGeoPositionInfoSource::Error error) { if (error == QGeoPositionInfoSource::AccessError) { diff --git a/src/imports/location/qdeclarativerectanglemapitem.cpp b/src/imports/location/qdeclarativerectanglemapitem.cpp index 713244be..d55a1df9 100644 --- a/src/imports/location/qdeclarativerectanglemapitem.cpp +++ b/src/imports/location/qdeclarativerectanglemapitem.cpp @@ -53,7 +53,7 @@ QT_BEGIN_NAMESPACE \qmlclass MapRectangle QDeclarativeRectangleMapItem \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-maps - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The MapRectangle element displays a rectangle on a Map. @@ -112,6 +112,9 @@ QGeoMapRectangleGeometry::QGeoMapRectangleGeometry(QObject *parent) : { } +/*! + \internal +*/ void QGeoMapRectangleGeometry::updatePoints(const QGeoMap &map, const QGeoCoordinate &topLeft, const QGeoCoordinate &bottomRight) @@ -169,6 +172,9 @@ QDeclarativeRectangleMapItem::~QDeclarativeRectangleMapItem() { } +/*! + \internal +*/ void QDeclarativeRectangleMapItem::setMap(QDeclarativeGeoMap* quickMap, QGeoMap *map) { QDeclarativeGeoMapItemBase::setMap(quickMap,map); @@ -197,7 +203,7 @@ QDeclarativeMapLineProperties *QDeclarativeRectangleMapItem::border() /*! \qmlproperty Coordinate MapRectangle::topLeft - Holds the top-left coordinate of the MapRectangle. + Holds the top-left coordinate of the MapRectangle which can be used to retrieve longitude, latitude and altitude of the coordination. */ void QDeclarativeRectangleMapItem::setTopLeft(QDeclarativeCoordinate *topLeft) { @@ -222,6 +228,9 @@ QDeclarativeCoordinate* QDeclarativeRectangleMapItem::topLeft() return topLeft_; } +/*! + \internal +*/ void QDeclarativeRectangleMapItem::updateMapItemAssumeDirty() { geometry_.markSourceDirty(); @@ -232,7 +241,7 @@ void QDeclarativeRectangleMapItem::updateMapItemAssumeDirty() /*! \qmlproperty Coordinate MapRectangle::bottomRight - Holds the bottom-right coordinate of the MapRectangle. + Holds the bottom-right coordinate of the MapRectangle which can be used to retrieve longitude, latitude and altitude of the coordination. */ void QDeclarativeRectangleMapItem::setBottomRight(QDeclarativeCoordinate *bottomRight) { @@ -286,6 +295,10 @@ void QDeclarativeRectangleMapItem::setColor(const QColor &color) If an item's opacity is set to 0, the item will no longer receive mouse events. Similarly, setting the visible property to false stops mouse events. */ + +/*! + \internal +*/ QSGNode* QDeclarativeRectangleMapItem::updatePaintNode(QSGNode* oldNode, UpdatePaintNodeData* data) { Q_UNUSED(data); @@ -306,6 +319,9 @@ QSGNode* QDeclarativeRectangleMapItem::updatePaintNode(QSGNode* oldNode, UpdateP return node; } +/*! + \internal +*/ void QDeclarativeRectangleMapItem::updateMapItem() { if (!map() || !topLeft() || !topLeft()->coordinate().isValid() @@ -348,6 +364,9 @@ void QDeclarativeRectangleMapItem::updateMapItem() update(); } +/*! + \internal +*/ void QDeclarativeRectangleMapItem::afterViewportChanged(const QGeoMapViewportChangeEvent &event) { // if the scene is tilted, we must regenerate our geometry every frame @@ -377,11 +396,17 @@ void QDeclarativeRectangleMapItem::afterViewportChanged(const QGeoMapViewportCha updateMapItem(); } +/*! + \internal +*/ bool QDeclarativeRectangleMapItem::contains(QPointF point) { return (geometry_.contains(point) || borderGeometry_.contains(point)); } +/*! + \internal +*/ void QDeclarativeRectangleMapItem::dragEnded() { QPointF newTopLeftPoint = QPointF(x(),y()); diff --git a/src/imports/location/qdeclarativeroutemapitem.cpp b/src/imports/location/qdeclarativeroutemapitem.cpp index ace7e24b..5b41fbf4 100644 --- a/src/imports/location/qdeclarativeroutemapitem.cpp +++ b/src/imports/location/qdeclarativeroutemapitem.cpp @@ -51,7 +51,7 @@ \qmlclass MapRoute QDeclarativeRouteMapItem \inqmlmodule QtLocation 5 \ingroup qml-QtLocation5-maps - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The MapRoute element displays a Route on a Map. @@ -96,6 +96,9 @@ QDeclarativeRouteMapItem::~QDeclarativeRouteMapItem() { } +/*! + \internal +*/ void QDeclarativeRouteMapItem::updateAfterLinePropertiesChanged() { // mark dirty just in case we're a width change @@ -103,6 +106,9 @@ void QDeclarativeRouteMapItem::updateAfterLinePropertiesChanged() updateMapItem(); } +/*! + \internal +*/ void QDeclarativeRouteMapItem::setMap(QDeclarativeGeoMap* quickMap, QGeoMap *map) { QDeclarativeGeoMapItemBase::setMap(quickMap,map); @@ -115,7 +121,7 @@ void QDeclarativeRouteMapItem::setMap(QDeclarativeGeoMap* quickMap, QGeoMap *map /*! \qmlproperty Route MapRoute::route - Holds the route to be drawn. + Holds the route to be drawn which can be used to represents one geographical route. */ QDeclarativeGeoRoute* QDeclarativeRouteMapItem::route() const { @@ -141,6 +147,9 @@ void QDeclarativeRouteMapItem::setRoute(QDeclarativeGeoRoute *route) } +/*! + \internal +*/ QSGNode* QDeclarativeRouteMapItem::updatePaintNode(QSGNode* oldNode, UpdatePaintNodeData* data) { Q_UNUSED(data); @@ -177,6 +186,9 @@ QDeclarativeMapLineProperties *QDeclarativeRouteMapItem::line() return &line_; } +/*! + \internal +*/ void QDeclarativeRouteMapItem::updateMapItem() { if (!map() || path_.isEmpty()) @@ -191,6 +203,9 @@ void QDeclarativeRouteMapItem::updateMapItem() update(); } +/*! + \internal +*/ void QDeclarativeRouteMapItem::afterViewportChanged(const QGeoMapViewportChangeEvent &event) { // if the scene is tilted, we must regenerate our geometry every frame @@ -216,6 +231,9 @@ void QDeclarativeRouteMapItem::afterViewportChanged(const QGeoMapViewportChangeE updateMapItem(); } +/*! + \internal +*/ bool QDeclarativeRouteMapItem::contains(QPointF point) { return geometry_.contains(point); diff --git a/src/imports/location/qgeomapitemgeometry.cpp b/src/imports/location/qgeomapitemgeometry.cpp index 52d4b5d8..e1a904be 100644 --- a/src/imports/location/qgeomapitemgeometry.cpp +++ b/src/imports/location/qgeomapitemgeometry.cpp @@ -50,6 +50,9 @@ QGeoMapItemGeometry::QGeoMapItemGeometry(QObject *parent) : { } +/*! + \internal +*/ void QGeoMapItemGeometry::translate(const QPointF &offset) { for (int i = 0; i < screenTriangles_.size()/2*2; i += 2) { @@ -61,6 +64,9 @@ void QGeoMapItemGeometry::translate(const QPointF &offset) screenBounds_.translate(offset); } +/*! + \internal +*/ QRectF QGeoMapItemGeometry::translateToCommonOrigin(QList<QGeoMapItemGeometry *> geoms) { QGeoCoordinate origin = geoms.at(0)->origin(); diff --git a/src/location/maps/qgeocameracapabilities.cpp b/src/location/maps/qgeocameracapabilities.cpp index 4cafb418..da82f864 100644 --- a/src/location/maps/qgeocameracapabilities.cpp +++ b/src/location/maps/qgeocameracapabilities.cpp @@ -109,7 +109,7 @@ QGeoCameraCapabilitiesPrivate& QGeoCameraCapabilitiesPrivate::operator = (const \class QGeoCameraCapabilities \inmodule QtLocation \ingroup QtLocation-impl - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QGeoCameraCapabilities class describes the limitations on camera settings imposed by a mapping plugin. diff --git a/src/location/maps/qgeocodereply.cpp b/src/location/maps/qgeocodereply.cpp index 75ad6809..9fa6dfea 100644 --- a/src/location/maps/qgeocodereply.cpp +++ b/src/location/maps/qgeocodereply.cpp @@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE \class QGeocodeReply \inmodule QtLocation \ingroup QtLocation-geocoding - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QGeocodeReply class manages an operation started by an instance of QGeocodingManager. diff --git a/src/location/maps/qgeocodingmanager.cpp b/src/location/maps/qgeocodingmanager.cpp index cb4bc3f7..8f68db72 100644 --- a/src/location/maps/qgeocodingmanager.cpp +++ b/src/location/maps/qgeocodingmanager.cpp @@ -54,7 +54,7 @@ QT_BEGIN_NAMESPACE \class QGeocodingManager \inmodule QtLocation \ingroup QtLocation-geocoding - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QGeocodingManager class provides support for geocoding operations. diff --git a/src/location/maps/qgeocodingmanagerengine.cpp b/src/location/maps/qgeocodingmanagerengine.cpp index b4478e29..2dc5f316 100644 --- a/src/location/maps/qgeocodingmanagerengine.cpp +++ b/src/location/maps/qgeocodingmanagerengine.cpp @@ -51,7 +51,7 @@ QT_BEGIN_NAMESPACE \class QGeocodingManagerEngine \inmodule QtLocation \ingroup QtLocation-impl - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QGeocodingManagerEngine class provides an interface and convenience methods to implementers of QGeoServiceProvider plugins who want diff --git a/src/location/maps/qgeomaneuver.cpp b/src/location/maps/qgeomaneuver.cpp index ec188e6f..50b5e56c 100644 --- a/src/location/maps/qgeomaneuver.cpp +++ b/src/location/maps/qgeomaneuver.cpp @@ -50,7 +50,7 @@ QT_BEGIN_NAMESPACE \class QGeoManeuver \inmodule QtLocation \ingroup QtLocation-routing - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QGeoManeuver class represents the information relevant to the point at which two QGeoRouteSegments meet. diff --git a/src/location/maps/qgeomappingmanager.cpp b/src/location/maps/qgeomappingmanager.cpp index d142fa37..abfc47ea 100644 --- a/src/location/maps/qgeomappingmanager.cpp +++ b/src/location/maps/qgeomappingmanager.cpp @@ -58,7 +58,7 @@ QT_BEGIN_NAMESPACE \class QGeoMappingManager \inmodule QtLocation \ingroup QtLocation-maps - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QGeoMappingManager class provides support for displaying and interacting with maps. diff --git a/src/location/maps/qgeomappingmanagerengine.cpp b/src/location/maps/qgeomappingmanagerengine.cpp index a91cdd64..d476c835 100644 --- a/src/location/maps/qgeomappingmanagerengine.cpp +++ b/src/location/maps/qgeomappingmanagerengine.cpp @@ -53,7 +53,7 @@ QT_BEGIN_NAMESPACE \class QGeoMappingManagerEngine \inmodule QtLocation \ingroup QtLocation-impl - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QGeoMappingManagerEngine class provides an interface and convenience methods to implementors of QGeoServiceProvider plugins who want to provide support for displaying diff --git a/src/location/maps/qgeoroute.cpp b/src/location/maps/qgeoroute.cpp index bc8a38a1..a641a1de 100644 --- a/src/location/maps/qgeoroute.cpp +++ b/src/location/maps/qgeoroute.cpp @@ -53,7 +53,7 @@ QT_BEGIN_NAMESPACE \class QGeoRoute \inmodule QtLocation \ingroup QtLocation-routing - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QGeoRoute class represents a route between two points. @@ -118,11 +118,11 @@ bool QGeoRoute::operator !=(const QGeoRoute &other) const } /*! - Sets the ID of this route to \a id. + Sets the identifier of this route to \a id. Service providers which support the updating of routes commonly assign - IDs to routes. If this route came from such a service provider changing - the ID will probably cause route updates to stop working. + identifiers to routes. If this route came from such a service provider changing + the identifier will probably cause route updates to stop working. */ void QGeoRoute::setRouteId(const QString &id) { @@ -130,10 +130,10 @@ void QGeoRoute::setRouteId(const QString &id) } /*! - Returns the ID of this route. + Returns the identifier of this route. Service providers which support the updating of routes commonly assign - IDs to routes. If this route did not come from such a service provider + identifiers to routes. If this route did not come from such a service provider the function will return an empty string. */ QString QGeoRoute::routeId() const diff --git a/src/location/maps/qgeoroutereply.cpp b/src/location/maps/qgeoroutereply.cpp index f5264384..730100cd 100644 --- a/src/location/maps/qgeoroutereply.cpp +++ b/src/location/maps/qgeoroutereply.cpp @@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE \class QGeoRouteReply \inmodule QtLocation \ingroup QtLocation-routing - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QGeoRouteReply class manages an operation started by an instance of QGeoRoutingManager. diff --git a/src/location/maps/qgeorouterequest.cpp b/src/location/maps/qgeorouterequest.cpp index 7e0eacee..2f9f3d39 100644 --- a/src/location/maps/qgeorouterequest.cpp +++ b/src/location/maps/qgeorouterequest.cpp @@ -51,7 +51,7 @@ QT_BEGIN_NAMESPACE \class QGeoRouteRequest \inmodule QtLocation \ingroup QtLocation-routing - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QGeoRouteRequest class represents the parameters and restrictions which define a request for routing information. diff --git a/src/location/maps/qgeoroutesegment.cpp b/src/location/maps/qgeoroutesegment.cpp index 73a893ec..653dccd1 100644 --- a/src/location/maps/qgeoroutesegment.cpp +++ b/src/location/maps/qgeoroutesegment.cpp @@ -51,7 +51,7 @@ QT_BEGIN_NAMESPACE \class QGeoRouteSegment \inmodule QtLocation \ingroup QtLocation-routing - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QGeoRouteSegment class represents a segment of a route. diff --git a/src/location/maps/qgeoroutingmanager.cpp b/src/location/maps/qgeoroutingmanager.cpp index 6d5e5acc..e74bdbab 100644 --- a/src/location/maps/qgeoroutingmanager.cpp +++ b/src/location/maps/qgeoroutingmanager.cpp @@ -51,7 +51,7 @@ QT_BEGIN_NAMESPACE \class QGeoRoutingManager \inmodule QtLocation \ingroup QtLocation-routing - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QGeoRoutingManager class provides support for geographic routing operations. diff --git a/src/location/maps/qgeoroutingmanagerengine.cpp b/src/location/maps/qgeoroutingmanagerengine.cpp index d6f64e2c..416de09d 100644 --- a/src/location/maps/qgeoroutingmanagerengine.cpp +++ b/src/location/maps/qgeoroutingmanagerengine.cpp @@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE \class QGeoRoutingManagerEngine \inmodule QtLocation \ingroup QtLocation-impl - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QGeoRoutingManagerEngine class provides an interface and convenience methods to implementers of QGeoServiceProvider plugins who want diff --git a/src/location/maps/qgeoserviceprovider.cpp b/src/location/maps/qgeoserviceprovider.cpp index d4ef4582..fa337aed 100644 --- a/src/location/maps/qgeoserviceprovider.cpp +++ b/src/location/maps/qgeoserviceprovider.cpp @@ -81,7 +81,7 @@ Q_GLOBAL_STATIC_WITH_ARGS(QFactoryLoader, loader, \class QGeoServiceProvider \inmodule QtLocation \ingroup QtLocation-common - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QGeoServiceProvider class aggregates access to services which provide geographical information. diff --git a/src/location/maps/qgeoserviceproviderfactory.cpp b/src/location/maps/qgeoserviceproviderfactory.cpp index 6761d762..30e072af 100644 --- a/src/location/maps/qgeoserviceproviderfactory.cpp +++ b/src/location/maps/qgeoserviceproviderfactory.cpp @@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE \class QGeoServiceProviderFactory \inmodule QtLocation \ingroup QtLocation-impl - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QGeoServiceProviderFactory class is a factory class used as the plugin interface for services related to geographical information. diff --git a/src/location/maps/qgeotiledmapreply.cpp b/src/location/maps/qgeotiledmapreply.cpp index af7c5f81..736648dd 100644 --- a/src/location/maps/qgeotiledmapreply.cpp +++ b/src/location/maps/qgeotiledmapreply.cpp @@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE \class QGeoTiledMapReply \inmodule QtLocation \ingroup QtLocation-impl - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QGeoTiledMapReply class manages a tile fetch operation started by an instance of QGeoTiledManagerEngine. diff --git a/src/location/places/qplace.cpp b/src/location/places/qplace.cpp index e7cfbcce..9ce10e3d 100644 --- a/src/location/places/qplace.cpp +++ b/src/location/places/qplace.cpp @@ -55,7 +55,7 @@ QT_BEGIN_NAMESPACE \inmodule QtLocation \ingroup QtLocation-places \ingroup QtLocation-places-data - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QPlace class represents a set of data about a place. @@ -340,8 +340,8 @@ void QPlace::setName(const QString &name) } /*! - Returns the id of the place. The place id is only meaningful to the QPlaceManager that - generated it and is not transferable between managers. The place id is not guaranteed + Returns the identifier of the place. The place identifier is only meaningful to the QPlaceManager that + generated it and is not transferable between managers. The place identifier is not guaranteed to be universally unique, but unique for the manager that generated it. */ QString QPlace::placeId() const @@ -351,12 +351,12 @@ QString QPlace::placeId() const } /*! - Sets the \a id of the place. + Sets the \a identifier of the place. */ -void QPlace::setPlaceId(const QString &id) +void QPlace::setPlaceId(const QString &identifier) { Q_D(QPlace); - d->placeId = id; + d->placeId = identifier; } /*! @@ -497,7 +497,7 @@ QPlaceAttribute QPlace::extendedAttribute(const QString &attributeType) const already exists in the place, then it is overwritten. If \a attribute is a default constructed QPlaceAttribute, then the \a attributeType - is removed from the place i.e it will not be listed by QPlace::extendedAttributeTypes(). + is removed from the place which means it will not be listed by QPlace::extendedAttributeTypes(). */ void QPlace::setExtendedAttribute(const QString &attributeType, const QPlaceAttribute &attribute) diff --git a/src/location/places/qplace.h b/src/location/places/qplace.h index 2de45693..c3bfc34d 100644 --- a/src/location/places/qplace.h +++ b/src/location/places/qplace.h @@ -104,7 +104,7 @@ public: QString name() const; void setName(const QString &name); QString placeId() const; - void setPlaceId(const QString &placeId); + void setPlaceId(const QString &identifier); QString primaryPhone() const; QString primaryFax() const; diff --git a/src/location/places/qplaceattribute.cpp b/src/location/places/qplaceattribute.cpp index caa09f69..c210697f 100644 --- a/src/location/places/qplaceattribute.cpp +++ b/src/location/places/qplaceattribute.cpp @@ -77,7 +77,7 @@ bool QPlaceAttributePrivate::isEmpty() const \inmodule QtLocation \ingroup QtLocation-places \ingroup QtLocation-places-data - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QPlaceAttribute class represents generic attribute information about a place. @@ -94,8 +94,8 @@ bool QPlaceAttributePrivate::isEmpty() const \li QPlaceAttribute::Provider \endlist - There is a class of attribute types of the format x_id_<provider> e.g. x_id_nokia. - This class of attributes is a set of alternative ids of the place, from the specified provider's + There is a class of attribute types of the format x_id_<provider> for example x_id_nokia. + This class of attributes is a set of alternative identifiers of the place, from the specified provider's perspective. The above types are used to access and modify attributes in QPlace via: @@ -110,7 +110,7 @@ bool QPlaceAttributePrivate::isEmpty() const new attributes as necessary. Custom attribute types should always be prefixed by a qualifier in order to avoid conflicts. - \section3 User readable vs non-user readable attributes + \section3 User Readable vs Non-User Readable Attributes Some attributes may not be intended to be readable by end users, the label field of such attributes are empty to indicate this fact. */ diff --git a/src/location/places/qplacecategory.cpp b/src/location/places/qplacecategory.cpp index a33d5d68..fb7c8b67 100644 --- a/src/location/places/qplacecategory.cpp +++ b/src/location/places/qplacecategory.cpp @@ -80,7 +80,7 @@ bool QPlaceCategoryPrivate::isEmpty() const \inmodule QtLocation \ingroup QtLocation-places \ingroup QtLocation-places-data - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QPlaceCategory class represents a category that a \l QPlace can be associated with. @@ -143,8 +143,8 @@ bool QPlaceCategory::operator==(const QPlaceCategory &other) const } /*! - Returns the id of the category. The category id is a string which uniquely identifies this category - within a particular \l QPlaceManager. The id is only meaningful to the QPlaceManager + Returns the identifier of the category. The category identifier is a string which uniquely identifies this category + within a particular \l QPlaceManager. The identifier is only meaningful to the QPlaceManager that generated it and is not transferable between managers. */ QString QPlaceCategory::categoryId() const @@ -153,11 +153,11 @@ QString QPlaceCategory::categoryId() const } /*! - Sets the \a id of the category. + Sets the \a identifier of the category. */ -void QPlaceCategory::setCategoryId(const QString &id) +void QPlaceCategory::setCategoryId(const QString &identifier) { - d->categoryId = id; + d->categoryId = identifier; } /*! diff --git a/src/location/places/qplacecategory.h b/src/location/places/qplacecategory.h index b0da859a..e661e6c3 100644 --- a/src/location/places/qplacecategory.h +++ b/src/location/places/qplacecategory.h @@ -74,7 +74,7 @@ public: } QString categoryId() const; - void setCategoryId(const QString &id); + void setCategoryId(const QString &identifier); QString name() const; void setName(const QString &name); diff --git a/src/location/places/qplacecontent.cpp b/src/location/places/qplacecontent.cpp index 9d839386..0916ca12 100644 --- a/src/location/places/qplacecontent.cpp +++ b/src/location/places/qplacecontent.cpp @@ -75,7 +75,7 @@ bool QPlaceContentPrivate::compare(const QPlaceContentPrivate *other) const \inmodule QtLocation \ingroup QtLocation-places \ingroup QtLocation-places-data - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QPlaceContent class serves as the base class for rich content types. @@ -112,7 +112,7 @@ bool QPlaceContentPrivate::compare(const QPlaceContentPrivate *other) const index of the content. The value is the content object itself. The \c {Collection} is intended to be a container where content items, that have been retrieved - as pages, can be stored. This enables a developer to skip pages, e.g. indexes 0-9 may be + as pages, can be stored. This enables a developer to skip pages, for example indexes 0-9 may be stored in the collection, if the user skips to indexes 80-99, these can be stored in the collection as well. */ diff --git a/src/location/places/qplacecontentreply.cpp b/src/location/places/qplacecontentreply.cpp index 4a17fd22..b74dc236 100644 --- a/src/location/places/qplacecontentreply.cpp +++ b/src/location/places/qplacecontentreply.cpp @@ -64,7 +64,7 @@ QT_USE_NAMESPACE \inmodule QtLocation \ingroup QtLocation-places \ingroup QtLocation-places-replies - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QPlaceContentReply class manages a content retrieval operation started by an instance of QPlaceManager. diff --git a/src/location/places/qplacecontentrequest.cpp b/src/location/places/qplacecontentrequest.cpp index c6ca3a5e..00ca77f0 100644 --- a/src/location/places/qplacecontentrequest.cpp +++ b/src/location/places/qplacecontentrequest.cpp @@ -80,7 +80,7 @@ void QPlaceContentRequestPrivate::clear() \inmodule QtLocation \ingroup QtLocation-places \ingroup QtLocation-places-requests - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QPlaceContentRequest class represents the parameters of a content request. @@ -150,7 +150,7 @@ bool QPlaceContentRequest::operator!= (const QPlaceContentRequest &other) const } /*! - Returns the type of content to be requested, e.g. reviews or images + Returns the type of content to be requested, for example reviews or images */ QPlaceContent::Type QPlaceContentRequest::contentType() const { diff --git a/src/location/places/qplacedetailsreply.cpp b/src/location/places/qplacedetailsreply.cpp index 2ac69ec6..a1984fdd 100644 --- a/src/location/places/qplacedetailsreply.cpp +++ b/src/location/places/qplacedetailsreply.cpp @@ -60,7 +60,7 @@ QT_USE_NAMESPACE \inmodule QtLocation \ingroup QtLocation-places \ingroup QtLocation-places-replies - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QPlaceDetailsReply class manages a place details fetch operation started by an instance of QPlaceManager. diff --git a/src/location/places/qplaceeditorial.cpp b/src/location/places/qplaceeditorial.cpp index a88e715c..dcf53752 100644 --- a/src/location/places/qplaceeditorial.cpp +++ b/src/location/places/qplaceeditorial.cpp @@ -73,7 +73,7 @@ bool QPlaceEditorialPrivate::compare(const QPlaceContentPrivate *other) const \inmodule QtLocation \ingroup QtLocation-places \ingroup QtLocation-places-data - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QPlaceEditorial class represents a publisher's article describing a place. diff --git a/src/location/places/qplaceicon.cpp b/src/location/places/qplaceicon.cpp index 45e0f12b..21064a1b 100644 --- a/src/location/places/qplaceicon.cpp +++ b/src/location/places/qplaceicon.cpp @@ -80,7 +80,7 @@ bool QPlaceIconPrivate::operator == (const QPlaceIconPrivate &other) const \inmodule QtLocation \ingroup QtLocation-places \ingroup QtLocation-places-data - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QPlaceIcon class represents an icon. diff --git a/src/location/places/qplaceidreply.cpp b/src/location/places/qplaceidreply.cpp index 72c7c6cd..e8d728c5 100644 --- a/src/location/places/qplaceidreply.cpp +++ b/src/location/places/qplaceidreply.cpp @@ -62,16 +62,16 @@ QT_USE_NAMESPACE \inmodule QtLocation \ingroup QtLocation-places \ingroup QtLocation-places-replies - \since QtLocation 5.0 + \since Qt Location 5.0 - \brief The QPlaceIdReply class manages operations which return an id such as + \brief The QPlaceIdReply class manages operations which return an identifier such as saving and removal operations of places and categories. The QPlaceIdReply can be considered a multipurpose reply in that it can be used to save places, save categories, remove places and remove categories. - In each case it returns an id of the place or category that was added/modified/removed. + In each case it returns an identifier of the place or category that was added, modified or removed. - See \l {Saving a place cpp}{Saving a place} for an example of how to use an id reply. + See \l {Saving a place cpp}{Saving a place} for an example of how to use an identifier reply. \sa QPlaceManager */ @@ -85,7 +85,7 @@ QT_USE_NAMESPACE */ /*! - Constructs an id reply with a given \a operationType and \a parent. + Constructs a reply which contains the identifier of the object operated upon. The reply is for the given \a operationType and with \a parent. */ QPlaceIdReply::QPlaceIdReply(QPlaceIdReply::OperationType operationType, QObject *parent) : QPlaceReply(new QPlaceIdReplyPrivate(operationType), parent) {} @@ -106,8 +106,8 @@ QPlaceReply::Type QPlaceIdReply::type() const } /*! - Returns the operation type of the reply. i.e whether this - id reply was for a save place operation, + Returns the operation type of the reply. This means whether this + identifier reply was for a save place operation, remove category operation and so on. */ QPlaceIdReply::OperationType QPlaceIdReply::operationType() const @@ -117,9 +117,9 @@ QPlaceIdReply::OperationType QPlaceIdReply::operationType() const } /*! - Returns the relevant id for the operation. Eg for a save place operation, - the id is that of the saved place. For a category removal operation, - it is the id of the category that was removed. + Returns the relevant identifier for the operation. For example for a save place operation, + the identifier is that of the saved place. For a category removal operation, + it is the identifier of the category that was removed. */ QString QPlaceIdReply::id() const { @@ -128,10 +128,10 @@ QString QPlaceIdReply::id() const } /*! - Sets the \a id of the reply. + Sets the \a identifier of the reply. */ -void QPlaceIdReply::setId(const QString &id) +void QPlaceIdReply::setId(const QString &identifier) { Q_D(QPlaceIdReply); - d->id = id; + d->id = identifier; } diff --git a/src/location/places/qplaceidreply.h b/src/location/places/qplaceidreply.h index 9a1fd154..f9846525 100644 --- a/src/location/places/qplaceidreply.h +++ b/src/location/places/qplaceidreply.h @@ -73,7 +73,7 @@ public: QString id() const; protected: - void setId(const QString &id); + void setId(const QString &identifier); private: Q_DISABLE_COPY(QPlaceIdReply) Q_DECLARE_PRIVATE(QPlaceIdReply) diff --git a/src/location/places/qplaceimage.cpp b/src/location/places/qplaceimage.cpp index 4daeb2cb..79ff1156 100644 --- a/src/location/places/qplaceimage.cpp +++ b/src/location/places/qplaceimage.cpp @@ -72,12 +72,12 @@ bool QPlaceImagePrivate::compare(const QPlaceContentPrivate *other) const \inmodule QtLocation \ingroup QtLocation-places \ingroup QtLocation-places-data - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QPlaceImage class represents a reference to an image. Each QPlaceImage represents a set of metadata about an image such as it's - url, id and MIME type. These are properties in addition to those provided + url, identifier and MIME type. These are properties in addition to those provided by QPlaceContent. Note: The Places API only supports images as 'retrieve-only' objects. Submitting @@ -128,7 +128,7 @@ void QPlaceImage::setUrl(const QUrl &url) } /*! - Returns the image's id. + Returns the image's identifier. */ QString QPlaceImage::imageId() const { @@ -137,12 +137,12 @@ QString QPlaceImage::imageId() const } /*! - Sets image's \a id. + Sets image's \a identifier. */ -void QPlaceImage::setImageId(const QString &id) +void QPlaceImage::setImageId(const QString &identifier) { Q_D(QPlaceImage); - d->id = id; + d->id = identifier; } /*! diff --git a/src/location/places/qplaceimage.h b/src/location/places/qplaceimage.h index 0c5e0e5a..a8b2fcfc 100644 --- a/src/location/places/qplaceimage.h +++ b/src/location/places/qplaceimage.h @@ -72,7 +72,7 @@ public: void setUrl(const QUrl &url); QString imageId() const; - void setImageId(const QString &id); + void setImageId(const QString &identifier); QString mimeType() const; void setMimeType(const QString &data); diff --git a/src/location/places/qplacemanager.cpp b/src/location/places/qplacemanager.cpp index 8767db2d..68ba0df5 100644 --- a/src/location/places/qplacemanager.cpp +++ b/src/location/places/qplacemanager.cpp @@ -51,7 +51,7 @@ QT_BEGIN_NAMESPACE \inmodule QtLocation \ingroup QtLocation-places \ingroup QtLocation-places-manager - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QPlaceManager class provides the interface which allows clients to access places stored in a particular backend. @@ -82,7 +82,7 @@ QT_BEGIN_NAMESPACE \li Rich content such as images, reviews etc can be retrieved in a paged fashion. \row - \li Place/Category management + \li Place or Category management \li Places and categories may be saved and removed. It is possible for notifications to be given when this happens. \row @@ -91,12 +91,12 @@ QT_BEGIN_NAMESPACE data in different languages. \endtable - \section1 Obtaining a QPlaceManager instance + \section1 Obtaining a QPlaceManager Instance Creation of a QPlaceManager is facilitated by the QGeoServiceProvider. See \l {Initializing a manager} for an example on how to create a manager. - \section1 Asynchronous interface. + \section1 Asynchronous Interface. The QPlaceManager class provides an abstraction of the datastore which contains place information. The functions provided by the QPlaceManager and primarily asynchronous and follow a request-reply model. Typically a request is given to the manager, consisting @@ -144,7 +144,7 @@ QT_BEGIN_NAMESPACE \value LocaleFeature The manager can be used to provide place data localized according to locale \value NotificationsFeature The manager has signal notifications for when - places/categories are added/modified/removed. + places or categories are added, modified or removed. \value MatchingFeature The manager support matching places from other managers. */ @@ -317,7 +317,7 @@ QPlaceReply *QPlaceManager::initializeCategories() } /*! - Returns the parent category id of the category corresponding to \a categoryId. + Returns the parent category identifier of the category corresponding to \a categoryId. */ QString QPlaceManager::parentCategoryId(const QString &categoryId) const { @@ -325,8 +325,8 @@ QString QPlaceManager::parentCategoryId(const QString &categoryId) const } /*! - Returns the child category ids of the category corresponding to \a parentId. - If \a parentId is empty then all top level category ids are returned. + Returns the child category identifiers of the category corresponding to \a parentId. + If \a parentId is empty then all top level category identifiers are returned. */ QStringList QPlaceManager::childCategoryIds(const QString &parentId) const { diff --git a/src/location/places/qplacemanagerengine.cpp b/src/location/places/qplacemanagerengine.cpp index 0c076a37..66f7410e 100644 --- a/src/location/places/qplacemanagerengine.cpp +++ b/src/location/places/qplacemanagerengine.cpp @@ -55,7 +55,7 @@ QT_BEGIN_NAMESPACE \ingroup QtLocation-impl \ingroup QtLocation-places \ingroup QtLocation-places-manager - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QPlaceManagerEngine class provides an interface for implementers of QGeoServiceProvider plugins who want to provide access to place @@ -256,7 +256,7 @@ QPlaceReply *QPlaceManagerEngine::initializeCategories() } /*! - Returns the parent category id of the category corresponding to \a categoryId. + Returns the parent category identifier of the category corresponding to \a categoryId. */ QString QPlaceManagerEngine::parentCategoryId(const QString &categoryId) const { @@ -266,8 +266,8 @@ QString QPlaceManagerEngine::parentCategoryId(const QString &categoryId) const } /*! - Returns the child category ids of the category corresponding to \a parentId. If \a parentId is - empty then all top level category ids are returned. + Returns the child category identifiers of the category corresponding to \a parentId. If \a parentId is + empty then all top level category identifiers are returned. */ QStringList QPlaceManagerEngine::childCategoryIds(const QString &categoryId) const { diff --git a/src/location/places/qplacematchreply.cpp b/src/location/places/qplacematchreply.cpp index 8f8b8726..42c54834 100644 --- a/src/location/places/qplacematchreply.cpp +++ b/src/location/places/qplacematchreply.cpp @@ -61,7 +61,7 @@ QT_USE_NAMESPACE \inmodule QtLocation \ingroup QtLocation-places \ingroup QtLocation-places-replies - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QPlaceMatchReply class manages a place matching operation started by an instance of QPlaceManager. diff --git a/src/location/places/qplacematchrequest.cpp b/src/location/places/qplacematchrequest.cpp index 128a5323..65568986 100644 --- a/src/location/places/qplacematchrequest.cpp +++ b/src/location/places/qplacematchrequest.cpp @@ -105,7 +105,7 @@ void QPlaceMatchRequestPrivate::clear() \inmodule QtLocation \ingroup QtLocation-places \ingroup QtLocation-places-requests - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QPlaceMatchRequest class is used to find places from one manager that match those from another. It represents a set of request parameters. @@ -113,8 +113,8 @@ void QPlaceMatchRequestPrivate::clear() Places from another manager that may have corresponding/matching places in the current manager are assigned using setPlaces() or setResults(). A set of further parameters are specified which determines the criteria for matching. - The typical key for matching is the QPlaceMatchRequest::AlternativeId, the value is an alternative id attribute type of the format - x_id_<provider name> eg x_id_nokia. The provider name is name supplied to the QGeoServiceProvider instance. + The typical key for matching is the QPlaceMatchRequest::AlternativeId, the value is an alternative identifier attribute type of the format + x_id_<provider name> for example x_id_nokia. The provider name is name supplied to the QGeoServiceProvider instance. See \l {Matching places between managers} for an example on how to use a match request. @@ -123,7 +123,7 @@ void QPlaceMatchRequestPrivate::clear() /*! \variable QPlaceMatchRequest::AlternativeId - The key to specify that matching is to be accomplished via an alternative place id. + The key to specify that matching is to be accomplished via an alternative place identifier. */ const QString QPlaceMatchRequest::AlternativeId(QLatin1String("alternativeId")); diff --git a/src/location/places/qplaceratings.cpp b/src/location/places/qplaceratings.cpp index 9fc791ac..145b709f 100644 --- a/src/location/places/qplaceratings.cpp +++ b/src/location/places/qplaceratings.cpp @@ -73,7 +73,7 @@ bool QPlaceRatingsPrivate::isEmpty() const \inmodule QtLocation \ingroup QtLocation-places \ingroup QtLocation-places-data - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QPlaceRatings class holds rating information about a place. diff --git a/src/location/places/qplacereply.cpp b/src/location/places/qplacereply.cpp index 7658a673..270752e3 100644 --- a/src/location/places/qplacereply.cpp +++ b/src/location/places/qplacereply.cpp @@ -49,7 +49,7 @@ QT_USE_NAMESPACE \inmodule QtLocation \ingroup QtLocation-places \ingroup QtLocation-places-replies - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QPlaceReply class manages an operation started by an instance of QPlaceManager and serves as a base class for more specialized replies. @@ -109,8 +109,8 @@ QT_USE_NAMESPACE \value ContentReply This is a reply for content associated with a place. \value IdReply - This is a reply that returns an id of a place/category. - Typically used for place/category save and remove operations. + This is a reply that returns an identifier of a place or category. + Typically used for place or category save and remove operations. \value MatchReply This is a reply that returns places that match those from another provider. diff --git a/src/location/places/qplacereview.cpp b/src/location/places/qplacereview.cpp index 09c21072..8395796a 100644 --- a/src/location/places/qplacereview.cpp +++ b/src/location/places/qplacereview.cpp @@ -81,7 +81,7 @@ bool QPlaceReviewPrivate::compare(const QPlaceContentPrivate *other) const \inmodule QtLocation \ingroup QtLocation-places \ingroup QtLocation-places-data - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QPlaceReview class represents a review of a place. @@ -196,7 +196,7 @@ void QPlaceReview::setRating(qreal rating) } /*! - Returns the review's id. + Returns the review's identifier. */ QString QPlaceReview::reviewId() const { @@ -205,12 +205,12 @@ QString QPlaceReview::reviewId() const } /*! - Sets the \a id of the review. + Sets the \a identifier of the review. */ -void QPlaceReview::setReviewId(const QString &id) +void QPlaceReview::setReviewId(const QString &identifier) { Q_D(QPlaceReview); - d->reviewId = id; + d->reviewId = identifier; } /*! diff --git a/src/location/places/qplacereview.h b/src/location/places/qplacereview.h index 10546b36..bc2d5b59 100644 --- a/src/location/places/qplacereview.h +++ b/src/location/places/qplacereview.h @@ -74,7 +74,7 @@ public: qreal rating() const; void setRating(qreal data); QString reviewId() const; - void setReviewId(const QString &data); + void setReviewId(const QString &identifier); QString title() const; void setTitle(const QString &data); diff --git a/src/location/places/qplacesearchreply.cpp b/src/location/places/qplacesearchreply.cpp index 936531ed..63c9fbe7 100644 --- a/src/location/places/qplacesearchreply.cpp +++ b/src/location/places/qplacesearchreply.cpp @@ -61,7 +61,7 @@ QT_USE_NAMESPACE \inmodule QtLocation \ingroup QtLocation-places \ingroup QtLocation-places-replies - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QPlaceSearchReply class manages a place search operation started by an instance of QPlaceManager. diff --git a/src/location/places/qplacesearchrequest.cpp b/src/location/places/qplacesearchrequest.cpp index 64596f1d..a4c97ec1 100644 --- a/src/location/places/qplacesearchrequest.cpp +++ b/src/location/places/qplacesearchrequest.cpp @@ -139,7 +139,7 @@ void QPlaceSearchRequestPrivate::clear() \inmodule QtLocation \ingroup QtLocation-places \ingroup QtLocation-places-requests - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QPlaceSearchRequest class represents the set of parameters for a search request. @@ -157,11 +157,11 @@ void QPlaceSearchRequestPrivate::clear() \l {QPlaceManager::search()} {search for places}, however it is also used to provide parameters for \l {QPlaceManager::searchSuggestions()}{generating search term suggestions} and \l {QPlaceManager::recommendations()} {retreiving recommendations}. Note that depending on usage, - some parameters may not be relevant, e.g. the relevance hint is not important for search term suggestions. However - in general, most of the parameters are useful for each of these operations, eg for a recommendation, a search area + some parameters may not be relevant, for example the relevance hint is not important for search term suggestions. However + in general, most of the parameters are useful for each of these operations, for example for a recommendation, a search area and categories can be useful in narrowing down recommendation candidates. - Also be aware that providers may vary by which parameters they support e.g. some providers may not support + Also be aware that providers may vary by which parameters they support for example some providers may not support paging while others do, some providers may honor relevance hints while others may completely ignore them, see \l {Information about plugins}. @@ -349,7 +349,7 @@ void QPlaceSearchRequest::setVisibilityScope(QtLocation::VisibilityScope scope) /*! Returns the relevance hint of the request. The hint is given to the provider - to help but not dictate the ranking of results. e.g. providing a distance hint + to help but not dictate the ranking of results. For example providing a distance hint may give closer places a higher ranking but it doesn't necessarily mean that he results will be ordered strictly according to distance. */ diff --git a/src/location/places/qplacesearchresult.cpp b/src/location/places/qplacesearchresult.cpp index 4e6d1d4c..7f3204c1 100644 --- a/src/location/places/qplacesearchresult.cpp +++ b/src/location/places/qplacesearchresult.cpp @@ -79,7 +79,7 @@ bool QPlaceSearchResultPrivate::operator==(const QPlaceSearchResultPrivate &othe \inmodule QtLocation \ingroup QtLocation-places \ingroup QtLocation-places-data - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QPlaceSearchResult class represents a search result. diff --git a/src/location/places/qplacesearchsuggestionreply.cpp b/src/location/places/qplacesearchsuggestionreply.cpp index bd1d56e7..e635f1e4 100644 --- a/src/location/places/qplacesearchsuggestionreply.cpp +++ b/src/location/places/qplacesearchsuggestionreply.cpp @@ -60,7 +60,7 @@ QT_USE_NAMESPACE \inmodule QtLocation \ingroup QtLocation-places \ingroup QtLocation-places-replies - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QPlaceSearchSuggestionReply class manages a search suggestion operation started by an instance of QPlaceManager. diff --git a/src/location/places/qplacesupplier.cpp b/src/location/places/qplacesupplier.cpp index 01b73dff..3d86f35e 100644 --- a/src/location/places/qplacesupplier.cpp +++ b/src/location/places/qplacesupplier.cpp @@ -85,7 +85,7 @@ bool QPlaceSupplierPrivate::isEmpty() const \inmodule QtLocation \ingroup QtLocation-places \ingroup QtLocation-places-data - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QPlaceSupplier class represents a supplier of a place or content associated with a place. @@ -166,7 +166,7 @@ void QPlaceSupplier::setName(const QString &name) } /*! - Returns the id of the supplier. The id is unique + Returns the identifier of the supplier. The identifier is unique to the manager backend which provided the supplier and is generally not suitable for displaying to the user. */ @@ -176,11 +176,11 @@ QString QPlaceSupplier::supplierId() const } /*! - Sets the \a id of the supplier. + Sets the \a identifier of the supplier. */ -void QPlaceSupplier::setSupplierId(const QString &id) +void QPlaceSupplier::setSupplierId(const QString &identifier) { - d->supplierId = id; + d->supplierId = identifier; } /*! diff --git a/src/location/places/qplacesupplier.h b/src/location/places/qplacesupplier.h index bffed1b0..8d685115 100644 --- a/src/location/places/qplacesupplier.h +++ b/src/location/places/qplacesupplier.h @@ -71,7 +71,7 @@ public: void setName(const QString &data); QString supplierId() const; - void setSupplierId(const QString &data); + void setSupplierId(const QString &identifier); QUrl url() const; void setUrl(const QUrl &data); diff --git a/src/location/places/qplaceuser.cpp b/src/location/places/qplaceuser.cpp index 1b4f6f47..75c77ba1 100644 --- a/src/location/places/qplaceuser.cpp +++ b/src/location/places/qplaceuser.cpp @@ -68,7 +68,7 @@ bool QPlaceUserPrivate::operator==(const QPlaceUserPrivate &other) const \inmodule QtLocation \ingroup QtLocation-places \ingroup QtLocation-places-data - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QPlaceUser class represents an individual user. */ @@ -122,7 +122,7 @@ bool QPlaceUser::operator==(const QPlaceUser &other) const } /*! - Returns the id of the user. + Returns the identifier of the user. */ QString QPlaceUser::userId() const { @@ -130,11 +130,11 @@ QString QPlaceUser::userId() const } /*! - Sets the \a id of the user. + Sets the \a identifier of the user. */ -void QPlaceUser::setUserId(const QString &id) +void QPlaceUser::setUserId(const QString &identifier) { - d->userId = id; + d->userId = identifier; } /*! diff --git a/src/location/places/qplaceuser.h b/src/location/places/qplaceuser.h index 02b13fa7..3edec796 100644 --- a/src/location/places/qplaceuser.h +++ b/src/location/places/qplaceuser.h @@ -67,7 +67,7 @@ public: } QString userId() const; - void setUserId(const QString &); + void setUserId(const QString &identifier); QString name() const; void setName(const QString &name); diff --git a/src/location/qgeoaddress.cpp b/src/location/qgeoaddress.cpp index 3c4840ad..c2fb0614 100644 --- a/src/location/qgeoaddress.cpp +++ b/src/location/qgeoaddress.cpp @@ -77,24 +77,24 @@ QGeoAddressPrivate::~QGeoAddressPrivate() \ingroup QtLocation-positioning \ingroup QtLocation-places-data \ingroup QtLocation-places - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QGeoAddress class represents an address of a \l QGeoLocation. The address' attributes are normalized to US feature names and can be mapped - to the local feature levels (e.g. State matches "Bundesland" in Germany). + to the local feature levels (for example State matches "Bundesland" in Germany). The address contains a \l text() for displaying purposes and additional properties to access the components of an address: \list - \o QGeoAddress::country() - \o QGeoAddress::countryCode() - \o QGeoAddress::state() - \o QGeoAddress::city() - \o QGeoAddress::district() - \o QGeoAddress::street() - \o QGeoAddress::postalCode() + \li QGeoAddress::country() + \li QGeoAddress::countryCode() + \li QGeoAddress::state() + \li QGeoAddress::city() + \li QGeoAddress::district() + \li QGeoAddress::street() + \li QGeoAddress::postalCode() \endlist */ diff --git a/src/location/qgeoareamonitor.cpp b/src/location/qgeoareamonitor.cpp index 94c12c77..6b992dcf 100644 --- a/src/location/qgeoareamonitor.cpp +++ b/src/location/qgeoareamonitor.cpp @@ -46,7 +46,7 @@ \class QGeoAreaMonitor \inmodule QtLocation \ingroup QtLocation-positioning - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QGeoAreaMonitor class enables the detection of proximity changes for a specified set of coordinates. diff --git a/src/location/qgeoboundingarea.cpp b/src/location/qgeoboundingarea.cpp index 31bd407f..dbad8fec 100644 --- a/src/location/qgeoboundingarea.cpp +++ b/src/location/qgeoboundingarea.cpp @@ -62,7 +62,7 @@ bool QGeoBoundingAreaPrivate::operator==(const QGeoBoundingAreaPrivate &other) c \class QGeoBoundingArea \inmodule QtLocation \ingroup QtLocation-positioning - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QGeoBoundingArea class defines a geographic area. diff --git a/src/location/qgeoboundingbox.cpp b/src/location/qgeoboundingbox.cpp index 2aea005e..357ef07c 100644 --- a/src/location/qgeoboundingbox.cpp +++ b/src/location/qgeoboundingbox.cpp @@ -51,7 +51,7 @@ QT_BEGIN_NAMESPACE \class QGeoBoundingBox \inmodule QtLocation \ingroup QtLocation-positioning - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QGeoBoundingBox class defines a rectangular geographic area. diff --git a/src/location/qgeoboundingcircle.cpp b/src/location/qgeoboundingcircle.cpp index f37ce64d..3356e6c3 100644 --- a/src/location/qgeoboundingcircle.cpp +++ b/src/location/qgeoboundingcircle.cpp @@ -53,7 +53,7 @@ QT_BEGIN_NAMESPACE \class QGeoBoundingCircle \inmodule QtLocation \ingroup QtLocation-positioning - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QGeoBoundingCircle class defines a circular geographic area. diff --git a/src/location/qgeocoordinate.cpp b/src/location/qgeocoordinate.cpp index 4902a493..fe08be0f 100644 --- a/src/location/qgeocoordinate.cpp +++ b/src/location/qgeocoordinate.cpp @@ -81,7 +81,7 @@ QGeoCoordinatePrivate::QGeoCoordinatePrivate() { \class QGeoCoordinate \inmodule QtLocation \ingroup QtLocation-positioning - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QGeoCoordinate class defines a geographical position on the surface of the Earth. diff --git a/src/location/qgeolocation.cpp b/src/location/qgeolocation.cpp index d0689c71..6a2b5f43 100644 --- a/src/location/qgeolocation.cpp +++ b/src/location/qgeolocation.cpp @@ -83,7 +83,7 @@ bool QGeoLocationPrivate::isEmpty() const \ingroup QtLocation-positioning \ingroup QtLocation-places \ingroup QtLocation-places-data - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QGeoLocation class represents basic information about a location. diff --git a/src/location/qgeopositioninfo.cpp b/src/location/qgeopositioninfo.cpp index 9931594a..f3c454a1 100644 --- a/src/location/qgeopositioninfo.cpp +++ b/src/location/qgeopositioninfo.cpp @@ -58,7 +58,7 @@ public: \class QGeoPositionInfo \inmodule QtLocation \ingroup QtLocation-positioning - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QGeoPositionInfo class contains information gathered on a global position, direction and velocity at a particular point in time. diff --git a/src/location/qgeopositioninfosource.cpp b/src/location/qgeopositioninfosource.cpp index 86360952..54ae2538 100644 --- a/src/location/qgeopositioninfosource.cpp +++ b/src/location/qgeopositioninfosource.cpp @@ -62,7 +62,7 @@ Q_GLOBAL_STATIC_WITH_ARGS(QFactoryLoader, loader, \class QGeoPositionInfoSource \inmodule QtLocation \ingroup QtLocation-positioning - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QGeoPositionInfoSource class is an abstract base class for the distribution of positional updates. @@ -104,7 +104,7 @@ Q_GLOBAL_STATIC_WITH_ARGS(QFactoryLoader, loader, Defines the types of positioning methods. \value SatellitePositioningMethods Satellite-based positioning methods such as GPS or GLONASS. - \value NonSatellitePositioningMethods Other positioning methods such as 3GPP cell ID or WiFi based positioning. + \value NonSatellitePositioningMethods Other positioning methods such as 3GPP cell identifier or WiFi based positioning. \value AllPositioningMethods Satellite-based positioning methods as soon as available. Otherwise non-satellite based methods. */ @@ -427,7 +427,7 @@ QStringList QGeoPositionInfoSource::availableSources() \value AccessError The connection setup to the remote positioning backend failed because the application lacked the required privileges. - \value ClosedError The remote positioning backend closed the connection, which happens e.g. in case + \value ClosedError The remote positioning backend closed the connection, which happens for example in case the user is switching location services to off. This object becomes invalid and should be deleted. A call to createDefaultSource() can be used to create a new source later on. \value UnknownSourceError An unidentified error occurred. diff --git a/src/location/qgeopositioninfosourcefactory.cpp b/src/location/qgeopositioninfosourcefactory.cpp index 8dc552f6..80f9fafe 100644 --- a/src/location/qgeopositioninfosourcefactory.cpp +++ b/src/location/qgeopositioninfosourcefactory.cpp @@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE \class QGeoPositionInfoSourceFactory \inmodule QtLocation \ingroup QtLocation-impl - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QGeoPositionInfoSourceFactory class is a factory class used as the plugin interface for external providers of positioning data. diff --git a/src/location/qgeosatelliteinfo.cpp b/src/location/qgeosatelliteinfo.cpp index 69805452..80769fb5 100644 --- a/src/location/qgeosatelliteinfo.cpp +++ b/src/location/qgeosatelliteinfo.cpp @@ -60,7 +60,7 @@ public: \class QGeoSatelliteInfo \inmodule QtLocation \ingroup QtLocation-positioning - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QGeoSatelliteInfo class contains basic information about a satellite. @@ -165,11 +165,11 @@ QGeoSatelliteInfo::SatelliteSystem QGeoSatelliteInfo::satelliteSystem() const } /*! - Sets the satellite ID number to \a satId. + Sets the satellite identifier number to \a satId. - The satellite ID number can be used to identify a satellite inside the satellite system. - For satellite system GPS the satellite ID number represents the PRN (Pseudo-random noise) number. - For satellite system GLONASS the satellite ID number represents the slot number. + The satellite identifier number can be used to identify a satellite inside the satellite system. + For satellite system GPS the satellite identifier number represents the PRN (Pseudo-random noise) number. + For satellite system GLONASS the satellite identifier number represents the slot number. */ void QGeoSatelliteInfo::setSatelliteIdentifier(int satId) { @@ -177,11 +177,11 @@ void QGeoSatelliteInfo::setSatelliteIdentifier(int satId) } /*! - Returns the satellite ID number. + Returns the satellite identifier number. - The satellite ID number can be used to identify a satellite inside the satellite system. - For satellite system GPS the satellite ID number represents the PRN (Pseudo-random noise) number. - For satellite system GLONASS the satellite ID number represents the slot number. + The satellite identifier number can be used to identify a satellite inside the satellite system. + For satellite system GPS the satellite identifier number represents the PRN (Pseudo-random noise) number. + For satellite system GLONASS the satellite identifier number represents the slot number. */ int QGeoSatelliteInfo::satelliteIdentifier() const { diff --git a/src/location/qgeosatelliteinfosource.cpp b/src/location/qgeosatelliteinfosource.cpp index eaa9268a..3c1d5d32 100644 --- a/src/location/qgeosatelliteinfosource.cpp +++ b/src/location/qgeosatelliteinfosource.cpp @@ -53,7 +53,7 @@ QT_BEGIN_NAMESPACE \class QGeoSatelliteInfoSource \inmodule QtLocation \ingroup QtLocation-positioning - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QGeoSatelliteInfoSource class is an abstract base class for the distribution of satellite information updates. @@ -297,7 +297,7 @@ QStringList QGeoSatelliteInfoSource::availableSources() \value AccessError The connection setup to the remote positioning backend failed because the application lacked the required privileges. - \value ClosedError The remote satellite backend closed the connection, which happens e.g. in case + \value ClosedError The remote satellite backend closed the connection, which happens for example in case the user is switching location services to off. This object becomes invalid and should be deleted. A new satellite source can be created by calling createDefaultSource() later on. \value UnknownSourceError An unidentified error occurred. diff --git a/src/location/qlocationutils_p.h b/src/location/qlocationutils_p.h index ae43e514..54710e42 100644 --- a/src/location/qlocationutils_p.h +++ b/src/location/qlocationutils_p.h @@ -91,7 +91,7 @@ public: Q_AUTOTEST_EXPORT static bool getNmeaTime(const QByteArray &bytes, QTime *time); /* - Accepts e.g. ("2734.7964", 'S', "15306.0124", 'E') and returns the + Accepts for example ("2734.7964", 'S', "15306.0124", 'E') and returns the lat-long values. Fails if lat or long fail isValidLat() or isValidLong(). */ Q_AUTOTEST_EXPORT static bool getNmeaLatLong(const QByteArray &latString, char latDirection, const QByteArray &lngString, char lngDirection, double *lat, double *lon); diff --git a/src/location/qnmeapositioninfosource.cpp b/src/location/qnmeapositioninfosource.cpp index a0cc1871..0fab0e59 100644 --- a/src/location/qnmeapositioninfosource.cpp +++ b/src/location/qnmeapositioninfosource.cpp @@ -431,7 +431,7 @@ void QNmeaPositionInfoSourcePrivate::emitUpdated(const QGeoPositionInfo &update) \class QNmeaPositionInfoSource \inmodule QtLocation \ingroup QtLocation-positioning - \since QtLocation 5.0 + \since Qt Location 5.0 \brief The QNmeaPositionInfoSource class provides positional information using a NMEA data source. |