Implemented custom close handling

Author: githubuser0xFFFF

demo/MainWindow.cpp

@@ -53,6 +53,7 @@
 #include <QRubberBand>
 #include <QPlainTextEdit>
 #include <QTableWidget>
+#include <QMessageBox>
 
 #include <QMap>
 #include <QElapsedTimer>
@@ -171,6 +172,7 @@ static ads::CDockWidget* createEditorWidget(QMenu* ViewMenu)
 	ads::CDockWidget* DockWidget = new ads::CDockWidget(QString("Editor %1").arg(EditorCount++));
 	DockWidget->setWidget(w);
 	DockWidget->setIcon(svgIcon(":/adsdemo/images/edit.svg"));
+	DockWidget->setFeature(ads::CDockWidget::CustomCloseHandling, true);
 	ViewMenu->addAction(DockWidget->toggleViewAction());
 	return DockWidget;
 }
@@ -475,6 +477,21 @@ void CMainWindow::createEditor()
 	DockWidget->setFeature(ads::CDockWidget::DockWidgetDeleteOnClose, true);
 	auto FloatingWidget = d->DockManager->addDockWidgetFloating(DockWidget);
     FloatingWidget->move(QPoint(20, 20));
+    connect(DockWidget, SIGNAL(closeRequested()), SLOT(onEditorCloseRequested()));
+}
+
+
+//============================================================================
+void CMainWindow::onEditorCloseRequested()
+{
+	auto DockWidget = qobject_cast<ads::CDockWidget*>(sender());
+	int Result = QMessageBox::question(this, "Close Editor", QString("Editor %1 "
+		"contains unsaved changes? Would you like to close it?")
+		.arg(DockWidget->windowTitle()));
+	if (QMessageBox::Yes == Result)
+	{
+		DockWidget->closeDockWidget();
+	}
 }
 
 

demo/MainWindow.h

@@ -61,6 +61,7 @@ private slots:
 	void onViewToggled(bool Open);
 	void createEditor();
 	void createTable();
+	void onEditorCloseRequested();
 };
 
 #endif // MAINWINDOW_H

src/DockAreaTabBar.cpp

@@ -478,7 +478,14 @@ void CDockAreaTabBar::onCloseOtherTabsRequested()
 			int Offset = Tab->dockWidget()->features().testFlag(
 				CDockWidget::DockWidgetDeleteOnClose) ? 1 : 0;
 			closeTab(i);
-			i -= Offset;
+
+			// If the the dock widget blocks closing, i.e. if the flag
+			// CustomCloseHandling is set, and the dock widget is still open,
+			// then we do not need to correct the index
+			if (Tab->dockWidget()->isClosed())
+			{
+				i -= Offset;
+			}
 		}
 	}
 }
@@ -569,7 +576,7 @@ void CDockAreaTabBar::closeTab(int Index)
 	{
 		return;
 	}
-	Tab->hide();
+	//Tab->hide();
 	emit tabCloseRequested(Index);
 }
 

src/DockAreaWidget.cpp

@@ -495,7 +495,7 @@ void CDockAreaWidget::onTabCloseRequested(int Index)
     if (DockWidget->features().testFlag(CDockWidget::DockWidgetDeleteOnClose))
     {
     	//DockWidget->deleteDockWidget();
-    	DockWidget->closeDockWidget();
+    	DockWidget->closeDockWidgetInternal();
     }
     else
     {
@@ -758,15 +758,26 @@ CDockWidget* CDockAreaWidget::nextOpenDockWidget(CDockWidget* DockWidget) const
 
 
 //============================================================================
-CDockWidget::DockWidgetFeatures CDockAreaWidget::features() const
+CDockWidget::DockWidgetFeatures CDockAreaWidget::features(eBitwiseOperator Mode) const
 {
-	CDockWidget::DockWidgetFeatures Features(CDockWidget::AllDockWidgetFeatures);
-	for (const auto DockWidget : dockWidgets())
+	if (BitwiseAnd == Mode)
 	{
-		Features &= DockWidget->features();
+		CDockWidget::DockWidgetFeatures Features(CDockWidget::AllDockWidgetFeatures);
+		for (const auto DockWidget : dockWidgets())
+		{
+			Features &= DockWidget->features();
+		}
+		return Features;
+	}
+	else
+	{
+		CDockWidget::DockWidgetFeatures Features(CDockWidget::NoDockWidgetFeatures);
+		for (const auto DockWidget : dockWidgets())
+		{
+			Features |= DockWidget->features();
+		}
+		return Features;
 	}
-
-	return Features;
 }
 
 
@@ -805,7 +816,7 @@ void CDockAreaWidget::closeArea()
 	auto OpenDockWidgets = openedDockWidgets();
 	if (OpenDockWidgets.count() == 1 && OpenDockWidgets[0]->features().testFlag(CDockWidget::DockWidgetDeleteOnClose))
 	{
-		OpenDockWidgets[0]->deleteDockWidget();
+		OpenDockWidgets[0]->closeDockWidgetInternal();
 	}
 	else
 	{

src/DockAreaWidget.h

@@ -238,10 +238,10 @@ protected slots:
 	 * A bitwise and is used to combine the flags of all dock widgets. That
 	 * means, if only one single dock widget does not support a certain flag,
 	 * the whole dock are does not support the flag. I.e. if one single
-	 * dock widget in this area is not closabe, the whole dock are is not
+	 * dock widget in this area is not closable, the whole dock are is not
 	 * closable.
 	 */
-	CDockWidget::DockWidgetFeatures features() const;
+	CDockWidget::DockWidgetFeatures features(eBitwiseOperator Mode = BitwiseAnd) const;
 
 	/**
 	 * Returns the title bar button corresponding to the given title bar

src/DockContainerWidget.cpp

@@ -1713,10 +1713,24 @@ void CDockContainerWidget::closeOtherAreas(CDockAreaWidget* KeepOpenArea)
 {
 	for (const auto DockArea : d->DockAreas)
 	{
-		if (DockArea != KeepOpenArea && DockArea->features().testFlag(CDockWidget::DockWidgetClosable))
+		if (DockArea == KeepOpenArea)
 		{
-			DockArea->closeArea();
+			continue;
+		}
+
+		if (!DockArea->features(BitwiseAnd).testFlag(CDockWidget::DockWidgetClosable))
+		{
+			continue;
 		}
+
+		// We do not close areas with widgets with custom close handling
+		if (DockArea->features(BitwiseOr).testFlag(CDockWidget::CustomCloseHandling))
+		{
+			std::cout << "CDockWidget::CustomCloseHandling" << std::endl;
+			continue;
+		}
+
+		DockArea->closeArea();
 	}
 }
 

src/DockWidget.cpp

@@ -64,7 +64,7 @@ struct DockWidgetPrivate
 	QBoxLayout* Layout = nullptr;
 	QWidget* Widget = nullptr;
 	CDockWidgetTab* TabWidget = nullptr;
-	CDockWidget::DockWidgetFeatures Features = CDockWidget::AllDockWidgetFeatures;
+	CDockWidget::DockWidgetFeatures Features = CDockWidget::DefaultDockWidgetFeatures;
 	CDockManager* DockManager = nullptr;
 	CDockAreaWidget* DockArea = nullptr;
 	QAction* ToggleViewAction = nullptr;
@@ -744,42 +744,40 @@ void CDockWidget::deleteDockWidget()
 {
 	dockManager()->removeDockWidget(this);
 	deleteLater();
+	d->Closed = true;
 }
 
 
 //============================================================================
-bool CDockWidget::handleCloseRequest()
+void CDockWidget::closeDockWidget()
 {
-	std::cout << "CDockWidget::handleCloseRequest()" << std::endl;
-	return true;
+	closeDockWidgetInternal(true);
 }
 
 
 //============================================================================
-void CDockWidget::closeDockWidget()
+bool CDockWidget::closeDockWidgetInternal(bool ForceClose)
 {
-	closeDockWidgetInternal();
-}
+	if (!ForceClose)
+	{
+		emit closeRequested();
+	}
 
+	if (!ForceClose && features().testFlag(CDockWidget::CustomCloseHandling))
+	{
+		return false;
+	}
 
-//============================================================================
-bool CDockWidget::closeDockWidgetInternal()
-{
 	if (features().testFlag(CDockWidget::DockWidgetDeleteOnClose))
     {
-		if (handleCloseRequest())
-		{
-			deleteDockWidget();
-			return true;
-		}
+		deleteDockWidget();
     }
     else
     {
     	toggleView(false);
-    	return true;
     }
 
-	return false;
+	return true;
 }