while dockManager.removeDockWidget , the dockManager() returns null (#399)

This adds a `addDockWidgetToContainer()` method to `CDockManager`, which allows a dock widget to be registered with the dock manager, and added to a specific container, even if that container doesn't currently have any `DockAreaWidget`s.

This is pretty much just a clone of `addDockWidget()`, but with the ability to specify a container widget instead of a dock area.

CMakeLists.txt

@@ -1,20 +1,41 @@
 cmake_minimum_required(VERSION 3.5)
-set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake/modules ${CMAKE_MODULE_PATH})
-include(GetGitRevisionDescription)
-git_describe(GitTagVersion --tags)
-string(REGEX REPLACE "^([0-9]+)\\..*" "\\1" VERSION_MAJOR "${GitTagVersion}")
-string(REGEX REPLACE "^[0-9]+\\.([0-9]+).*" "\\1" VERSION_MINOR "${GitTagVersion}")
-string(REGEX REPLACE "^[0-9]+\\.[0-9]+\\.([0-9]+).*" "\\1" VERSION_PATCH "${GitTagVersion}")
-set(VERSION_SHORT "${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_PATCH}")
+
+# By default, the version information is extracted from the git index. However,
+# we can override this behavior by explicitly setting ADS_VERSION and
+# skipping the git checks. This is useful for cases where this project is being
+# used independently of its original git repo (e.g. vendored in another project)
+if(NOT ADS_VERSION)
+    set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake/modules ${CMAKE_MODULE_PATH})
+    include(GetGitRevisionDescription)
+    git_describe(GitTagVersion --tags)
+    string(REGEX REPLACE "^([0-9]+)\\..*" "\\1" VERSION_MAJOR "${GitTagVersion}")
+    string(REGEX REPLACE "^[0-9]+\\.([0-9]+).*" "\\1" VERSION_MINOR "${GitTagVersion}")
+    string(REGEX REPLACE "^[0-9]+\\.[0-9]+\\.([0-9]+).*" "\\1" VERSION_PATCH "${GitTagVersion}")
+    set(VERSION_SHORT "${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_PATCH}")
+else()
+    string(REGEX MATCHALL "[\.]" VERSION_DOT_MATCHES ${ADS_VERSION})
+    list(LENGTH VERSION_DOT_MATCHES VERSION_DOT_COUNT)
+    if(VERSION_DOT_COUNT EQUAL 2)
+        set(VERSION_SHORT ${ADS_VERSION})
+    else()
+        message(FATAL_ERROR "ADS_VERSION must be in major.minor.patch format, e.g. 3.8.1. Got ${ADS_VERSION}")
+    endif()
+endif()
+
+
 project(QtADS LANGUAGES CXX VERSION ${VERSION_SHORT})
+
 option(BUILD_STATIC "Build the static library" OFF)
 option(BUILD_EXAMPLES "Build the examples" ON)
+
 if("${CMAKE_SIZEOF_VOID_P}" STREQUAL "4")
     set(ads_PlatformDir "x86")
 else()
     set(ads_PlatformDir "x64")
 endif()
+
 add_subdirectory(src)
+
 if(BUILD_EXAMPLES)
     add_subdirectory(examples)
     add_subdirectory(demo)

README.md

@@ -15,20 +15,20 @@ integrated development environments (IDEs) such as Visual Studio.
 
 ## New and Noteworthy
 
-The [release 3.8](https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System/releases/tag/3.8.0)
+The [release 3.8](https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System/releases/tag/3.8.1)
 adds the following features:
 
 - option to close tabs with the middle mouse button
 - `DeleteContentOnClose` flag for dynamic deletion and creation of dock widget
   content
 
