;

PopupAttachment Class

  • PopupAttachment
  • class Esri::ArcGISRuntime::PopupAttachment

    An attachment to a Popup, which contains the attachment data and some additional metadata about the attachment. More...

    Header: #include <PopupAttachment>
    Since: Esri::ArcGISRuntime 100.0
    Inherits: Esri::ArcGISRuntime::Object and Esri::ArcGISRuntime::Loadable

    This class was introduced in Esri::ArcGISRuntime 100.0.

    Public Functions

    virtual ~PopupAttachment() override
    Esri::ArcGISRuntime::Attachment *attachment() const
    QUrl attachmentUrl() const
    QString contentType() const
    Esri::ArcGISRuntime::PopupAttachmentEditState editState() const
    QUuid fullImage()
    bool isLocal() const
    QString name() const
    Esri::ArcGISRuntime::PopupAttachmentType popupType() const
    qint64 size() const
    QUuid thumbnail(int width, int height, Esri::ArcGISRuntime::AspectRatioMode aspectRatioMode = AspectRatioMode::KeepAspectRatio)

    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(Esri::ArcGISRuntime::Error error)
    void fullImageCompleted(QUuid taskId, const QImage &thumbnail)
    void loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)
    void thumbnailCompleted(QUuid taskId, const QImage &thumbnail)

    Detailed Description

    Obtain PopupAttachments from the PopupAttachmentManager.

    Member Function Documentation

    [signal] void PopupAttachment::doneLoading(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.

    See also Loadable and Object.

    [signal] void PopupAttachment::fullImageCompleted(QUuid taskId, const QImage &thumbnail)

    Signal emitted when the full image of the attachment is obtained.

    • taskId - The task ID for the asynchronous operation.
    • thumbnail - The full image of the attachment.

    [signal] void PopupAttachment::loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

    Signal emitted when the loadStatus changes for this object.

    See also Loadable.

    [signal] void PopupAttachment::thumbnailCompleted(QUuid taskId, const QImage &thumbnail)

    Signal emitted when the thumbnail image of the attachment is obtained.

    • taskId - The task ID for the asynchronous operation.
    • thumbnail - The thumbnail image of the attachment.

    [override virtual] PopupAttachment::~PopupAttachment()

    Destructor.

    Esri::ArcGISRuntime::Attachment *PopupAttachment::attachment() const

    Returns the underlying attachment.

    QUrl PopupAttachment::attachmentUrl() const

    Returns the PopupAttachment URL.

    [override virtual] void PopupAttachment::cancelLoad()

    Reimplements: Loadable::cancelLoad().

    See Loadable.

    QString PopupAttachment::contentType() const

    Returns the content type of the PopupAttachment.

    Esri::ArcGISRuntime::PopupAttachmentEditState PopupAttachment::editState() const

    Returns the edit state of the PopupAttachment.

    QUuid PopupAttachment::fullImage()

    Returns 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 Image.

    The fullImageCompleted signal emits when this asynchronous operation completes. Use the returned QUuid to keep track of concurrent operations.

    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.

    QString PopupAttachment::name() const

    Returns the name of the PopupAttachment.

    Esri::ArcGISRuntime::PopupAttachmentType PopupAttachment::popupType() const

    Returns the type of the PopupAttachment.

    [override virtual] void PopupAttachment::retryLoad()

    Reimplements: Loadable::retryLoad().

    See Loadable.

    qint64 PopupAttachment::size() const

    Returns the size of the PopupAttachment in bytes.

    QUuid PopupAttachment::thumbnail(int width, int height, Esri::ArcGISRuntime::AspectRatioMode aspectRatioMode = AspectRatioMode::KeepAspectRatio)

    Returns a thumbnail image with a give width, height, and aspectRatioMode.

    This is only supported if the PopupAttachmentType is Image.

    The thumbnailCompleted signal emits when this asynchronous operation completes. Use the returned QUuid to keep track of concurrent operations.

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.