qgslayoutitemmarker.h

Go to the documentation of this file.

/***************************************************************************
                              qgslayoutitemmarker.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 QGSLAYOUTITEMMARKER_H
#define QGSLAYOUTITEMMARKER_H
 
#include "qgis_core.h"
#include "qgslayoutitem.h"
#include "qgslayoutitemregistry.h"
#include "qgslayoutnortharrowhandler.h"
 
class QgsMarkerSymbol;

class CORE_EXPORT QgsLayoutItemMarker : public QgsLayoutItem
{
    Q_OBJECT
 
  public:
    explicit QgsLayoutItemMarker( QgsLayout *layout );
    ~QgsLayoutItemMarker() override;

    static QgsLayoutItemMarker *create( QgsLayout *layout ) SIP_FACTORY;
 
 
    int type() const override;
    QIcon icon() const override;

    void setSymbol( QgsMarkerSymbol *symbol SIP_TRANSFER );

    QgsMarkerSymbol *symbol();

    void setLinkedMap( QgsLayoutItemMap *map );

    QgsLayoutItemMap *linkedMap() const;

    double northArrowRotation() const { return mNorthArrowRotation; }

    QgsLayoutNorthArrowHandler::NorthMode northMode() const;

    void setNorthMode( QgsLayoutNorthArrowHandler::NorthMode mode );

    double northOffset() const;

    void setNorthOffset( double offset );
 
    // Depending on the symbol style, the bounding rectangle can be larger than the shape
    QRectF boundingRect() const override;
 
    QgsLayoutSize fixedSize() const override;
 
    bool accept( QgsStyleEntityVisitorInterface *visitor ) const override;
 
  protected:
    void draw( QgsLayoutItemRenderContext &context ) override;
 
    bool writePropertiesToElement( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const override;
    bool readPropertiesFromElement( const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context ) override;
 
    void finalizeRestoreFromXml() override;
  private slots:

    void refreshSymbol();

    void updateBoundingRect();
 
    void northArrowRotationChanged( double rotation );
 
  private:
    std::unique_ptr< QgsMarkerSymbol > mShapeStyleSymbol;
 
    QPointF mPoint;
    QRectF mCurrentRectangle;
    QgsLayoutSize mFixedSize;
 
    QString mRotationMapUuid;
    QgsLayoutNorthArrowHandler *mNorthArrowHandler = nullptr;
    double mNorthArrowRotation = 0;
 
    QgsLayoutItemMarker( const QgsLayoutItemMarker & ) = delete;
    QgsLayoutItemMarker &operator=( const QgsLayoutItemMarker & ) = delete;
};
 
 
#endif //QGSLAYOUTITEMMARKER_H