Skip to content

Commit

Permalink
API documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@m-kuhn @nyalldawson
m-kuhn authored and nyalldawson committed Mar 6, 2018
1 parent 542910e commit b5672d7
Show file tree
Hide file tree
Showing 4 changed files with 148 additions and 2 deletions.
2 changes: 1 addition & 1 deletion python/core/processing/qgsprocessingparameters.sip.in
View file
Expand Up @@ -956,7 +956,7 @@ Creates a new parameter using the definition from a script code.
class QgsProcessingParameterMatrix : QgsProcessingParameterDefinition
{
%Docstring
An table (matrix) parameter for processing algorithms.
A table (matrix) parameter for processing algorithms.

.. versionadded:: 3.0
%End
Expand Down
2 changes: 1 addition & 1 deletion src/core/processing/qgsprocessingparameters.h
View file
Expand Up @@ -994,7 +994,7 @@ class CORE_EXPORT QgsProcessingParameterFile : public QgsProcessingParameterDefi
/**
* \class QgsProcessingParameterMatrix
* \ingroup core
* An table (matrix) parameter for processing algorithms.
* A table (matrix) parameter for processing algorithms.
* \since QGIS 3.0
*/
class CORE_EXPORT QgsProcessingParameterMatrix : public QgsProcessingParameterDefinition
Expand Down
1 change: 1 addition & 0 deletions src/core/processing/qgsprocessingparametertype.h
View file
Expand Up @@ -10,6 +10,7 @@
* Makes metadata of processing parameters available.
*
* \since QGIS 3.2
* \ingroup core
*/
class CORE_EXPORT QgsProcessingParameterType
{
Expand Down
145 changes: 145 additions & 0 deletions src/core/processing/qgsprocessingparametertypeimpl.h
View file
Expand Up @@ -8,6 +8,13 @@

#define SIP_NO_FILE

/**
* A raster layer parameter for processing algorithms.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType()
*/
class CORE_EXPORT QgsProcessingParameterTypeRasterLayer : public QgsProcessingParameterType
{
virtual QgsProcessingParameterDefinition *create( const QString &name ) const override SIP_FACTORY
Expand All @@ -31,6 +38,13 @@ class CORE_EXPORT QgsProcessingParameterTypeRasterLayer : public QgsProcessingPa
}
};

/**
* A vector layer parameter for processing algorithms.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType()
*/
class CORE_EXPORT QgsProcessingParameterTypeVectorLayer : public QgsProcessingParameterType
{
virtual QgsProcessingParameterDefinition *create( const QString &name ) const override SIP_FACTORY
Expand All @@ -54,6 +68,13 @@ class CORE_EXPORT QgsProcessingParameterTypeVectorLayer : public QgsProcessingPa
}
};

/**
* A boolean parameter for processing algorithms.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType()
*/
class CORE_EXPORT QgsProcessingParameterTypeBoolean : public QgsProcessingParameterType
{
virtual QgsProcessingParameterDefinition *create( const QString &name ) const override SIP_FACTORY
Expand All @@ -77,6 +98,13 @@ class CORE_EXPORT QgsProcessingParameterTypeBoolean : public QgsProcessingParame
}
};

/**
* A crs parameter for processing algorithms.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType()
*/
class CORE_EXPORT QgsProcessingParameterTypeCrs : public QgsProcessingParameterType
{
virtual QgsProcessingParameterDefinition *create( const QString &name ) const override SIP_FACTORY
Expand All @@ -100,6 +128,13 @@ class CORE_EXPORT QgsProcessingParameterTypeCrs : public QgsProcessingParameterT
}
};

/**
* A numeric range parameter for processing algorithms.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType()
*/
class CORE_EXPORT QgsProcessingParameterTypeRange : public QgsProcessingParameterType
{
virtual QgsProcessingParameterDefinition *create( const QString &name ) const override SIP_FACTORY
Expand All @@ -123,6 +158,13 @@ class CORE_EXPORT QgsProcessingParameterTypeRange : public QgsProcessingParamete
}
};

/**
* A point parameter for processing algorithms.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType()
*/
class CORE_EXPORT QgsProcessingParameterTypePoint : public QgsProcessingParameterType
{
virtual QgsProcessingParameterDefinition *create( const QString &name ) const override SIP_FACTORY
Expand All @@ -146,6 +188,13 @@ class CORE_EXPORT QgsProcessingParameterTypePoint : public QgsProcessingParamete
}
};

/**
* An enum based parameter for processing algorithms, allowing for selection from predefined values.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType()
*/
class CORE_EXPORT QgsProcessingParameterTypeEnum : public QgsProcessingParameterType
{
virtual QgsProcessingParameterDefinition *create( const QString &name ) const override SIP_FACTORY
Expand All @@ -169,6 +218,13 @@ class CORE_EXPORT QgsProcessingParameterTypeEnum : public QgsProcessingParameter
}
};

/**
* A rectangular map extent parameter for processing algorithms.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType()
*/
class CORE_EXPORT QgsProcessingParameterTypeExtent : public QgsProcessingParameterType
{
virtual QgsProcessingParameterDefinition *create( const QString &name ) const override SIP_FACTORY
Expand All @@ -192,6 +248,13 @@ class CORE_EXPORT QgsProcessingParameterTypeExtent : public QgsProcessingParamet
}
};

