Properly implemented showing and hiding of TitleBarUndockButton

Author: Uwe Kindler

src/DockAreaWidget.cpp

@@ -66,8 +66,8 @@ static const int APPEND = -1;
 
 
 /**
- * New dock area layout mimics stack layout but ony inserts the current
- * widget
+ * New dock area layout mimics stack layout but only inserts the current
+ * widget into the internal QLayout object
  */
 class CDockAreaLayout
 {
@@ -78,17 +78,27 @@ class CDockAreaLayout
 	QWidget* m_CurrentWidget = nullptr;
 
 public:
+	/**
+	 * Creates an instance with the given parent layout
+	 */
 	CDockAreaLayout(QBoxLayout* ParentLayout)
 		: m_ParentLayout(ParentLayout)
 	{
 
 	}
 
+	/**
+	 * Returns the number of widgets in this layout
+	 */
 	int count() const
 	{
 		return m_Widgets.count();
 	}
 
+	/**
+	 * Inserts the widget at the given index position into the internal widget
+	 * list
+	 */
 	void insertWidget(int index, QWidget* Widget)
 	{
 		Widget->setParent(0);
@@ -110,6 +120,9 @@ class CDockAreaLayout
 		}
 	}
 
+	/**
+	 * Removes the given widget from the lyout
+	 */
 	void removeWidget(QWidget* Widget)
 	{
 		if (currentWidget() == Widget)
@@ -125,11 +138,17 @@ class CDockAreaLayout
 		m_Widgets.removeOne(Widget);
 	}
 
+	/**
+	 * Returns the current selected widget
+	 */
 	QWidget* currentWidget() const
 	{
 		return m_CurrentWidget;
 	}
 
+	/**
+	 * Activates the widget with the give index.
+	 */
 	void setCurrentIndex(int index)
 	{
 		QWidget *prev = currentWidget();
@@ -169,26 +188,41 @@ class CDockAreaLayout
 		}
 	}
 
+	/**
+	 * Returns the index of the current active widget
+	 */
 	int currentIndex() const
 	{
 		return m_CurrentIndex;
 	}
 
+	/**
+	 * Returns true if there are no widgets in the layout
+	 */
 	bool isEmpty() const
 	{
 		return m_Widgets.empty();
 	}
 
+	/**
+	 * Returns the index of the given widget
+	 */
 	int indexOf(QWidget* w) const
 	{
 		return m_Widgets.indexOf(w);
 	}
 
+	/**
+	 * Returns the widget for the given index
+	 */
 	QWidget* widget(int index) const
 	{
 		return (index < m_Widgets.size()) ? m_Widgets.at(index) : nullptr;
 	}
 
+	/**
+	 * Returns the geometry of the current active widget
+	 */
 	QRect geometry() const
 	{
 		return m_Widgets.empty() ? QRect() : currentWidget()->geometry();
@@ -254,12 +288,6 @@ struct DockAreaWidgetPrivate
 		return DockWidget->property(INDEX_PROPERTY).toInt();
 	}
 
-	/**
-	 * Updates the tab bar visibility depending on the number of dock widgets
-	 * in this area
-	 */
-	void updateTitleBarVisibility();
-
 	/**
 	 * Convenience function for tabbar access
 	 */
@@ -293,19 +321,6 @@ void DockAreaWidgetPrivate::createTitleBar()
 }
 
 
-//============================================================================
-void DockAreaWidgetPrivate::updateTitleBarVisibility()
-{
-	CDockContainerWidget* Container = _this->dockContainer();
-	if (!Container)
-	{
-		return;
-	}
-
-	TitleBar->setVisible(!Container->isFloating() || !Container->hasTopLevelDockWidget());
-}
-
-
 //============================================================================
 CDockAreaWidget::CDockAreaWidget(CDockManager* DockManager, CDockContainerWidget* parent) :
 	QFrame(parent),
@@ -402,7 +417,7 @@ void CDockAreaWidget::removeDockWidget(CDockWidget* DockWidget)
 		hideAreaWithNoVisibleContent();
 	}
 
-	d->updateTitleBarVisibility();
+	updateTitleBarVisibility();
 	auto TopLevelDockWidget = dockContainer()->topLevelDockWidget();
 	if (TopLevelDockWidget)
 	{
@@ -440,7 +455,7 @@ void CDockAreaWidget::hideAreaWithNoVisibleContent()
 		return;
 	}
 
-	d->updateTitleBarVisibility();
+	updateTitleBarVisibility();
 	auto TopLevelWidget = Container->topLevelDockWidget();
 	auto FloatingWidget = Container->floatingWidget();
 	if (TopLevelWidget)
