Skip to content

Commit fa4a426

Browse files
committed
Update documentation and sip binding
1 parent 0dcfd56 commit fa4a426

File tree

3 files changed

+39
-0
lines changed

3 files changed

+39
-0
lines changed

python/core/qgsvectorlayerjoininfo.sip

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,19 +167,35 @@ Returns whether values from the joined layer should be cached in memory to speed
167167
%End
168168

169169
void setJoinFieldNamesBlackList( const QStringList &blackList );
170+
%Docstring
171+
Sets a list of fields to ignore whatever happens.
172+
173+
.. versionadded:: 3.0
174+
%End
170175

171176
QStringList joinFieldNamesBlackList() const;
172177
%Docstring
178+
Returns the list of fields to ignore.
179+
180+
.. versionadded:: 3.0
173181
:rtype: list of str
174182
%End
175183

176184
bool hasSubset( bool blacklisted = true ) const;
177185
%Docstring
186+
Returns true if blacklisted fields is not empty or if a subset of names
187+
has been set.
188+
189+
.. versionadded:: 3.0
178190
:rtype: bool
179191
%End
180192

181193
static QStringList joinFieldNamesSubset( const QgsVectorLayerJoinInfo &info, bool blacklisted = true );
182194
%Docstring
195+
Returns the list of field names to use for joining considering
196+
blacklisted fields and subset.
197+
198+
.. versionadded:: 3.0
183199
:rtype: list of str
184200
%End
185201

src/core/qgsproperty.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,7 @@ class CORE_EXPORT QgsPropertyDefinition
105105
DataTypeBoolean,
106106
};
107107

108+
//! Indicates for which settings the property has been set
108109
enum Origin
109110
{
110111
Diagram,

src/core/qgsvectorlayerjoininfo.h

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,12 +141,34 @@ class CORE_EXPORT QgsVectorLayerJoinInfo
141141
*/
142142
QgsFeature extractJoinedFeature( const QgsFeature &feature ) const;
143143

144+
/**
145+
* Sets a list of fields to ignore whatever happens.
146+
*
147+
* \since QGIS 3.0
148+
*/
144149
void setJoinFieldNamesBlackList( const QStringList &blackList ) { mBlackList = blackList; }
145150

151+
/**
152+
* Returns the list of fields to ignore.
153+
*
154+
* \since QGIS 3.0
155+
*/
146156
QStringList joinFieldNamesBlackList() const { return mBlackList; }
147157

158+
/**
159+
* Returns true if blacklisted fields is not empty or if a subset of names
160+
* has been set.
161+
*
162+
* \since QGIS 3.0
163+
*/
148164
bool hasSubset( bool blacklisted = true ) const;
149165

166+
/**
167+
* Returns the list of field names to use for joining considering
168+
* blacklisted fields and subset.
169+
*
170+
* \since QGIS 3.0
171+
*/
150172
static QStringList joinFieldNamesSubset( const QgsVectorLayerJoinInfo &info, bool blacklisted = true );
151173

152174
bool operator==( const QgsVectorLayerJoinInfo &other ) const

0 commit comments

Comments
 (0)