A widget for configuring properties of pages in a layout. More...
#include <qgslayoutpagepropertieswidget.h>
Inheritance diagram for QgsLayoutPagePropertiesWidget:
Signals | |
| void | pageOrientationChanged () |
| Emitted when page orientation changes. | |
 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. | |
Public Member Functions | |
| QgsLayoutPagePropertiesWidget (QWidget *parent, QgsLayoutItem *page) | |
| Constructor for QgsLayoutPagePropertiesWidget. | |
| Public Member Functions inherited from QgsLayoutItemBaseWidget | |
| 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. | |
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. | |
| 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. | |
| Protected Member Functions inherited from QgsLayoutItemBaseWidget | |
| 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. | |
Detailed Description
A widget for configuring properties of pages in a layout.
- Note
- This class is not a part of public API
- Since
- QGIS 3.12
Definition at line 42 of file qgslayoutpagepropertieswidget.h.
Constructor & Destructor Documentation
◆ QgsLayoutPagePropertiesWidget()
| QgsLayoutPagePropertiesWidget::QgsLayoutPagePropertiesWidget | ( | QWidget * | parent, |
| QgsLayoutItem * | page | ||
| ) |
Constructor for QgsLayoutPagePropertiesWidget.
Definition at line 29 of file qgslayoutpagepropertieswidget.cpp.
Member Function Documentation
◆ pageOrientationChanged
|
signal |
Emitted when page orientation changes.
The documentation for this class was generated from the following files:
- /build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/gui/layout/qgslayoutpagepropertieswidget.h
- /build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/gui/layout/qgslayoutpagepropertieswidget.cpp
