Skip to content

Commit

Permalink
Add documentation for onlyActive parameter
Browse files Browse the repository at this point in the history
  • Loading branch information
pblottiere committed Mar 29, 2018
1 parent 624e446 commit 810e531
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
7 changes: 6 additions & 1 deletion python/core/symbology/qgsrulebasedrenderer.sip.in
Expand Up @@ -326,7 +326,12 @@ Returns which legend keys match the feature

QgsRuleBasedRenderer::RuleList rulesForFeature( QgsFeature &feat, QgsRenderContext *context = 0, bool onlyActive = true );
%Docstring
tell which rules will be used to render the feature
Returns the list of rules used to render the feature in a specific
context.

:param feat: The feature for which rules have to be find
:param context: The rendering context
:param onlyActive: True to search for active rules only, false otherwise
%End

void stopRender( QgsRenderContext &context );
Expand Down
9 changes: 8 additions & 1 deletion src/core/symbology/qgsrulebasedrenderer.h
Expand Up @@ -342,7 +342,14 @@ class CORE_EXPORT QgsRuleBasedRenderer : public QgsFeatureRenderer
*/
QSet< QString > legendKeysForFeature( QgsFeature &feat, QgsRenderContext *context = nullptr );

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

/**
Expand Down

0 comments on commit 810e531

Please sign in to comment.