• PopupField
  • class Esri::ArcGISRuntime::PopupField

    A representation of a GeoElement's attribute field in a Popup. More...

    Header: #include <PopupField.h>
    Since: Esri::ArcGISRuntime 100.0
    Inherits: Esri::ArcGISRuntime::Object

    Public Functions

    PopupField(QObject *parent = nullptr)
    virtual ~PopupField() override
    QString fieldName() const
    Esri::ArcGISRuntime::PopupFieldFormat *format() const
    bool isEditable() const
    bool isVisible() const
    QString label() const
    void setEditable(bool editable)
    void setFieldName(const QString &fieldName)
    void setFormat(Esri::ArcGISRuntime::PopupFieldFormat *format)
    void setLabel(const QString &label)
    void setStringFieldOption(Esri::ArcGISRuntime::PopupStringFieldOption popupStringFieldOption)
    void setTooltip(const QString &tooltip)
    void setVisible(bool visible)
    Esri::ArcGISRuntime::PopupStringFieldOption stringFieldOption() const
    QString tooltip() const

    Detailed Description

    Member Function Documentation

    [explicit] PopupField::PopupField(QObject *parent = nullptr)

    Default constructor that takes an optional parent.

    [override virtual noexcept] PopupField::~PopupField()

    Destructor.

    QString PopupField::fieldName() const

    Returns the field name.

    See also setFieldName().

    Esri::ArcGISRuntime::PopupFieldFormat *PopupField::format() const

    Returns the PopupFieldFormat.

    See also setFormat().

    bool PopupField::isEditable() const

    Returns whether the field is editable.

    bool PopupField::isVisible() const

    Returns whether the field is visible.

    QString PopupField::label() const

    Returns the field label.

    See also setLabel().

    void PopupField::setEditable(bool editable)

    Sets whether the field is editable.

    See also isEditable().

    void PopupField::setFieldName(const QString &fieldName)

    Sets the fieldName.

    See also fieldName().

    void PopupField::setFormat(Esri::ArcGISRuntime::PopupFieldFormat *format)

    Sets the Popup field format.

    See also format().

    void PopupField::setLabel(const QString &label)

    Sets the field label.

    See also label().

    void PopupField::setStringFieldOption(Esri::ArcGISRuntime::PopupStringFieldOption popupStringFieldOption)

    Sets the format used to display the field as popupStringFieldOption.

    See also stringFieldOption().

    void PopupField::setTooltip(const QString &tooltip)

    Sets a string providing an editing tooltip for editors of the field.

    See also tooltip().

    void PopupField::setVisible(bool visible)

    Sets whether the field is visible.

    See also isVisible().

    Esri::ArcGISRuntime::PopupStringFieldOption PopupField::stringFieldOption() const

    Returns the format used to display the field.

    See also setStringFieldOption().

    QString PopupField::tooltip() const

    Returns a string providing an editing hint for editors of the field.

    See also setTooltip().