QGIS API Documentation  3.17.0-Master (57c5a6fc26)
Public Member Functions | Protected Slots | List of all members
QgsLayoutItemPropertiesWidget Class Reference

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

#include <qgslayoutitemwidget.h>

Inheritance diagram for QgsLayoutItemPropertiesWidget:
Inheritance graph
[legend]

Public Member Functions

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

Protected Slots

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

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.

Since
QGIS 3.0

Definition at line 218 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 258 of file qgslayoutitemwidget.cpp.

Member Function Documentation

◆ initializeDataDefinedButtons

void QgsLayoutItemPropertiesWidget::initializeDataDefinedButtons ( )
protectedslot

Initializes data defined buttons to current atlas coverage layer.

Definition at line 725 of file qgslayoutitemwidget.cpp.

◆ populateDataDefinedButtons

void QgsLayoutItemPropertiesWidget::populateDataDefinedButtons ( )
protectedslot

Sets data defined button state to match item.

Definition at line 739 of file qgslayoutitemwidget.cpp.

◆ positionMode()

QgsLayoutItem::ReferencePoint QgsLayoutItemPropertiesWidget::positionMode ( ) const

Returns the position mode.

Definition at line 470 of file qgslayoutitemwidget.cpp.

◆ setItem()

void QgsLayoutItemPropertiesWidget::setItem ( QgsLayoutItem item)

Sets the layout item.

Definition at line 362 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 381 of file qgslayoutitemwidget.cpp.

◆ showBackgroundGroup()

void QgsLayoutItemPropertiesWidget::showBackgroundGroup ( bool  showGroup)

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

Definition at line 352 of file qgslayoutitemwidget.cpp.

◆ showFrameGroup()

void QgsLayoutItemPropertiesWidget::showFrameGroup ( bool  showGroup)

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

Definition at line 357 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 237 of file qgslayoutitemwidget.cpp.


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