Some changes for dockwidget tab close button, some refactorings to make insertion of widgets into dock widget easier, added createDefaultToolBar function for creation of toolbar and removed layout flags from CDockWidget

Author: Uwe Kindler

demo/MainWindow.cpp

@@ -94,8 +94,7 @@ static ads::CDockWidget* createCalendarDockWidget(QMenu* ViewMenu)
 {
 	static int CalendarCount = 0;
 	QCalendarWidget* w = new QCalendarWidget();
-	ads::CDockWidget* DockWidget = new ads::CDockWidget(QString("Calendar %1").arg(CalendarCount++),
-		nullptr, ads::CDockWidget::WithScrollArea);
+	ads::CDockWidget* DockWidget = new ads::CDockWidget(QString("Calendar %1").arg(CalendarCount++));
 	DockWidget->setWidget(w);
 	DockWidget->setToggleViewActionMode(ads::CDockWidget::ActionModeShow);
 	ViewMenu->addAction(DockWidget->toggleViewAction());
@@ -112,8 +111,7 @@ static ads::CDockWidget* createFileSystemTreeDockWidget(QMenu* ViewMenu)
 	QFileSystemModel* m = new QFileSystemModel(w);
 	m->setRootPath(QDir::currentPath());
 	w->setModel(m);
-	ads::CDockWidget* DockWidget = new ads::CDockWidget(QString("Filesystem %1").arg(FileSystemCount++),
-		nullptr, ads::CDockWidget::WithTopToolBar);
+	ads::CDockWidget* DockWidget = new ads::CDockWidget(QString("Filesystem %1").arg(FileSystemCount++));
 	DockWidget->setWidget(w);
 	ViewMenu->addAction(DockWidget->toggleViewAction());
     return DockWidget;
@@ -178,13 +176,13 @@ void MainWindowPrivate::createContent()
 	DockManager->addDockWidget(ads::LeftDockWidgetArea, DockWidget);
 	DockManager->addDockWidget(ads::LeftDockWidgetArea, createLongTextLabelDockWidget(ViewMenu));
 	auto FileSystemWidget = createFileSystemTreeDockWidget(ViewMenu);
-	auto ToolBar = FileSystemWidget->toolBar();
+	auto ToolBar = FileSystemWidget->createDefaultToolBar();
 	ToolBar->addAction(ui.actionSaveState);
 	ToolBar->addAction(ui.actionRestoreState);
 	DockManager->addDockWidget(ads::BottomDockWidgetArea, FileSystemWidget);
 
 	FileSystemWidget = createFileSystemTreeDockWidget(ViewMenu);
-	ToolBar = FileSystemWidget->toolBar();
+	ToolBar = FileSystemWidget->createDefaultToolBar();
 	ToolBar->addAction(ui.actionSaveState);
 	ToolBar->addAction(ui.actionRestoreState);
 	FileSystemWidget->setFeature(ads::CDockWidget::DockWidgetMovable, false);

src/DockAreaTabBar.cpp

@@ -288,6 +288,7 @@ void CDockAreaTabBar::insertTab(int Index, CDockWidgetTab* Tab)
 {
 	d->TabsLayout->insertWidget(Index, Tab);
 	connect(Tab, SIGNAL(clicked()), this, SLOT(onTabClicked()));
+	connect(Tab, SIGNAL(closeButtonClicked()), this, SLOT(onTabCloseButtonClicked()));
 	connect(Tab, SIGNAL(moved(const QPoint&)), this, SLOT(onTabWidgetMoved(const QPoint&)));
 	Tab->installEventFilter(this);
 	emit tabInserted(Index);
@@ -400,6 +401,13 @@ void CDockAreaTabBar::onTabClicked()
 }
 
 
+//===========================================================================
+void CDockAreaTabBar::onTabCloseButtonClicked()
+{
+	closeTab(currentIndex());
+}
+
+
 //===========================================================================
 CDockWidgetTab* CDockAreaTabBar::tab(int Index) const
 {

src/DockAreaTabBar.h

@@ -54,6 +54,7 @@ class CDockAreaTabBar : public QScrollArea
 
 private slots:
 	void onTabClicked();
+	void onTabCloseButtonClicked();
 	void onTabWidgetMoved(const QPoint& GlobalPos);
 
 protected:

src/DockAreaTitleBar.cpp

@@ -37,9 +37,8 @@
 #include <QScrollArea>
 #include <QMouseEvent>
 #include <QDebug>
-#include <QStyleOptionButton>
-#include <QPainter>
 
+#include "ads_globals.h"
 #include "FloatingDockContainer.h"
 #include "DockAreaWidget.h"
 #include "DockOverlay.h"
@@ -81,8 +80,6 @@ struct DockAreaTitleBarPrivate
 	 * Creates the internal TabBar
 	 */
 	void createTabBar();
-
-	QPixmap createTransparentPixmap(const QPixmap& Source);
 };// struct DockAreaTitleBarPrivate
 
 
@@ -95,18 +92,6 @@ DockAreaTitleBarPrivate::DockAreaTitleBarPrivate(CDockAreaTitleBar* _public) :
 }
 
 
-//============================================================================
-QPixmap DockAreaTitleBarPrivate::createTransparentPixmap(const QPixmap& Source)
-{
-	QPixmap disabledPixmap(Source.size());
-	disabledPixmap.fill(Qt::transparent);
-	QPainter p(&disabledPixmap);
-	p.setOpacity(0.25);
-	p.drawPixmap(0, 0, Source);
-	return disabledPixmap;
-}
-
-
 //============================================================================
 void DockAreaTitleBarPrivate::createButtons()
 {
@@ -137,14 +122,14 @@ void DockAreaTitleBarPrivate::createButtons()
 	CloseButton->setObjectName("closeButton");
 	CloseButton->setAutoRaise(true);
 
-	// The standard icons do does not look good on high DPI screens
+	// The standard icons do not look good on high DPI screens
 	QIcon CloseIcon =  _this->style()->standardIcon(QStyle::SP_TitleBarCloseButton);
 	QPixmap normalPixmap = _this->style()->standardPixmap(QStyle::SP_TitleBarCloseButton, 0, CloseButton);
-	QPixmap disabledPixmap = createTransparentPixmap(normalPixmap);
+	QPixmap disabledPixmap = internal::createTransparentPixmap(normalPixmap, 0.25);
 	CloseIcon.addPixmap(disabledPixmap, QIcon::Disabled);
 
 	CloseButton->setIcon(CloseIcon);
-	CloseButton->setToolTip(QObject::tr("Close"));
+	CloseButton->setToolTip(QObject::tr("Close all tabs"));
 	CloseButton->setSizePolicy(QSizePolicy::Fixed, QSizePolicy::Expanding);
 	TopLayout->addWidget(CloseButton, 0);
 	_this->connect(CloseButton, SIGNAL(clicked()), SLOT(onCloseButtonClicked()));
@@ -236,7 +221,8 @@ void CDockAreaTitleBar::onTabsMenuAboutToShow()
 void CDockAreaTitleBar::onCloseButtonClicked()
 {
 	qDebug() << "CDockAreaTitleBar::onCloseButtonClicked";
-	d->TabBar->closeTab(d->TabBar->currentIndex());
+	//d->TabBar->closeTab(d->TabBar->currentIndex());
+	d->DockArea->closeArea();
 }
 
 
@@ -263,8 +249,8 @@ void CDockAreaTitleBar::onCurrentTabChanged(int Index)
 	{
 		return;
 	}
-	CDockWidget* DockWidget = d->TabBar->tab(Index)->dockWidget();
-	d->CloseButton->setEnabled(DockWidget->features().testFlag(CDockWidget::DockWidgetClosable));
+	/*CDockWidget* DockWidget = d->TabBar->tab(Index)->dockWidget();
+	d->CloseButton->setEnabled(DockWidget->features().testFlag(CDockWidget::DockWidgetClosable));*/
 }
 
 

src/DockAreaTitleBar.h

@@ -82,6 +82,9 @@ private slots:
 	 */
 	QAbstractButton* button(TitleBarButton which) const;
 
+	/**
+	 * This function is here for debug reasons
+	 */
 	virtual void setVisible(bool Visible) override;
 
 signals:

src/DockAreaWidget.cpp

@@ -739,6 +739,16 @@ QAbstractButton* CDockAreaWidget::titleBarButton(TitleBarButton which) const
 {
 	return d->TitleBar->button(which);
 }
+
+
+//============================================================================
+void CDockAreaWidget::closeArea()
+{
+	for (auto DockWidget : openedDockWidgets())
+	{
+		DockWidget->toggleView(false);
+	}
+}
 } // namespace ads
 
 //---------------------------------------------------------------------------

src/DockAreaWidget.h

@@ -130,6 +130,9 @@ private slots:
 	 */
 	void internalSetCurrentDockWidget(CDockWidget* DockWidget);
 
+protected slots:
+	void toggleView(bool Open);
+
 public:
 	using Super = QFrame;
 
@@ -247,10 +250,9 @@ public slots:
 	void setCurrentIndex(int index);
 
 	/**
-	 * This property controls whether the dock area is open or closed.
-	 * The toogleViewAction triggers this slot.
+	 * Closes the dock area and all dock widgets in this area
 	 */
-	void toggleView(bool Open);
+	void closeArea();
 
 signals:
 	/**

src/DockWidget.cpp

@@ -68,7 +68,6 @@ struct DockWidgetPrivate
 	CDockAreaWidget* DockArea = nullptr;
 	QAction* ToggleViewAction;
 	bool Closed = false;
-	CDockWidget::LayoutFlags LayoutFlags;
 	QScrollArea* ScrollArea = nullptr;
 	QToolBar* ToolBar = nullptr;
 	Qt::ToolButtonStyle ToolBarStyleDocked = Qt::ToolButtonIconOnly;
@@ -182,11 +181,6 @@ void DockWidgetPrivate::updateParentDockArea()
 //============================================================================
 void DockWidgetPrivate::setupToolBar()
 {
-	if (!LayoutFlags.testFlag(CDockWidget::WithTopToolBar))
-	{
-		return;
-	}
-
 	ToolBar = new QToolBar(_this);
 	ToolBar->setObjectName("dockWidgetToolBar");
 	Layout->addWidget(ToolBar);
@@ -201,11 +195,6 @@ void DockWidgetPrivate::setupToolBar()
 //============================================================================
 void DockWidgetPrivate::setupScrollArea()
 {
-	if (!LayoutFlags.testFlag(CDockWidget::WithScrollArea))
-	{
-		return;
-	}
-
 	ScrollArea = new QScrollArea(_this);
 	ScrollArea->setObjectName("dockWidgetScrollArea");
 	ScrollArea->setWidgetResizable(true);
@@ -214,20 +203,16 @@ void DockWidgetPrivate::setupScrollArea()
 
 
 //============================================================================
-CDockWidget::CDockWidget(const QString &title, QWidget *parent,
-	LayoutFlags layoutFlags) :
+CDockWidget::CDockWidget(const QString &title, QWidget *parent) :
 	QFrame(parent),
 	d(new DockWidgetPrivate(this))
 {
-	d->LayoutFlags = layoutFlags;
 	d->Layout = new QBoxLayout(QBoxLayout::TopToBottom);
 	d->Layout->setContentsMargins(0, 0, 0, 0);
 	d->Layout->setSpacing(0);
 	setLayout(d->Layout);
 	setWindowTitle(title);
 	setObjectName(title);
-	d->setupToolBar();
-	d->setupScrollArea();
 
 	d->TabWidget = new CDockWidgetTab(this);
 	d->ToggleViewAction = new QAction(title);
@@ -256,16 +241,14 @@ void CDockWidget::setToggleViewActionChecked(bool Checked)
 
 
 //============================================================================
-void CDockWidget::setWidget(QWidget* widget)
+void CDockWidget::setWidget(QWidget* widget, eInsertMode InsertMode)
 {
-	if (d->LayoutFlags.testFlag(WithScrollArea))
+	QScrollArea* ScrollAreaWidget = qobject_cast<QScrollArea*>(widget);
+	if (ScrollAreaWidget || ForceNoScrollArea != InsertMode)
 	{
+		d->setupScrollArea();
 		d->ScrollArea->setWidget(widget);
 	}
-	else if (d->Widget)
-	{
-		d->Layout->replaceWidget(d->Widget, widget);
-	}
 	else
 	{
 		d->Layout->addWidget(widget);
@@ -545,6 +528,18 @@ QToolBar* CDockWidget::toolBar() const
 }
 
 
+//============================================================================
+QToolBar* CDockWidget::createDefaultToolBar()
+{
+	if (!d->ToolBar)
+	{
+		d->setupToolBar();
+	}
+
+	return d->ToolBar;
+}
+
+
 //============================================================================
 void CDockWidget::setToolBar(QToolBar* ToolBar)
 {

src/DockWidget.h

@@ -152,26 +152,12 @@ private slots:
 		StateFloating
 	};
 
-	/**
-	 * Use the layout flags to configure the layout of the dock widget.
-	 * The content of a dock widget should be resizable do a very small size to
-	 * prevent the dock widget from blocking the resizing. To ensure, that a
-	 * dock widget can be resized very well, it is better to insert the content+
-	 * widget into a scroll area. Enable the WithScrollArea
-	 * feature to use this feature. If your content widget is already in a
-	 * scroll area or if it is a derived class like QTableView, the you should
-	 * disable the WithScrollArea flag.
-	 * Often dock widgets need a ToolBar for control of operations in the dock
-	 * widget. Use the WithToolBar feature to enable a tool bar that is placed
-	 * on top of the dock widget content. If this flag is disabled, the toolBar()
-	 * function returns a nullptr.
-	 */
-	enum LayoutFlag
+	enum eInsertMode
 	{
-		WithScrollArea = 0x01,
-		WithTopToolBar = 0x02
+		AutoScrollArea,
+		ForceScrollArea,
+		ForceNoScrollArea
 	};
