Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Update documentation and sip binding
  • Loading branch information
pblottiere committed Oct 9, 2017
1 parent 0dcfd56 commit fa4a426
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 0 deletions.
16 changes: 16 additions & 0 deletions python/core/qgsvectorlayerjoininfo.sip
Expand Up @@ -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

Expand Down
1 change: 1 addition & 0 deletions src/core/qgsproperty.h
Expand Up @@ -105,6 +105,7 @@ class CORE_EXPORT QgsPropertyDefinition
DataTypeBoolean,
};

//! Indicates for which settings the property has been set
enum Origin
{
Diagram,
Expand Down
22 changes: 22 additions & 0 deletions src/core/qgsvectorlayerjoininfo.h
Expand Up @@ -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
Expand Down

0 comments on commit fa4a426

Please sign in to comment.