qgscolorramplegendnodesettings.h

Go to the documentation of this file.

/***************************************************************************
  qgscolorramplegendnode.h
  --------------------------------------
  Date                 : December 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 QGSCOLORRAMPLEGENDNODESETTINGS_H
#define QGSCOLORRAMPLEGENDNODESETTINGS_H
 
#include <memory>
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgstextformat.h"
 
#include <QString>
 
class QgsNumericFormat;
class QgsReadWriteContext;
class QDomDocument;
class QDomElement;

class CORE_EXPORT QgsColorRampLegendNodeSettings
{
  public:

    enum Direction
    {
      MinimumToMaximum, 
      MaximumToMinimum,
    };
 
    QgsColorRampLegendNodeSettings();
 
    ~QgsColorRampLegendNodeSettings();
 
    QgsColorRampLegendNodeSettings( const QgsColorRampLegendNodeSettings &other );
    SIP_SKIP QgsColorRampLegendNodeSettings( QgsColorRampLegendNodeSettings &&other );
 
    QgsColorRampLegendNodeSettings &operator=( const QgsColorRampLegendNodeSettings &other );
    QgsColorRampLegendNodeSettings &operator=( QgsColorRampLegendNodeSettings &&other );

    QgsColorRampLegendNodeSettings::Direction direction() const;

    void setDirection( QgsColorRampLegendNodeSettings::Direction direction );

    QString minimumLabel() const;

    void setMinimumLabel( const QString &label );

    QString maximumLabel() const;

    void setMaximumLabel( const QString &label );

    const QgsNumericFormat *numericFormat() const;

    void setNumericFormat( QgsNumericFormat *format SIP_TRANSFER );

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

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

    QString prefix() const;

    void setPrefix( const QString &prefix );

    QString suffix() const;

    void setSuffix( const QString &suffix );

    QgsTextFormat textFormat() const;

    void setTextFormat( const QgsTextFormat &format );

    Qt::Orientation orientation() const;

    void setOrientation( Qt::Orientation orientation );

    bool useContinuousLegend() const;

    void setUseContinuousLegend( bool useContinuousLegend );
 
  private:
    bool mUseContinuousLegend = true;
    QString mMinimumLabel;
    QString mMaximumLabel;
    QString mPrefix;
    QString mSuffix;
    Direction mDirection = MinimumToMaximum;
    std::unique_ptr< QgsNumericFormat > mNumericFormat;
    QgsTextFormat mTextFormat;
    Qt::Orientation mOrientation = Qt::Vertical;
};
 
#endif // QGSCOLORRAMPLEGENDNODESETTINGS_H