qgslabelplacementsettings.h

Go to the documentation of this file.

/***************************************************************************
  qgslabelplacementsettings.h
  --------------------------
  Date                 : May 2022
  Copyright            : (C) 2022 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 QGSLABELPLACEMENTSETTINGS_H
#define QGSLABELPLACEMENTSETTINGS_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
 
class QgsPropertyCollection;
class QgsExpressionContext;

class CORE_EXPORT QgsLabelPlacementSettings
{
  public:
    Qgis::LabelOverlapHandling overlapHandling() const { return mOverlapHandling; }

    void setOverlapHandling( Qgis::LabelOverlapHandling handling ) { mOverlapHandling = handling; }

    bool allowDegradedPlacement() const { return mAllowDegradedPlacement; }

    void setAllowDegradedPlacement( bool allow ) { mAllowDegradedPlacement = allow; }

    Qgis::LabelPrioritization prioritization() const { return mPrioritization; }

    void setPrioritization( Qgis::LabelPrioritization prioritization ) { mPrioritization = prioritization; }

    Qgis::MultiPartLabelingBehavior multiPartBehavior() const { return mMultiPartBehavior; }

    void setMultiPartBehavior( Qgis::MultiPartLabelingBehavior behavior ) { mMultiPartBehavior = behavior; }

    Qgis::LabelWhitespaceCollisionHandling whitespaceCollisionHandling() const { return mWhitespaceCollisionHandling; }

    void setWhitespaceCollisionHandling( Qgis::LabelWhitespaceCollisionHandling handling ) { mWhitespaceCollisionHandling = handling; }

    void updateDataDefinedProperties( const QgsPropertyCollection &properties, QgsExpressionContext &context );
 
  private:
    Qgis::LabelOverlapHandling mOverlapHandling = Qgis::LabelOverlapHandling::PreventOverlap;
    Qgis::LabelPrioritization mPrioritization = Qgis::LabelPrioritization::PreferCloser;
 
    bool mAllowDegradedPlacement = false;
 
    Qgis::MultiPartLabelingBehavior mMultiPartBehavior = Qgis::MultiPartLabelingBehavior::LabelLargestPartOnly;
    Qgis::LabelWhitespaceCollisionHandling mWhitespaceCollisionHandling = Qgis::LabelWhitespaceCollisionHandling::TreatWhitespaceAsCollision;
};
 
#endif // QGSLABELPLACEMENTSETTINGS_H