QgsSymbolConverterOgrStyle Class Reference

A symbol converter for converting QgsSymbol objects to and from the OGR style string format. More...

#include <qgssymbolconverterogrstyle.h>

Inheritance diagram for QgsSymbolConverterOgrStyle:

Public Member Functions
Qgis::SymbolConverterCapabilities	capabilities () const override
	Returns the capabilities of the converter.
std::unique_ptr< QgsSymbol >	createSymbol (const QVariant &variant, QgsSymbolConverterContext &context) const override
	Creates a new QgsSymbol from a QVariant representation.
QString	formatName () const override
	Returns a translated, user-friendly name for the converter's data format.
QString	name () const override
	Returns the unique name for the converter.
QVariant	toVariant (const QgsSymbol *symbol, QgsSymbolConverterContext &context) const override
	Converts a symbol into a QVariant representation.
Public Member Functions inherited from QgsAbstractSymbolConverter
virtual	~QgsAbstractSymbolConverter ()

Detailed Description

A symbol converter for converting QgsSymbol objects to and from the OGR style string format.

Since

QGIS 4.2

Definition at line 29 of file qgssymbolconverterogrstyle.h.

Member Function Documentation

capabilities()

Qgis::SymbolConverterCapabilities QgsSymbolConverterOgrStyle::capabilities ( ) const

overridevirtual

Returns the capabilities of the converter.

Implements QgsAbstractSymbolConverter.

Definition at line 28 of file qgssymbolconverterogrstyle.cpp.

createSymbol()

std::unique_ptr< QgsSymbol > QgsSymbolConverterOgrStyle::createSymbol ( const QVariant & variant, QgsSymbolConverterContext & context ) const

overridevirtual

Creates a new QgsSymbol from a QVariant representation.

Parameters

variant	The QVariant containing the serialized symbol data.
context	conversion context

Returns

A new QgsSymbol instance representing the data in the variant. The caller takes ownership of the returned object. Returns nullptr if the variant cannot be converted or parsed.

Exceptions

QgsNotSupportedException

if the converter does not support deserialization of symbols.

Implements QgsAbstractSymbolConverter.

Definition at line 48 of file qgssymbolconverterogrstyle.cpp.

formatName()

QString QgsSymbolConverterOgrStyle::formatName ( ) const

overridevirtual

Returns a translated, user-friendly name for the converter's data format.

E.g. "Styled Layer Descriptor (SLD)" for a converter which handles the SLD format.

See also

name()

Implements QgsAbstractSymbolConverter.

Definition at line 38 of file qgssymbolconverterogrstyle.cpp.

name()

QString QgsSymbolConverterOgrStyle::name ( ) const

overridevirtual

Returns the unique name for the converter.

This should be an untranslated string identifying the converter.

See also

formatName()

Implements QgsAbstractSymbolConverter.

Definition at line 33 of file qgssymbolconverterogrstyle.cpp.

toVariant()

QVariant QgsSymbolConverterOgrStyle::toVariant ( const QgsSymbol * symbol, QgsSymbolConverterContext & context ) const

overridevirtual

Converts a symbol into a QVariant representation.

The resulting QVariant may be a dictionary (QVariantMap), a JSON string, an XML representation of the symbol, or some binary QByteArray value, depending on the concrete implementation (e.g., SLD vs. Mapbox GL).

Returns an invalid variant if the symbol could not be converted, or if serialization of symbols is not supported for this converter.

Exceptions

QgsNotSupportedException

if the converter does not support serialization of symbols.

Implements QgsAbstractSymbolConverter.

Definition at line 43 of file qgssymbolconverterogrstyle.cpp.

---

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

• /build/qgis-4.1.0+git20260419+3b8ef1f72a3+99sid/src/core/symbology/converters/qgssymbolconverterogrstyle.h
• /build/qgis-4.1.0+git20260419+3b8ef1f72a3+99sid/src/core/symbology/converters/qgssymbolconverterogrstyle.cpp