qgslegendpatchshape.h

Go to the documentation of this file.

/***************************************************************************
                         qgslegendpatchshape.h
                         -------------------
begin                : April 2020
copyright            : (C) 2020 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 QGSLEGENDPATCHSHAPE_H
#define QGSLEGENDPATCHSHAPE_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsgeometry.h"
 
class QgsReadWriteContext;

class CORE_EXPORT QgsLegendPatchShape
{
  public:

    QgsLegendPatchShape() = default;

    QgsLegendPatchShape( Qgis::SymbolType type,
                         const QgsGeometry &geometry,
                         bool preserveAspectRatio = true );

    bool isNull() const;

    Qgis::SymbolType symbolType() const;

    void setSymbolType( Qgis::SymbolType type );

    QgsGeometry geometry() const;

    void setGeometry( const QgsGeometry &geometry );

    bool preserveAspectRatio() const;

    void setPreserveAspectRatio( bool preserve );

    bool scaleToOutputSize() const;

    void setScaleToOutputSize( bool scale );

    QgsGeometry scaledGeometry( QSizeF size ) const;

    QList< QList< QPolygonF > > toQPolygonF( Qgis::SymbolType type, QSizeF size ) const;

    void readXml( const QDomElement &element, const QgsReadWriteContext &context );

    void writeXml( QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context ) const;
 
  private:
    Qgis::SymbolType mSymbolType = Qgis::SymbolType::Fill;
    QgsGeometry mGeometry;
    bool mPreserveAspectRatio = true;
    bool mScaleToTargetSize = true;
 
};
 
#endif // QGSLEGENDPATCHSHAPE_H