qgslabellinesettings.h

Go to the documentation of this file.

/***************************************************************************
  qgslabellinesettings.h
  --------------------------
  Date                 : August 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 QGSLABELLINESETTINGS_H
#define QGSLABELLINESETTINGS_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsmapunitscale.h"
 
#include <QString>
 
class QgsPropertyCollection;
class QgsExpressionContext;

class CORE_EXPORT QgsLabelLineSettings
{
    Q_GADGET
 
  public:
    enum class DirectionSymbolPlacement : int
    {
      SymbolLeftRight, 
      SymbolAbove,     
      SymbolBelow      
    };
    Q_ENUM( DirectionSymbolPlacement )
 
    
    enum class AnchorType : int
    {
      HintOnly, 
      Strict,   
    };
    Q_ENUM( AnchorType )
 
    
    enum class AnchorClipping : int
    {
      UseVisiblePartsOfLine, 
      UseEntireLine,         
    };
    Q_ENUM( AnchorClipping )
 
    
    Qgis::LabelLinePlacementFlags placementFlags() const { return mPlacementFlags; }

    void setPlacementFlags( Qgis::LabelLinePlacementFlags flags ) { mPlacementFlags = flags; }

    bool mergeLines() const { return mMergeLines; }

    void setMergeLines( bool merge ) { mMergeLines = merge; }

    void updateDataDefinedProperties( const QgsPropertyCollection &properties, QgsExpressionContext &context );

    bool addDirectionSymbol() const { return mAddDirectionSymbol; }

    void setAddDirectionSymbol( bool enabled ) { mAddDirectionSymbol = enabled; }

    QString leftDirectionSymbol() const { return mLeftDirectionSymbol; }

    void setLeftDirectionSymbol( const QString &symbol ) { mLeftDirectionSymbol = symbol; }

    QString rightDirectionSymbol() const { return mRightDirectionSymbol; }

    void setRightDirectionSymbol( const QString &symbol ) { mRightDirectionSymbol = symbol; }

    bool reverseDirectionSymbol() const { return mReverseDirectionSymbol; }

    void setReverseDirectionSymbol( bool reversed ) { mReverseDirectionSymbol = reversed; }

    DirectionSymbolPlacement directionSymbolPlacement() const { return mPlaceDirectionSymbol; }

    void setDirectionSymbolPlacement( DirectionSymbolPlacement placement ) { mPlaceDirectionSymbol = placement; }

    double overrunDistance() const { return mOverrunDistance; }

    void setOverrunDistance( double distance ) { mOverrunDistance = distance; }

    Qgis::RenderUnit overrunDistanceUnit() const { return mOverrunDistanceUnit; }

    void setOverrunDistanceUnit( const Qgis::RenderUnit &unit ) { mOverrunDistanceUnit = unit; }

    QgsMapUnitScale overrunDistanceMapUnitScale() const { return mOverrunDistanceMapUnitScale; }

    void setOverrunDistanceMapUnitScale( const QgsMapUnitScale &scale ) { mOverrunDistanceMapUnitScale = scale; }

    double lineAnchorPercent() const { return mLineAnchorPercent; }

    void setLineAnchorPercent( double percent ) { mLineAnchorPercent = percent; }

    AnchorType anchorType() const { return mAnchorType; }

    void setAnchorType( AnchorType type ) { mAnchorType = type; }

    AnchorClipping anchorClipping() const { return mAnchorClipping; }

    void setAnchorClipping( AnchorClipping clipping ) { mAnchorClipping = clipping; }

    Qgis::TextAnchorPoint anchorTextPoint() const { return mAnchorTextPoint; }

    void setAnchorTextPoint( Qgis::TextAnchorPoint point ) { mAnchorTextPoint = point; }

    Qgis::CurvedLabelMode curvedLabelMode() const { return mCurvedLabelMode; }

    void setCurvedLabelMode( Qgis::CurvedLabelMode mode ) { mCurvedLabelMode = mode; }
 
  private:
    Qgis::LabelLinePlacementFlags mPlacementFlags = Qgis::LabelLinePlacementFlag::AboveLine | Qgis::LabelLinePlacementFlag::MapOrientation;
    bool mMergeLines = false;
    bool mAddDirectionSymbol = false;
    QString mLeftDirectionSymbol = QString( '<' );
    QString mRightDirectionSymbol = QString( '>' );
    bool mReverseDirectionSymbol = false;
    DirectionSymbolPlacement mPlaceDirectionSymbol = DirectionSymbolPlacement::SymbolLeftRight;
    double mOverrunDistance = 0;
    Qgis::RenderUnit mOverrunDistanceUnit = Qgis::RenderUnit::Millimeters;
    QgsMapUnitScale mOverrunDistanceMapUnitScale;
 
    double mLineAnchorPercent = 0.5;
    AnchorType mAnchorType = AnchorType::HintOnly;
    AnchorClipping mAnchorClipping = AnchorClipping::UseVisiblePartsOfLine;
    Qgis::TextAnchorPoint mAnchorTextPoint = Qgis::TextAnchorPoint::FollowPlacement;
 
    Qgis::CurvedLabelMode mCurvedLabelMode = Qgis::CurvedLabelMode::Default;
};
 
#endif // QGSLABELLINESETTINGS_H