sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-04-17 00:04:02 -04:00
Code Issues Packages Projects Releases Wiki Activity

Dox, spelling

Browse Source
This commit is contained in:
Nyall Dawson 2019-10-28 10:02:48 +10:00
parent 2a7f9c32c7
commit 351970e1c2
4 changed files with 81 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
python/core/auto_generated/symbology/qgsfillsymbollayer.sip.in
View File

@ -28,6 +28,11 @@ class QgsSimpleFillSymbolLayer : QgsFillSymbolLayer
static QgsSymbolLayer *create( const QgsStringMap &properties = QgsStringMap() ) /Factory/;
%Docstring
Creates a new QgsSimpleFillSymbolLayer using the specified ``properties`` map containing symbol properties (see properties()).
Caller takes ownership of the returned symbol layer.
%End
static QgsSymbolLayer *createFromSld( QDomElement &element ) /Factory/;
@ -193,6 +198,11 @@ class QgsGradientFillSymbolLayer : QgsFillSymbolLayer
static QgsSymbolLayer *create( const QgsStringMap &properties = QgsStringMap() ) /Factory/;
%Docstring
Creates a new QgsGradientFillSymbolLayer using the specified ``properties`` map containing symbol properties (see properties()).
Caller takes ownership of the returned symbol layer.
%End
virtual QString layerType() const;
@ -348,6 +358,11 @@ class QgsShapeburstFillSymbolLayer : QgsFillSymbolLayer
static QgsSymbolLayer *create( const QgsStringMap &properties = QgsStringMap() ) /Factory/;
%Docstring
Creates a new QgsShapeburstFillSymbolLayer using the specified ``properties`` map containing symbol properties (see properties()).
Caller takes ownership of the returned symbol layer.
%End
virtual QString layerType() const;
@ -1588,6 +1603,11 @@ class QgsPointPatternFillSymbolLayer: QgsImageFillSymbolLayer
~QgsPointPatternFillSymbolLayer();
static QgsSymbolLayer *create( const QgsStringMap &properties = QgsStringMap() ) /Factory/;
%Docstring
Creates a new QgsPointPatternFillSymbolLayer using the specified ``properties`` map containing symbol properties (see properties()).
Caller takes ownership of the returned symbol layer.
%End
static QgsSymbolLayer *createFromSld( QDomElement &element ) /Factory/;
virtual QString layerType() const;
@ -1910,10 +1930,15 @@ A fill symbol layer which places markers at random locations within polygons.
Constructor for QgsRandomMarkerFillSymbolLayer, with the specified ``pointCount``.
Optionally a specific random number ``seed`` can be used when generating points. A ``seed`` of 0 indicates that
a truely random sequence should be used.
a truly random sequence should be used.
%End
static QgsSymbolLayer *create( const QgsStringMap &properties = QgsStringMap() ) /Factory/;
%Docstring
Creates a new QgsRandomMarkerFillSymbolLayer using the specified ``properties`` map containing symbol properties (see properties()).
Caller takes ownership of the returned symbol layer.
%End
virtual QString layerType() const;
@ -1970,7 +1995,7 @@ Sets the ``count`` of random points to render in the fill.
unsigned long seed() const;
%Docstring
Returns the random number seed to use when generating points, or 0 if
a truely random sequence should be used.
a truly random sequence should be used.
.. seealso:: :py:func:`setSeed`
%End
@ -1978,7 +2003,7 @@ a truely random sequence should be used.
void setSeed( unsigned long seed );
%Docstring
Sets the random number ``seed`` to use when generating points, or 0 if
a truely random sequence should be used.
a truly random sequence should be used.
.. seealso:: :py:func:`seed`
%End
@ -1997,6 +2022,11 @@ Sets whether point markers should be ``clipped`` to the polygon boundary.
.. seealso:: :py:func:`clipPoints`
%End
virtual void startFeatureRender( const QgsFeature &feature, QgsRenderContext &context );
virtual void stopFeatureRender( const QgsFeature &feature, QgsRenderContext &context );
private:
QgsRandomMarkerFillSymbolLayer( const QgsRandomMarkerFillSymbolLayer &other );
};
@ -2013,6 +2043,11 @@ class QgsCentroidFillSymbolLayer : QgsFillSymbolLayer
static QgsSymbolLayer *create( const QgsStringMap &properties = QgsStringMap() ) /Factory/;
%Docstring
Creates a new QgsCentroidFillSymbolLayer using the specified ``properties`` map containing symbol properties (see properties()).
Caller takes ownership of the returned symbol layer.
%End
static QgsSymbolLayer *createFromSld( QDomElement &element ) /Factory/;

6
python/gui/auto_generated/symbology/qgssymbollayerwidget.sip.in
View File

