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.
double	columnRight = 0.0
	Right side of current legend column.
Q_NOWARN_DEPRECATED_POP QgsRenderContext *	context = nullptr
	Render context, if available.
Q_DECL_DEPRECATED double	labelXOffset = 0.0
	Offset from the left side where label should start.
double	maxSiblingSymbolWidth = 0.0
	Largest symbol width, considering all other sibling legend components associated with the current component.
QPainter *	painter = nullptr
	Painter.
QgsLegendPatchShape	patchShape
	The patch shape to render for the node.
QSizeF	patchSize
	Symbol patch size to render for the node.
Q_DECL_DEPRECATED QPointF	point
	Top-left corner of the legend item.
QgsScreenProperties	screenProperties
	Destination screen properties.
const QgsTextDocument *	textDocument = nullptr
	Optional text document.
const QgsTextDocumentMetrics *	textDocumentMetrics = nullptr
	Optional text document metrics.
double	top = 0.0
	Top y-position of legend item.

Detailed Description

Definition at line 178 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 213 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 221 of file qgslayertreemodellegendnode.h.

context

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

Render context, if available.

Definition at line 185 of file qgslayertreemodellegendnode.h.

labelXOffset

Q_DECL_DEPRECATED double QgsLayerTreeModelLegendNode::ItemContext::labelXOffset = 0.0

Offset from the left side where label should start.

Deprecated:

QGIS 3.40. Use columnLeft, columnRight instead.

Definition at line 199 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 228 of file qgslayertreemodellegendnode.h.

painter

QPainter* QgsLayerTreeModelLegendNode::ItemContext::painter = nullptr

Painter.

Definition at line 187 of file qgslayertreemodellegendnode.h.

patchShape

QgsLegendPatchShape QgsLayerTreeModelLegendNode::ItemContext::patchShape

The patch shape to render for the node.

Since

QGIS 3.14

Definition at line 235 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 244 of file qgslayertreemodellegendnode.h.

point

Q_DECL_DEPRECATED QPointF QgsLayerTreeModelLegendNode::ItemContext::point

Top-left corner of the legend item.

Deprecated:

QGIS 3.40. Use top, columnLeft, columnRight instead.

Definition at line 193 of file qgslayertreemodellegendnode.h.

screenProperties

QgsScreenProperties QgsLayerTreeModelLegendNode::ItemContext::screenProperties

Destination screen properties.

Since

QGIS 3.32

Definition at line 265 of file qgslayertreemodellegendnode.h.

textDocument

const QgsTextDocument* QgsLayerTreeModelLegendNode::ItemContext::textDocument = nullptr

Optional text document.

Since

QGIS 3.30

Definition at line 251 of file qgslayertreemodellegendnode.h.

textDocumentMetrics

const QgsTextDocumentMetrics* QgsLayerTreeModelLegendNode::ItemContext::textDocumentMetrics = nullptr

Optional text document metrics.

Since

QGIS 3.30

Definition at line 258 of file qgslayertreemodellegendnode.h.

top

double QgsLayerTreeModelLegendNode::ItemContext::top = 0.0

Top y-position of legend item.

Since

QGIS 3.10

Definition at line 205 of file qgslayertreemodellegendnode.h.

---

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

• /build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/core/layertree/qgslayertreemodellegendnode.h