QGIS API Documentation 3.32.0-Lima (311a8cb8a6)
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
QgsLayoutLabelWidget Class Reference

A widget for layout item settings. More...

#include <qgslayoutlabelwidget.h>

Inheritance diagram for QgsLayoutLabelWidget:
Inheritance graph
[legend]

Public Member Functions

 QgsLayoutLabelWidget (QgsLayoutItemLabel *label)
 constructor More...
 
QgsExpressionContext createExpressionContext () const override
 This method needs to be reimplemented in all classes which implement this interface and return an expression context. More...
 
void setMasterLayout (QgsMasterLayoutInterface *masterLayout) override
 Sets the master layout associated with the item. More...
 
- Public Member Functions inherited from QgsLayoutItemBaseWidget
 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...
 
- Public Member Functions inherited from QgsExpressionContextGenerator
virtual ~QgsExpressionContextGenerator ()=default
 
virtual QgsExpressionContext createExpressionContext () const =0
 This method needs to be reimplemented in all classes which implement this interface and return an expression context. More...
 

Static Public Member Functions

static void buildInsertDynamicTextMenu (QgsLayout *layout, QMenu *menu, const std::function< void(const QString &expression) > &callback)
 Populates the specified menu with actions reflecting dynamic text expressions applicable for a layout. 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...
 

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
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...
 

Detailed Description

A widget for layout item settings.

Note
This class is not a part of public API
Since
QGIS 3.12

Definition at line 37 of file qgslayoutlabelwidget.h.

Constructor & Destructor Documentation

◆ QgsLayoutLabelWidget()

QgsLayoutLabelWidget::QgsLayoutLabelWidget ( QgsLayoutItemLabel label)
explicit

constructor

Definition at line 33 of file qgslayoutlabelwidget.cpp.

Member Function Documentation

◆ buildInsertDynamicTextMenu()

void QgsLayoutLabelWidget::buildInsertDynamicTextMenu ( QgsLayout layout,
QMenu *  menu,
const std::function< void(const QString &expression) > &  callback 
)
static

Populates the specified menu with actions reflecting dynamic text expressions applicable for a layout.

This includes dynamic text for expressions like:

  • current date
  • total page count
  • current page number
  • etc

The callback function will be called whenever one of the created actions is triggered.

Since
QGIS 3.18

Definition at line 112 of file qgslayoutlabelwidget.cpp.

◆ createExpressionContext()

QgsExpressionContext QgsLayoutLabelWidget::createExpressionContext ( ) const
overridevirtual

This method needs to be reimplemented in all classes which implement this interface and return an expression context.

Since
QGIS 3.0

Implements QgsExpressionContextGenerator.

Definition at line 107 of file qgslayoutlabelwidget.cpp.

◆ setMasterLayout()

void QgsLayoutLabelWidget::setMasterLayout ( QgsMasterLayoutInterface masterLayout)
overridevirtual

Sets the master layout associated with the item.

Since
QGIS 3.10

Reimplemented from QgsLayoutItemBaseWidget.

Definition at line 101 of file qgslayoutlabelwidget.cpp.

◆ setNewItem()

bool QgsLayoutLabelWidget::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 241 of file qgslayoutlabelwidget.cpp.


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