QGIS API Documentation 4.1.0-Master (3b8ef1f72a3)
Loading...
Searching...
No Matches
QgsSymbolConverterContext Class Reference

Represents the context in which a QgsSymbolConverter conversion occurs. More...

#include <qgssymbolconverter.h>

Public Member Functions

 QgsSymbolConverterContext (QgsReadWriteContext &rwContext)
 Constructor for QgsSymbolConverterContext.
QStringList errors () const
 Returns a list of errors which occurred during the conversion.
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.
QgsReadWriteContextreadWriteContext ()
 Returns the read-write context associated with the context.
void setTypeHint (Qgis::SymbolType hint)
 Sets the symbol type hint.
Qgis::SymbolType typeHint () const
 Returns the symbol type hint, or Qgis::SymbolType::Hybrid if unknown.
QStringList warnings () const
 Returns a list of warnings which occurred during the conversion.

Detailed Description

Represents the context in which a QgsSymbolConverter conversion occurs.

Since
QGIS 4.2

Definition at line 34 of file qgssymbolconverter.h.

Constructor & Destructor Documentation

◆ QgsSymbolConverterContext()

QgsSymbolConverterContext::QgsSymbolConverterContext ( QgsReadWriteContext & rwContext)

Constructor for QgsSymbolConverterContext.

The rwContext object must exist for the lifetime of this context.

Definition at line 22 of file qgssymbolconverter.cpp.

Member Function Documentation

◆ errors()

QStringList QgsSymbolConverterContext::errors ( ) const
inline

Returns a list of errors which occurred during the conversion.

See also
pushError()
warnings()

Definition at line 55 of file qgssymbolconverter.h.

◆ pushError()

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

Pushes a error message generated during the conversion.

See also
errors()
pushWarning()

Definition at line 63 of file qgssymbolconverter.h.

◆ pushWarning()

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

Pushes a warning message generated during the conversion.

See also
warnings()
pushError()

Definition at line 79 of file qgssymbolconverter.h.

◆ readWriteContext()

QgsReadWriteContext & QgsSymbolConverterContext::readWriteContext ( )

Returns the read-write context associated with the context.

Definition at line 26 of file qgssymbolconverter.cpp.

◆ setTypeHint()

void QgsSymbolConverterContext::setTypeHint ( Qgis::SymbolType hint)
inline

Sets the symbol type hint.

Set to Qgis::SymbolType::Hybrid if unknown.

See also
typeHint()

Definition at line 95 of file qgssymbolconverter.h.

◆ typeHint()

Qgis::SymbolType QgsSymbolConverterContext::typeHint ( ) const
inline

Returns the symbol type hint, or Qgis::SymbolType::Hybrid if unknown.

See also
setTypeHint()

Definition at line 86 of file qgssymbolconverter.h.

◆ warnings()

QStringList QgsSymbolConverterContext::warnings ( ) const
inline

Returns a list of warnings which occurred during the conversion.

See also
pushWarning()
errors()

Definition at line 71 of file qgssymbolconverter.h.


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