mirror of
https://github.com/qgis/QGIS.git
synced 2025-10-06 00:07:29 -04:00
f1b8682e36
Deprecate old methods and make methods always take QgsSldExportContext. Add capacity to QgsSldExportContext to collect export errors and warnings. The old API had no way to reliably report errors/warnings during export to users.
144 lines
3.7 KiB
Plaintext
144 lines
3.7 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/qgssldexportcontext.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|
|
|
|
|
|
class QgsSldExportContext
|
|
{
|
|
%Docstring(signature="appended")
|
|
Holds SLD export options and other information related to SLD export of
|
|
a QGIS layer style.
|
|
|
|
.. versionadded:: 3.30
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgssldexportcontext.h"
|
|
%End
|
|
public:
|
|
|
|
QgsSldExportContext();
|
|
%Docstring
|
|
Constructs a default SLD export context
|
|
%End
|
|
|
|
~QgsSldExportContext();
|
|
|
|
QgsSldExportContext( const QgsSldExportContext &other );
|
|
|
|
QgsSldExportContext( const Qgis::SldExportOptions &options, const Qgis::SldExportVendorExtension &vendorExtension, const QString &filePath );
|
|
%Docstring
|
|
/brief Create a new QgsSldExportContext /param options SLD export
|
|
options /param vendorExtension SLD export vendor extension /param
|
|
filePath SLD export file path
|
|
%End
|
|
|
|
Qgis::SldExportOptions exportOptions() const;
|
|
%Docstring
|
|
Returns the export options
|
|
%End
|
|
|
|
void setExportOptions( const Qgis::SldExportOptions &exportOptions );
|
|
%Docstring
|
|
Set export options to ``exportOptions``
|
|
%End
|
|
|
|
Qgis::SldExportVendorExtension vendorExtensions() const;
|
|
%Docstring
|
|
Returns the vendor extension enabled for the SLD export
|
|
%End
|
|
|
|
void setVendorExtension( const Qgis::SldExportVendorExtension &vendorExtension );
|
|
%Docstring
|
|
Sets the vendor extensions to ``vendorExtension``
|
|
%End
|
|
|
|
QString exportFilePath() const;
|
|
%Docstring
|
|
Returns the export file path for the SLD
|
|
%End
|
|
|
|
void setExportFilePath( const QString &exportFilePath );
|
|
%Docstring
|
|
Sets the export file path for the SLD to ``exportFilePath``
|
|
%End
|
|
|
|
QStringList errors() const;
|
|
%Docstring
|
|
Returns a list of errors which occurred during the conversion.
|
|
|
|
.. seealso:: :py:func:`pushError`
|
|
|
|
.. seealso:: :py:func:`warnings`
|
|
|
|
.. versionadded:: 3.44
|
|
%End
|
|
|
|
void pushError( const QString &error );
|
|
%Docstring
|
|
Pushes a ``error`` message generated during the conversion.
|
|
|
|
.. seealso:: :py:func:`errors`
|
|
|
|
.. seealso:: :py:func:`pushWarning`
|
|
|
|
.. versionadded:: 3.44
|
|
%End
|
|
|
|
QStringList warnings() const;
|
|
%Docstring
|
|
Returns a list of warnings which occurred during the conversion.
|
|
|
|
.. seealso:: :py:func:`pushWarning`
|
|
|
|
.. seealso:: :py:func:`errors`
|
|
|
|
.. versionadded:: 3.44
|
|
%End
|
|
|
|
void pushWarning( const QString &warning );
|
|
%Docstring
|
|
Pushes a ``warning`` message generated during the conversion.
|
|
|
|
.. seealso:: :py:func:`warnings`
|
|
|
|
.. seealso:: :py:func:`pushError`
|
|
|
|
.. versionadded:: 3.44
|
|
%End
|
|
|
|
QVariantMap extraProperties() const;
|
|
%Docstring
|
|
Returns the open ended set of properties that can drive/inform the SLD
|
|
encoding.
|
|
|
|
.. seealso:: :py:func:`setExtraProperties`
|
|
|
|
.. versionadded:: 3.44
|
|
%End
|
|
|
|
void setExtraProperties( const QVariantMap &properties );
|
|
%Docstring
|
|
Sets the open ended set of properties that can drive/inform the SLD
|
|
encoding.
|
|
|
|
.. seealso:: :py:func:`extraProperties`
|
|
|
|
.. versionadded:: 3.44
|
|
%End
|
|
|
|
};
|
|
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/qgssldexportcontext.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|