qgslegendstyle.h

Go to the documentation of this file.

/***************************************************************************
                         qgslegendstyle.h
                         -------------------
    begin                : March 2013
    copyright            : (C) 2013 by Radim Blazek
    email                : [email protected]
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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 QGSLEGENDSTYLE_H
#define QGSLEGENDSTYLE_H
 
#include <QFont>
#include <QMap>
#include <QString>
#include <QDomElement>
#include <QDomDocument>
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgstextformat.h"
#include "qgsreadwritecontext.h"
 
class CORE_EXPORT QgsLegendStyle
{
  public:
 
    enum Style
    {
      Undefined, 
      Hidden, 
      Title, 
      Group, 
      Subgroup, 
      Symbol, 
      SymbolLabel, 
    };
 
    // TODO QGIS 4.0 - use Qt enum instead
 
    enum Side
    {
      Top = 0, 
      Bottom = 1, 
      Left = 2, 
      Right = 3, 
    };
 
    QgsLegendStyle();
 
    Q_DECL_DEPRECATED QFont font() const SIP_DEPRECATED { return mTextFormat.font(); }
 
    Q_DECL_DEPRECATED void setFont( const QFont &font ) SIP_DEPRECATED;
 
    QgsTextFormat &textFormat() { return mTextFormat; }
 
    QgsTextFormat textFormat() const SIP_SKIP { return mTextFormat; }
 
    void setTextFormat( const QgsTextFormat &format ) { mTextFormat = format; }
 
    double margin( Side side ) const { return mMarginMap.value( side ); }
 
    void setMargin( Side side, double margin ) { mMarginMap[side] = margin; }
 
    void setMargin( double margin );
 
    Qt::Alignment alignment() const { return mAlignment; }
 
    void setAlignment( Qt::Alignment alignment ) { mAlignment = alignment; }
 
    double indent() const { return mIndent; }
 
    void setIndent( double indent ) { mIndent = indent; }
 
    void writeXml( const QString &name, QDomElement &elem, QDomDocument &doc, const QgsReadWriteContext &context = QgsReadWriteContext() ) const;
 
    void readXml( const QDomElement &elem, const QDomDocument &doc, const QgsReadWriteContext &context = QgsReadWriteContext() );
 
    static QString styleName( Style s );
 
    static Style styleFromName( const QString &styleName );
 
    static QString styleLabel( Style s );
 
  private:
    QgsTextFormat mTextFormat;
    QMap<Side, double> mMarginMap;
    Qt::Alignment mAlignment = Qt::AlignLeft;
    double mIndent = 0;
};
 
#endif