QGIS API Documentation  3.21.0-Master (5b68dc587e)
Public Member Functions | Public Attributes | List of all members
QgsLayerTreeModelLegendNode::ItemContext Struct Reference

#include <qgslayertreemodellegendnode.h>

Public Member Functions

Q_NOWARN_DEPRECATED_PUSH ItemContext ()=default
 

Public Attributes

double columnLeft = 0.0
 Left side of current legend column. More...
 
double columnRight = 0.0
 Right side of current legend column. More...
 
Q_NOWARN_DEPRECATED_POP QgsRenderContextcontext = nullptr
 Render context, if available. More...
 
Q_DECL_DEPRECATED double labelXOffset = 0.0
 Offset from the left side where label should start. More...
 
double maxSiblingSymbolWidth = 0.0
 Largest symbol width, considering all other sibling legend components associated with the current component. More...
 
QPainter * painter = nullptr
 Painter. More...
 
QgsLegendPatchShape patchShape
 The patch shape to render for the node. More...
 
QSizeF patchSize
 Symbol patch size to render for the node. More...
 
Q_DECL_DEPRECATED QPointF point
 Top-left corner of the legend item. More...
 
double top = 0.0
 Top y-position of legend item. More...
 

Detailed Description

Definition at line 168 of file qgslayertreemodellegendnode.h.

Constructor & Destructor Documentation

◆ ItemContext()

Q_NOWARN_DEPRECATED_PUSH QgsLayerTreeModelLegendNode::ItemContext::ItemContext ( )
default

Member Data Documentation

◆ columnLeft

double QgsLayerTreeModelLegendNode::ItemContext::columnLeft = 0.0

Left side of current legend column.

This should be used when determining where to render legend item content, correctly respecting the symbol and text alignment from the legend settings.

Since
QGIS 3.10

Definition at line 203 of file qgslayertreemodellegendnode.h.

◆ columnRight

double QgsLayerTreeModelLegendNode::ItemContext::columnRight = 0.0

Right side of current legend column.

This should be used when determining where to render legend item content, correctly respecting the symbol and text alignment from the legend settings.

Since
QGIS 3.10

Definition at line 211 of file qgslayertreemodellegendnode.h.

◆ context

Q_NOWARN_DEPRECATED_POP QgsRenderContext* QgsLayerTreeModelLegendNode::ItemContext::context = nullptr

Render context, if available.

Definition at line 175 of file qgslayertreemodellegendnode.h.

◆ labelXOffset

Q_DECL_DEPRECATED double QgsLayerTreeModelLegendNode::ItemContext::labelXOffset = 0.0

Offset from the left side where label should start.

Deprecated:
use columnLeft, columnRight instead.

Definition at line 189 of file qgslayertreemodellegendnode.h.

◆ maxSiblingSymbolWidth

double QgsLayerTreeModelLegendNode::ItemContext::maxSiblingSymbolWidth = 0.0

Largest symbol width, considering all other sibling legend components associated with the current component.

Since
QGIS 3.10

Definition at line 218 of file qgslayertreemodellegendnode.h.

◆ painter

QPainter* QgsLayerTreeModelLegendNode::ItemContext::painter = nullptr

Painter.

Definition at line 177 of file qgslayertreemodellegendnode.h.

◆ patchShape

QgsLegendPatchShape QgsLayerTreeModelLegendNode::ItemContext::patchShape

The patch shape to render for the node.

Since
QGIS 3.14

Definition at line 225 of file qgslayertreemodellegendnode.h.

◆ patchSize

QSizeF QgsLayerTreeModelLegendNode::ItemContext::patchSize

Symbol patch size to render for the node.

If either the width or height are zero, then the default width/height from QgsLegendSettings::symbolSize() should be used instead.

Since
QGIS 3.14

Definition at line 234 of file qgslayertreemodellegendnode.h.

◆ point

Q_DECL_DEPRECATED QPointF QgsLayerTreeModelLegendNode::ItemContext::point

Top-left corner of the legend item.

Deprecated:
Use top, columnLeft, columnRight instead.

Definition at line 183 of file qgslayertreemodellegendnode.h.

◆ top

double QgsLayerTreeModelLegendNode::ItemContext::top = 0.0

Top y-position of legend item.

Since
QGIS 3.10

Definition at line 195 of file qgslayertreemodellegendnode.h.


The documentation for this struct was generated from the following file: