Added support for setting the DockWidget icon - this icon is shown in the title bar or when using the ToggleViewAction

2025-01-12 00:00:25 +08:00 · 2018-01-02 08:01:23 +01:00 · 2018-01-02 08:01:23 +01:00 · e878bb47ed
commit e878bb47ed
parent dae852d9f9
8 changed files with 116 additions and 7 deletions
--- a/.cproject
+++ b/.cproject
@ -24,6 +24,7 @@
 									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/QtAdvancedDockingSystem/demo}&quot;"/>
 									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/QtAdvancedDockingSystem/src}&quot;"/>
 									<listOptionValue builtIn="false" value="&quot;${QTDIR}/include&quot;"/>
+									<listOptionValue builtIn="false" value="&quot;${QTDIR}/include/QtCore&quot;"/>
 								</option>
 								<inputType id="cdt.managedbuild.tool.gnu.assembler.input.1249325593" superClass="cdt.managedbuild.tool.gnu.assembler.input"/>
 							</tool>
@ -33,8 +34,9 @@
 									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/QtAdvancedDockingSystem/src}&quot;"/>
 									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/QtAdvancedDockingSystem/demo}&quot;"/>
 									<listOptionValue builtIn="false" value="&quot;${QTDIR}/include&quot;"/>
+									<listOptionValue builtIn="false" value="&quot;${QTDIR}/include/QtCore&quot;"/>
 								</option>
-								<option id="gnu.cpp.compiler.option.preprocessor.def.56223209" name="Defined symbols (-D)" superClass="gnu.cpp.compiler.option.preprocessor.def" useByScannerDiscovery="false" valueType="definedSymbols"/>
+								<option id="gnu.cpp.compiler.option.preprocessor.def.56223209" name="Defined symbols (-D)" superClass="gnu.cpp.compiler.option.preprocessor.def" useByScannerDiscovery="false"/>
 								<inputType id="cdt.managedbuild.tool.gnu.cpp.compiler.input.1318830536" superClass="cdt.managedbuild.tool.gnu.cpp.compiler.input"/>
 							</tool>
 							<tool id="cdt.managedbuild.tool.gnu.c.compiler.mingw.base.389117097" name="GCC C Compiler" superClass="cdt.managedbuild.tool.gnu.c.compiler.mingw.base">
@ -42,8 +44,9 @@
 									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/QtAdvancedDockingSystem/demo}&quot;"/>
 									<listOptionValue builtIn="false" value="&quot;${workspace_loc:/QtAdvancedDockingSystem/src}&quot;"/>
 									<listOptionValue builtIn="false" value="&quot;${QTDIR}/include&quot;"/>
+									<listOptionValue builtIn="false" value="&quot;${QTDIR}/include/QtCore&quot;"/>
 								</option>
-								<option id="gnu.c.compiler.option.preprocessor.def.symbols.806805509" name="Defined symbols (-D)" superClass="gnu.c.compiler.option.preprocessor.def.symbols" useByScannerDiscovery="false" valueType="definedSymbols"/>
+								<option id="gnu.c.compiler.option.preprocessor.def.symbols.806805509" name="Defined symbols (-D)" superClass="gnu.c.compiler.option.preprocessor.def.symbols" useByScannerDiscovery="false"/>
 								<inputType id="cdt.managedbuild.tool.gnu.c.compiler.input.1568363924" superClass="cdt.managedbuild.tool.gnu.c.compiler.input"/>
 							</tool>
 							<tool id="cdt.managedbuild.tool.gnu.c.linker.mingw.base.1734874312" name="MinGW C Linker" superClass="cdt.managedbuild.tool.gnu.c.linker.mingw.base"/>
--- a/.settings/language.settings.xml
+++ b/.settings/language.settings.xml
@ -2,7 +2,7 @@
 <project>
 	<configuration id="cdt.managedbuild.toolchain.gnu.mingw.base.1119687795" name="Default">
 		<extension point="org.eclipse.cdt.core.LanguageSettingsProvider">
-			<provider class="org.eclipse.cdt.managedbuilder.internal.language.settings.providers.GCCBuiltinSpecsDetectorMinGW" console="false" env-hash="-1519829723851667984" id="org.eclipse.cdt.managedbuilder.core.GCCBuiltinSpecsDetectorMinGW" keep-relative-paths="false" name="CDT GCC Built-in Compiler Settings MinGW" parameter="${COMMAND} ${FLAGS} -E -P -v -dD -std=c++14 &quot;${INPUTS}&quot;" prefer-non-shared="true">
+			<provider class="org.eclipse.cdt.managedbuilder.internal.language.settings.providers.GCCBuiltinSpecsDetectorMinGW" console="false" env-hash="-550644722333667955" id="org.eclipse.cdt.managedbuilder.core.GCCBuiltinSpecsDetectorMinGW" keep-relative-paths="false" name="CDT GCC Built-in Compiler Settings MinGW" parameter="${COMMAND} ${FLAGS} -E -P -v -dD -std=c++14 &quot;${INPUTS}&quot;" prefer-non-shared="true">
 				<language-scope id="org.eclipse.cdt.core.gcc"/>
 				<language-scope id="org.eclipse.cdt.core.g++"/>
 			</provider>
--- a/demo/mainwindow.cpp
+++ b/demo/mainwindow.cpp
@ -58,6 +58,7 @@ static ads::CDockWidget* createCalendarDockWidget(QMenu* ViewMenu)
 	ads::CDockWidget* DockWidget = new ads::CDockWidget(QString("Calendar %1").arg(CalendarCount++));
 	DockWidget->setWidget(w);
 	DockWidget->setObjectName(DockWidget->windowTitle());
+	DockWidget->setToggleViewActionMode(ads::CDockWidget::ActionModeShow);
 	ViewMenu->addAction(DockWidget->toggleViewAction());
 	return DockWidget;
 }
@ -84,6 +85,10 @@ MainWindow::MainWindow(QWidget *parent) :
 	ui(new Ui::MainWindow)
 {
 	ui->setupUi(this);
+	ui->toolBar->addAction(ui->actionSaveState);
+	ui->actionSaveState->setIcon(style()->standardIcon(QStyle::SP_DialogSaveButton));
+	ui->toolBar->addAction(ui->actionRestoreState);
+	ui->actionRestoreState->setIcon(style()->standardIcon(QStyle::SP_DialogOpenButton));

 	m_DockManager = new ads::CDockManager(this);
 	createContent();
@ -102,10 +107,11 @@ void MainWindow::createContent()
 	// Test container docking
 	QMenu* ViewMenu = this->ui->menuView;
 	auto DockWidget = createCalendarDockWidget(ViewMenu);
+	DockWidget->setIcon(style()->standardIcon(QStyle::SP_DialogOpenButton));
 	DockWidget->setFeatures(DockWidget->features().setFlag(ads::CDockWidget::DockWidgetClosable, false));
 	m_DockManager->addDockWidget(ads::LeftDockWidgetArea, DockWidget);
 	m_DockManager->addDockWidget(ads::LeftDockWidgetArea, createLongTextLabelDockWidget(ViewMenu));
-	/*m_DockManager->addDockWidget(ads::BottomDockWidgetArea, createFileSystemTreeDockWidget(ViewMenu));
+	m_DockManager->addDockWidget(ads::BottomDockWidgetArea, createFileSystemTreeDockWidget(ViewMenu));
 	auto TopDockArea = m_DockManager->addDockWidget(ads::TopDockWidgetArea, createFileSystemTreeDockWidget(ViewMenu));
 	DockWidget = createCalendarDockWidget(ViewMenu);
 	DockWidget->setFeatures(DockWidget->features().setFlag(ads::CDockWidget::DockWidgetClosable, false));
@ -116,7 +122,7 @@ void MainWindow::createContent()
 	m_DockManager->addDockWidget(ads::TopDockWidgetArea, createLongTextLabelDockWidget(ViewMenu), RighDockArea);
 	auto BottomDockArea = m_DockManager->addDockWidget(ads::BottomDockWidgetArea, createLongTextLabelDockWidget(ViewMenu), RighDockArea);
 	m_DockManager->addDockWidget(ads::RightDockWidgetArea, createLongTextLabelDockWidget(ViewMenu), RighDockArea);
-	m_DockManager->addDockWidget(ads::CenterDockWidgetArea, createLongTextLabelDockWidget(ViewMenu), BottomDockArea);*/
+	m_DockManager->addDockWidget(ads::CenterDockWidgetArea, createLongTextLabelDockWidget(ViewMenu), BottomDockArea);
 }


--- a/demo/mainwindow.ui
+++ b/demo/mainwindow.ui
@ -13,6 +13,9 @@
  <property name="windowTitle">
   <string>MainWindow</string>
  </property>
+  <property name="dockOptions">
+   <set>QMainWindow::AllowTabbedDocks</set>
+  </property>
  <widget class="QWidget" name="centralWidget"/>
  <widget class="QStatusBar" name="statusBar"/>
  <widget class="QMenuBar" name="menuBar">
@ -46,6 +49,17 @@
   <addaction name="menuView"/>
   <addaction name="menuAbout"/>
  </widget>
+  <widget class="QToolBar" name="toolBar">
+   <property name="windowTitle">
+    <string>toolBar</string>
+   </property>
+   <attribute name="toolBarArea">
+    <enum>TopToolBarArea</enum>
+   </attribute>
+   <attribute name="toolBarBreak">
+    <bool>false</bool>
+   </attribute>
+  </widget>
  <action name="actionExit">
   <property name="text">
    <string>Exit</string>
