diff options
author | Paolo Angelelli <paolo.angelelli@qt.io> | 2018-03-21 15:10:47 +0100 |
---|---|---|
committer | Paolo Angelelli <paolo.angelelli@qt.io> | 2018-04-17 09:37:30 +0000 |
commit | cacb45bc736a3326ffedc18ba421f8db54dfc2a9 (patch) | |
tree | 5af12bce1b13d9405f4893e60bff0d41f33cd144 /src | |
parent | e7287e9f2ac9a6ad99c0c8c93a128655e15af565 (diff) | |
download | qtlocation-cacb45bc736a3326ffedc18ba421f8db54dfc2a9.tar.gz |
Add documentation for QMapIconObject
Change-Id: I36f2cc5d8fe71c0a3446b8572203bd2e032e9541
Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
Diffstat (limited to 'src')
-rw-r--r-- | src/location/labs/qmapiconobject.cpp | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/src/location/labs/qmapiconobject.cpp b/src/location/labs/qmapiconobject.cpp index 7a3a1a75..507492d2 100644 --- a/src/location/labs/qmapiconobject.cpp +++ b/src/location/labs/qmapiconobject.cpp @@ -40,6 +40,19 @@ QT_BEGIN_NAMESPACE +/*! + \qmltype MapIconObject + \instantiates QMapIconObject + \inqmlmodule Qt.labs.location + \ingroup qml-QtLocation5-maps + \inherits QGeoMapObject + + \brief The MapIconObject displays an icon on a Map. + + The MapIconObject displays an icon on a Map. + The MapIconObject type only makes sense when contained in a Map or in a \l MapObjectView. +*/ + QMapIconObjectPrivate::~QMapIconObjectPrivate() { @@ -138,12 +151,34 @@ QMapIconObject::~QMapIconObject() } +/*! + \qmlproperty Variant Qt.labs.location::MapIconObject::content + + This property holds the content to be used for the icon. The actual content of this property is somehow + backend-dependent. The implementation for the raster engine accepts local urls or paths. + Other implementations may accept additional content types. +*/ QVariant QMapIconObject::content() const { const QMapIconObjectPrivate *d = static_cast<const QMapIconObjectPrivate *>(d_ptr.data()); return d->content(); } +/*! + \qmlproperty Variant Qt.labs.location::MapIconObject::coordinate + + The coordinate where the icon is going to be shown. + What pixel of the icon matches the coordinate is somehow backend-dependent. + For example, due to limitations, some backends might associate the center of the icon with the + coordinate, others one of the corners. + If there is a choice, backend developers should use the center of the icon as the default anchor + point. + + The behavior is also intended to be customizable with a \l DynamicParameter, when + using backends that support anchoring arbitrary points of the icon to the coordinate. + What kind of parameter to use and how to achieve this behavior is intended to be + documented per-backend. +*/ QGeoCoordinate QMapIconObject::coordinate() const { const QMapIconObjectPrivate *d = static_cast<const QMapIconObjectPrivate *>(d_ptr.data()); @@ -170,6 +205,11 @@ void QMapIconObject::setCoordinate(const QGeoCoordinate ¢er) emit coordinateChanged(center); } +/*! + \qmlproperty Variant Qt.labs.location::MapIconObject::size + + The size of the icon as it will be shown on the map. +*/ QSizeF QMapIconObject::size() const { const QMapIconObjectPrivate *d = static_cast<const QMapIconObjectPrivate *>(d_ptr.data()); |