Represents the contents of a BasemapGallery. Can be accessed via BasemapGalleryController::gallery. More...
| Header: | #include <BasemapGalleryItem> |
| Inherits: | QObject |
Properties
|
Public Functions
| BasemapGalleryItem(QObject *parent = nullptr) | |
| BasemapGalleryItem(Esri::ArcGISRuntime::Basemap *basemap, QObject *parent = nullptr) | |
| BasemapGalleryItem(Esri::ArcGISRuntime::Basemap *basemap, QImage thumbnail, QString tooltip, QObject *parent = nullptr) | |
| virtual | ~BasemapGalleryItem() override |
| Esri::ArcGISRuntime::Basemap * | basemap() const |
| QString | name() const |
| void | setBasemap(Esri::ArcGISRuntime::Basemap *basemap) |
| void | setThumbnailOverride(QImage thumbnail) |
| void | setTooltipOverride(QString tooltip) |
| QImage | thumbnail() const |
| QImage | thumbnailOverride() const |
| QString | tooltip() const |
| QString | tooltipOverride() const |
Signals
| void | basemapChanged() |
| void | thumbnailChanged() |
| void | thumbnailOverrideChanged() |
| void | tooltipChanged() |
| void | tooltipOverrideChanged() |
Detailed Description
The BasemapGalleryItem is a wrapper around a Basemap, along with any additional meta-information.
The BasemapGalleryItem allows for the optional application of a thumbnail and tooltip, which override the given thumbnail/tooltip of the Basemap.
This is handy when creating Basemaps on the fly from a BasemapStyle or other means, as these basemaps do not come with a thumbnail or tooltip by default.
Property Documentation
basemap : Basemap*
This property holds the basemap this item represents.
Access functions:
| Esri::ArcGISRuntime::Basemap * | basemap() const |
| void | setBasemap(Esri::ArcGISRuntime::Basemap *basemap) |
Notifier signal:
| void | basemapChanged() |
See also Esri::ArcGISRuntime::Toolkit::BasemapGalleryItem::basemap().
[read-only] name : const QString
This property holds the name of the basemap, if set.
Access functions:
| QString | name() const |
Notifier signal:
| void | basemapChanged() |
See also Esri::ArcGISRuntime::Toolkit::BasemapGalleryItem::name().
[read-only] thumbnail : const QImage
This property holds the thumbnail the item will display in the gallery.
Access functions:
| QImage | thumbnail() const |
Notifier signal:
| void | thumbnailChanged() |
See also Esri::ArcGISRuntime::Toolkit::BasemapGalleryItem::thumbnail().
thumbnailOverride : QImage
This property holds a thumbnail the developer can set to replace the default thumbnail.
Access functions:
| QImage | thumbnailOverride() const |
| void | setThumbnailOverride(QImage thumbnail) |
Notifier signal:
| void | thumbnailOverrideChanged() |
See also Esri::ArcGISRuntime::Toolkit::BasemapGalleryItem::thumbnailOverride().
[read-only] tooltip : const QString
This property holds the tooltip the item will display in the gallery.
Access functions:
| QString | tooltip() const |
Notifier signal:
| void | tooltipChanged() |
See also Esri::ArcGISRuntime::Toolkit::BasemapGalleryItem::tooltip().
tooltipOverride : QString
This property holds a tooltip the developer can set to replace the default tooltip.
Access functions:
| QString | tooltipOverride() const |
| void | setTooltipOverride(QString tooltip) |
Notifier signal:
| void | tooltipOverrideChanged() |
See also Esri::ArcGISRuntime::Toolkit::BasemapGalleryItem::tooltipOverride().
Member Function Documentation
[invokable] BasemapGalleryItem::BasemapGalleryItem (QObject *parent = nullptr)
Constructor. Takes a parent object. Constructs an empty item.
Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.
[invokable] BasemapGalleryItem::BasemapGalleryItem (Esri::ArcGISRuntime::Basemap *basemap, QObject *parent = nullptr)
Constructor. Takes a basemap and parent object. Constructs an item that represents the given basemap in the gallery.
Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.
[invokable] BasemapGalleryItem::BasemapGalleryItem (Esri::ArcGISRuntime::Basemap *basemap, QImage thumbnail, QString tooltip, QObject *parent = nullptr)
Constructor. Takes a basemap, thumbnail, tooltip, and parent object.
Constructs an item that represents the given basemap in the gallery. The thumbnail and tooltip objects provided are used in place of the thumbnail and description of the basemap's item, if provided.
Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.
[override virtual] BasemapGalleryItem::~BasemapGalleryItem ()
Destructor.
Esri::ArcGISRuntime::Basemap *BasemapGalleryItem::basemap() const
Returns the basemap this gallery item represents.
Note: Getter function for property basemap.
See also setBasemap().
[signal] void BasemapGalleryItem::basemapChanged ()
Emitted when the basemap has changed.
QString BasemapGalleryItem::name() const
Returns the name of the basemap.
Note: Getter function for property name.
void BasemapGalleryItem::setBasemap (Esri::ArcGISRuntime::Basemap *basemap)
Sets the basemap this gallery item represents.
Note: Setter function for property basemap.
See also basemap().
void BasemapGalleryItem::setThumbnailOverride (QImage thumbnail)
Sets the thumbnail override of this item, which replaces the thumbnail of the basemap when rendering the gallery.
Note: Setter function for property thumbnailOverride.
See also thumbnailOverride().
void BasemapGalleryItem::setTooltipOverride (QString tooltip)
Sets the tooltip override of this item, which replaces the tooltip of the basemap when rendering the gallery.
Note: Setter function for property tooltipOverride.
See also tooltipOverride().
QImage BasemapGalleryItem::thumbnail() const
Returns the thumbnail override of this item if valid. Otherwise returns the thumbnail on the basemap's item, if available. Otherwise, returns the default thumbnail.
Note: Getter function for property thumbnail.
See also BasemapGalleryItem::thumbnailOverride.
[signal] void BasemapGalleryItem::thumbnailChanged ()
Emitted when the thumbnail has changed.
Note: Notifier signal for property thumbnail.
QImage BasemapGalleryItem::thumbnailOverride () const
Returns the thumbnail of this item which overrides the basemap's items' thumbnail in the gallery.
Note: Getter function for property thumbnailOverride.
See also setThumbnailOverride() and BasemapGalleryItem::thumbnail.
[signal] void BasemapGalleryItem::thumbnailOverrideChanged ()
Emitted when the thumbnail override has changed.
Note: Notifier signal for property thumbnailOverride.
QString BasemapGalleryItem::tooltip() const
Returns the tooltip override of this item if non-empty. Otherwise returns the description on the basemap's item, if available.
Note: Getter function for property tooltip.
See also BasemapGalleryItem::tooltipOverride.
[signal] void BasemapGalleryItem::tooltipChanged ()
Emitted when the toolip has changed.
Note: Notifier signal for property tooltip.
QString BasemapGalleryItem::tooltipOverride () const
Returns the tooltip of this item which overrides the basemap's items' description in the gallery.
Note: Getter function for property tooltipOverride.
See also setTooltipOverride() and BasemapGalleryItem::tooltip.
[signal] void BasemapGalleryItem::tooltipOverrideChanged ()
Emitted when the toolip override has changed.
Note: Notifier signal for property tooltipOverride.