Update documentation and sip binding

This commit is contained in:
Blottiere Paul 2017-08-29 10:13:39 +01:00
parent 0dcfd56cdf
commit fa4a426893
3 changed files with 39 additions and 0 deletions

View File

@ -167,19 +167,35 @@ Returns whether values from the joined layer should be cached in memory to speed
%End
void setJoinFieldNamesBlackList( const QStringList &blackList );
%Docstring
Sets a list of fields to ignore whatever happens.
.. versionadded:: 3.0
%End
QStringList joinFieldNamesBlackList() const;
%Docstring
Returns the list of fields to ignore.
.. versionadded:: 3.0
:rtype: list of str
%End
bool hasSubset( bool blacklisted = true ) const;
%Docstring
Returns true if blacklisted fields is not empty or if a subset of names
has been set.
.. versionadded:: 3.0
:rtype: bool
%End
static QStringList joinFieldNamesSubset( const QgsVectorLayerJoinInfo &info, bool blacklisted = true );
%Docstring
Returns the list of field names to use for joining considering
blacklisted fields and subset.
.. versionadded:: 3.0
:rtype: list of str
%End

View File

@ -105,6 +105,7 @@ class CORE_EXPORT QgsPropertyDefinition
DataTypeBoolean,
};
//! Indicates for which settings the property has been set
enum Origin
{
Diagram,

View File

@ -141,12 +141,34 @@ class CORE_EXPORT QgsVectorLayerJoinInfo
*/
QgsFeature extractJoinedFeature( const QgsFeature &feature ) const;
/**
* Sets a list of fields to ignore whatever happens.
*
* \since QGIS 3.0
*/
void setJoinFieldNamesBlackList( const QStringList &blackList ) { mBlackList = blackList; }
/**
* Returns the list of fields to ignore.
*
* \since QGIS 3.0
*/
QStringList joinFieldNamesBlackList() const { return mBlackList; }
/**
* Returns true if blacklisted fields is not empty or if a subset of names
* has been set.
*
* \since QGIS 3.0
*/
bool hasSubset( bool blacklisted = true ) const;
/**
* Returns the list of field names to use for joining considering
* blacklisted fields and subset.
*
* \since QGIS 3.0
*/
static QStringList joinFieldNamesSubset( const QgsVectorLayerJoinInfo &info, bool blacklisted = true );
bool operator==( const QgsVectorLayerJoinInfo &other ) const