UI,docs: Send a custom event to the dock widget when closing

obsproject · Aug 4, 2024 · 3b266fe · 3b266fe
1 parent 58a8d79
commit 3b266fe
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 0 deletions.
diff --git a/UI/window-basic-main.cpp b/UI/window-basic-main.cpp
@@ -329,6 +329,8 @@ OBSBasic::OBSBasic(QWidget *parent)
 
 	setContextMenuPolicy(Qt::CustomContextMenu);
 
+	QEvent::registerEventType(QEvent::User + QEvent::Close);
+
 	api = InitializeAPIInterface(this);
 
 	ui->setupUi(this);

diff --git a/UI/window-dock.cpp b/UI/window-dock.cpp
@@ -34,6 +34,11 @@ void OBSDock::closeEvent(QCloseEvent *event)
 	}
 
 	QDockWidget::closeEvent(event);
+
+	if (widget() && event->isAccepted()) {
+		QEvent widgetEvent(QEvent::Type(QEvent::User + QEvent::Close));
+		qApp->sendEvent(widget(), &widgetEvent);
+	}
 }
 
 void OBSDock::showEvent(QShowEvent *event)

diff --git a/docs/sphinx/reference-frontend-api.rst b/docs/sphinx/reference-frontend-api.rst
@@ -480,6 +480,12 @@ Functions
    Adds a dock with the widget to the UI with a toggle in the Docks
    menu.
 
+   When the dock is closed, a custom QEvent of type `QEvent::User + QEvent::Close`
+   is sent to the widget to enable it to react to the event (e.g., unload elements
+   to save resources).
+   A generic QShowEvent is already sent by default when the widget is being
+   shown (e.g., dock opened).
+
    Note: Use :c:func:`obs_frontend_remove_dock` to remove the dock
          and the id from the UI.