An attachment to a Popup, which contains the attachment data and some additional metadata about the attachment. More...
Header: | #include <PopupAttachment.h> |
Since: | Esri::ArcGISRuntime 100.0 |
Inherits: | Esri::ArcGISRuntime::Object and Esri::ArcGISRuntime::Loadable |
Public Functions
virtual | ~PopupAttachment() override |
Esri::ArcGISRuntime::Attachment * | attachment() const |
QString | contentType() const |
QFuture<QImage> | createFullImageAsync() |
QFuture<QImage> | createThumbnailAsync(int width, int height) |
QString | filePath() const |
bool | isLocal() const |
QString | name() const |
Esri::ArcGISRuntime::PopupAttachmentType | popupAttachmentType() const |
qint64 | size() const |
Reimplemented Public Functions
virtual void | cancelLoad() override |
virtual void | load() override |
virtual Esri::ArcGISRuntime::Error | loadError() const override |
virtual Esri::ArcGISRuntime::LoadStatus | loadStatus() const override |
virtual void | retryLoad() override |
Signals
void | doneLoading(const Esri::ArcGISRuntime::Error &error) |
void | loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus) |
Detailed Description
Obtain PopupAttachments from the PopupAttachmentManager.
Member Function Documentation
[override virtual]
PopupAttachment::~PopupAttachment ()
Destructor.
Esri::ArcGISRuntime::Attachment *PopupAttachment::attachment() const
Returns the underlying attachment.
[override virtual]
void PopupAttachment::cancelLoad ()
Reimplements: Loadable::cancelLoad().
See Loadable.
QString PopupAttachment::contentType () const
Returns the content type of the PopupAttachment.
[since Esri::ArcGISRuntime 200.3]
QFuture<QImage> PopupAttachment::createFullImageAsync ()
Returns asynchronously the full image for displaying the attachment in full screen or some UI larger than a thumbnail.
This is only supported if the popupAttachmentType is PopupAttachmentType::Image.
This function was introduced in Esri::ArcGISRuntime 200.3.
[since Esri::ArcGISRuntime 200.3]
QFuture<QImage> PopupAttachment::createThumbnailAsync (int width, int height)
Returns asynchronously a thumbnail image with the specified width and height.
- width - Width of the thumbnail.
- height - Height of the thumbnail.
This is only supported if the popupAttachmentType is PopupAttachmentType::Image.
This function was introduced in Esri::ArcGISRuntime 200.3.
[signal]
void PopupAttachment::doneLoading (const Esri::ArcGISRuntime::Error &error)
Signal emitted when this object is done loading.
- error - Details about any error that may have occurred.
Note: If there is a load error it will also be emitted on the errorOccurred
signal.
[since Esri::ArcGISRuntime 200.2]
QString PopupAttachment::filePath () const
Returns the local temporary filepath where we store the attachment once it is loaded.
This function was introduced in Esri::ArcGISRuntime 200.2.
bool PopupAttachment::isLocal () const
Returns whether the PopupAttachment is local.
[override virtual]
void PopupAttachment::load()
Reimplements: Loadable::load().
See Loadable.
[override virtual]
Esri::ArcGISRuntime::Error PopupAttachment::loadError () const
Reimplements: Loadable::loadError() const.
See Loadable.
[override virtual]
Esri::ArcGISRuntime::LoadStatus PopupAttachment::loadStatus () const
Reimplements: Loadable::loadStatus() const.
See Loadable.
[signal]
void PopupAttachment::loadStatusChanged (Esri::ArcGISRuntime::LoadStatus loadStatus )
Signal emitted when the loadStatus changes for this object.
See also Loadable.
QString PopupAttachment::name() const
Returns the name of the PopupAttachment.
[since Esri::ArcGISRuntime 200.3]
Esri::ArcGISRuntime::PopupAttachmentType PopupAttachment::popupAttachmentType () const
Returns the type of the PopupAttachment.
This function was introduced in Esri::ArcGISRuntime 200.3.
[override virtual]
void PopupAttachment::retryLoad ()
Reimplements: Loadable::retryLoad().
See Loadable.
qint64 PopupAttachment::size() const
Returns the size of the PopupAttachment in bytes.