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"

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();

    QFont font() const { return mFont; }

    void setFont( const QFont &font ) { mFont = font; }

    SIP_SKIP QFont &rfont() { return mFont; }

    double margin( Side side ) { 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; }

    void writeXml( const QString &name, QDomElement &elem, QDomDocument &doc ) const;

    void readXml( const QDomElement &elem, const QDomDocument &doc );

    static QString styleName( Style s );

    static Style styleFromName( const QString &styleName );

    static QString styleLabel( Style s );

  private:
    QFont mFont;
    QMap<Side, double> mMarginMap;
    Qt::Alignment mAlignment = Qt::AlignLeft;
};

#endif