-	Q_DECLARE_FLAGS(LayoutFlags, LayoutFlag)
 
 	/**
 	 * This mode configures the behavior of the toggle view action.
@@ -201,8 +187,7 @@ private slots:
 	 * by calling setObjectName() after construction.
 	 * Use the layoutFlags to configure the layout of the dock widget.
 	 */
-	CDockWidget(const QString &title, QWidget* parent = 0,
-		LayoutFlags layoutFlags = 0);
+	CDockWidget(const QString &title, QWidget* parent = 0);
 
 	/**
 	 * Virtual Destructor
@@ -216,8 +201,22 @@ private slots:
 
 	/**
 	 * Sets the widget for the dock widget to widget.
+	 * The InsertMode defines how the widget is inserted into the dock widget.
+	 * The content of a dock widget should be resizable do a very small size to
+	 * prevent the dock widget from blocking the resizing. To ensure, that a
+	 * dock widget can be resized very well, it is better to insert the content+
+	 * widget into a scroll area or to provide a widget that is already a scroll
+	 * area or that contains a scroll area.
+	 * If the InsertMode is AutoScrollArea, the DockWidget tries to automatically
+	 * detect how to insert the given widget. If the widget is derived from
+	 * QScrollArea (i.e. an QAbstractItemView), then the widget is inserted
+	 * directly. If the given widget is not a scroll area, the widget will be
+	 * inserted into a scroll area.
+	 * To force insertion into a scroll area, you can also provide the InsertMode
+	 * ForceScrollArea. To prevent insertion into a scroll area, you can
+	 * provide the InsertMode ForceNoScrollArea
 	 */
-	void setWidget(QWidget* widget);
+	void setWidget(QWidget* widget, eInsertMode InsertMode = AutoScrollArea);
 
 	/**
 	 * Returns the widget for the dock widget. This function returns zero if
@@ -306,17 +305,30 @@ private slots:
 	void setIcon(const QIcon& Icon);
 
 	/**
-	 * Returns tzhe icon that has been assigned to the dock widget
+	 * Returns the icon that has been assigned to the dock widget
 	 */
 	QIcon icon() const;
 
 	/**
 	 * If the WithToolBar layout flag is enabled, then this function returns
 	 * the dock widget toolbar. If the flag is disabled, the function returns
 	 * a nullptr.
+	 * This function returns the dock widget top tool bar.
+	 * If no toolbar is assigned, this function returns nullptr. To get a vaild
+	 * toolbar you either need to create a default empty toolbar via
+	 * createDefaultToolBar() function or you need to assign you custom
+	 * toolbar via setToolBar().
 	 */
 	QToolBar* toolBar() const;
 
+	/**
+	 * If you would like to use the default top tool bar, then call this
+	 * function to create the default tool bar.
+	 * After this function the toolBar() function will return a valid toolBar()
+	 * object.
+	 */
+	QToolBar* createDefaultToolBar();
+
 	/**
 	 * Assign a new tool bar that is shown above the content widget.
 	 * The dock widget will become the owner of the tool bar and deletes it