--- a/src/DockWidget.cpp
+++ b/src/DockWidget.cpp
@ -330,9 +330,31 @@ QAction* CDockWidget::toggleViewAction() const
 }


+//============================================================================
+void CDockWidget::setToggleViewActionMode(eToggleViewActionMode Mode)
+{
+	if (ActionModeToggle == Mode)
+	{
+		d->ToggleViewAction->setCheckable(true);
+		d->ToggleViewAction->setIcon(QIcon());
+	}
+	else
+	{
+		d->ToggleViewAction->setCheckable(false);
+		d->ToggleViewAction->setIcon(d->TitleWidget->icon());
+	}
+}
+
+
 //============================================================================
 void CDockWidget::toggleView(bool Open)
 {
+	QAction* Sender = qobject_cast<QAction*>(sender());
+	if (Sender == d->ToggleViewAction && !d->ToggleViewAction->isCheckable())
+	{
+		Open = true;
+	}
+
 	if (Open)
 	{
 		d->showDockWidget();
@ -391,6 +413,17 @@ bool CDockWidget::event(QEvent *e)
 }


+//============================================================================
+void CDockWidget::setIcon(const QIcon& Icon)
+{
+	d->TitleWidget->setIcon(Icon);
+	if (!d->ToggleViewAction->isCheckable())
+	{
+		d->ToggleViewAction->setIcon(Icon);
+	}
+}
+
+

 } // namespace ads

--- a/src/DockWidget.h
+++ b/src/DockWidget.h
@ -115,6 +115,20 @@ public:
 		StateFloating
 	};

+	/**
+	 * This mode configures the behavior of the toggle view action.
+	 * If the mode if ActionModeToggle, then the toggle view action is
+	 * a checkable action to show / hide the dock widget. If the mode
+	 * is ActionModeShow, then the action is not checkable an it will
+	 * always show the dock widget if clicked. If the mode is ActionModeShow,
+	 * the user can only close the DockWidget with the close button.
+	 */
+	enum eToggleViewActionMode
+	{
+		ActionModeToggle,//!< ActionModeToggle
+		ActionModeShow   //!< ActionModeShow
+	};
+
 	/**
 	 * Default Constructor
 	 */
@ -189,16 +203,28 @@ public:
 	QAction* toggleViewAction() const;

 	/**
-	 * Emits titleChanged signal if title change event occures
+	 * Configures the behavior of the toggle view action.
+	 * \see eToggleViewActionMode for a detailed description
+	 */
+	void setToggleViewActionMode(eToggleViewActionMode Mode);
+
+	/**
+	 * Emits titleChanged signal if title change event occurs
 	 */
 	virtual bool event(QEvent *e) override;

+	/**
+	 * Sets the dock widget icon that is shown in tabs and in toggle view
+	 * actions
+	 */
+	void setIcon(const QIcon& Icon);
+
 public slots:
 	/**
 	 * This property controls whether the dock widget is open or closed.
 	 * The toogleViewAction triggers this slot
 	 */
-	void toggleView(bool Open);
+	void toggleView(bool Open = true);

 signals:
 	/**
--- a/src/DockWidgetTitleBar.cpp
+++ b/src/DockWidgetTitleBar.cpp
@ -73,6 +73,7 @@ struct DockWidgetTitleBarPrivate
 	CDockAreaWidget* DockArea = nullptr;
 	eDragState DragState = DraggingInactive;
 	CFloatingDockContainer* FloatingWidget = nullptr;
+	QIcon Icon;

 	/**
 	 * Private data constructor
@ -347,6 +348,22 @@ CDockAreaWidget* CDockWidgetTitleBar::dockAreaWidget() const
 {
 	return d->DockArea;
 }
+
+
+//============================================================================
+void CDockWidgetTitleBar::setIcon(const QIcon& Icon)
+{
+	d->Icon = Icon;
+	d->IconLabel->setPixmap(Icon.pixmap(this->windowHandle(), QSize(16, 16)));
+	d->IconLabel->setVisible(true);
+}
+
+
+//============================================================================
+const QIcon& CDockWidgetTitleBar::icon() const
+{
+	return d->Icon;
+}
 } // namespace ads

 //---------------------------------------------------------------------------
--- a/src/DockWidgetTitleBar.h
+++ b/src/DockWidgetTitleBar.h
@ -96,6 +96,16 @@ public:
 	 */
 	CDockAreaWidget* dockAreaWidget() const;

+	/**
+	 * Sets the icon to show in title bar
+	 */
+	void setIcon(const QIcon& Icon);
+
+	/**
+	 * Returns the icon
+	 */
+	const QIcon& icon() const;
+
 signals:
 	void activeTabChanged();
 	void clicked();