Skip to content

Commit

Permalink
API documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
m-kuhn committed Apr 18, 2018
1 parent 7e9aeda commit 85719e8
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 1 deletion.
2 changes: 1 addition & 1 deletion python/core/symbology/qgsgraduatedsymbolrenderer.sip.in
Expand Up @@ -442,7 +442,7 @@ Will return null if the functionality is disabled.

QgsSymbol *symbolForValue( double value ) const;
%Docstring
attribute index (derived from attribute name in startRender)
Get the symbol which is used to represent ``value``.
%End

QString legendKeyForValue( double value ) const;
Expand Down
6 changes: 6 additions & 0 deletions python/core/symbology/qgsrenderer.sip.in
Expand Up @@ -482,6 +482,12 @@ implementation does not use subrenderers and will always return null.
int layer,
bool selected,
bool drawVertexMarker );
%Docstring
Render the ``feature`` with the ``symbol`` using ``context``.
Use ``layer`` to specify the symbol layer, ``selected`` to
specify if it should be rendered as selected and ``drawVertexMarker``
to specify if vertex markers should be rendered.
%End

void renderVertexMarker( QPointF pt, QgsRenderContext &context );
%Docstring
Expand Down
3 changes: 3 additions & 0 deletions src/core/symbology/qgsgraduatedsymbolrenderer.h
Expand Up @@ -408,6 +408,9 @@ class CORE_EXPORT QgsGraduatedSymbolRenderer : public QgsFeatureRenderer

std::unique_ptr<QgsDataDefinedSizeLegend> mDataDefinedSizeLegend;

/**
* Get the symbol which is used to represent \a value.
*/
QgsSymbol *symbolForValue( double value ) const;

/**
Expand Down
6 changes: 6 additions & 0 deletions src/core/symbology/qgsrenderer.h
Expand Up @@ -462,6 +462,12 @@ class CORE_EXPORT QgsFeatureRenderer
protected:
QgsFeatureRenderer( const QString &type );

/**
* Render the \a feature with the \a symbol using \a context.
* Use \a layer to specify the symbol layer, \a selected to
* specify if it should be rendered as selected and \a drawVertexMarker
* to specify if vertex markers should be rendered.
*/
void renderFeatureWithSymbol( const QgsFeature &feature,
QgsSymbol *symbol,
QgsRenderContext &context,
Expand Down

0 comments on commit 85719e8

Please sign in to comment.