QGIS API Documentation  3.21.0-Master (5b68dc587e)
Public Member Functions | Protected Member Functions | List of all members
QgsLayoutItemBaseWidget Class Reference

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

#include <qgslayoutitemwidget.h>

Inheritance diagram for QgsLayoutItemBaseWidget:
Inheritance graph
[legend]

Public Member Functions

 QgsLayoutItemBaseWidget (QWidget *parent SIP_TRANSFERTHIS, QgsLayoutObject *layoutObject)
 Constructor for QgsLayoutItemBaseWidget, linked with the specified layoutObject. More...
 
QgsLayoutObjectlayoutObject ()
 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...
 
virtual void setMasterLayout (QgsMasterLayoutInterface *masterLayout)
 Sets the master layout associated with the item. More...
 
virtual void setReportTypeString (const QString &string)
 Sets the string to use to describe the current report type (e.g. 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...
 
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. 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

QgsVectorLayercoverageLayer () const
 Returns the current layout context coverage layer (if set). More...
 
QgsLayoutAtlaslayoutAtlas () 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...
 
virtual bool setNewItem (QgsLayoutItem *item)
 Attempts to update the widget to show the properties for the specified item. 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

- 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...
 
- 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 QgsPanelWidgetfindParentPanel (QWidget *widget)
 Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget. More...
 

Detailed Description

A base class for property widgets for layout items.

All layout item widgets should inherit from this base class.

Since
QGIS 3.0

Definition at line 122 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 168 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 236 of file qgslayoutitemwidget.cpp.

◆ layoutAtlas()

QgsLayoutAtlas * QgsLayoutItemBaseWidget::layoutAtlas ( ) const
protected

Returns the atlas for the layout (if available)

Definition at line 246 of file qgslayoutitemwidget.cpp.

◆ layoutObject()

QgsLayoutObject * QgsLayoutItemBaseWidget::layoutObject ( )

Returns the layout object associated with this widget.

Definition at line 176 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 226 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 QgsLayoutMapWidget.

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

◆ setMasterLayout()

void QgsLayoutItemBaseWidget::setMasterLayout ( QgsMasterLayoutInterface masterLayout)
virtual

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

Definition at line 241 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 QgsLayoutMapClippingWidget, QgsLayoutMapWidget, and QgsLayoutAttributeTableWidget.

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


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