QgsWidgetStateHelper class

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

Contents

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

Constructors, destructors, conversion operators

QgsWidgetStateHelper(QObject* parent = nullptr) explicit
QgsWidgetStateHelper.

Public functions

auto eventFilter(QObject* object, QEvent* event) -> bool 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.

Function documentation

QgsWidgetStateHelper::QgsWidgetStateHelper(QObject* parent = nullptr) explicit

QgsWidgetStateHelper.

Parameters
parent Parent object

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.

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.