PopupDefinition Class
Defines how a Popup will be displayed and behave. More...
Header: | #include <PopupDefinition> |
Since: | Esri::ArcGISRuntime 100.0 |
Inherits: | Object |
Public Functions
PopupDefinition(QObject *parent = nullptr) | |
PopupDefinition(GeoElement *geoElement, QObject *parent = nullptr) | |
PopupDefinition(PopupSource *popupSource, QObject *parent = nullptr) | |
~PopupDefinition() | |
QString | description() const |
QList<PopupExpression *> | expressions() const |
QList<PopupField *> | fields() const |
bool | isDeleteAllowed() const |
bool | isEditGeometryAllowed() const |
bool | isEditingAllowed() const |
bool | isShowAttachments() const |
bool | isShowEditSummary() const |
QList<PopupMedia *> | media() const |
PopupRelatedFeaturesDefinition * | relatedFeaturesDefinition() const |
void | setDeleteAllowed(bool deleteAllowed) |
void | setDescription(const QString &description) |
void | setEditGeometryAllowed(bool editGeometryAllowed) |
void | setEditingAllowed(bool editingAllowed) |
void | setExpressions(const QList<PopupExpression *> &expressions) |
void | setFields(const QList<PopupField *> &fields) |
void | setMedia(const QList<PopupMedia *> &media) |
void | setRelatedFeaturesDefinition(PopupRelatedFeaturesDefinition *relatedFeaturesDefinition) |
void | setShowAttachments(bool showAttachments) |
void | setShowEditSummary(bool showEditSummary) |
void | setTitle(const QString &title) |
QString | title() const |
- 31 public functions inherited from QObject
Additional Inherited Members
- 1 property inherited from QObject
- 1 public slot inherited from QObject
- 1 signal inherited from Esri::ArcGISRuntime::Object
- 2 signals inherited from QObject
- 1 public variable inherited from QObject
- 10 static public members inherited from QObject
- 9 protected functions inherited from QObject
- 2 protected variables inherited from QObject
Detailed Description
Defines how a Popup will be displayed and behave.
Popup definitions contain information such as:
- Which attributes the Popup should display
- Whether the attributes are editable
- How to format numbers and dates
- Whether the Popup should show attachments for the GeoElement
- What media, such as charts and images, should be displayed for the GeoElement
Member Function Documentation
PopupDefinition::PopupDefinition(QObject *parent = nullptr)
Default constructor that takes an optional parent.
PopupDefinition::PopupDefinition(GeoElement *geoElement, QObject *parent = nullptr)
Constructor that takes a geoElement with an optional parent.
PopupDefinition::PopupDefinition(PopupSource *popupSource, QObject *parent = nullptr)
Constructor that takes a popupSource with an optional parent.
PopupDefinition::~PopupDefinition()
Destructor.
QString PopupDefinition::description() const
Returns the string that appears in the body of the Popup as a description.
See also setDescription().
QList<PopupExpression *> PopupDefinition::expressions() const
Returns a list of PopupExpression objects defining the various Arcade expressions on the popup.
This function was introduced in Esri::ArcGISRuntime 100.3.
See also setExpressions().
QList<PopupField *> PopupDefinition::fields() const
Returns a list of PopupField objects defining how each field participates in the Popup.
See also setFields().
bool PopupDefinition::isDeleteAllowed() const
Returns whether the PopupSource allows the GeoElement to be deleted.
bool PopupDefinition::isEditGeometryAllowed() const
Returns whether the PopupSource allows the GeoElement's geometry to be edited.
bool PopupDefinition::isEditingAllowed() const
Returns whether the PopupSource allows the GeoElement's attributes to be edited.
bool PopupDefinition::isShowAttachments() const
Returns whether the Popup should show attachments of the GeoElement.
bool PopupDefinition::isShowEditSummary() const
Returns whether the Popup should show the edit summary of the GeoElement.
QList<PopupMedia *> PopupDefinition::media() const
Returns a list of PopupMedia objects that define images and charts displayed in the Popup.
See also setMedia().
PopupRelatedFeaturesDefinition *PopupDefinition::relatedFeaturesDefinition() const
Returns the PopupRelatedFeaturesDefinition.
This function was introduced in Esri::ArcGISRuntime 100.1.
See also setRelatedFeaturesDefinition().
void PopupDefinition::setDeleteAllowed(bool deleteAllowed)
Sets whether the PopupSource allows the GeoElement to be deleted.
Set deleteAllowed to true
to allow the GeoElement to be deleted.
See also isDeleteAllowed().
void PopupDefinition::setDescription(const QString &description)
Sets the string that appears in the body of the Popup as a description.
See also description().
void PopupDefinition::setEditGeometryAllowed(bool editGeometryAllowed)
Sets whether the PopupSource allows the GeoElement's geometry to be edited.
Set editGeometryAllowed to true
to allow the GeoElement's geometry to be edited.
See also isEditGeometryAllowed().
void PopupDefinition::setEditingAllowed(bool editingAllowed)
Sets whether the PopupSource allows the GeoElement's attributes to be edited.
Set editingAllowed to true
to allow the GeoElement's attributes to be edited.
See also isEditingAllowed().
void PopupDefinition::setExpressions(const QList<PopupExpression *> &expressions)
Sets the list of PopupExpression objects defining the various Arcade expressions on the popup.
This function was introduced in Esri::ArcGISRuntime 100.3.
See also expressions().
void PopupDefinition::setFields(const QList<PopupField *> &fields)
Sets a list of fields defining how each PopupField participates in the Popup.
See also fields().
void PopupDefinition::setMedia(const QList<PopupMedia *> &media)
Sets a list of media that define images and charts displayed in the Popup.
See also media().
void PopupDefinition::setRelatedFeaturesDefinition(PopupRelatedFeaturesDefinition *relatedFeaturesDefinition)
Sets the PopupRelatedFeaturesDefinition to relatedFeaturesDefinition.
This function was introduced in Esri::ArcGISRuntime 100.1.
See also relatedFeaturesDefinition().
void PopupDefinition::setShowAttachments(bool showAttachments)
Sets whether the Popup should showAttachments of the GeoElement.
See also isShowAttachments().
void PopupDefinition::setShowEditSummary(bool showEditSummary)
Sets whether the Popup should showEditSummary of the GeoElement.
See also isShowEditSummary().
void PopupDefinition::setTitle(const QString &title)
Sets a string that appears at the top of the Popup as a title.
See also title().
QString PopupDefinition::title() const
Returns a string that appears at the top of the Popup as a title.
See also setTitle().