Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgslegendstyle.h
       3                 :            :                          -------------------
       4                 :            :     begin                : March 2013
       5                 :            :     copyright            : (C) 2013 by Radim Blazek
       6                 :            :     email                : radim.blazek@gmail.com
       7                 :            :  ***************************************************************************/
       8                 :            : 
       9                 :            : /***************************************************************************
      10                 :            :  *                                                                         *
      11                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      12                 :            :  *   it under the terms of the GNU General Public License as published by  *
      13                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      14                 :            :  *   (at your option) any later version.                                   *
      15                 :            :  *                                                                         *
      16                 :            :  ***************************************************************************/
      17                 :            : 
      18                 :            : #ifndef QGSLEGENDSTYLE_H
      19                 :            : #define QGSLEGENDSTYLE_H
      20                 :            : 
      21                 :            : #include <QFont>
      22                 :            : #include <QMap>
      23                 :            : #include <QString>
      24                 :            : #include <QDomElement>
      25                 :            : #include <QDomDocument>
      26                 :            : 
      27                 :            : #include "qgis_core.h"
      28                 :            : #include "qgis_sip.h"
      29                 :            : #include "qgsreadwritecontext.h"
      30                 :            : 
      31                 :            : /**
      32                 :            :  * \ingroup core
      33                 :            :  * \brief Contains detailed styling information relating to how a layout legend should be rendered.
      34                 :            :  */
      35                 :          0 : class CORE_EXPORT QgsLegendStyle
      36                 :            : {
      37                 :            :   public:
      38                 :            : 
      39                 :            :     //! Component of legends which can be styled
      40                 :            :     enum Style
      41                 :            :     {
      42                 :            :       Undefined, //!< Should not happen, only if corrupted project file
      43                 :            :       Hidden, //!< Special style, item is hidden including margins around
      44                 :            :       Title, //!< Legend title
      45                 :            :       Group, //!< Legend group title
      46                 :            :       Subgroup, //!< Legend subgroup title
      47                 :            :       Symbol, //!< Symbol icon (excluding label)
      48                 :            :       SymbolLabel, //!< Symbol label (excluding icon)
      49                 :            :     };
      50                 :            : 
      51                 :            :     // TODO QGIS 4.0 - use Qt enum instead
      52                 :            : 
      53                 :            :     //! Margin sides
      54                 :            :     enum Side
      55                 :            :     {
      56                 :            :       Top = 0, //!< Top side
      57                 :            :       Bottom = 1, //!< Bottom side
      58                 :            :       Left = 2, //!< Left side
      59                 :            :       Right = 3, //!< Right side
      60                 :            :     };
      61                 :            : 
      62                 :            :     QgsLegendStyle();
      63                 :            : 
      64                 :            :     /**
      65                 :            :      * Returns the font used for rendering this legend component.
      66                 :            :      * \see setFont()
      67                 :            :      */
      68                 :          0 :     QFont font() const { return mFont; }
      69                 :            : 
      70                 :            :     /**
      71                 :            :      * Sets the \a font used for rendering this legend component.
      72                 :            :      * \see font()
      73                 :            :      */
      74                 :          0 :     void setFont( const QFont &font ) { mFont = font; }
      75                 :            : 
      76                 :            :     /**
      77                 :            :      * Returns a modifiable reference to the component's font.
      78                 :            :      *
      79                 :            :      * \see setFont()
      80                 :            :      * \note Not available in Python bindings
      81                 :            :      */
      82                 :          0 :     SIP_SKIP QFont &rfont() { return mFont; }
      83                 :            : 
      84                 :            :     /**
      85                 :            :      * Returns the margin (in mm) for the specified \a side of the component.
      86                 :            :      *
      87                 :            :      * \note Not all legend components respect all margin side settings!
      88                 :            :      *
      89                 :            :      * \see setMargin()
      90                 :            :      */
      91                 :          0 :     double margin( Side side ) { return mMarginMap.value( side ); }
      92                 :            : 
      93                 :            :     /**
      94                 :            :      * Sets the \a margin (in mm) for the specified \a side of the component.
      95                 :            :      *
      96                 :            :      * \note Not all legend components respect all margin side settings!
      97                 :            :      *
      98                 :            :      * \see margin()
      99                 :            :      */
     100                 :          0 :     void setMargin( Side side, double margin ) { mMarginMap[side] = margin; }
     101                 :            : 
     102                 :            :     /**
     103                 :            :      * Sets all margin sides to the same \a margin size (in mm).
     104                 :            :      * \see margin()
     105                 :            :      */
     106                 :            :     void setMargin( double margin );
     107                 :            : 
     108                 :            :     /**
     109                 :            :      * Returns the alignment for the legend component.
     110                 :            :      *
     111                 :            :      * \see setAlignment()
     112                 :            :      * \since QGIS 3.10
     113                 :            :      */
     114                 :          0 :     Qt::Alignment alignment() const { return mAlignment; }
     115                 :            : 
     116                 :            :     /**
     117                 :            :      * Sets the alignment for the legend component.
     118                 :            :      *
     119                 :            :      * \see alignment()
     120                 :            :      * \since QGIS 3.10
     121                 :            :      */
     122                 :            :     void setAlignment( Qt::Alignment alignment ) { mAlignment = alignment; }
     123                 :            : 
     124                 :            :     /**
     125                 :            :      * Writes the component's style definition to an XML element.
     126                 :            :      * \see readXml()
     127                 :            :      */
     128                 :            :     void writeXml( const QString &name, QDomElement &elem, QDomDocument &doc, const QgsReadWriteContext &context = QgsReadWriteContext() ) const;
     129                 :            : 
     130                 :            :     /**
     131                 :            :      * Reads the component's style definition from an XML element.
     132                 :            :      * \see writeXml()
     133                 :            :      */
     134                 :            :     void readXml( const QDomElement &elem, const QDomDocument &doc, const QgsReadWriteContext &context = QgsReadWriteContext() );
     135                 :            : 
     136                 :            :     /**
     137                 :            :      * Returns the name for a style component as a string.
     138                 :            :      *
     139                 :            :      * This is a non-localised version, for internal use.
     140                 :            :      *
     141                 :            :      * \see styleFromName()
     142                 :            :      * \see styleLabel()
     143                 :            :      */
     144                 :            :     static QString styleName( Style s );
     145                 :            : 
     146                 :            :     /**
     147                 :            :      * Returns the style from name string.
     148                 :            :      * \see styleName()
     149                 :            :      */
     150                 :            :     static Style styleFromName( const QString &styleName );
     151                 :            : 
     152                 :            :     /**
     153                 :            :      * Returns a translated string representing a style component, for use in UI.
     154                 :            :      * \see styleName()
     155                 :            :      */
     156                 :            :     static QString styleLabel( Style s );
     157                 :            : 
     158                 :            :   private:
     159                 :            :     QFont mFont;
     160                 :            :     QMap<Side, double> mMarginMap;
     161                 :            :     Qt::Alignment mAlignment = Qt::AlignLeft;
     162                 :            : };
     163                 :            : 
     164                 :            : #endif