Skip to content

Commit

Permalink
Add doxygen comments to updated methods
Browse files Browse the repository at this point in the history
  • Loading branch information
wonder-sk committed May 13, 2017
1 parent bbb13f4 commit 93bfa94
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/core/qgsdiagramrenderer.h
Original file line number Diff line number Diff line change
Expand Up @@ -423,7 +423,9 @@ class CORE_EXPORT QgsDiagramSettings
//! Scale diagrams smaller than mMinimumSize to mMinimumSize
double minimumSize;

//! Reads diagram settings from XML
void readXml( const QDomElement &elem );
//! Writes diagram settings to XML
void writeXml( QDomElement &rendererElem, QDomDocument &doc ) const;

/** Returns list of legend nodes for the diagram
Expand Down
7 changes: 7 additions & 0 deletions src/core/symbology-ng/qgsfillsymbollayer.h
Original file line number Diff line number Diff line change
Expand Up @@ -834,12 +834,19 @@ class CORE_EXPORT QgsRasterFillSymbolLayer: public QgsImageFillSymbolLayer
class CORE_EXPORT QgsSVGFillSymbolLayer: public QgsImageFillSymbolLayer
{
public:
//! Constructs SVG fill symbol layer with picture from given absolute path to a SVG file
QgsSVGFillSymbolLayer( const QString &svgFilePath, double width = 20, double rotation = 0.0 );
QgsSVGFillSymbolLayer( const QByteArray &svgData, double width = 20, double rotation = 0.0 );
~QgsSVGFillSymbolLayer();

static QgsSymbolLayer *create( const QgsStringMap &properties = QgsStringMap() ) SIP_FACTORY;
static QgsSymbolLayer *createFromSld( QDomElement &element ) SIP_FACTORY;

/**
* Turns relative paths in properties map to absolute when reading and vice versa when writing.
* Used internally when reading/writing symbols.
* \since QGIS 3.0
*/
static void resolvePaths( QgsStringMap &properties, const QgsPathResolver &pathResolver, bool saving );

// implemented from base classes
Expand Down
1 change: 1 addition & 0 deletions src/core/symbology-ng/qgsheatmaprenderer.h
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ class CORE_EXPORT QgsHeatmapRenderer : public QgsFeatureRenderer
virtual QgsSymbolList symbols( QgsRenderContext &context ) override;
virtual QString dump() const override;
virtual QSet<QString> usedAttributes( const QgsRenderContext &context ) const override;
//! Creates a new heatmap renderer instance from XML
static QgsFeatureRenderer *create( QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY;
virtual QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context ) override;
static QgsHeatmapRenderer *convertFromRenderer( const QgsFeatureRenderer *renderer ) SIP_FACTORY;
Expand Down
7 changes: 7 additions & 0 deletions src/core/symbology-ng/qgsmarkersymbollayer.h
Original file line number Diff line number Diff line change
Expand Up @@ -444,6 +444,7 @@ class CORE_EXPORT QgsFilledMarkerSymbolLayer : public QgsSimpleMarkerSymbolLayer
class CORE_EXPORT QgsSvgMarkerSymbolLayer : public QgsMarkerSymbolLayer
{
public:
//! Constructs SVG marker symbol layer with picture from given absolute path to a SVG file
QgsSvgMarkerSymbolLayer( const QString &path,
double size = DEFAULT_SVGMARKER_SIZE,
double angle = DEFAULT_SVGMARKER_ANGLE,
Expand All @@ -453,6 +454,12 @@ class CORE_EXPORT QgsSvgMarkerSymbolLayer : public QgsMarkerSymbolLayer

static QgsSymbolLayer *create( const QgsStringMap &properties = QgsStringMap() ) SIP_FACTORY;
static QgsSymbolLayer *createFromSld( QDomElement &element ) SIP_FACTORY;

/**
* Turns relative paths in properties map to absolute when reading and vice versa when writing.
* Used internally when reading/writing symbols.
* \since QGIS 3.0
*/
static void resolvePaths( QgsStringMap &properties, const QgsPathResolver &pathResolver, bool saving );

// implemented from base classes
Expand Down
1 change: 1 addition & 0 deletions src/core/symbology-ng/qgsrulebasedrenderer.h
Original file line number Diff line number Diff line change
Expand Up @@ -405,6 +405,7 @@ class CORE_EXPORT QgsRuleBasedRenderer : public QgsFeatureRenderer

/////

//! Creates a new rule-based renderer instance from XML
static QgsFeatureRenderer *create( QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY;

//! Constructs the renderer from given tree of rules (takes ownership)
Expand Down
4 changes: 4 additions & 0 deletions src/core/symbology-ng/qgssymbollayerutils.h
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,9 @@ class CORE_EXPORT QgsSymbolLayerUtils
}
}

//! Reads and returns symbol layer from XML. Caller is responsible for deleting the returned object
static QgsSymbolLayer *loadSymbolLayer( QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY;
//! Writes a symbol definition to XML
static QDomElement saveSymbol( const QString &symbolName, QgsSymbol *symbol, QDomDocument &doc, const QgsReadWriteContext &context );

/** Returns a string representing the symbol. Can be used to test for equality
Expand Down Expand Up @@ -348,7 +350,9 @@ class CORE_EXPORT QgsSymbolLayerUtils
static QgsStringMap parseProperties( QDomElement &element );
static void saveProperties( QgsStringMap 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.
static QgsSymbolMap loadSymbols( QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY;
//! Writes a collection of symbols to XML with specified tagName for the top-level element
static QDomElement saveSymbols( QgsSymbolMap &symbols, const QString &tagName, QDomDocument &doc, const QgsReadWriteContext &context );

static void clearSymbolMap( QgsSymbolMap &symbols );
Expand Down

0 comments on commit 93bfa94

Please sign in to comment.