A base class for property widgets for layout items. More...

#include <qgslayoutitemwidget.h>

Inheritance diagram for QgsLayoutItemBaseWidget:

[legend]

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

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

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

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

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

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

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

virtual bool	applySizeConstraintsToStack () const
	Returns `true` if the size constraints and hints for the panel widget should be applied to the parent QgsPanelWidgetStack which this panel is shown in.

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

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.

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.

bool	dockMode ()
	Returns the dock mode state.

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

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

QString	panelTitle ()
	The title of the panel.

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

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

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

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

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

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

virtual bool	setNewItem (QgsLayoutItem *item)
	Attempts to update the widget to show the properties for the specified item.

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

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

Additional Inherited Members
Public Slots inherited from QgsPanelWidget
void	acceptPanel ()
	Accept the panel.

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.

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

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

void	widgetChanged ()
	Emitted when the widget state changes.

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.

Detailed Description

A base class for property widgets for layout items.

All layout item widgets should inherit from this base class.

Definition at line 120 of file qgslayoutitemwidget.h.

Constructor & Destructor Documentation

◆ QgsLayoutItemBaseWidget()

QgsLayoutItemBaseWidget::QgsLayoutItemBaseWidget	(	QWidget *parent	SIP_TRANSFERTHIS,
		QgsLayoutObject *	layoutObject
	)

Constructor for QgsLayoutItemBaseWidget, linked with the specified layoutObject.

Definition at line 190 of file qgslayoutitemwidget.cpp.

Member Function Documentation

◆ coverageLayer()

QgsVectorLayer * QgsLayoutItemBaseWidget::coverageLayer ( ) const

protected

Returns the current layout context coverage layer (if set).

Definition at line 258 of file qgslayoutitemwidget.cpp.

◆ layoutAtlas()

QgsLayoutAtlas * QgsLayoutItemBaseWidget::layoutAtlas ( ) const

protected

Returns the atlas for the layout (if available)

Definition at line 268 of file qgslayoutitemwidget.cpp.

◆ layoutObject()

QgsLayoutObject * QgsLayoutItemBaseWidget::layoutObject ( )

Returns the layout object associated with this widget.

Definition at line 198 of file qgslayoutitemwidget.cpp.

◆ registerDataDefinedButton()

void QgsLayoutItemBaseWidget::registerDataDefinedButton	(	QgsPropertyOverrideButton *	button,
		QgsLayoutObject::DataDefinedProperty	property
	)

protected

Registers a data defined button, setting up its initial value, connections and description.

The corresponding property key must be specified.

Definition at line 248 of file qgslayoutitemwidget.cpp.

◆ setDesignerInterface()

void QgsLayoutItemBaseWidget::setDesignerInterface ( QgsLayoutDesignerInterface * iface )

virtual

Sets the the layout designer interface in which the widget is being shown.

Since: QGIS 3.6

Reimplemented in QgsLayoutElevationProfileWidget, and QgsLayoutMapWidget.

Definition at line 229 of file qgslayoutitemwidget.cpp.

◆ setItem()

bool QgsLayoutItemBaseWidget::setItem ( QgsLayoutItem * item )

Sets the current item to show in the widget.

If true is returned, item was an acceptable type for display in this widget and the widget has been updated to match item's properties.

If false is returned, then the widget could not be successfully updated to show the properties of item.

Definition at line 203 of file qgslayoutitemwidget.cpp.

◆ setMasterLayout()

void QgsLayoutItemBaseWidget::setMasterLayout ( QgsMasterLayoutInterface * masterLayout )

virtual

Sets the master layout associated with the item.

Since: QGIS 3.10

Reimplemented in QgsLayoutAttributeTableWidget, QgsLayoutElevationProfileWidget, QgsLayoutHtmlWidget, QgsLayoutLabelWidget, QgsLayoutManualTableWidget, QgsLayoutMapWidget, QgsLayoutMarkerWidget, QgsLayoutPictureWidget, QgsLayoutPolygonWidget, QgsLayoutPolylineWidget, QgsLayoutScaleBarWidget, and QgsLayoutShapeWidget.

Definition at line 243 of file qgslayoutitemwidget.cpp.

◆ setNewItem()

bool QgsLayoutItemBaseWidget::setNewItem ( QgsLayoutItem * item )

protectedvirtual

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 in QgsLayoutMapLabelingWidget, QgsLayoutMapClippingWidget, QgsLayoutAttributeTableWidget, QgsLayoutElevationProfileWidget, QgsLayoutHtmlWidget, QgsLayoutLabelWidget, QgsLayoutManualTableWidget, QgsLayoutMapWidget, QgsLayoutMarkerWidget, QgsLayoutPictureWidget, QgsLayoutPolygonWidget, QgsLayoutPolylineWidget, QgsLayoutScaleBarWidget, and QgsLayoutShapeWidget.

Definition at line 263 of file qgslayoutitemwidget.cpp.

◆ setReportTypeString()

void QgsLayoutItemBaseWidget::setReportTypeString ( const QString & string )

virtual

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 in QgsLayoutAttributeTableWidget, QgsLayoutElevationProfileWidget, QgsLayoutMapWidget, and QgsLayoutMapClippingWidget.

Definition at line 225 of file qgslayoutitemwidget.cpp.

◆ updateDataDefinedButton()

void QgsLayoutItemBaseWidget::updateDataDefinedButton ( QgsPropertyOverrideButton * button )

protected

Updates a previously registered data defined button to reflect the item's current properties.

Definition at line 253 of file qgslayoutitemwidget.cpp.

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

/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/gui/layout/qgslayoutitemwidget.h
/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/gui/layout/qgslayoutitemwidget.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsLayoutItemBaseWidget()

Member Function Documentation

◆ coverageLayer()

◆ layoutAtlas()

◆ layoutObject()

◆ registerDataDefinedButton()

◆ setDesignerInterface()

◆ setItem()

◆ setMasterLayout()

◆ setNewItem()

◆ setReportTypeString()

◆ updateDataDefinedButton()