A widget for setting properties relating to a layout legend. More...

#include <qgslayoutlegendwidget.h>

Inheritance diagram for QgsLayoutLegendWidget:

Public Slots
void	resetLayerNodeToDefaults ()
	Reset a layer node to the default settings. More...

void	setCurrentNodeStyleFromAction ()
	Sets the current node style from the data of the action which invokes this slot. More...

Public Slots inherited from QgsPanelWidget
void	acceptPanel ()
	Accept the panel. More...

void	openPanel (QgsPanelWidget *panel)
	Open a panel or dialog depending on dock mode setting If dock mode is `true` this method will emit the showPanel signal for connected slots to handle the open event. More...

Public Member Functions
	QgsLayoutLegendWidget (QgsLayoutItemLegend legend, QgsMapCanvas mapCanvas)
	constructor More...

QgsLayoutItemLegend *	legend ()
	Returns the legend item associated to this widget. More...

void	setMasterLayout (QgsMasterLayoutInterface *masterLayout) override
	Sets the master layout associated with the item. More...

void	setReportTypeString (const QString &string) override
	Sets the string to use to describe the current report type (e.g. More...

void	updateLegend ()
	Updates the legend layers and groups. More...

Public Member Functions inherited from QgsLayoutItemBaseWidget
	QgsLayoutItemBaseWidget (QWidget parent SIP_TRANSFERTHIS, QgsLayoutObject layoutObject)
	Constructor for QgsLayoutItemBaseWidget, linked with the specified layoutObject. More...

QgsLayoutObject *	layoutObject ()
	Returns the layout object associated with this widget. More...

virtual void	setDesignerInterface (QgsLayoutDesignerInterface *iface)
	Sets the the layout designer interface in which the widget is being shown. More...

bool	setItem (QgsLayoutItem *item)
	Sets the current item to show in the widget. More...

Public Member Functions inherited from QgsPanelWidget
	QgsPanelWidget (QWidget *parent=nullptr)
	Base class for any widget that can be shown as a inline panel. More...

bool	autoDelete ()
	The the auto delete property on the widget. More...

void	connectChildPanel (QgsPanelWidget *panel)
	Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user. More...

void	connectChildPanels (const QList< QgsPanelWidget *> &panels)
	Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user. More...

bool	dockMode ()
	Returns the dock mode state. More...

virtual QMenu *	menuButtonMenu ()
	Returns the menu to use for the menu button for this panel, or `nullptr` if no menu button is required. More...

virtual QString	menuButtonTooltip () const
	Returns the (translated) tooltip text to use for the menu button for this panel. More...

QString	panelTitle ()
	The title of the panel. More...

void	setAutoDelete (bool autoDelete)
	The the auto delete property on the widget. More...

virtual void	setDockMode (bool dockMode)
	Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs. More...

void	setPanelTitle (const QString &panelTitle)
	Set the title of the panel when shown in the interface. More...

Protected Member Functions
bool	setNewItem (QgsLayoutItem *item) override
	Attempts to update the widget to show the properties for the specified item. More...

Protected Member Functions inherited from QgsLayoutItemBaseWidget
QgsVectorLayer *	coverageLayer () const
	Returns the current layout context coverage layer (if set). More...

QgsLayoutAtlas *	layoutAtlas () const
	Returns the atlas for the layout (if available) More...

void	registerDataDefinedButton (QgsPropertyOverrideButton *button, QgsLayoutObject::DataDefinedProperty property)
	Registers a data defined button, setting up its initial value, connections and description. More...

void	updateDataDefinedButton (QgsPropertyOverrideButton *button)
	Updates a previously registered data defined button to reflect the item's current properties. More...

Protected Member Functions inherited from QgsPanelWidget
void	keyPressEvent (QKeyEvent *event) override
	Overridden key press event to handle the esc event on the widget. More...

Additional Inherited Members
Signals inherited from QgsPanelWidget
void	panelAccepted (QgsPanelWidget *panel)
	Emitted when the panel is accepted by the user. More...

void	showPanel (QgsPanelWidget *panel)
	Emit when you require a panel to be show in the interface. More...

void	widgetChanged ()
	Emitted when the widget state changes. More...

Static Public Member Functions inherited from QgsPanelWidget
static QgsPanelWidget *	findParentPanel (QWidget *widget)
	Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget. More...

Detailed Description

A widget for setting properties relating to a layout legend.

Note: This class is not a part of public API

Since: QGIS 3.12

Definition at line 38 of file qgslayoutlegendwidget.h.

Constructor & Destructor Documentation

◆ QgsLayoutLegendWidget()

QgsLayoutLegendWidget::QgsLayoutLegendWidget	(	QgsLayoutItemLegend *	legend,
		QgsMapCanvas *	mapCanvas
	)

explicit

constructor

Definition at line 67 of file qgslayoutlegendwidget.cpp.

Member Function Documentation

◆ legend()

QgsLayoutItemLegend* QgsLayoutLegendWidget::legend ( )

inline

Returns the legend item associated to this widget.

Definition at line 51 of file qgslayoutlegendwidget.h.

◆ resetLayerNodeToDefaults

void QgsLayoutLegendWidget::resetLayerNodeToDefaults ( )

slot

Reset a layer node to the default settings.

Definition at line 913 of file qgslayoutlegendwidget.cpp.

◆ setCurrentNodeStyleFromAction

void QgsLayoutLegendWidget::setCurrentNodeStyleFromAction ( )

slot

Sets the current node style from the data of the action which invokes this slot.

See also: QgsLayoutLegendMenuProvider::createContextMenu

Definition at line 1246 of file qgslayoutlegendwidget.cpp.

◆ setMasterLayout()

void QgsLayoutLegendWidget::setMasterLayout ( QgsMasterLayoutInterface * masterLayout )

overridevirtual

Sets the master layout associated with the item.

Since: QGIS 3.10

Reimplemented from QgsLayoutItemBaseWidget.

Definition at line 198 of file qgslayoutlegendwidget.cpp.

◆ setNewItem()

bool QgsLayoutLegendWidget::setNewItem ( QgsLayoutItem * item )

overrideprotectedvirtual

Attempts to update the widget to show the properties for the specified item.

Subclasses can override this if they support changing items in place.

Implementations must return true if the item was accepted and the widget was updated.

Reimplemented from QgsLayoutItemBaseWidget.

Definition at line 1133 of file qgslayoutlegendwidget.cpp.

◆ setReportTypeString()

void QgsLayoutLegendWidget::setReportTypeString ( const QString & string )

overridevirtual

Sets the string to use to describe the current report type (e.g.

"atlas" or "report"). Subclasses which display this text to users should override this and update their widget labels accordingly.

Reimplemented from QgsLayoutItemBaseWidget.

Definition at line 1127 of file qgslayoutlegendwidget.cpp.

◆ updateLegend()

void QgsLayoutLegendWidget::updateLegend ( )

Updates the legend layers and groups.

Definition at line 1113 of file qgslayoutlegendwidget.cpp.

The documentation for this class was generated from the following files:

/build/qgis-3.12.1+28bionic/src/gui/layout/qgslayoutlegendwidget.h
/build/qgis-3.12.1+28bionic/src/gui/layout/qgslayoutlegendwidget.cpp

Public Slots

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsLayoutLegendWidget()

Member Function Documentation

◆ legend()

◆ resetLayerNodeToDefaults

◆ setCurrentNodeStyleFromAction

◆ setMasterLayout()

◆ setNewItem()

◆ setReportTypeString()

◆ updateLegend()