Class QfReferencingFeatureListModel

ClassList > QfReferencingFeatureListModel

Inherits the following classes: QSortFilterProxyModel

Public Properties

Type	Name
property int	attachmentDocumentViewer
property QString	attachmentFieldName
property QString	attachmentStorageAuthConfigId
property QString	attachmentStorageType
property QString	attachmentStorageUrl
property QString	currentNmRelationId
property QString	currentRelationId
property QgsFeature	feature
property bool	isLoading
property QgsRelation	nmRelation
property bool	parentPrimariesAvailable
property QgsRelation	relation
property Qt::SortOrder	sortOrder

Public Signals

Type	Name
signal void	attachmentDetailsChanged
signal void	attributeFormModelChanged
signal void	beforeModelUpdated
signal void	featureChanged
signal void	isLoadingChanged
signal void	modelUpdated
signal void	nmRelationChanged
signal void	parentPrimariesAvailableChanged
signal void	relationChanged
signal void	sortOrderChanged

Public Functions

Type	Name
	QfReferencingFeatureListModel (QObject * parent=nullptr)
int	attachmentDocumentViewer () const
QString	attachmentFieldName () const
QString	attachmentStorageAuthConfigId () const
QString	attachmentStorageType () const
QString	attachmentStorageUrl () const
QString	currentNmRelationId () const On many-to-many relations returns the second relation id connecting the children in the association table to their other parent.
QString	currentRelationId () const Returns the id of the relation connecting the parent feature with the children in this model.
Q_INVOKABLE bool	deleteFeature (QgsFeatureId referencingFeatureId)
QgsFeature	feature () const
Q_INVOKABLE int	getFeatureIdRow (QgsFeatureId featureId)
bool	isLoading () const
QgsRelation	nmRelation () const
bool	parentPrimariesAvailable () const
QgsRelation	relation () const
Q_INVOKABLE void	reload ()
void	setCurrentNmRelationId (const QString & nmRelationId) On many-to-many relations sets the second relation connecting the children in the association table to their other parent.
void	setCurrentRelationId (const QString & relationId) Sets the relation connecting the parent feature with the children in this model.
void	setFeature (const QgsFeature & feature)
void	setNmRelation (const QgsRelation & relation)
void	setParentPrimariesAvailable (const bool parentPrimariesAvailable)
void	setRelation (const QgsRelation & relation)
void	setSortOrder (Qt::SortOrder sortOrder) Sets the sort order and re-applies sorting.
Qt::SortOrder	sortOrder () const Returns the current sort order (ascending or descending).

Protected Functions

Type	Name
bool	lessThan (const QModelIndex & left, const QModelIndex & right) override const

Public Properties Documentation

property attachmentDocumentViewer [1/2]

int QfReferencingFeatureListModel::attachmentDocumentViewer;

---

property attachmentFieldName [1/2]

QString QfReferencingFeatureListModel::attachmentFieldName;

---

property attachmentStorageAuthConfigId [1/2]

QString QfReferencingFeatureListModel::attachmentStorageAuthConfigId;

---

property attachmentStorageType [1/2]

QString QfReferencingFeatureListModel::attachmentStorageType;

---

property attachmentStorageUrl [1/2]

QString QfReferencingFeatureListModel::attachmentStorageUrl;

---

property currentNmRelationId [1/2]

QString QfReferencingFeatureListModel::currentNmRelationId;

---

property currentRelationId [1/2]

QString QfReferencingFeatureListModel::currentRelationId;

---

property feature [1/2]

QgsFeature QfReferencingFeatureListModel::feature;

---

property isLoading [1/2]

bool QfReferencingFeatureListModel::isLoading;

---

property nmRelation [1/2]

QgsRelation QfReferencingFeatureListModel::nmRelation;

---

property parentPrimariesAvailable [1/2]

bool QfReferencingFeatureListModel::parentPrimariesAvailable;

---

property relation [1/2]

QgsRelation QfReferencingFeatureListModel::relation;

---

property sortOrder [1/2]

Qt::SortOrder QfReferencingFeatureListModel::sortOrder;

---

Public Signals Documentation

signal attachmentDetailsChanged

void QfReferencingFeatureListModel::attachmentDetailsChanged;

---

signal attributeFormModelChanged

void QfReferencingFeatureListModel::attributeFormModelChanged;

---

signal beforeModelUpdated

void QfReferencingFeatureListModel::beforeModelUpdated;

---

signal featureChanged

void QfReferencingFeatureListModel::featureChanged;

---

signal isLoadingChanged

void QfReferencingFeatureListModel::isLoadingChanged;

---

signal modelUpdated

void QfReferencingFeatureListModel::modelUpdated;

---

signal nmRelationChanged

void QfReferencingFeatureListModel::nmRelationChanged;

---

signal parentPrimariesAvailableChanged

void QfReferencingFeatureListModel::parentPrimariesAvailableChanged;

---

signal relationChanged

void QfReferencingFeatureListModel::relationChanged;

---

signal sortOrderChanged

void QfReferencingFeatureListModel::sortOrderChanged;

---

Public Functions Documentation

function QfReferencingFeatureListModel

explicit QfReferencingFeatureListModel::QfReferencingFeatureListModel (
    QObject * parent=nullptr
) 

---

function attachmentDocumentViewer [2/2]

int QfReferencingFeatureListModel::attachmentDocumentViewer () const

