QGIS API Documentation  3.37.0-Master (a5b4d9743e8)
qgslegendsymbolitem.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgslegendsymbolitem.h
3  --------------------------------------
4  Date : August 2014
5  Copyright : (C) 2014 by Martin Dobias
6  Email : wonder dot sk at gmail dot com
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 
16 #ifndef QGSLEGENDSYMBOLITEM_H
17 #define QGSLEGENDSYMBOLITEM_H
18 
19 #include <memory>
20 #include <QString>
21 
22 #include "qgis.h"
23 #include "qgis_core.h"
24 
26 class QgsSymbol;
27 
35 class CORE_EXPORT QgsLegendSymbolItem
36 {
37  public:
38 
42  QgsLegendSymbolItem() = default;
43 
47  QgsLegendSymbolItem( QgsSymbol *symbol, const QString &label, const QString &ruleKey, bool checkable = false, int scaleMinDenom = -1, int scaleMaxDenom = -1, int level = 0, const QString &parentRuleKey = QString() );
49 
51  QgsLegendSymbolItem &operator=( const QgsLegendSymbolItem &other );
52 
54  QgsSymbol *symbol() const { return mSymbol; }
56  QString label() const { return mLabel; }
58  QString ruleKey() const { return mKey; }
60  bool isCheckable() const { return mCheckable; }
61 
63  QgsSymbol *legacyRuleKey() const { return mOriginalSymbolPointer; }
64 
66  bool isScaleOK( double scale ) const;
67 
72  int scaleMinDenom() const { return mScaleMinDenom; }
73 
78  int scaleMaxDenom() const { return mScaleMaxDenom; }
79 
81  int level() const { return mLevel; }
82 
87  QString parentRuleKey() const { return mParentKey; }
88 
96  void setSymbol( QgsSymbol *s );
97 
104  void setDataDefinedSizeLegendSettings( QgsDataDefinedSizeLegend *settings SIP_TRANSFER );
105 
109  QgsDataDefinedSizeLegend *dataDefinedSizeLegendSettings() const;
110 
111  private:
113  QgsSymbol *mSymbol = nullptr;
115  QString mLabel;
117  QString mKey;
119  bool mCheckable = false;
120 
121  QgsSymbol *mOriginalSymbolPointer = nullptr;
122 
127  QgsDataDefinedSizeLegend *mDataDefinedSizeLegendSettings = nullptr;
128 
129  // additional data that may be used for filtering
130 
131  int mScaleMinDenom = -1;
132  int mScaleMaxDenom = -1;
133 
135  int mLevel = 0;
137  QString mParentKey;
138 };
139 
140 typedef QList< QgsLegendSymbolItem > QgsLegendSymbolList;
141 
142 #endif // QGSLEGENDSYMBOLITEM_H
Object that keeps configuration of appearance of marker symbol's data-defined size in legend.
The class stores information about one class/rule of a vector layer renderer in a unified way that ca...
QString parentRuleKey() const
Key of the parent legend node.
int level() const
Indentation level that tells how deep the item is in a hierarchy of items. For flat lists level is 0.
int scaleMaxDenom() const
Max scale denominator of the scale range.
QgsSymbol * symbol() const
Returns associated symbol. May be nullptr.
int scaleMinDenom() const
Min scale denominator of the scale range.
QgsLegendSymbolItem()=default
Constructor for QgsLegendSymbolItem.
QString ruleKey() const
Returns unique identifier of the rule for identification of the item within renderer.
bool isCheckable() const
Returns whether the item is user-checkable - whether renderer supports enabling/disabling it.
QString label() const
Returns text label.
QgsSymbol * legacyRuleKey() const
Used for older code that identifies legend entries from symbol pointer within renderer.
Abstract base class for all rendered symbols.
Definition: qgssymbol.h:94
#define SIP_TRANSFER
Definition: qgis_sip.h:36
QList< QgsLegendSymbolItem > QgsLegendSymbolList