QGIS/python/core/auto_generated/raster/qgsrasterrendererutils.sip.in
Nyall Dawson afd7698460 Extract utility functions for saving and reading raster color map definitions
to file to new QgsRasterRendererUtils class
2020-09-16 06:12:35 +10:00

55 lines
2.1 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/raster/qgsrasterrendererutils.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsRasterRendererUtils
{
%Docstring
Utility functions for raster renderers.
.. versionadded:: 3.16
%End
%TypeHeaderCode
#include "qgsrasterrendererutils.h"
%End
public:
static bool parseColorMapFile( const QString &path, QList<QgsColorRampShader::ColorRampItem> &items /Out/,
QgsColorRampShader::Type &type /Out/,
QStringList &errors /Out/ );
%Docstring
Parses an exported color map file at the specified ``path`` and extracts the stored color ramp ``items``
and ramp shader ``type``.
Returns ``True`` if the parsing was successful. If not, a list of ``errors`` will be generated.
.. seealso:: :py:func:`saveColorMapFile`
%End
static bool saveColorMapFile( const QString &path, const QList<QgsColorRampShader::ColorRampItem> &items, QgsColorRampShader::Type type );
%Docstring
Exports a list of color ramp ``items`` and ramp shader ``type`` to a color map file at the specified
``path``.
Returns ``True`` if the save was successful.
.. seealso:: :py:func:`parseColorMapFile`
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/raster/qgsrasterrendererutils.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/