Returns the document viewer type of the first ExternalResource field found on the referencing layer. The value corresponds to the "DocumentViewer" configuration entry of the editor widget setup (0 = file, 1 = image, 3 = audio, 4 = video). Returns 0 if no ExternalResource field exists.

See also: QgsExternalResourceWidget::DocumentViewerContent in https://github.com/qgis/QGIS/blob/6ca6cf1bab8e017355f7631115cf48bc3c6a4601/src/gui/qgsexternalresourcewidget.h#L72-L79

---

function attachmentFieldName [2/2]

QString QfReferencingFeatureListModel::attachmentFieldName () const

Returns the field name of the first ExternalResource field found on the referencing layer, or an empty string if no such field exists.

---

function attachmentStorageAuthConfigId [2/2]

QString QfReferencingFeatureListModel::attachmentStorageAuthConfigId () const

Returns the authentication configuration ID for the external storage configured on the attachment field, or an empty string if none is set.

---

function attachmentStorageType [2/2]

QString QfReferencingFeatureListModel::attachmentStorageType () const

Returns the external storage type configured on the attachment field (e.g. "WebDAV"), or an empty string if none is set.

---

function attachmentStorageUrl [2/2]

QString QfReferencingFeatureListModel::attachmentStorageUrl () const

Returns the external storage URL configured on the attachment field (e.g. "https://server.com/remote.php/dav/files/user/"), or an empty string if none is set.

---

function currentNmRelationId [2/2]

On many-to-many relations returns the second relation id connecting the children in the association table to their other parent.

QString QfReferencingFeatureListModel::currentNmRelationId () const

---

function currentRelationId [2/2]

Returns the id of the relation connecting the parent feature with the children in this model.

QString QfReferencingFeatureListModel::currentRelationId () const

---

function deleteFeature

Q_INVOKABLE bool QfReferencingFeatureListModel::deleteFeature (
    QgsFeatureId referencingFeatureId
) 

Deletes a feature regarding the referencing layer and the feature id of the selected child

Parameters:

• referencingFeatureId id of the selected child

---

function feature [2/2]

QgsFeature QfReferencingFeatureListModel::feature () const

The parent feature for which this model contains the children

Returns:

the parent feature

See also: setFeature

---

function getFeatureIdRow

Q_INVOKABLE int QfReferencingFeatureListModel::getFeatureIdRow (
    QgsFeatureId featureId
) 

Returns the row number for a given feature id

Parameters:

• featureId the feature id

---

function isLoading [2/2]

bool QfReferencingFeatureListModel::isLoading () const

Indicator if the model is currently performing any feature iteration in the background.

---

function nmRelation [2/2]

QgsRelation QfReferencingFeatureListModel::nmRelation () const

On many-to-many relations this is the second relation connecting the children in the associationtable to their other parent

Returns:

associated relation

See also: setNmRelation

---

function parentPrimariesAvailable [2/2]

bool QfReferencingFeatureListModel::parentPrimariesAvailable () const

The status if the pk of the parent feature (this feature) are valid (not null) It's needed to check on opening a form to add a new child

Returns:

parentPrimariesAvailable The status if the parent pks are available

See also: setParentPrimariesAvailable

---

function relation [2/2]

QgsRelation QfReferencingFeatureListModel::relation () const

The relation connecting the parent feature with the children in this model

Returns:

relation

See also: setRelation

---

function reload

Q_INVOKABLE void QfReferencingFeatureListModel::reload () 

Reloads the model by starting the reload functionality in the gatherer (seperate thread) Sets the property parentPrimariesAvailable

---

function setCurrentNmRelationId

On many-to-many relations sets the second relation connecting the children in the association table to their other parent.

void QfReferencingFeatureListModel::setCurrentNmRelationId (
    const QString & nmRelationId
) 

---

function setCurrentRelationId

Sets the relation connecting the parent feature with the children in this model.

void QfReferencingFeatureListModel::setCurrentRelationId (
    const QString & relationId
) 

---

function setFeature

void QfReferencingFeatureListModel::setFeature (
    const QgsFeature & feature
) 

The parent feature for which this model contains the children

Parameters:

• feature

See also: feature

---

function setNmRelation

void QfReferencingFeatureListModel::setNmRelation (
    const QgsRelation & relation
) 

On many-to-many relations this is the second relation connecting the children in the associationtable to their other parent

Parameters:

• relation The associated relation

See also: nmRelation

---

function setParentPrimariesAvailable

void QfReferencingFeatureListModel::setParentPrimariesAvailable (
    const bool parentPrimariesAvailable
) 

The status if the pk of the parent feature (this feature) are valid (not null)

Parameters:

• parentPrimariesAvailable The status if the parent pks are available

See also: parentPrimariesAvailable

---

function setRelation

void QfReferencingFeatureListModel::setRelation (
    const QgsRelation & relation
) 

The relation connecting the parent feature with the children in this model

Parameters:

• relation

See also: relation

---

function setSortOrder

Sets the sort order and re-applies sorting.

void QfReferencingFeatureListModel::setSortOrder (
    Qt::SortOrder sortOrder
) 

Parameters:

• sortOrder The new sort order to use.

---

function sortOrder [2/2]

Returns the current sort order (ascending or descending).

Qt::SortOrder QfReferencingFeatureListModel::sortOrder () const

---

Protected Functions Documentation

function lessThan

bool QfReferencingFeatureListModel::lessThan (
    const QModelIndex & left,
    const QModelIndex & right
) override const

---

---

The documentation for this class was generated from the following file src/gui/qfreferencingfeaturelistmodel.h