Skip to content

Commit 810e531

Browse files
committed
Add documentation for onlyActive parameter
1 parent 624e446 commit 810e531

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

python/core/symbology/qgsrulebasedrenderer.sip.in

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -326,7 +326,12 @@ Returns which legend keys match the feature
326326

327327
QgsRuleBasedRenderer::RuleList rulesForFeature( QgsFeature &feat, QgsRenderContext *context = 0, bool onlyActive = true );
328328
%Docstring
329-
tell which rules will be used to render the feature
329+
Returns the list of rules used to render the feature in a specific
330+
context.
331+
332+
:param feat: The feature for which rules have to be find
333+
:param context: The rendering context
334+
:param onlyActive: True to search for active rules only, false otherwise
330335
%End
331336

332337
void stopRender( QgsRenderContext &context );

src/core/symbology/qgsrulebasedrenderer.h

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -342,7 +342,14 @@ class CORE_EXPORT QgsRuleBasedRenderer : public QgsFeatureRenderer
342342
*/
343343
QSet< QString > legendKeysForFeature( QgsFeature &feat, QgsRenderContext *context = nullptr );
344344

345-
//! tell which rules will be used to render the feature
345+
/**
346+
* Returns the list of rules used to render the feature in a specific
347+
* context.
348+
*
349+
* \param feat The feature for which rules have to be find
350+
* \param context The rendering context
351+
* \param onlyActive True to search for active rules only, false otherwise
352+
*/
346353
QgsRuleBasedRenderer::RuleList rulesForFeature( QgsFeature &feat, QgsRenderContext *context = nullptr, bool onlyActive = true );
347354

348355
/**

0 commit comments

Comments
 (0)