QgsLayoutItemPropertiesWidget Class Reference

A widget for controlling the common properties of layout items (e.g. More...

#include <qgslayoutitemwidget.h>

Inheritance diagram for QgsLayoutItemPropertiesWidget:

Public Member Functions
	QgsLayoutItemPropertiesWidget (QWidget *parent, QgsLayoutItem *item)
	Constructs a QgsLayoutItemPropertiesWidget with a parent and for the given layout item.
QgsLayoutItem::ReferencePoint	positionMode () const
	Returns the position mode.
void	setItem (QgsLayoutItem *item)
	Sets the layout item.
void	setMasterLayout (QgsMasterLayoutInterface *masterLayout)
	Sets the master layout associated with the item.
void	showBackgroundGroup (bool showGroup)
	Determines if the background of the group box shall be shown.
void	showFrameGroup (bool showGroup)
	Determines if the frame of the group box shall be shown.
void	updateVariables ()
	Updates the variables widget, refreshing the values of variables shown.

Protected Slots
void	initializeDataDefinedButtons ()
	Initializes data defined buttons to current atlas coverage layer.
void	populateDataDefinedButtons ()
	Sets data defined button state to match item.

Detailed Description

A widget for controlling the common properties of layout items (e.g.

position and size, background, stroke, frame). This widget can be embedded into other layout item widgets.

Definition at line 213 of file qgslayoutitemwidget.h.

Constructor & Destructor Documentation

QgsLayoutItemPropertiesWidget()

QgsLayoutItemPropertiesWidget::QgsLayoutItemPropertiesWidget	(	QWidget *	parent,
		QgsLayoutItem *	item )

Constructs a QgsLayoutItemPropertiesWidget with a parent and for the given layout item.

Definition at line 306 of file qgslayoutitemwidget.cpp.

Member Function Documentation

initializeDataDefinedButtons

void QgsLayoutItemPropertiesWidget::initializeDataDefinedButtons ( )

protectedslot

Initializes data defined buttons to current atlas coverage layer.

Definition at line 759 of file qgslayoutitemwidget.cpp.

populateDataDefinedButtons

void QgsLayoutItemPropertiesWidget::populateDataDefinedButtons ( )

protectedslot

Sets data defined button state to match item.

Definition at line 773 of file qgslayoutitemwidget.cpp.

positionMode()

QgsLayoutItem::ReferencePoint QgsLayoutItemPropertiesWidget::positionMode

(

)

const

Returns the position mode.

Definition at line 523 of file qgslayoutitemwidget.cpp.

setItem()

void QgsLayoutItemPropertiesWidget::setItem

(

QgsLayoutItem *

item

)

Sets the layout item.

Definition at line 415 of file qgslayoutitemwidget.cpp.

setMasterLayout()

void QgsLayoutItemPropertiesWidget::setMasterLayout

(

QgsMasterLayoutInterface *

masterLayout

)

Sets the master layout associated with the item.

Since

QGIS 3.10

Definition at line 434 of file qgslayoutitemwidget.cpp.

showBackgroundGroup()

void QgsLayoutItemPropertiesWidget::showBackgroundGroup

(

bool

showGroup

)

Determines if the background of the group box shall be shown.

Definition at line 405 of file qgslayoutitemwidget.cpp.

showFrameGroup()

void QgsLayoutItemPropertiesWidget::showFrameGroup

(

bool

showGroup

)

Determines if the frame of the group box shall be shown.

Definition at line 410 of file qgslayoutitemwidget.cpp.

updateVariables()

void QgsLayoutItemPropertiesWidget::updateVariables

(

)

Updates the variables widget, refreshing the values of variables shown.

Since

QGIS 3.10

Definition at line 285 of file qgslayoutitemwidget.cpp.

---

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

• /build/qgis-4.3.0+git20261026+16eddb2670e+99sid/src/gui/layout/qgslayoutitemwidget.h
• /build/qgis-4.3.0+git20261026+16eddb2670e+99sid/src/gui/layout/qgslayoutitemwidget.cpp