Doxyfixes

This commit is contained in:
Matthias Kuhn 2017-10-25 15:10:10 +02:00
parent 51c5e8a063
commit 0b090fe141
No known key found for this signature in database
GPG Key ID: A0E766808764D73F
5 changed files with 21 additions and 6 deletions

View File

@ -30,6 +30,9 @@ class QgsFeatureFilterModel : QAbstractItemModel
};
QgsFeatureFilterModel( QObject *parent = 0 );
%Docstring
Create a new QgsFeatureFilterModel, optionally specifying a ``parent``.
%End
~QgsFeatureFilterModel();
QgsVectorLayer *sourceLayer() const;

View File

@ -12,7 +12,7 @@
class QgsFeatureListComboBox : QComboBox
{
%Docstring
This offers a combobox with autocompleter that allows to select features from a layer.
This offers a combobox with autocompleter that allows selecting features from a layer.
It will show up to 100 entries at a time. The entries can be chosen based on the displayExpression
and whenever text is typed into the combobox, the completer and popup will adjust to features matching the typed text.
@ -24,7 +24,11 @@ class QgsFeatureListComboBox : QComboBox
#include "qgsfeaturelistcombobox.h"
%End
public:
QgsFeatureListComboBox( QWidget *parent = 0 );
%Docstring
Create a new QgsFeatureListComboBox, optionally specifying a ``parent``.
%End
QgsVectorLayer *sourceLayer() const;
%Docstring

View File

@ -213,7 +213,7 @@ void QgsFeatureFilterModel::updateCompleter()
firstRow = 1;
}
// Remove all entries (except for extra entry if existant)
// Remove all entries (except for extra entry if existent)
beginRemoveRows( QModelIndex(), firstRow, mEntries.size() - firstRow );
mEntries.remove( firstRow, mEntries.size() - firstRow );
endRemoveRows();
@ -295,7 +295,7 @@ void QgsFeatureFilterModel::scheduledReload()
request.setFilterExpression( filterClause );
}
QSet<QString> attributes = request.filterExpression().referencedColumns();
QSet<QString> attributes = request.filterExpression()->referencedColumns();
attributes << mIdentifierField;
request.setSubsetOfAttributes( attributes, mSourceLayer->fields() );
request.setFlags( QgsFeatureRequest::NoGeometry );

View File

@ -23,6 +23,7 @@
class QgsFieldExpressionValuesGatherer;
/**
* \ingroup core
* Provides a list of features based on filter conditions.
* Features are fetched asynchronously.
*
@ -59,10 +60,13 @@ class CORE_EXPORT QgsFeatureFilterModel : public QAbstractItemModel
*/
enum Role
{
IdentifierValueRole = Qt::UserRole, //!<
ValueRole
IdentifierValueRole = Qt::UserRole, //!< Used to retrieve the identifierValue (primary key) of a feature.
ValueRole //!< Used to retrieve the displayExpression of a feature.
};
/**
* Create a new QgsFeatureFilterModel, optionally specifying a \a parent.
*/
QgsFeatureFilterModel( QObject *parent = nullptr );
~QgsFeatureFilterModel();

View File

@ -28,7 +28,8 @@ class QgsAnimatedIcon;
class QgsFilterLineEdit;
/**
* This offers a combobox with autocompleter that allows to select features from a layer.
* \ingroup gui
* This offers a combobox with autocompleter that allows selecting features from a layer.
*
* It will show up to 100 entries at a time. The entries can be chosen based on the displayExpression
* and whenever text is typed into the combobox, the completer and popup will adjust to features matching the typed text.
@ -47,6 +48,9 @@ class GUI_EXPORT QgsFeatureListComboBox : public QComboBox
Q_PROPERTY( bool allowNull READ allowNull WRITE setAllowNull NOTIFY allowNullChanged )
public:
/**
* Create a new QgsFeatureListComboBox, optionally specifying a \a parent.
*/
QgsFeatureListComboBox( QWidget *parent = nullptr );
/**