@@ -626,14 +641,20 @@ void CDockAreaWidget::toggleDockWidgetView(CDockWidget* DockWidget, bool Open)
 {
 	Q_UNUSED(DockWidget);
 	Q_UNUSED(Open);
-	updateTabBarVisibility();
+	updateTitleBarVisibility();
 }
 
 
 //============================================================================
-void CDockAreaWidget::updateTabBarVisibility()
+void CDockAreaWidget::updateTitleBarVisibility()
 {
-	d->updateTitleBarVisibility();
+	CDockContainerWidget* Container = dockContainer();
+	if (!Container)
+	{
+		return;
+	}
+
+	d->TitleBar->setVisible(!Container->isFloating() || !Container->hasTopLevelDockWidget());
 }
 
 

src/DockAreaWidget.h

@@ -121,7 +121,7 @@ private slots:
 	/**
 	 * Updates the dock area layout and components visibility
 	 */
-	void updateTabBarVisibility();
+	void updateTitleBarVisibility();
 
 	/**
 	 * This is the internal private function for setting the current widget.

src/DockContainerWidget.cpp

@@ -37,6 +37,7 @@
 #include <QVariant>
 #include <QDebug>
 #include <QXmlStreamWriter>
+#include <QAbstractButton>
 
 #include "DockManager.h"
 #include "DockAreaWidget.h"
@@ -105,6 +106,7 @@ class DockContainerWidgetPrivate
 	bool isFloating = false;
 	CDockAreaWidget* LastAddedAreaCache[5]{0, 0, 0, 0, 0};
 	int VisibleDockAreaCount = -1;
+	CDockAreaWidget* TopLevelDockArea = nullptr;
 
 	/**
 	 * Private data constructor
@@ -144,6 +146,12 @@ class DockContainerWidgetPrivate
 	 */
 	void addDockAreasToList(const QList<CDockAreaWidget*> NewDockAreas);
 
+	/**
+	 * Wrapper function for DockAreas append, that ensures that dock area signals
+	 * are properly connected to dock container slots
+	 */
+	void appendDockAreas(const QList<CDockAreaWidget*> NewDockAreas);
+
 	/**
 	 * Save state of child nodes
 	 */
@@ -208,11 +216,31 @@ class DockContainerWidgetPrivate
 		return VisibleDockAreaCount;
 	}
 
+	/**
+	 * The visible dock area count changes, if dock areas are remove, added or
+	 * when its view is toggled
+	 */
+	void onVisibleDockAreaCountChanged();
+
+	void emitDockAreasRemoved()
+	{
+		onVisibleDockAreaCountChanged();
+		emit _this->dockAreasRemoved();
+	}
+
+	void emitDockAreasAdded()
+	{
+		onVisibleDockAreaCountChanged();
+		emit _this->dockAreasAdded();
+	}
+
 // private slots: ------------------------------------------------------------
 	void onDockAreaViewToggled(bool Visible)
 	{
-		std::cout << "onDockAreaViewToggled " << Visible << std::endl;
+		CDockAreaWidget* DockArea = qobject_cast<CDockAreaWidget*>(_this->sender());
 		VisibleDockAreaCount += Visible ? 1 : -1;
+		onVisibleDockAreaCountChanged();
+		emit _this->dockAreaViewToggled(DockArea, Visible);
 	}
 }; // struct DockContainerWidgetPrivate
 
@@ -225,6 +253,24 @@ DockContainerWidgetPrivate::DockContainerWidgetPrivate(CDockContainerWidget* _pu
 }
 
 
+//============================================================================
+void DockContainerWidgetPrivate::onVisibleDockAreaCountChanged()
+{
+	auto TopLevelDockArea = _this->topLevelDockArea();
+
+	if (TopLevelDockArea)
+	{
+		this->TopLevelDockArea = TopLevelDockArea;
+		TopLevelDockArea->titleBarButton(TitleBarButtonUndock)->setVisible(false || !_this->isFloating());
+	}
+	else if (this->TopLevelDockArea)
+	{
+		this->TopLevelDockArea->titleBarButton(TitleBarButtonUndock)->setVisible(true);
+		this->TopLevelDockArea = nullptr;
+	}
+}
+
+
 //============================================================================
 void DockContainerWidgetPrivate::dropIntoContainer(CFloatingDockContainer* FloatingWidget,
 	DockWidgetArea area)
@@ -299,7 +345,7 @@ void DockContainerWidgetPrivate::dropIntoSection(CFloatingDockContainer* Floatin
 		}
 		TargetArea->setCurrentIndex(0); // make the topmost widget active
 		FloatingWidget->deleteLater();
