Skip to content

Commit dd78f09

Browse files
committed
Fix doxygen warnings, fix missing bindings
1 parent 45d4793 commit dd78f09

8 files changed

+36
-11
lines changed

python/core/layertree/qgslayertreemodellegendnode.sip

+4-2
Original file line numberDiff line numberDiff line change
@@ -62,13 +62,17 @@ class QgsLayerTreeModelLegendNode : QObject
6262

6363
/**
6464
* Draws symbol on the left side of the item
65+
* @param settings Legend layout configuration
66+
* @param ctx Context for rendering - may be null if only doing layout without actual rendering
6567
* @param itemHeight Minimal height of the legend item - used for correct positioning when rendering
6668
* @return Real size of the symbol (may be bigger than "normal" symbol size from settings)
6769
*/
6870
virtual QSizeF drawSymbol( const QgsLegendSettings& settings, ItemContext* ctx, double itemHeight ) const;
6971

7072
/**
7173
* Draws label on the right side of the item
74+
* @param settings Legend layout configuration
75+
* @param ctx Context for rendering - may be null if only doing layout without actual rendering
7276
* @param symbolSize Real size of the associated symbol - used for correct positioning when rendering
7377
* @return Size of the label (may span multiple lines)
7478
*/
@@ -103,8 +107,6 @@ class QgsSymbolV2LegendNode : QgsLayerTreeModelLegendNode
103107
virtual QVariant data( int role ) const;
104108
virtual bool setData( const QVariant& value, int role );
105109

106-
/** Draws a symbol at the current y position and returns the new x position. Returns real symbol height, because for points,
107-
it is possible that it differs from mSymbolHeight */
108110
QSizeF drawSymbol( const QgsLegendSettings& settings, ItemContext* ctx, double itemHeight ) const;
109111

110112
virtual void setEmbeddedInParent( bool embedded );

python/core/symbology-ng/qgsrendererv2.sip

+4-4
Original file line numberDiff line numberDiff line change
@@ -128,15 +128,15 @@ class QgsFeatureRendererV2
128128
virtual QgsLegendSymbologyList legendSymbologyItems( QSize iconSize );
129129

130130
//! items of symbology items in legend should be checkable
131-
//! @node added in 2.5
131+
//! @note added in 2.5
132132
virtual bool legendSymbolItemsCheckable() const;
133133

134134
//! items of symbology items in legend is checked
135-
//! @node added in 2.5
135+
//! @note added in 2.5
136136
virtual bool legendSymbolItemChecked( QString key );
137137

138138
//! item in symbology was checked
139-
//! @node added in 2.5
139+
//! @note added in 2.5
140140
virtual void checkLegendSymbolItem( QString key, bool state = true );
141141

142142
//! return a list of item text / symbol
@@ -146,7 +146,7 @@ class QgsFeatureRendererV2
146146

147147
//! Return a list of symbology items for the legend. Better choice than legendSymbolItems().
148148
//! Default fallback implementation just uses legendSymbolItems() implementation
149-
//! @node added in 2.6
149+
//! @note added in 2.6
150150
virtual QgsLegendSymbolListV2 legendSymbolItemsV2() const;
151151

152152
//! If supported by the renderer, return classification attribute for the use in legend

python/core/symbology-ng/qgsrulebasedrendererv2.sip

+17
Original file line numberDiff line numberDiff line change
@@ -178,11 +178,28 @@ class QgsRuleBasedRendererV2 : QgsFeatureRendererV2
178178
//! return a list of symbology items for the legend
179179
virtual QgsLegendSymbologyList legendSymbologyItems( QSize iconSize );
180180

181+
//! items of symbology items in legend should be checkable
182+
//! @note added in 2.5
183+
virtual bool legendSymbolItemsCheckable() const;
184+
185+
//! items of symbology items in legend is checked
186+
//! @note added in 2.5
187+
virtual bool legendSymbolItemChecked( QString key );
188+
189+
//! item in symbology was checked
190+
//! @note added in 2.5
191+
virtual void checkLegendSymbolItem( QString key, bool state = true );
192+
181193
//! return a list of item text / symbol
182194
//! @note: this method was added in version 1.5
183195
//! @note not available in python bindings
184196
// virtual QgsLegendSymbolList legendSymbolItems();
185197

