qgslabelingenginesettings.h

Go to the documentation of this file.

/***************************************************************************
    qgslabelingenginesettings.h
    ---------------------
    begin                : April 2017
    copyright            : (C) 2017 by Martin Dobias
    email                : wonder dot sk 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 QGSLABELINGENGINESETTINGS_H
#define QGSLABELINGENGINESETTINGS_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QColor>
 
class QgsProject;
class QgsAbstractLabelingEngineRule;
class QDomDocument;
class QDomElement;
class QgsReadWriteContext;

class CORE_EXPORT QgsLabelingEngineSettings
{
  public:
    // TODO QGIS 5 - remove

    enum Search
    {
      Chain,
      Popmusic_Tabu,
      Popmusic_Chain,
      Popmusic_Tabu_Chain,
      Falp
    };
 
    QgsLabelingEngineSettings();
    ~QgsLabelingEngineSettings();
 
    QgsLabelingEngineSettings( const QgsLabelingEngineSettings &other );
    SIP_SKIP QgsLabelingEngineSettings( QgsLabelingEngineSettings &&other );
 
    QgsLabelingEngineSettings &operator=( const QgsLabelingEngineSettings &other );
    QgsLabelingEngineSettings &operator=( QgsLabelingEngineSettings &&other );

    void clear();

    void setFlags( Qgis::LabelingFlags flags ) { mFlags = flags; }
    Qgis::LabelingFlags flags() const { return mFlags; }
    bool testFlag( Qgis::LabelingFlag f ) const { return mFlags.testFlag( f ); }
    void setFlag( Qgis::LabelingFlag f, bool enabled = true )
    {
      if ( enabled )
        mFlags |= f;
      else
        mFlags &= ~static_cast< int >( f );
    }

    double maximumLineCandidatesPerCm() const { return mMaxLineCandidatesPerCm; }

    void setMaximumLineCandidatesPerCm( double candidates ) { mMaxLineCandidatesPerCm = candidates; }

    double maximumPolygonCandidatesPerCmSquared() const { return mMaxPolygonCandidatesPerCmSquared; }

    void setMaximumPolygonCandidatesPerCmSquared( double candidates ) { mMaxPolygonCandidatesPerCmSquared = candidates; }

    Q_DECL_DEPRECATED void numCandidatePositions( int &candPoint, int &candLine, int &candPolygon ) const SIP_DEPRECATED
    {
      Q_UNUSED( candPoint )
      Q_UNUSED( candLine )
      Q_UNUSED( candPolygon )
    }

    Q_DECL_DEPRECATED void setNumCandidatePositions( int candPoint, int candLine, int candPolygon ) SIP_DEPRECATED
    {
      Q_UNUSED( candPoint )
      Q_UNUSED( candLine )
      Q_UNUSED( candPolygon )
    }

    Q_DECL_DEPRECATED void setSearchMethod( Search s ) SIP_DEPRECATED { Q_UNUSED( s ) }

    Q_DECL_DEPRECATED Search searchMethod() const SIP_DEPRECATED { return Chain; }
 
    // TODO QGIS 5.0 -- remove these, and just use read/writeXml directly:

    void readSettingsFromProject( QgsProject *project );

    void writeSettingsToProject( QgsProject *project );

    void writeXml( QDomDocument &doc, QDomElement &element, const QgsReadWriteContext &context ) const;

    void readXml( const QDomElement &element, const QgsReadWriteContext &context );

    void resolveReferences( const QgsProject *project ); // cppcheck-suppress functionConst
 
    // TODO QGIS 5.0: In reality the text render format settings don't only apply to labels, but also
    // ANY text rendered using QgsTextRenderer (including some non-label text items in layouts).
    // These methods should possibly be moved out of here and into the general QgsProject settings.

    Qgis::TextRenderFormat defaultTextRenderFormat() const { return mDefaultTextRenderFormat; }

    void setDefaultTextRenderFormat( Qgis::TextRenderFormat format ) { mDefaultTextRenderFormat = format; }

    QColor unplacedLabelColor() const;

    void setUnplacedLabelColor( const QColor &color );

    Qgis::LabelPlacementEngineVersion placementVersion() const;

    void setPlacementVersion( Qgis::LabelPlacementEngineVersion version );

    QList< QgsAbstractLabelingEngineRule * > rules();

    QList< const QgsAbstractLabelingEngineRule * > rules() const SIP_SKIP;

    void addRule( QgsAbstractLabelingEngineRule *rule SIP_TRANSFER );

    void setRules( const QList< QgsAbstractLabelingEngineRule * > &rules SIP_TRANSFER );
 
  private:
    Qgis::LabelingFlags mFlags = Qgis::LabelingFlag::UsePartialCandidates;
    Search mSearchMethod = Chain;
 
    // maximum density of line/polygon candidates per mm
    double mMaxLineCandidatesPerCm = 5;
    double mMaxPolygonCandidatesPerCmSquared = 2.5;
 
    QColor mUnplacedLabelColor = QColor( 255, 0, 0 );
 
    Qgis::LabelPlacementEngineVersion mPlacementVersion = Qgis::LabelPlacementEngineVersion::Version2;
 
    Qgis::TextRenderFormat mDefaultTextRenderFormat = Qgis::TextRenderFormat::AlwaysOutlines;
 
    std::vector< std::unique_ptr< QgsAbstractLabelingEngineRule > > mEngineRules;
};
 
#endif // QGSLABELINGENGINESETTINGS_H