Skip to content

Commit

Permalink
Doxyfixes
Browse files Browse the repository at this point in the history
  • Loading branch information
m-kuhn committed Oct 26, 2017
1 parent 51c5e8a commit 0b090fe
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 6 deletions.
3 changes: 3 additions & 0 deletions python/core/qgsfeaturefiltermodel.sip
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
6 changes: 5 additions & 1 deletion python/gui/qgsfeaturelistcombobox.sip
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions src/core/qgsfeaturefiltermodel.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -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();
Expand Down Expand Up @@ -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 );
Expand Down
8 changes: 6 additions & 2 deletions src/core/qgsfeaturefiltermodel.h
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
class QgsFieldExpressionValuesGatherer;

/**
* \ingroup core
* Provides a list of features based on filter conditions.
* Features are fetched asynchronously.
*
Expand Down Expand Up @@ -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();

Expand Down
6 changes: 5 additions & 1 deletion src/gui/qgsfeaturelistcombobox.h
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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 );

/**
Expand Down

0 comments on commit 0b090fe

Please sign in to comment.