198+
//! Return a list of symbology items for the legend. Better choice than legendSymbolItems().
199+
//! Default fallback implementation just uses legendSymbolItems() implementation
200+
//! @note added in 2.6
201+
virtual QgsLegendSymbolListV2 legendSymbolItemsV2() const;
202+
186203
//! for debugging
187204
virtual QString dump() const;
188205

python/core/symbology-ng/qgssinglesymbolrendererv2.sip

+4
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,10 @@ class QgsSingleSymbolRendererV2 : QgsFeatureRendererV2
6262
//! @note not available in python bindings
6363
// virtual QgsLegendSymbolList legendSymbolItems( double scaleDenominator = -1, QString rule = QString() );
6464

65+
//! Return a list of symbology items for the legend. Better choice than legendSymbolItems().
66+
//! @note added in 2.6
67+
virtual QgsLegendSymbolListV2 legendSymbolItemsV2() const;
68+
6569
private:
6670
QgsSingleSymbolRendererV2( const QgsSingleSymbolRendererV2 & );
6771
QgsSingleSymbolRendererV2 & operator=( const QgsSingleSymbolRendererV2 & );

src/core/layertree/qgslayertreemodellegendnode.h

+4-2
Original file line numberDiff line numberDiff line change
@@ -84,13 +84,17 @@ class CORE_EXPORT QgsLayerTreeModelLegendNode : public QObject
8484

8585
/**
8686
* Draws symbol on the left side of the item
87+
* @param settings Legend layout configuration
88+
* @param ctx Context for rendering - may be null if only doing layout without actual rendering
8789
* @param itemHeight Minimal height of the legend item - used for correct positioning when rendering
8890
* @return Real size of the symbol (may be bigger than "normal" symbol size from settings)
8991
*/
9092
virtual QSizeF drawSymbol( const QgsLegendSettings& settings, ItemContext* ctx, double itemHeight ) const;
9193

9294
/**
9395
* Draws label on the right side of the item
96+
* @param settings Legend layout configuration
97+
* @param ctx Context for rendering - may be null if only doing layout without actual rendering
9498
* @param symbolSize Real size of the associated symbol - used for correct positioning when rendering
9599
* @return Size of the label (may span multiple lines)
96100
*/
@@ -124,8 +128,6 @@ class CORE_EXPORT QgsSymbolV2LegendNode : public QgsLayerTreeModelLegendNode
124128
virtual QVariant data( int role ) const;
125129
virtual bool setData( const QVariant& value, int role );
126130

127-
/** Draws a symbol at the current y position and returns the new x position. Returns real symbol height, because for points,
128-
it is possible that it differs from mSymbolHeight */
129131
QSizeF drawSymbol( const QgsLegendSettings& settings, ItemContext* ctx, double itemHeight ) const;
130132

131133
virtual void setEmbeddedInParent( bool embedded );

src/core/symbology-ng/qgsrendererv2.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ class CORE_EXPORT QgsFeatureRendererV2
172172

173173
//! Return a list of symbology items for the legend. Better choice than legendSymbolItems().
174174
//! Default fallback implementation just uses legendSymbolItems() implementation
175-
//! @node added in 2.6
175+
//! @note added in 2.6
176176
virtual QgsLegendSymbolListV2 legendSymbolItemsV2() const;
177177

178178
//! If supported by the renderer, return classification attribute for the use in legend

src/core/symbology-ng/qgsrulebasedrendererv2.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,7 @@ class CORE_EXPORT QgsRuleBasedRendererV2 : public QgsFeatureRendererV2
259259

260260
//! Return a list of symbology items for the legend. Better choice than legendSymbolItems().
261261
//! Default fallback implementation just uses legendSymbolItems() implementation
262-
//! @node added in 2.6
262+
//! @note added in 2.6
263263
virtual QgsLegendSymbolListV2 legendSymbolItemsV2() const;
264264

265265
//! for debugging

src/core/symbology-ng/qgssinglesymbolrendererv2.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ class CORE_EXPORT QgsSingleSymbolRendererV2 : public QgsFeatureRendererV2
8383
virtual QgsLegendSymbolList legendSymbolItems( double scaleDenominator = -1, QString rule = QString() );
8484

8585
//! Return a list of symbology items for the legend. Better choice than legendSymbolItems().
86-
//! @node added in 2.6
86+
//! @note added in 2.6
8787
virtual QgsLegendSymbolListV2 legendSymbolItemsV2() const;
8888

8989
protected:

0 commit comments

Comments
 (0)