@ -658,6 +658,12 @@ Creates a new QgsPointPatternFillSymbolLayerWidget.
class QgsRandomMarkerFillSymbolLayerWidget: QgsSymbolLayerWidget
{
%Docstring
Widget for controlling the properties of a :py:class:`QgsRandomMarkerFillSymbolLayer`.
.. versionadded:: 3.12
%End
%TypeHeaderCode
#include "qgssymbollayerwidget.h"

36
src/core/symbology/qgsfillsymbollayer.h
View File

@ -49,6 +49,11 @@ class CORE_EXPORT QgsSimpleFillSymbolLayer : public QgsFillSymbolLayer
// static stuff
/**
* Creates a new QgsSimpleFillSymbolLayer using the specified \a properties map containing symbol properties (see properties()).
*
* Caller takes ownership of the returned symbol layer.
*/
static QgsSymbolLayer *create( const QgsStringMap &properties = QgsStringMap() ) SIP_FACTORY;
static QgsSymbolLayer *createFromSld( QDomElement &element ) SIP_FACTORY;
@ -209,6 +214,11 @@ class CORE_EXPORT QgsGradientFillSymbolLayer : public QgsFillSymbolLayer
// static stuff
/**
* Creates a new QgsGradientFillSymbolLayer using the specified \a properties map containing symbol properties (see properties()).
*
* Caller takes ownership of the returned symbol layer.
*/
static QgsSymbolLayer *create( const QgsStringMap &properties = QgsStringMap() ) SIP_FACTORY;
// implemented from base classes
@ -366,6 +376,11 @@ class CORE_EXPORT QgsShapeburstFillSymbolLayer : public QgsFillSymbolLayer
// static stuff
/**
* Creates a new QgsShapeburstFillSymbolLayer using the specified \a properties map containing symbol properties (see properties()).
*
* Caller takes ownership of the returned symbol layer.
*/
static QgsSymbolLayer *create( const QgsStringMap &properties = QgsStringMap() ) SIP_FACTORY;
// implemented from base classes
@ -1452,6 +1467,11 @@ class CORE_EXPORT QgsPointPatternFillSymbolLayer: public QgsImageFillSymbolLayer
QgsPointPatternFillSymbolLayer();
~QgsPointPatternFillSymbolLayer() override;
/**
* Creates a new QgsPointPatternFillSymbolLayer using the specified \a properties map containing symbol properties (see properties()).
*
* Caller takes ownership of the returned symbol layer.
*/
static QgsSymbolLayer *create( const QgsStringMap &properties = QgsStringMap() ) SIP_FACTORY;
static QgsSymbolLayer *createFromSld( QDomElement &element ) SIP_FACTORY;
@ -1718,10 +1738,15 @@ class CORE_EXPORT QgsRandomMarkerFillSymbolLayer : public QgsFillSymbolLayer
* Constructor for QgsRandomMarkerFillSymbolLayer, with the specified \a pointCount.
*
* Optionally a specific random number \a seed can be used when generating points. A \a seed of 0 indicates that
* a truely random sequence should be used.
* a truly random sequence should be used.
*/
QgsRandomMarkerFillSymbolLayer( int pointCount = 1, unsigned long seed = 0 );
/**
* Creates a new QgsRandomMarkerFillSymbolLayer using the specified \a properties map containing symbol properties (see properties()).
*
* Caller takes ownership of the returned symbol layer.
*/
static QgsSymbolLayer *create( const QgsStringMap &properties = QgsStringMap() ) SIP_FACTORY;
QString layerType() const override;
@ -1762,7 +1787,7 @@ class CORE_EXPORT QgsRandomMarkerFillSymbolLayer : public QgsFillSymbolLayer
/**
* Returns the random number seed to use when generating points, or 0 if
* a truely random sequence should be used.
* a truly random sequence should be used.
*
* \see setSeed()
*/
@ -1770,7 +1795,7 @@ class CORE_EXPORT QgsRandomMarkerFillSymbolLayer : public QgsFillSymbolLayer
/**
* Sets the random number \a seed to use when generating points, or 0 if
* a truely random sequence should be used.
* a truly random sequence should be used.
*
* \see seed()
*/
@ -1828,6 +1853,11 @@ class CORE_EXPORT QgsCentroidFillSymbolLayer : public QgsFillSymbolLayer
// static stuff
/**
* Creates a new QgsCentroidFillSymbolLayer using the specified \a properties map containing symbol properties (see properties()).
*
* Caller takes ownership of the returned symbol layer.
*/
static QgsSymbolLayer *create( const QgsStringMap &properties = QgsStringMap() ) SIP_FACTORY;
static QgsSymbolLayer *createFromSld( QDomElement &element ) SIP_FACTORY;

4
src/gui/symbology/qgssymbollayerwidget.h
View File

@ -898,6 +898,10 @@ class QgsRandomMarkerFillSymbolLayer;
/**
* \ingroup gui
* \class QgsRandomMarkerFillSymbolLayerWidget
*
* Widget for controlling the properties of a QgsRandomMarkerFillSymbolLayer.
*
* \since QGIS 3.12
*/
class GUI_EXPORT QgsRandomMarkerFillSymbolLayerWidget: public QgsSymbolLayerWidget, private Ui::WidgetRandomMarkerFill
{