/**
* A table (matrix) parameter for processing algorithms.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType()
*/
class CORE_EXPORT QgsProcessingParameterTypeMatrix : public QgsProcessingParameterType
{
virtual QgsProcessingParameterDefinition *create( const QString &name ) const override SIP_FACTORY
Expand All @@ -215,6 +278,13 @@ class CORE_EXPORT QgsProcessingParameterTypeMatrix : public QgsProcessingParamet
}
};

/**
* An input file or folder parameter for processing algorithms.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType()
*/
class CORE_EXPORT QgsProcessingParameterTypeFile : public QgsProcessingParameterType
{
virtual QgsProcessingParameterDefinition *create( const QString &name ) const override SIP_FACTORY
Expand All @@ -238,6 +308,13 @@ class CORE_EXPORT QgsProcessingParameterTypeFile : public QgsProcessingParameter
}
};

/**
* A vector layer or feature source field parameter for processing algorithms.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType()
*/
class CORE_EXPORT QgsProcessingParameterTypeField : public QgsProcessingParameterType
{
virtual QgsProcessingParameterDefinition *create( const QString &name ) const override SIP_FACTORY
Expand All @@ -261,6 +338,14 @@ class CORE_EXPORT QgsProcessingParameterTypeField : public QgsProcessingParamete
}
};

/**
* A vector layer destination parameter, for specifying the destination path for a vector layer
* created by the algorithm.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType()
*/
class CORE_EXPORT QgsProcessingParameterTypeVectorDestination : public QgsProcessingParameterType
{
virtual QgsProcessingParameterDefinition *create( const QString &name ) const override SIP_FACTORY
Expand Down Expand Up @@ -288,6 +373,14 @@ class CORE_EXPORT QgsProcessingParameterTypeVectorDestination : public QgsProces
}
};

/**
* A generic file based destination parameter, for specifying the destination path for a file (non-map layer)
* created by the algorithm.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType()
*/
class CORE_EXPORT QgsProcessingParameterTypeFileDestination : public QgsProcessingParameterType
{
virtual QgsProcessingParameterDefinition *create( const QString &name ) const override SIP_FACTORY
Expand All @@ -313,6 +406,15 @@ class CORE_EXPORT QgsProcessingParameterTypeFileDestination : public QgsProcessi
}
};

/**
* A folder destination parameter, for specifying the destination path for a folder created
* by the algorithm or used for creating new files within the algorithm.
* A folder output parameter.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType()
*/
class CORE_EXPORT QgsProcessingParameterTypeFolderDestination : public QgsProcessingParameterType
{
virtual QgsProcessingParameterDefinition *create( const QString &name ) const override SIP_FACTORY
Expand All @@ -338,6 +440,14 @@ class CORE_EXPORT QgsProcessingParameterTypeFolderDestination : public QgsProces
}
};

/**
* A raster layer destination parameter, for specifying the destination path for a raster layer
* created by the algorithm.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType()
*/
class CORE_EXPORT QgsProcessingParameterTypeRasterDestination : public QgsProcessingParameterType
{
virtual QgsProcessingParameterDefinition *create( const QString &name ) const override SIP_FACTORY
Expand All @@ -363,6 +473,13 @@ class CORE_EXPORT QgsProcessingParameterTypeRasterDestination : public QgsProces
}
};

/**
* A string parameter for processing algorithms.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType()
*/
class CORE_EXPORT QgsProcessingParameterTypeString : public QgsProcessingParameterType
{
virtual QgsProcessingParameterDefinition *create( const QString &name ) const override SIP_FACTORY
Expand All @@ -386,6 +503,13 @@ class CORE_EXPORT QgsProcessingParameterTypeString : public QgsProcessingParamet
}
};

/**
* A parameter for processing algorithms which accepts multiple map layers.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType()
*/
class CORE_EXPORT QgsProcessingParameterTypeMultipleLayers : public QgsProcessingParameterType
{
virtual QgsProcessingParameterDefinition *create( const QString &name ) const override SIP_FACTORY
Expand All @@ -409,6 +533,13 @@ class CORE_EXPORT QgsProcessingParameterTypeMultipleLayers : public QgsProcessin
}
};

/**
* An input feature source (such as vector layers) parameter for processing algorithms.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType()
*/
class CORE_EXPORT QgsProcessingParameterTypeFeatureSource : public QgsProcessingParameterType
{
virtual QgsProcessingParameterDefinition *create( const QString &name ) const override SIP_FACTORY
Expand Down Expand Up @@ -436,6 +567,13 @@ class CORE_EXPORT QgsProcessingParameterTypeFeatureSource : public QgsProcessing
}
};

/**
* A numeric parameter for processing algorithms.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType()
*/
class CORE_EXPORT QgsProcessingParameterTypeNumber : public QgsProcessingParameterType
{
virtual QgsProcessingParameterDefinition *create( const QString &name ) const override SIP_FACTORY
Expand All @@ -459,6 +597,13 @@ class CORE_EXPORT QgsProcessingParameterTypeNumber : public QgsProcessingParamet
}
};

/**
* A raster band parameter for Processing algorithms.
*
* \since QGIS 3.2
* \ingroup core
* \note No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType()
*/
class CORE_EXPORT QgsProcessingParameterTypeBand : public QgsProcessingParameterType
{
virtual QgsProcessingParameterDefinition *create( const QString &name ) const override SIP_FACTORY
Expand Down

0 comments on commit b5672d7

Please sign in to comment.