PopupFieldListModel Class

  • PopupFieldListModel
  • class Esri::ArcGISRuntime::PopupFieldListModel

    A list model storing pop-up fields. More...

    Header: #include <PopupFieldListModel.h>
    Since: Esri::ArcGISRuntime 100.14
    Inherits: QAbstractListModel and Esri::ArcGISRuntime::Iterable

    This class was introduced in Esri::ArcGISRuntime 100.14.

    Public Functions

    virtual ~PopupFieldListModel() override
    void append(Esri::ArcGISRuntime::PopupField *popupField)
    void clear()
    bool contains(Esri::ArcGISRuntime::PopupField *popupField) const
    Esri::ArcGISRuntime::PopupField *first() const
    int indexOf(Esri::ArcGISRuntime::PopupField *popupField) const
    void insert(int index, Esri::ArcGISRuntime::PopupField *popupField)
    bool isEmpty() const
    Esri::ArcGISRuntime::PopupField *last() const
    void move(int from, int to)
    void removeAt(int index)
    void removeOne(Esri::ArcGISRuntime::PopupField *popupField)

    Reimplemented Public Functions

    virtual Esri::ArcGISRuntime::PopupField *at(int index) const override
    virtual int size() const override

    Signals

    void elementAdded(int index)
    void elementRemoved(int index)
    void errorOccurred(Esri::ArcGISRuntime::Error error)

    Detailed Description

    The model returns data for the following roles:

    RoleTypeDescription
    nameQStringThe pop-up field's name.
    formatPopupFieldFormat*Format options for the pop-up field.
    editableboolWhether the pop-up field is editable.
    visibleboolWhether the pop-up field is visible.
    labelQStringThe pop-up field's label.
    stringFieldOptionPopupStringFieldOptionThe pop-up field's string field options.
    tooltipQStringThe pop-up field's tooltip.

    Member Function Documentation

    [signal] void PopupFieldListModel::elementAdded(int index)

    Signal emitted when a pop-up field is added to the list model.

    • index is the index of the added popup field.

    [signal] void PopupFieldListModel::elementRemoved(int index)

    Signal emitted when a pop-up field is removed from the list model.

    • index is the index of the removed popup field.

    [signal] void PopupFieldListModel::errorOccurred(Esri::ArcGISRuntime::Error error)

    Signal emitted when an error occurs.

    • error - Details about the error.

    [override virtual] PopupFieldListModel::~PopupFieldListModel()

    destructor

    void PopupFieldListModel::append(Esri::ArcGISRuntime::PopupField *popupField)

    Appends a popupField to the layer list model.

    [override virtual] Esri::ArcGISRuntime::PopupField *PopupFieldListModel::at(int index) const

    Returns the PopupField at the specified index.

    void PopupFieldListModel::clear()

    Removes all PopupField from the list model.

    List models do not take ownership of the objects they contain. Therefore, removing or clearing objects from the list model will not delete those objects. An RAII technique should be used to ensure that memory is properly deallocated.

    bool PopupFieldListModel::contains(Esri::ArcGISRuntime::PopupField *popupField) const

    Returns true if the list model contains the specified popupField.

    Esri::ArcGISRuntime::PopupField *PopupFieldListModel::first() const

    Returns the first PopupField in the list model.

    int PopupFieldListModel::indexOf(Esri::ArcGISRuntime::PopupField *popupField) const

    Returns the index of the popupField specified.

    void PopupFieldListModel::insert(int index, Esri::ArcGISRuntime::PopupField *popupField)

    Inserts a popupField at a specified index in the list model.

    This method will append to the list if the index is greater than the current size of the list model.

    bool PopupFieldListModel::isEmpty() const

    Returns true if the list model contains no popup fields.

    Esri::ArcGISRuntime::PopupField *PopupFieldListModel::last() const

    Returns the last PopupField in the list model.

    void PopupFieldListModel::move(int from, int to)

    Moves one PopupField from an index in the list model to a different index.

    void PopupFieldListModel::removeAt(int index)

    Removes a PopupField at the specified index.

    List models do not take ownership of the objects they contain. Therefore, removing or clearing objects from the list model will not delete those objects. An RAII technique should be used to ensure that memory is properly deallocated.

    void PopupFieldListModel::removeOne(Esri::ArcGISRuntime::PopupField *popupField)

    Removes the specified popupField from the list model.

    List models do not take ownership of the objects they contain. Therefore, removing or clearing objects from the list model will not delete those objects. An RAII technique should be used to ensure that memory is properly deallocated.

    [override virtual] int PopupFieldListModel::size() const

    Returns the number of PopupField contained in the list model.

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