Skip to content
Permalink
Browse files
Dox
  • Loading branch information
nyalldawson committed May 18, 2021
1 parent b61dc7c commit 7291bbb45731eb0e8da808108fb5bfdd484f6cd5
@@ -611,6 +611,7 @@ Internally, this notifies all symbol layers which were used via a call to
%End

protected:

QgsSymbol( Qgis::SymbolType type, const QgsSymbolLayerList &layers /Transfer/ ); // can't be instantiated

static QPointF _getPoint( QgsRenderContext &context, const QgsPoint &point );
@@ -353,7 +353,20 @@ The default implementation returns ``False``.
%End

void setLocked( bool locked );
%Docstring
Sets whether the layer's colors are locked.

If ``locked`` is ``True`` then the symbol layer colors are locked and the layer will ignore any symbol-level color changes.

.. seealso:: :py:func:`isLocked`
%End

bool isLocked() const;
%Docstring
Returns ``True`` if the symbol layer colors are locked and the layer will ignore any symbol-level color changes.

.. seealso:: :py:func:`setLocked`
%End

virtual double estimateMaxBleed( const QgsRenderContext &context ) const;
%Docstring
@@ -550,6 +563,12 @@ This is a list of symbol layers of other layers that should be occluded.
protected:

QgsSymbolLayer( Qgis::SymbolType type, bool locked = false );
%Docstring
Constructor for QgsSymbolLayer.

:param type: specifies the associated symbol type
:param locked: if ``True``, then symbol layer colors will be locked and will ignore any symbol-level color changes.
%End



@@ -25,7 +25,15 @@ Stores metadata about one symbol layer class.
#include "qgssymbollayerregistry.h"
%End
public:

QgsSymbolLayerAbstractMetadata( const QString &name, const QString &visibleName, Qgis::SymbolType type );
%Docstring
Constructor for QgsSymbolLayerAbstractMetadata.

:param name: internal symbol layer name (unique identifier)
:param visibleName: user visible, translated name for symbol layer
:param type: associated symbol type
%End

virtual ~QgsSymbolLayerAbstractMetadata();

@@ -598,6 +598,12 @@ class CORE_EXPORT QgsSymbol
void stopFeatureRender( const QgsFeature &feature, QgsRenderContext &context, int layer = -1 );

protected:

/**
* Constructor for a QgsSymbol of the specified \a type.
*
* Ownership of \a layers will be transferred to the symbol.
*/
QgsSymbol( Qgis::SymbolType type, const QgsSymbolLayerList &layers SIP_TRANSFER ); // can't be instantiated

/**
@@ -376,7 +376,20 @@ class CORE_EXPORT QgsSymbolLayer
*/
virtual bool canCauseArtifactsBetweenAdjacentTiles() const;

/**
* Sets whether the layer's colors are locked.
*
* If \a locked is TRUE then the symbol layer colors are locked and the layer will ignore any symbol-level color changes.
*
* \see isLocked()
*/
void setLocked( bool locked ) { mLocked = locked; }

/**
* Returns TRUE if the symbol layer colors are locked and the layer will ignore any symbol-level color changes.
*
* \see setLocked()
*/
bool isLocked() const { return mLocked; }

/**
@@ -539,6 +552,11 @@ class CORE_EXPORT QgsSymbolLayer

protected:

/**
* Constructor for QgsSymbolLayer.
* \param type specifies the associated symbol type
* \param locked if TRUE, then symbol layer colors will be locked and will ignore any symbol-level color changes.
*/
QgsSymbolLayer( Qgis::SymbolType type, bool locked = false );

Qgis::SymbolType mType;
@@ -35,6 +35,13 @@ class QDomElement;
class CORE_EXPORT QgsSymbolLayerAbstractMetadata
{
public:

/**
* Constructor for QgsSymbolLayerAbstractMetadata.
* \param name internal symbol layer name (unique identifier)
* \param visibleName user visible, translated name for symbol layer
* \param type associated symbol type
*/
QgsSymbolLayerAbstractMetadata( const QString &name, const QString &visibleName, Qgis::SymbolType type )
: mName( name )
, mVisibleName( visibleName )

0 comments on commit 7291bbb

Please sign in to comment.