QgsWidgetStateHelper Class Reference

QgsWidgetStateHelper is a helper class to save and restore the geometry of QWidgets in the application. More...

#include <qgswidgetstatehelper_p.h>

Inheritance diagram for QgsWidgetStateHelper:

Public Member Functions
	QgsWidgetStateHelper (QObject *parent=nullptr)
	QgsWidgetStateHelper.
bool	eventFilter (QObject *object, QEvent *event) override
	Event filter to catch events from registered widgets.
void	registerWidget (QWidget *widget, const QString &key=QString())
	Register a widget to have it geometry state automatically saved and restored.

Detailed Description

QgsWidgetStateHelper is a helper class to save and restore the geometry of QWidgets in the application.

This removes the need for devs to remember to call saveGeometry() and restoreGeometry() when writing new widgets.

This helper is internal and should only be called via QgsGui::enabledAutoGeometryRestore

Definition at line 31 of file qgswidgetstatehelper_p.h.

Constructor & Destructor Documentation

QgsWidgetStateHelper()

QgsWidgetStateHelper::QgsWidgetStateHelper ( QObject *  parent = nullptr )

explicit

QgsWidgetStateHelper.

Parameters

parent

Parent object

Definition at line 26 of file qgswidgetstatehelper_p.cpp.

Member Function Documentation

eventFilter()

bool QgsWidgetStateHelper::eventFilter ( QObject *  object, QEvent *  event  )

override

Event filter to catch events from registered widgets.

Parameters

object	Object getting the event.
event	Event sent from Qt.

Returns

Always returns true so that widget still gets event.

Definition at line 31 of file qgswidgetstatehelper_p.cpp.

registerWidget()

void QgsWidgetStateHelper::registerWidget	(	QWidget *	widget,
		const QString &	key = QString()
	)

Register a widget to have it geometry state automatically saved and restored.

Parameters

widget	The widget to save. Must have objectName() set.
key	The override settings key name to use if objectName() isn't to be used. objectName() is the default if not set.

Definition at line 73 of file qgswidgetstatehelper_p.cpp.

---

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

• /build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/gui/qgswidgetstatehelper_p.h
• /build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/gui/qgswidgetstatehelper_p.cpp