QGIS API Documentation 3.43.0-Master (2366440f66a)
Public Member Functions | List of all members
QgsSldExportContext Class Reference

Holds SLD export options and other information related to SLD export of a QGIS layer style. More...

#include <qgssldexportcontext.h>

Public Member Functions

 QgsSldExportContext ()=default
 Constructs a default SLD export context.
 
 QgsSldExportContext (const Qgis::SldExportOptions &options, const Qgis::SldExportVendorExtension &vendorExtension, const QString &filePath)
 /brief Create a new QgsSldExportContext /param options SLD export options /param vendorExtension SLD export vendor extension /param filePath SLD export file path
 
 QgsSldExportContext (const QgsSldExportContext &other)=default
 
 ~QgsSldExportContext ()=default
 
QStringList errors () const
 Returns a list of errors which occurred during the conversion.
 
QString exportFilePath () const
 Returns the export file path for the SLD.
 
Qgis::SldExportOptions exportOptions () const
 Returns the export options.
 
QVariantMap extraProperties () const
 Returns the open ended set of properties that can drive/inform the SLD encoding.
 
QgsSldExportContextoperator= (const QgsSldExportContext &other)=default
 
void pushError (const QString &error)
 Pushes a error message generated during the conversion.
 
void pushWarning (const QString &warning)
 Pushes a warning message generated during the conversion.
 
void setExportFilePath (const QString &exportFilePath)
 Sets the export file path for the SLD to exportFilePath.
 
void setExportOptions (const Qgis::SldExportOptions &exportOptions)
 Set export options to exportOptions.
 
void setExtraProperties (const QVariantMap &properties)
 Sets the open ended set of properties that can drive/inform the SLD encoding.
 
void setVendorExtension (const Qgis::SldExportVendorExtension &vendorExtension)
 Sets the vendor extensions to vendorExtension.
 
Qgis::SldExportVendorExtension vendorExtensions () const
 Returns the vendor extension enabled for the SLD export.
 
QStringList warnings () const
 Returns a list of warnings which occurred during the conversion.
 

Detailed Description

Holds SLD export options and other information related to SLD export of a QGIS layer style.

Since
QGIS 3.30

Definition at line 28 of file qgssldexportcontext.h.

Constructor & Destructor Documentation

◆ QgsSldExportContext() [1/3]

QgsSldExportContext::QgsSldExportContext ( )
default

Constructs a default SLD export context.

◆ ~QgsSldExportContext()

QgsSldExportContext::~QgsSldExportContext ( )
default

◆ QgsSldExportContext() [2/3]

QgsSldExportContext::QgsSldExportContext ( const QgsSldExportContext other)
default

◆ QgsSldExportContext() [3/3]

QgsSldExportContext::QgsSldExportContext ( const Qgis::SldExportOptions options,
const Qgis::SldExportVendorExtension vendorExtension,
const QString &  filePath 
)

/brief Create a new QgsSldExportContext /param options SLD export options /param vendorExtension SLD export vendor extension /param filePath SLD export file path

Definition at line 18 of file qgssldexportcontext.cpp.

Member Function Documentation

◆ errors()

QStringList QgsSldExportContext::errors ( ) const
inline

Returns a list of errors which occurred during the conversion.

See also
pushError()
warnings()
Since
QGIS 3.44

Definition at line 87 of file qgssldexportcontext.h.

◆ exportFilePath()

QString QgsSldExportContext::exportFilePath ( ) const

Returns the export file path for the SLD.

Definition at line 46 of file qgssldexportcontext.cpp.

◆ exportOptions()

Qgis::SldExportOptions QgsSldExportContext::exportOptions ( ) const

Returns the export options.

Definition at line 26 of file qgssldexportcontext.cpp.

◆ extraProperties()

QVariantMap QgsSldExportContext::extraProperties ( ) const

Returns the open ended set of properties that can drive/inform the SLD encoding.

See also
setExtraProperties()
Since
QGIS 3.44

Definition at line 56 of file qgssldexportcontext.cpp.

◆ operator=()

QgsSldExportContext & QgsSldExportContext::operator= ( const QgsSldExportContext other)
default

◆ pushError()

void QgsSldExportContext::pushError ( const QString &  error)
inline

Pushes a error message generated during the conversion.

See also
errors()
pushWarning()
Since
QGIS 3.44

Definition at line 96 of file qgssldexportcontext.h.

◆ pushWarning()

void QgsSldExportContext::pushWarning ( const QString &  warning)
inline

Pushes a warning message generated during the conversion.

See also
warnings()
pushError()
Since
QGIS 3.44

Definition at line 114 of file qgssldexportcontext.h.

◆ setExportFilePath()

void QgsSldExportContext::setExportFilePath ( const QString &  exportFilePath)

Sets the export file path for the SLD to exportFilePath.

Definition at line 51 of file qgssldexportcontext.cpp.

◆ setExportOptions()

void QgsSldExportContext::setExportOptions ( const Qgis::SldExportOptions exportOptions)

Set export options to exportOptions.

Definition at line 31 of file qgssldexportcontext.cpp.

◆ setExtraProperties()

void QgsSldExportContext::setExtraProperties ( const QVariantMap &  properties)

Sets the open ended set of properties that can drive/inform the SLD encoding.

See also
extraProperties()
Since
QGIS 3.44

Definition at line 61 of file qgssldexportcontext.cpp.

◆ setVendorExtension()

void QgsSldExportContext::setVendorExtension ( const Qgis::SldExportVendorExtension vendorExtension)

Sets the vendor extensions to vendorExtension.

Definition at line 41 of file qgssldexportcontext.cpp.

◆ vendorExtensions()

Qgis::SldExportVendorExtension QgsSldExportContext::vendorExtensions ( ) const

Returns the vendor extension enabled for the SLD export.

Definition at line 36 of file qgssldexportcontext.cpp.

◆ warnings()

QStringList QgsSldExportContext::warnings ( ) const
inline

Returns a list of warnings which occurred during the conversion.

See also
pushWarning()
errors()
Since
QGIS 3.44

Definition at line 105 of file qgssldexportcontext.h.


The documentation for this class was generated from the following files: