qgssymbolconverter.h

Go to the documentation of this file.

/***************************************************************************
                             qgssymbolconverter.h
                             -----------------
    begin                : February 2026
    copyright            : (C) 2026 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSSYMBOLCONVERTER_H
#define QGSSYMBOLCONVERTER_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgsreadwritecontext.h"
 
class QgsSymbol;

class CORE_EXPORT QgsSymbolConverterContext
{
  public:
    QgsSymbolConverterContext( QgsReadWriteContext &rwContext );

    QgsReadWriteContext &readWriteContext();

    QStringList errors() const { return mErrors; }

    void pushError( const QString &error ) { mErrors << error; }

    QStringList warnings() const { return mWarnings; }

    void pushWarning( const QString &warning ) { mWarnings << warning; }

    Qgis::SymbolType typeHint() const { return mTypeHint; }

    void setTypeHint( Qgis::SymbolType hint ) { mTypeHint = hint; }
 
  private:
#ifdef SIP_RUN
    QgsSymbolConverterContext( const QgsSymbolConverterContext &other );
#endif
 
    QgsReadWriteContext &mRwContext;
    QStringList mErrors;
    QStringList mWarnings;
    Qgis::SymbolType mTypeHint = Qgis::SymbolType::Hybrid;
};

class CORE_EXPORT QgsAbstractSymbolConverter
{
  public:
    virtual ~QgsAbstractSymbolConverter();

    virtual Qgis::SymbolConverterCapabilities capabilities() const = 0;

    virtual QString name() const = 0;

    virtual QString formatName() const = 0;

    virtual QVariant toVariant( const QgsSymbol *symbol, QgsSymbolConverterContext &context ) const = 0 SIP_THROW( QgsNotSupportedException );

    virtual std::unique_ptr< QgsSymbol > createSymbol( const QVariant &variant, QgsSymbolConverterContext &context ) const = 0 SIP_THROW( QgsNotSupportedException );
};
 
#endif //QGSSYMBOLCONVERTER_H