-		TargetArea->updateTabBarVisibility();
+		TargetArea->updateTitleBarVisibility();
 		return;
 	}
 
@@ -364,21 +410,39 @@ void DockContainerWidgetPrivate::addDockAreasToList(const QList<CDockAreaWidget*
 {
 	int CountBefore = DockAreas.count();
 	int NewAreaCount = NewDockAreas.count();
-	DockAreas.append(NewDockAreas);
+	appendDockAreas(NewDockAreas);
+	// If the user dropped a floating widget that contains only one single
+	// visible dock area, then its title bar button TitleBarButtonUndock is
+	// likely hidden. We need to ensure, that it is visible
+	for (auto DockArea : NewDockAreas)
+	{
+		DockArea->titleBarButton(TitleBarButtonUndock)->setVisible(true);
+	}
 
 	// We need to ensure, that the dock area title bar is visible. The title bar
 	// is invisible, if the dock are is a single dock area in a floating widget.
 	if (1 == CountBefore)
 	{
-		DockAreas.at(0)->updateTabBarVisibility();
+		DockAreas.at(0)->updateTitleBarVisibility();
 	}
 
 	if (1 == NewAreaCount)
 	{
-		DockAreas.last()->updateTabBarVisibility();
+		DockAreas.last()->updateTitleBarVisibility();
 	}
 
-	emit _this->dockAreasAdded();
+	emitDockAreasAdded();
+}
+
+
+//============================================================================
+void DockContainerWidgetPrivate::appendDockAreas(const QList<CDockAreaWidget*> NewDockAreas)
+{
+	DockAreas.append(NewDockAreas);
+	for (auto DockArea : NewDockAreas)
+	{
+		_this->connect(DockArea, SIGNAL(viewToggled(bool)), SLOT(onDockAreaViewToggled(bool)));
+	}
 }
 
 
@@ -588,7 +652,7 @@ bool DockContainerWidgetPrivate::restoreDockArea(QXmlStreamReader& s,
 	else
 	{
 		DockArea->setProperty("currentDockWidget", CurrentDockWidget);
-		DockAreas.append(DockArea);
+		appendDockAreas({DockArea});
 	}
 
 	CreatedWidget = DockArea;
@@ -631,7 +695,7 @@ CDockAreaWidget* DockContainerWidgetPrivate::dockWidgetIntoContainer(DockWidgetA
 	CDockAreaWidget* NewDockArea = new CDockAreaWidget(DockManager, _this);
 	NewDockArea->addDockWidget(Dockwidget);
 	addDockArea(NewDockArea, area);
-	NewDockArea->updateTabBarVisibility();
+	NewDockArea->updateTitleBarVisibility();
 	LastAddedAreaCache[areaIdToIndex(area)] = NewDockArea;
 	return NewDockArea;
 }
@@ -673,9 +737,9 @@ void DockContainerWidgetPrivate::addDockArea(CDockAreaWidget* NewDockArea, DockW
 		RootSplitter = NewSplitter;
 	}
 
-	DockAreas.append(NewDockArea);
-	NewDockArea->updateTabBarVisibility();
-	emit _this->dockAreasAdded();
+	appendDockAreas({NewDockArea});
+	NewDockArea->updateTitleBarVisibility();
+	emitDockAreasAdded();
 }
 
 
@@ -744,8 +808,8 @@ CDockAreaWidget* DockContainerWidgetPrivate::dockWidgetIntoDockArea(DockWidgetAr
 		TargetAreaSplitter->insertWidget(index, NewSplitter);
 	}
 
-	DockAreas.append(NewDockArea);
-	emit _this->dockAreasAdded();
+	appendDockAreas({NewDockArea});
+	emitDockAreasAdded();
 	return NewDockArea;
 }
 
@@ -853,6 +917,7 @@ void CDockContainerWidget::addDockArea(CDockAreaWidget* DockAreaWidget,
 void CDockContainerWidget::removeDockArea(CDockAreaWidget* area)
 {
 	qDebug() << "CDockContainerWidget::removeDockArea";
+	area->disconnect(this);
 	d->DockAreas.removeAll(area);
 	CDockSplitter* Splitter = internal::findParent<CDockSplitter*>(area);
 
@@ -913,7 +978,7 @@ void CDockContainerWidget::removeDockArea(CDockAreaWidget* area)
     // one single visible dock widget
 	CDockWidget::emitTopLevelEventForWidget(TopLevelWidget, true);
 	dumpLayout();
-	emit dockAreasRemoved();
+	d->emitDockAreasRemoved();
 }