qgscomposerarrow.h

Go to the documentation of this file.

/***************************************************************************
                         qgscomposerarrow.h
                         ----------------------
    begin                : November 2009
    copyright            : (C) 2009 by Marco Hugentobler
    email                : marco@hugis.net
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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 QGSCOMPOSERARROW_H
#define QGSCOMPOSERARROW_H

#include "qgscomposeritem.h"
#include <QBrush>
#include <QPen>

class QgsLineSymbolV2;

class CORE_EXPORT QgsComposerArrow: public QgsComposerItem
{
    Q_OBJECT

  public:

    enum MarkerMode
    {
      DefaultMarker,
      NoMarker,
      SVGMarker
    };

    QgsComposerArrow( QgsComposition* c );

    QgsComposerArrow( QPointF startPoint, QPointF stopPoint, QgsComposition* c );

    ~QgsComposerArrow();

    virtual int type() const override { return ComposerArrow; }

    void paint( QPainter* painter, const QStyleOptionGraphicsItem* itemStyle, QWidget* pWidget ) override;

    void setSceneRect( const QRectF& rectangle ) override;

    void setArrowHeadWidth( double width );

    double arrowHeadWidth() const { return mArrowHeadWidth; }

    Q_DECL_DEPRECATED void setOutlineWidth( double width );

    Q_DECL_DEPRECATED double outlineWidth() const;

    void setStartMarker( const QString& svgPath );

    QString startMarker() const { return mStartMarkerFile; }

    void setEndMarker( const QString& svgPath );

    QString endMarker() const { return mEndMarkerFile; }

    Q_DECL_DEPRECATED QColor arrowColor() const;

    Q_DECL_DEPRECATED void setArrowColor( const QColor& c );

    QColor arrowHeadOutlineColor() const { return mArrowHeadOutlineColor; }

    void setArrowHeadOutlineColor( const QColor& color );

    QColor arrowHeadFillColor() const { return mArrowHeadFillColor; }

    void setArrowHeadFillColor( const QColor& color );

    void setArrowHeadOutlineWidth( const double width );

    double arrowHeadOutlineWidth() const { return mArrowHeadOutlineWidth; }

    void setLineSymbol( QgsLineSymbolV2* symbol );

    QgsLineSymbolV2* lineSymbol() { return mLineSymbol; }

    MarkerMode markerMode() const { return mMarkerMode; }

    void setMarkerMode( MarkerMode mode );

    bool writeXML( QDomElement& elem, QDomDocument & doc ) const override;

    bool readXML( const QDomElement& itemElem, const QDomDocument& doc ) override;

  private:

    enum MarkerType
    {
      StartMarker,
      EndMarker
    };

    QPointF mStartPoint;
    QPointF mStopPoint;

    int mStartXIdx;
    int mStartYIdx;

    QPen mPen;
    QBrush mBrush;

    double mArrowHeadWidth;
    double mStartArrowHeadHeight;
    double mStopArrowHeadHeight;

    QString mStartMarkerFile;
    QString mEndMarkerFile;
    MarkerMode mMarkerMode;

    double mArrowHeadOutlineWidth;
    QColor mArrowHeadOutlineColor;
    QColor mArrowHeadFillColor;
    int mBoundsBehaviour;

    QgsLineSymbolV2* mLineSymbol;

    void adaptItemSceneRect();
    double computeMarkerMargin() const;
    void drawHardcodedMarker( QPainter* p, MarkerType type );
    void drawSVGMarker( QPainter* p, MarkerType type, const QString& markerPath );
    void init();
    void createDefaultLineSymbol();
    void drawLine( QPainter *painter );
};

#endif // QGSCOMPOSERARROW_H