QgsLayoutGuideWidget Class Reference

Widget for managing the layout guides. More...

#include <qgslayoutguidewidget.h>

Inheritance diagram for QgsLayoutGuideWidget:

Public Slots
void	setCurrentPage (int page)
	Sets the current page number to manage the guides for.
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.

Public Member Functions
	QgsLayoutGuideWidget (QWidget *parent, QgsLayout *layout, QgsLayoutView *layoutView)
	constructor
Public Member Functions inherited from QgsPanelWidget
	QgsPanelWidget (QWidget *parent=nullptr)
	Base class for any widget that can be shown as an 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
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.
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 QgsPanelWidget
void	keyPressEvent (QKeyEvent *event) override
	Overridden key press event to handle the esc event on the widget.

Detailed Description

Widget for managing the layout guides.

Note

This class is not a part of public API

Since

QGIS 3.12

Definition at line 40 of file qgslayoutguidewidget.h.

Constructor & Destructor Documentation

QgsLayoutGuideWidget()

QgsLayoutGuideWidget::QgsLayoutGuideWidget	(	QWidget *	parent,
		QgsLayout *	layout,
		QgsLayoutView *	layoutView
	)

constructor

Definition at line 26 of file qgslayoutguidewidget.cpp.

Member Function Documentation

setCurrentPage

void QgsLayoutGuideWidget::setCurrentPage ( int  page )

slot

Sets the current page number to manage the guides for.

Definition at line 107 of file qgslayoutguidewidget.cpp.

---

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

• /build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/gui/layout/qgslayoutguidewidget.h
• /build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/gui/layout/qgslayoutguidewidget.cpp