qgslabelpointsettings.h

Go to the documentation of this file.

/***************************************************************************
  qgslabelpointsettings.h
  --------------------------
  Date                 : May 2024
  Copyright            : (C) 2024 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 QGSLABELPOINTSETTINGS_H
#define QGSLABELPOINTSETTINGS_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsmapunitscale.h"
 
#include <QString>
 
class QgsPropertyCollection;
class QgsExpressionContext;

class CORE_EXPORT QgsLabelPointSettings
{
    Q_GADGET
 
  public:
    void updateDataDefinedProperties( const QgsPropertyCollection &properties, QgsExpressionContext &context );

    Qgis::LabelQuadrantPosition quadrant() const { return mQuadrant; }

    void setQuadrant( Qgis::LabelQuadrantPosition quadrant ) { mQuadrant = quadrant; }

    QVector< Qgis::LabelPredefinedPointPosition > predefinedPositionOrder() const { return mPredefinedPositionOrder; }

    void setPredefinedPositionOrder( const QVector< Qgis::LabelPredefinedPointPosition > &order ) { mPredefinedPositionOrder = order; }

    double maximumDistance() const { return mMaximumDistance; }

    void setMaximumDistance( double distance ) { mMaximumDistance = distance; }

    Qgis::RenderUnit maximumDistanceUnit() const { return mMaximumDistanceUnit; }

    void setMaximumDistanceUnit( Qgis::RenderUnit unit ) { mMaximumDistanceUnit = unit; }

    QgsMapUnitScale maximumDistanceMapUnitScale() const { return mMaximumDistanceMapUnitScale; }

    void setMaximumDistanceMapUnitScale( const QgsMapUnitScale &scale ) { mMaximumDistanceMapUnitScale = scale; }
 
  private:
    Qgis::LabelQuadrantPosition mQuadrant = Qgis::LabelQuadrantPosition::Over;
 
    QVector< Qgis::LabelPredefinedPointPosition > mPredefinedPositionOrder;
 
    double mMaximumDistance = 0;
    Qgis::RenderUnit mMaximumDistanceUnit = Qgis::RenderUnit::Millimeters;
    QgsMapUnitScale mMaximumDistanceMapUnitScale;
};
 
#endif // QGSLABELPOINTSETTINGS_H