Skip to content
Permalink
Browse files

add missing doxymentation

  • Loading branch information
3nids committed Jan 3, 2021
1 parent d1d28c5 commit 0cae2bea6a319d2a7f0d644bd95174ddd7d3c3dc
@@ -763,6 +763,9 @@ Constructor for QgsCptCityColorRamp
%End

static QgsColorRamp *create( const QVariantMap &properties = QVariantMap() ) /Factory/;
%Docstring
Creates the symbol layer
%End

static QString typeString();
%Docstring
@@ -22,6 +22,9 @@ A symbol layer for rendering objects with major and minor axis (e.g. ellipse, re
QgsEllipseSymbolLayer();

static QgsSymbolLayer *create( const QVariantMap &properties = QVariantMap() ) /Factory/;
%Docstring
Creates the symbol layer
%End
static QgsSymbolLayer *createFromSld( QDomElement &element ) /Factory/;

virtual void renderPoint( QPointF point, QgsSymbolRenderContext &context );
@@ -18,6 +18,9 @@ class QgsGeometryGeneratorSymbolLayer : QgsSymbolLayer
~QgsGeometryGeneratorSymbolLayer();

static QgsSymbolLayer *create( const QVariantMap &properties ) /Factory/;
%Docstring
Creates the symbol layer
%End

virtual QString layerType() const;

@@ -542,6 +542,9 @@ Constructs SVG marker symbol layer with picture from given absolute path to a SV


static QgsSymbolLayer *create( const QVariantMap &properties = QVariantMap() ) /Factory/;
%Docstring
Creates the symbol
%End
static QgsSymbolLayer *createFromSld( QDomElement &element ) /Factory/;

static void resolvePaths( QVariantMap &properties, const QgsPathResolver &pathResolver, bool saving );
@@ -279,6 +279,9 @@ clone this rule, return new instance
%End

void toSld( QDomDocument &doc, QDomElement &element, QVariantMap props ) const;
%Docstring
Saves the symbol layer as SLD
%End

static QgsRuleBasedRenderer::Rule *createFromSld( QDomElement &element, QgsWkbTypes::GeometryType geomType ) /Factory/;
%Docstring
@@ -306,6 +306,9 @@ Shall be reimplemented by subclasses to create a deep copy of the instance.
%End

virtual void toSld( QDomDocument &doc, QDomElement &element, const QVariantMap &props ) const;
%Docstring
Saves the symbol layer as SLD
%End

virtual QString ogrFeatureStyle( double mmScaleFactor, double mapUnitScaleFactor ) const;

@@ -463,7 +463,13 @@ Creates a OGC Expression element based on the provided function expression
static QgsStringMap getVendorOptionList( QDomElement &element );

static QVariantMap parseProperties( const QDomElement &element );
%Docstring
Parses the properties from XML and returns a map
%End
static void saveProperties( QVariantMap props, QDomDocument &doc, QDomElement &element );
%Docstring
Saves the map of properties to XML
%End

static QgsSymbolMap loadSymbols( QDomElement &element, const QgsReadWriteContext &context ) /Factory/;
%Docstring
@@ -41,6 +41,9 @@ A symbol layer class for displaying displacement arrows based on point layer att
QgsVectorFieldSymbolLayer();

static QgsSymbolLayer *create( const QVariantMap &properties = QVariantMap() );
%Docstring
Creates the symbol layer
%End
static QgsSymbolLayer *createFromSld( QDomElement &element );

virtual QString layerType() const;
@@ -701,6 +701,7 @@ class CORE_EXPORT QgsCptCityColorRamp : public QgsGradientColorRamp
const QString &variantName = QString(), bool inverted = false,
bool doLoadFile = true );

//! Creates the symbol layer
static QgsColorRamp *create( const QVariantMap &properties = QVariantMap() ) SIP_FACTORY;

/**
@@ -33,6 +33,7 @@ class CORE_EXPORT QgsEllipseSymbolLayer: public QgsMarkerSymbolLayer
public:
QgsEllipseSymbolLayer();

//! Creates the symbol layer
static QgsSymbolLayer *create( const QVariantMap &properties = QVariantMap() ) SIP_FACTORY;
static QgsSymbolLayer *createFromSld( QDomElement &element ) SIP_FACTORY;

@@ -28,6 +28,7 @@ class CORE_EXPORT QgsGeometryGeneratorSymbolLayer : public QgsSymbolLayer
public:
~QgsGeometryGeneratorSymbolLayer() override;

//! Creates the symbol layer
static QgsSymbolLayer *create( const QVariantMap &properties ) SIP_FACTORY;

QString layerType() const override;
@@ -496,6 +496,7 @@ class CORE_EXPORT QgsSvgMarkerSymbolLayer : public QgsMarkerSymbolLayer

// static stuff

//! Creates the symbol
static QgsSymbolLayer *create( const QVariantMap &properties = QVariantMap() ) SIP_FACTORY;
static QgsSymbolLayer *createFromSld( QDomElement &element ) SIP_FACTORY;

@@ -303,6 +303,7 @@ class CORE_EXPORT QgsRuleBasedRenderer : public QgsFeatureRenderer
//! clone this rule, return new instance
QgsRuleBasedRenderer::Rule *clone() const SIP_FACTORY;

//! Saves the symbol layer as SLD
void toSld( QDomDocument &doc, QDomElement &element, QVariantMap props ) const;

/**
@@ -333,6 +333,7 @@ class CORE_EXPORT QgsSymbolLayer
*/
virtual QgsSymbolLayer *clone() const = 0 SIP_FACTORY;

//! Saves the symbol layer as SLD
virtual void toSld( QDomDocument &doc, QDomElement &element, const QVariantMap &props ) const
{ Q_UNUSED( props ) element.appendChild( doc.createComment( QStringLiteral( "SymbolLayerV2 %1 not implemented yet" ).arg( layerType() ) ) ); }

@@ -451,7 +451,9 @@ class CORE_EXPORT QgsSymbolLayerUtils
static QDomElement createVendorOptionElement( QDomDocument &doc, const QString &name, const QString &value );
static QgsStringMap getVendorOptionList( QDomElement &element );

//! Parses the properties from XML and returns a map
static QVariantMap parseProperties( const QDomElement &element );
//! Saves the map of properties to XML
static void saveProperties( QVariantMap props, QDomDocument &doc, QDomElement &element );

//! Reads a collection of symbols from XML and returns them in a map. Caller is responsible for deleting returned symbols.
@@ -50,6 +50,7 @@ class CORE_EXPORT QgsVectorFieldSymbolLayer: public QgsMarkerSymbolLayer

QgsVectorFieldSymbolLayer();

//! Creates the symbol layer
static QgsSymbolLayer *create( const QVariantMap &properties = QVariantMap() );
static QgsSymbolLayer *createFromSld( QDomElement &element );

0 comments on commit 0cae2be

Please sign in to comment.
You can’t perform that action at this time.