QGIS API Documentation  3.17.0-Master (a84647cf30)
Public Slots | Public Member Functions | List of all members
QgsLayoutPropertiesWidget Class Reference

Widget for configuring the properties of a layout. More...

#include <qgslayoutpropertieswidget.h>

Inheritance diagram for QgsLayoutPropertiesWidget:
Inheritance graph
[legend]

Public Slots

void updateGui ()
 Refreshes the gui to reflect the current layout settings. More...
 
- 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...
 

Public Member Functions

 QgsLayoutPropertiesWidget (QWidget *parent, QgsLayout *layout)
 constructor More...
 
void setMasterLayout (QgsMasterLayoutInterface *masterLayout)
 Sets the master layout. 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...
 
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...
 

Additional Inherited Members

- 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...
 
- Protected Member Functions inherited from QgsPanelWidget
void keyPressEvent (QKeyEvent *event) override
 Overridden key press event to handle the esc event on the widget. More...
 

Detailed Description

Widget for configuring the properties of a layout.

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

Definition at line 37 of file qgslayoutpropertieswidget.h.

Constructor & Destructor Documentation

◆ QgsLayoutPropertiesWidget()

QgsLayoutPropertiesWidget::QgsLayoutPropertiesWidget ( QWidget *  parent,
QgsLayout layout 
)

constructor

Definition at line 27 of file qgslayoutpropertieswidget.cpp.

Member Function Documentation

◆ setMasterLayout()

void QgsLayoutPropertiesWidget::setMasterLayout ( QgsMasterLayoutInterface masterLayout)

Sets the master layout.

Definition at line 107 of file qgslayoutpropertieswidget.cpp.

◆ updateGui

void QgsLayoutPropertiesWidget::updateGui ( )
slot

Refreshes the gui to reflect the current layout settings.

Definition at line 116 of file qgslayoutpropertieswidget.cpp.


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