mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-25 00:58:06 -05:00
281 lines
7.5 KiB
Plaintext
281 lines
7.5 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/qgsfeaturepickermodelbase.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
class QgsFeaturePickerModelBase : QAbstractItemModel /Abstract/
|
|
{
|
|
%Docstring(signature="appended")
|
|
Provides a list of features based on filter conditions.
|
|
|
|
Features are fetched asynchronously.
|
|
|
|
.. versionadded:: 3.14
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsfeaturepickermodelbase.h"
|
|
%End
|
|
public:
|
|
|
|
|
|
enum class CustomRole /BaseType=IntEnum/
|
|
{
|
|
IdentifierValue,
|
|
IdentifierValues,
|
|
Value,
|
|
Feature,
|
|
FeatureId
|
|
};
|
|
|
|
explicit QgsFeaturePickerModelBase( QObject *parent = 0 );
|
|
%Docstring
|
|
Create a new QgsFeaturePickerModelBase, optionally specifying a ``parent``.
|
|
%End
|
|
~QgsFeaturePickerModelBase();
|
|
|
|
QgsVectorLayer *sourceLayer() const;
|
|
%Docstring
|
|
The source layer from which features will be fetched.
|
|
%End
|
|
|
|
void setSourceLayer( QgsVectorLayer *sourceLayer );
|
|
%Docstring
|
|
The source layer from which features will be fetched.
|
|
%End
|
|
|
|
QString displayExpression() const;
|
|
%Docstring
|
|
The display expression will be used for
|
|
|
|
- displaying values in the combobox
|
|
- filtering based on filterValue
|
|
%End
|
|
|
|
void setDisplayExpression( const QString &displayExpression );
|
|
%Docstring
|
|
The display expression will be used for
|
|
|
|
- displaying values in the combobox
|
|
- filtering based on filterValue
|
|
%End
|
|
|
|
QString filterValue() const;
|
|
%Docstring
|
|
This value will be used to filter the features available from
|
|
this model. Whenever a substring of the displayExpression of a feature
|
|
matches the filter value, it will be accessible by this model.
|
|
%End
|
|
|
|
void setFilterValue( const QString &filterValue );
|
|
%Docstring
|
|
This value will be used to filter the features available from
|
|
this model. Whenever a substring of the displayExpression of a feature
|
|
matches the filter value, it will be accessible by this model.
|
|
%End
|
|
|
|
virtual QModelIndex index( int row, int column, const QModelIndex &parent ) const;
|
|
|
|
virtual QModelIndex parent( const QModelIndex &child ) const;
|
|
|
|
virtual int rowCount( const QModelIndex &parent ) const;
|
|
|
|
virtual int columnCount( const QModelIndex &parent ) const;
|
|
virtual QVariant data( const QModelIndex &index, int role ) const;
|
|
|
|
|
|
QString filterExpression() const;
|
|
%Docstring
|
|
An additional filter expression to apply, next to the filterValue.
|
|
Can be used for spatial filtering etc.
|
|
%End
|
|
|
|
void setFilterExpression( const QString &filterExpression );
|
|
%Docstring
|
|
An additional filter expression to apply, next to the filterValue.
|
|
Can be used for spatial filtering etc.
|
|
%End
|
|
|
|
bool isLoading() const;
|
|
%Docstring
|
|
Indicator if the model is currently performing any feature iteration in the background.
|
|
%End
|
|
|
|
virtual void setExtraIdentifierValueToNull() = 0;
|
|
%Docstring
|
|
Allows specifying one value that does not need to match the filter criteria but will
|
|
still be available in the model as NULL value(s).
|
|
%End
|
|
|
|
int extraIdentifierValueIndex() const;
|
|
%Docstring
|
|
The index at which the extra identifier value is available within the model.
|
|
%End
|
|
|
|
bool extraValueDoesNotExist() const;
|
|
%Docstring
|
|
Flag indicating that the extraIdentifierValue does not exist in the data.
|
|
%End
|
|
|
|
bool allowNull() const;
|
|
%Docstring
|
|
Add a NULL entry to the list.
|
|
%End
|
|
|
|
void setAllowNull( bool allowNull );
|
|
%Docstring
|
|
Add a NULL entry to the list.
|
|
%End
|
|
|
|
bool fetchGeometry() const;
|
|
%Docstring
|
|
Returns if the geometry is fetched
|
|
%End
|
|
|
|
void setFetchGeometry( bool fetchGeometry );
|
|
%Docstring
|
|
Defines if the geometry will be fetched
|
|
%End
|
|
|
|
int fetchLimit() const;
|
|
%Docstring
|
|
Returns the feature request fetch limit
|
|
%End
|
|
|
|
void setFetchLimit( int fetchLimit );
|
|
%Docstring
|
|
Defines the feature request fetch limit
|
|
If set to 0, no limit is applied when fetching
|
|
%End
|
|
|
|
signals:
|
|
|
|
void currentFeatureChanged();
|
|
%Docstring
|
|
Emitted when the current feature in the model has changed
|
|
This emitted both when the extra value changes and when the extra value status changes.
|
|
It allows being notified when the feature is fetched after the extra value has been set.
|
|
|
|
.. versionadded:: 3.16.5
|
|
%End
|
|
|
|
void sourceLayerChanged();
|
|
%Docstring
|
|
The source layer from which features will be fetched.
|
|
%End
|
|
|
|
void displayExpressionChanged();
|
|
%Docstring
|
|
The display expression will be used for
|
|
|
|
- displaying values in the combobox
|
|
- filtering based on filterValue
|
|
%End
|
|
|
|
void filterValueChanged();
|
|
%Docstring
|
|
This value will be used to filter the features available from
|
|
this model. Whenever a substring of the displayExpression of a feature
|
|
matches the filter value, it will be accessible by this model.
|
|
%End
|
|
|
|
void filterExpressionChanged();
|
|
%Docstring
|
|
An additional filter expression to apply, next to the filterValue.
|
|
Can be used for spatial filtering etc.
|
|
%End
|
|
|
|
void isLoadingChanged();
|
|
%Docstring
|
|
Indicator if the model is currently performing any feature iteration in the background.
|
|
%End
|
|
|
|
void filterJobCompleted();
|
|
%Docstring
|
|
Indicates that a filter job has been completed and new data may be available.
|
|
%End
|
|
|
|
void extraIdentifierValueChanged();
|
|
%Docstring
|
|
Allows specifying one value that does not need to match the filter criteria but will
|
|
still be available in the model.
|
|
%End
|
|
|
|
void extraIdentifierValueIndexChanged( int index );
|
|
%Docstring
|
|
The index at which the extra identifier value is available within the model.
|
|
%End
|
|
|
|
void extraValueDoesNotExistChanged();
|
|
%Docstring
|
|
Flag indicating that the extraIdentifierValue does not exist in the data.
|
|
%End
|
|
|
|
void beginUpdate();
|
|
%Docstring
|
|
Notification that the model is about to be changed because a job was completed.
|
|
%End
|
|
|
|
void endUpdate();
|
|
%Docstring
|
|
Notification that the model change is finished. Will always be emitted in sync with beginUpdate.
|
|
%End
|
|
|
|
void allowNullChanged();
|
|
%Docstring
|
|
Add a NULL entry to the list.
|
|
%End
|
|
|
|
void fetchGeometryChanged();
|
|
%Docstring
|
|
Emitted when the fetching of the geometry changes
|
|
%End
|
|
|
|
void fetchLimitChanged();
|
|
%Docstring
|
|
Emitted when the fetching limit for the feature request changes
|
|
%End
|
|
|
|
|
|
protected:
|
|
|
|
QVariant extraIdentifierValue() const;
|
|
%Docstring
|
|
Allows specifying one value that does not need to match the filter criteria but will
|
|
still be available in the model.
|
|
%End
|
|
|
|
void setExtraIdentifierValue( const QVariant &extraIdentifierValue );
|
|
%Docstring
|
|
Allows specifying one value that does not need to match the filter criteria but will
|
|
still be available in the model.
|
|
%End
|
|
|
|
virtual void requestToReloadCurrentFeature( QgsFeatureRequest &request ) = 0;
|
|
%Docstring
|
|
Update the request to match the current feature to be reloaded
|
|
%End
|
|
|
|
void setExtraIdentifierValueUnguarded( const QVariant &identifierValue );
|
|
%Docstring
|
|
This will set the identifier value to be set in the model even if it doesn't exist currently in the data
|
|
%End
|
|
|
|
|
|
|
|
|
|
};
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/qgsfeaturepickermodelbase.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|