-The [release 3.7](https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System/releases/tag/3.7.0)
+The [release 3.7](https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System/releases/tag/3.7.2)
 adds the following features:
 
 - support for **Qt6.**
 - support for [empty dock area](doc/user-guide.md#empty-dock-area)
 
-The [release 3.6](https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System/releases/tag/3.6.0)
+The [release 3.6](https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System/releases/tag/3.6.3)
 adds some nice new features:
 
 - support for [central widget](doc/user-guide.md#central-widget) concept
@@ -90,6 +90,7 @@ know it from Visual Studio.
   - [HiveWE](#hivewe)
   - [Ramses Composer](#ramses-composer)
   - [Plot Juggler](#plot-juggler)
+  - [Notepad Next](#notepad-next)
 
 ### Docking everywhere - no central widget
 
@@ -371,13 +372,13 @@ Taken from the [Qt Blog](https://www.qt.io/blog/qt-design-studio-1.5-beta-releas
 
 [![Qt Design Studio](doc/showcase_qt_design_studio_video.png)](https://youtu.be/za9KBWcFXEw?t=84)
 
-### [QmixElements](https://www.cetoni.com/products/qmixelements/)
+### [CETONI Elements](https://www.cetoni.com/products/qmixelements/)
 
-The QmixElements software from [CETONI](https://www.cetoni.com) is a comprehensive, 
+The CETONI Elements software from [CETONI](https://www.cetoni.com) is a comprehensive, 
 plugin-based and modular laboratory automation software for controlling CETONI devices using a joint graphical user interface. The software features a powerful script system to automate processes. This [blog post](https://www.cetoni.com/blog/qmixelements-advanced-docking-system/) gives a nice overview about the use of the Qt
-Advanced Docking System in the QmixElements sofware.
+Advanced Docking System in the CETONI Elements sofware.
 
-![QmixElements](doc/showcase_qmix_elements.png)
+![CETONI_Elements](doc/showcase_qmix_elements.png)
 
 ### [ezEditor](https://github.com/ezEngine/ezEngine)
 
@@ -440,4 +441,13 @@ highlights are:
 
 [read more...](https://github.com/facontidavide/PlotJuggler)
 
-[![Plot Juggler](doc/showcase_plot_juggler.png)](https://vimeo.com/480588113#t=46s)
+[![Plot Juggler](doc/showcase_plot_juggler.png)](https://vimeo.com/480588113#t=46s)
+
+### [Notepad Next](https://github.com/dail8859/NotepadNext)
+
+Notepad Next is a cross-platform reimplementation of Notepad++ that uses the 
+Advanced Docking System to arrange the open source files on the screen.
+
+[learn more...](https://github.com/dail8859/NotepadNext)
+
+![NotepadNext](doc/showcase_notepad_next.png)

examples/CMakeLists.txt

@@ -1,6 +1,7 @@
 cmake_minimum_required(VERSION 3.5)
 project(QtADSExamples LANGUAGES CXX VERSION ${VERSION_SHORT})
 add_subdirectory(simple)
+add_subdirectory(hideshow)
 add_subdirectory(sidebar)
 add_subdirectory(deleteonclose)
 add_subdirectory(centralwidget)

examples/examples.pro

@@ -3,6 +3,7 @@ TEMPLATE = subdirs
 SUBDIRS = \
     centralwidget \
 	simple \
+	hideshow \
 	sidebar \
 	deleteonclose \
 	emptydockarea \

examples/hideshow/CMakeLists.txt

@@ -0,0 +1,28 @@
+cmake_minimum_required(VERSION 3.5)
+project(ads_example_hideshow VERSION ${VERSION_SHORT}) 
+find_package(QT NAMES Qt6 Qt5 COMPONENTS Core REQUIRED)
+find_package(Qt${QT_VERSION_MAJOR} 5.5 COMPONENTS Core Gui Widgets REQUIRED)
+set(CMAKE_INCLUDE_CURRENT_DIR ON)
+add_executable(HideShowExample WIN32 
+    main.cpp
+    MainWindow.cpp
+    MainWindow.ui
+)
+target_include_directories(HideShowExample PRIVATE "${CMAKE_CURRENT_SOURCE_DIR}/../../src")
+target_link_libraries(HideShowExample PRIVATE qtadvanceddocking)
+target_link_libraries(HideShowExample PUBLIC Qt${QT_VERSION_MAJOR}::Core 
+                                             Qt${QT_VERSION_MAJOR}::Gui 
+                                             Qt${QT_VERSION_MAJOR}::Widgets)
+set_target_properties(HideShowExample PROPERTIES 
+    AUTOMOC ON
+    AUTORCC ON
+    AUTOUIC ON
+    CXX_STANDARD 14
+    CXX_STANDARD_REQUIRED ON
+    CXX_EXTENSIONS OFF
+    VERSION ${VERSION_SHORT}
+    EXPORT_NAME "Qt Advanced Docking System Hide,Show Example"
+    ARCHIVE_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/${ads_PlatformDir}/lib"
+    LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/${ads_PlatformDir}/lib"
+    RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/${ads_PlatformDir}/bin"
+)

examples/hideshow/MainWindow.cpp

@@ -0,0 +1,78 @@
+#include "../../examples/hideshow/MainWindow.h"
+
+#include "ui_MainWindow.h"
+
+#include <QLabel>
+#include <QPushButton>
+
+MainWindow::MainWindow(QWidget *parent) :
+    QMainWindow(parent),
+    ui(new Ui::MainWindow)
+{
+    ui->setupUi(this);
+
+    ui->centralWidget->setLayout( m_layout = new QStackedLayout() );
+
+    m_welcomeWidget = new QWidget(this);
+    auto welcomeLayout = new QVBoxLayout(m_welcomeWidget);
+    welcomeLayout->addStretch();
+    QPushButton* openButton = new QPushButton("Open project");
+    welcomeLayout->addWidget( openButton );
+    welcomeLayout->addStretch();
+
+    connect( openButton, SIGNAL(clicked()), this, SLOT(openProject()) );
+
+    m_DockManager = new ads::CDockManager(ui->centralWidget);
+
+    // Create example content label - this can be any application specific
+	// widget
+	QLabel* l = new QLabel();
+	l->setWordWrap(true);
+	l->setAlignment(Qt::AlignTop | Qt::AlignLeft);
+	l->setText("Lorem ipsum dolor sit amet, consectetuer adipiscing elit. ");
+
+	// Create a dock widget with the title Label 1 and set the created label
+	// as the dock widget content
+	ads::CDockWidget* DockWidget = new ads::CDockWidget("Label 1");
+	DockWidget->setWidget(l);
+
+	// Add the toggleViewAction of the dock widget to the menu to give
+	// the user the possibility to show the dock widget if it has been closed
+	ui->menuView->addAction(DockWidget->toggleViewAction());
+
+    connect( ui->actionOpen, SIGNAL(triggered()), this, SLOT(openProject()) );
+    connect( ui->actionClose, SIGNAL(triggered()), this, SLOT(closeProject()) );
+
+	// Add the dock widget to the top dock widget area
+	m_DockManager->addDockWidget(ads::TopDockWidgetArea, DockWidget);
+
+    ui->centralWidget->layout()->addWidget( m_welcomeWidget );
+    ui->centralWidget->layout()->addWidget( m_DockManager );
+
+    closeProject();
+}
+
+MainWindow::~MainWindow()
+{
+    delete ui;
+}
+
+void MainWindow::openProject()
+{
+    ui->actionOpen->setEnabled(false);
+    ui->actionClose->setEnabled(true);
+    ui->menuView->setEnabled(true);
+
+    m_layout->setCurrentWidget( m_DockManager );
+}
+
+void MainWindow::closeProject()
+{
+    ui->actionOpen->setEnabled(true);
+    ui->actionClose->setEnabled(false);
+    ui->menuView->setEnabled(false);
+
+    m_DockManager->hideManagerAndFloatingWidgets();
+    m_layout->setCurrentWidget( m_welcomeWidget );
+}
+

examples/hideshow/MainWindow.h

@@ -0,0 +1,33 @@
+#ifndef MAINWINDOW_H
+#define MAINWINDOW_H
+
+#include <QMainWindow>
+#include <QStackedLayout>
+#include "DockManager.h"
+
+QT_BEGIN_NAMESPACE
+namespace Ui {
+class MainWindow;
+}
+QT_END_NAMESPACE
+
+class MainWindow : public QMainWindow
+{
+    Q_OBJECT
+
+public:
+    explicit MainWindow(QWidget *parent = 0);
+    ~MainWindow();
+
+private slots:
+    void openProject();
+    void closeProject();
+
+private:
+    Ui::MainWindow *ui;
+    QWidget* m_welcomeWidget;
+    ads::CDockManager* m_DockManager;
+    QStackedLayout* m_layout;
+};
+
+#endif // MAINWINDOW_H

examples/hideshow/MainWindow.ui

@@ -0,0 +1,56 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ui version="4.0">
+ <class>MainWindow</class>
+ <widget class="QMainWindow" name="MainWindow">
+  <property name="geometry">
+   <rect>
+    <x>0</x>
+    <y>0</y>
+    <width>400</width>
+    <height>300</height>
+   </rect>
+  </property>
+  <property name="windowTitle">
+   <string>MainWindow</string>
+  </property>
+  <widget class="QWidget" name="centralWidget"/>
+  <widget class="QMenuBar" name="menuBar">
+   <property name="geometry">
+    <rect>
+     <x>0</x>
+     <y>0</y>
+     <width>400</width>
+     <height>26</height>
+    </rect>
+   </property>
+   <widget class="QMenu" name="menuView">
+    <property name="title">
+     <string>View</string>
+    </property>
+   </widget>
+   <widget class="QMenu" name="menuFile">
+    <property name="title">
+     <string>File</string>
+    </property>
+    <addaction name="actionOpen"/>
+    <addaction name="actionClose"/>
+   </widget>
+   <addaction name="menuFile"/>
+   <addaction name="menuView"/>
+  </widget>
+  <widget class="QStatusBar" name="statusBar"/>
+  <action name="actionOpen">
+   <property name="text">
+    <string>Open project</string>
+   </property>
+  </action>
+  <action name="actionClose">
+   <property name="text">
+    <string>Close project</string>
+   </property>
+  </action>
+ </widget>
+ <layoutdefault spacing="6" margin="11"/>
+ <resources/>
+ <connections/>
+</ui>

examples/hideshow/hideshow.pro

@@ -0,0 +1,31 @@
+ADS_OUT_ROOT = $${OUT_PWD}/../..
+
+QT += core gui widgets
+
+TARGET = HideShowExample
+DESTDIR = $${ADS_OUT_ROOT}/lib
+TEMPLATE = app
+CONFIG += c++14
+CONFIG += debug_and_release
+adsBuildStatic {
+    DEFINES += ADS_STATIC
+}
+
+DEFINES += QT_DEPRECATED_WARNINGS
+
+SOURCES += \
+        main.cpp \
+        MainWindow.cpp
+
+HEADERS += \
+        MainWindow.h
+
+FORMS += \
+        MainWindow.ui
+        
+
+LIBS += -L$${ADS_OUT_ROOT}/lib
+include(../../ads.pri)
+INCLUDEPATH += ../../src
+DEPENDPATH += ../../src    
+

examples/hideshow/main.cpp

@@ -0,0 +1,11 @@
+#include <QApplication>
+#include "../../examples/hideshow/MainWindow.h"
+
+int main(int argc, char *argv[])
+{
+    QApplication a(argc, argv);
+    MainWindow w;
+    w.show();
+
+    return a.exec();
+}

src/DockContainerWidget.cpp

@@ -1286,7 +1286,7 @@ CDockContainerWidget::CDockContainerWidget(CDockManager* DockManager, QWidget *p
 	d->isFloating = floatingWidget() != nullptr;
 
 	d->Layout = new QGridLayout();
-	d->Layout->setContentsMargins(0, 1, 0, 1);
+	d->Layout->setContentsMargins(0, 0, 0, 0);
 	d->Layout->setSpacing(0);
 	setLayout(d->Layout);
 

src/DockManager.cpp

@@ -98,6 +98,7 @@ struct DockManagerPrivate
 {
 	CDockManager* _this;
 	QList<CFloatingDockContainer*> FloatingWidgets;
+	QList<CFloatingDockContainer*> HiddenFloatingWidgets;
 	QList<CDockContainerWidget*> Containers;
 	CDockOverlay* ContainerOverlay;
 	CDockOverlay* DockAreaOverlay;
@@ -755,6 +756,9 @@ CFloatingDockContainer* CDockManager::addDockWidgetFloating(CDockWidget* Dockwid
 void CDockManager::showEvent(QShowEvent *event)
 {
 	Super::showEvent(event);
+
+	// Fix Issue #380
+	restoreHiddenFloatingWidgets();
 	if (d->UninitializedFloatingWidgets.empty())
 	{
 		return;
@@ -773,6 +777,41 @@ void CDockManager::showEvent(QShowEvent *event)
 }
 
 
+//============================================================================
+void CDockManager::restoreHiddenFloatingWidgets()
+{
+	if (d->HiddenFloatingWidgets.isEmpty())
+	{
+		return;
+	}
+
+	// Restore floating widgets that were hidden upon hideManagerAndFloatingWidgets
+	for (auto FloatingWidget : d->HiddenFloatingWidgets)
+	{
+		bool hasDockWidgetVisible = false;
+
+		// Needed to prevent CFloatingDockContainer being shown empty
+		// Could make sense to move this to CFloatingDockContainer::showEvent(QShowEvent *event)
+		// if experiencing CFloatingDockContainer being shown empty in other situations, but let's keep
+		// it here for now to make sure changes to fix Issue #380 does not impact existing behaviours
+		for (auto dockWidget : FloatingWidget->dockWidgets())
+		{
+			if (dockWidget->toggleViewAction()->isChecked())
+			{
+				dockWidget->toggleView(true);
+				hasDockWidgetVisible = true;
+			}
+		}
+
+		if (hasDockWidgetVisible)
+		{
+			FloatingWidget->show();
+		}
+	}
+
+	d->HiddenFloatingWidgets.clear();
+}
+
 //============================================================================
 CDockAreaWidget* CDockManager::addDockWidget(DockWidgetArea area,
 	CDockWidget* Dockwidget, CDockAreaWidget* DockAreaWidget)
@@ -784,6 +823,16 @@ CDockAreaWidget* CDockManager::addDockWidget(DockWidgetArea area,
 	return AreaOfAddedDockWidget;
 }
 
+//============================================================================
+CDockAreaWidget* CDockManager::addDockWidgetToContainer(DockWidgetArea area,
+	CDockWidget* Dockwidget, CDockContainerWidget* DockContainerWidget)
+{
+	d->DockWidgetsMap.insert(Dockwidget->objectName(), Dockwidget);
+	auto AreaOfAddedDockWidget = DockContainerWidget->addDockWidget(area, Dockwidget);
+	Q_EMIT dockWidgetAdded(Dockwidget);
+	return AreaOfAddedDockWidget;
+}
+
 
 //============================================================================
 CDockAreaWidget* CDockManager::addDockWidgetTab(DockWidgetArea area,
@@ -1102,6 +1151,38 @@ void CDockManager::setDockWidgetFocused(CDockWidget* DockWidget)
 	}
 }
 
+//===========================================================================
+void CDockManager::hideManagerAndFloatingWidgets()
+{
+	hide();
+
+	d->HiddenFloatingWidgets.clear();
+	// Hide updates of floating widgets from user
+	for (auto FloatingWidget : d->FloatingWidgets)
+	{
+		if ( FloatingWidget->isVisible() )
+		{
+			QList<CDockWidget*> VisibleWidgets;
+			for ( auto dockWidget : FloatingWidget->dockWidgets() )
+			{
+				if ( dockWidget->toggleViewAction()->isChecked() )
+					VisibleWidgets.push_back( dockWidget );
+			}
+
+			// save as floating widget to be shown when CDockManager will be shown back
+			d->HiddenFloatingWidgets.push_back( FloatingWidget );
+			FloatingWidget->hide();
+
+			// hidding floating widget automatically marked contained CDockWidgets as hidden
+			// but they must remain marked as visible as we want them to be restored visible
+			// when CDockManager will be shown back
+			for ( auto dockWidget : VisibleWidgets )
+			{
+				dockWidget->toggleViewAction()->setChecked(true);
+			}
+		}
+		}
+}
 
 //===========================================================================
 CDockWidget* CDockManager::focusedDockWidget() const

src/DockManager.h

@@ -147,6 +147,11 @@ protected:
 	 */
 	CDockFocusController* dockFocusController() const;
 
+    /**
+     * Restore floating widgets hidden by an earlier call to hideManagerAndFloatingWidgets.
+     */
+    void restoreHiddenFloatingWidgets();
+
 public:
 	using Super = CDockContainerWidget;
 
@@ -278,6 +283,15 @@ public:
 	CDockAreaWidget* addDockWidget(DockWidgetArea area, CDockWidget* Dockwidget,
 		CDockAreaWidget* DockAreaWidget = nullptr);
 
+	/**
+	 * Adds dockwidget into the given container.
+	 * This allows you to place the dock widget into a container, even if that
+	 * container does not yet contain a DockAreaWidget.
+	 * \return Returns the dock area widget that contains the new DockWidget
+	 */
+	CDockAreaWidget* addDockWidgetToContainer(DockWidgetArea area, CDockWidget* Dockwidget,
+		CDockContainerWidget* DockContainerWidget);
+
 	/**
 	 * This function will add the given Dockwidget to the given dock area as
 	 * a new tab.
@@ -527,6 +541,12 @@ public Q_SLOTS:
 	 */
 	void setDockWidgetFocused(CDockWidget* DockWidget);
 
+    /**
+     * hide CDockManager and all floating widgets (See Issue #380). Calling regular QWidget::hide()
+     * hides the CDockManager but not the floating widgets;
+     */
+    void hideManagerAndFloatingWidgets();
+
 Q_SIGNALS:
 	/**
 	 * This signal is emitted if the list of perspectives changed.

src/DockWidget.cpp

@@ -893,7 +893,10 @@ void CDockWidget::setFloating()
 //============================================================================
 void CDockWidget::deleteDockWidget()
 {
-	dockManager()->removeDockWidget(this);
+	auto manager=dockManager();
+	if(manager){
+		manager->removeDockWidget(this);
+	}
 	deleteLater();
 	d->Closed = true;
 }

src/stylesheets/default.css

@@ -4,6 +4,9 @@
 ads--CDockContainerWidget {
 	background: palette(dark);
 }
+ads--CDockContainerWidget > QSplitter{
+        padding: 1 0 1 0;
+}
 
 ads--CDockContainerWidget ads--CDockSplitter::handle {
 	background: palette(dark);
@@ -90,4 +93,4 @@ QScrollArea#dockWidgetScrollArea {
 	qproperty-icon: url(:/ads/images/detach-button.svg),
 		url(:/ads/images/detach-button-disabled.svg) disabled;
 	qproperty-iconSize: 16px;	
-}
+}

src/stylesheets/default_linux.css

@@ -4,6 +4,9 @@
 ads--CDockContainerWidget {
 	background: palette(dark);
 }
+ads--CDockContainerWidget > QSplitter{
+        padding: 1 0 1 0;
+}
 
 ads--CDockContainerWidget ads--CDockSplitter::handle {
 	background: palette(dark);

src/stylesheets/focus_highlighting.css

@@ -4,6 +4,9 @@
 ads--CDockContainerWidget {
 	background: palette(dark);
 }
+ads--CDockContainerWidget > QSplitter{
+        padding: 1 0 1 0;
+}
 
 ads--CDockAreaWidget {
 	background: palette(window);
@@ -123,4 +126,4 @@ ads--CDockAreaWidget[focused="true"] ads--CDockAreaTitleBar {
 	background: transparent;
 	border-bottom: 2px solid palette(highlight);
 	padding-bottom: 0px;
-}
+}

src/stylesheets/focus_highlighting_linux.css

@@ -4,6 +4,10 @@
 ads--CDockContainerWidget {
         background: palette(dark);
 }
+ads--CDockContainerWidget > QSplitter{
+        padding: 1 0 1 0;
+}
+
 
 ads--CDockContainerWidget ads--CDockSplitter::handle {
         background: palette(dark);