mirror of
https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System.git
synced 2025-03-16 11:09:50 +08:00
1a11e5ddcd
Adde option to set a dock widget as central widget. It influences resizing behavior of the splitters. The central widget will be stretched with the main window and remaing dock widgets and threir respective areas will be resized only vertically if docked left or right and horizontaly if docked top or bottom
290 lines
9.1 KiB
C++
290 lines
9.1 KiB
C++
#ifndef DockContainerWidgetH
|
|
#define DockContainerWidgetH
|
|
/*******************************************************************************
|
|
** Qt Advanced Docking System
|
|
** Copyright (C) 2017 Uwe Kindler
|
|
**
|
|
** This library is free software; you can redistribute it and/or
|
|
** modify it under the terms of the GNU Lesser General Public
|
|
** License as published by the Free Software Foundation; either
|
|
** version 2.1 of the License, or (at your option) any later version.
|
|
**
|
|
** This library is distributed in the hope that it will be useful,
|
|
** but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
** Lesser General Public License for more details.
|
|
**
|
|
** You should have received a copy of the GNU Lesser General Public
|
|
** License along with this library; If not, see <http://www.gnu.org/licenses/>.
|
|
******************************************************************************/
|
|
|
|
|
|
//============================================================================
|
|
/// \file DockContainerWidget.h
|
|
/// \author Uwe Kindler
|
|
/// \date 24.02.2017
|
|
/// \brief Declaration of CDockContainerWidget class
|
|
//============================================================================
|
|
|
|
|
|
//============================================================================
|
|
// INCLUDES
|
|
//============================================================================
|
|
#include <QFrame>
|
|
|
|
#include "ads_globals.h"
|
|
#include "DockWidget.h"
|
|
|
|
QT_FORWARD_DECLARE_CLASS(QXmlStreamWriter)
|
|
|
|
|
|
namespace ads
|
|
{
|
|
class DockContainerWidgetPrivate;
|
|
class CDockAreaWidget;
|
|
class CDockWidget;
|
|
class CDockManager;
|
|
struct DockManagerPrivate;
|
|
class CFloatingDockContainer;
|
|
struct FloatingDockContainerPrivate;
|
|
class CFloatingDragPreview;
|
|
struct FloatingDragPreviewPrivate;
|
|
class CDockingStateReader;
|
|
|
|
/**
|
|
* Container that manages a number of dock areas with single dock widgets
|
|
* or tabyfied dock widgets in each area.
|
|
* Each window that support docking has a DockContainerWidget. That means
|
|
* the main application window and all floating windows contain a
|
|
* DockContainerWidget instance.
|
|
*/
|
|
class ADS_EXPORT CDockContainerWidget : public QFrame
|
|
{
|
|
Q_OBJECT
|
|
private:
|
|
DockContainerWidgetPrivate* d; ///< private data (pimpl)
|
|
friend class DockContainerWidgetPrivate;
|
|
friend class CDockManager;
|
|
friend struct DockManagerPrivate;
|
|
friend class CDockAreaWidget;
|
|
friend struct DockAreaWidgetPrivate;
|
|
friend class CFloatingDockContainer;
|
|
friend struct FloatingDockContainerPrivate;
|
|
friend class CDockWidget;
|
|
friend class CFloatingDragPreview;
|
|
friend struct FloatingDragPreviewPrivate;
|
|
|
|
protected:
|
|
/**
|
|
* Handles activation events to update zOrderIndex
|
|
*/
|
|
virtual bool event(QEvent *e) override;
|
|
|
|
/**
|
|
* Access function for the internal root splitter
|
|
*/
|
|
QSplitter* rootSplitter() const;
|
|
|
|
/**
|
|
* Helper function for creation of the root splitter
|
|
*/
|
|
void createRootSplitter();
|
|
|
|
/**
|
|
* Drop floating widget into the container
|
|
*/
|
|
void dropFloatingWidget(CFloatingDockContainer* FloatingWidget, const QPoint& TargetPos);
|
|
|
|
/**
|
|
* Drop a dock area or a dock widget given in widget parameter.
|
|
* If the TargetAreaWidget is a nullptr, then the DropArea indicates
|
|
* the drop area for the container. If the given TargetAreaWidget is not
|
|
* a nullptr, then the DropArea indicates the drop area in the given
|
|
* TargetAreaWidget
|
|
*/
|
|
void dropWidget(QWidget* Widget, DockWidgetArea DropArea, CDockAreaWidget* TargetAreaWidget);
|
|
|
|
/**
|
|
* Adds the given dock area to this container widget
|
|
*/
|
|
void addDockArea(CDockAreaWidget* DockAreaWidget, DockWidgetArea area = CenterDockWidgetArea);
|
|
|
|
/**
|
|
* Removes the given dock area from this container
|
|
*/
|
|
void removeDockArea(CDockAreaWidget* area);
|
|
|
|
/**
|
|
* Saves the state into the given stream
|
|
*/
|
|
void saveState(QXmlStreamWriter& Stream) const;
|
|
|
|
/**
|
|
* Restores the state from given stream.
|
|
* If Testing is true, the function only parses the data from the given
|
|
* stream but does not restore anything. You can use this check for
|
|
* faulty files before you start restoring the state
|
|
*/
|
|
bool restoreState(CDockingStateReader& Stream, bool Testing);
|
|
|
|
/**
|
|
* This function returns the last added dock area widget for the given
|
|
* area identifier or 0 if no dock area widget has been added for the given
|
|
* area
|
|
*/
|
|
CDockAreaWidget* lastAddedDockAreaWidget(DockWidgetArea area) const;
|
|
|
|
/**
|
|
* If hasSingleVisibleDockWidget() returns true, this function returns the
|
|
* one and only visible dock widget. Otherwise it returns a nullptr.
|
|
*/
|
|
CDockWidget* topLevelDockWidget() const;
|
|
|
|
/**
|
|
* Returns the top level dock area.
|
|
*/
|
|
CDockAreaWidget* topLevelDockArea() const;
|
|
|
|
/**
|
|
* This function returns a list of all dock widgets in this floating widget.
|
|
* It may be possible, depending on the implementation, that dock widgets,
|
|
* that are not visible to the user have no parent widget. Therefore simply
|
|
* calling findChildren() would not work here. Therefore this function
|
|
* iterates over all dock areas and creates a list that contains all
|
|
* dock widgets returned from all dock areas.
|
|
*/
|
|
QList<CDockWidget*> dockWidgets() const;
|
|
|
|
/**
|
|
* This finction forces the dock container widget to update handles of splitters
|
|
* based on resize modes of dock widgets aontained in the container.
|
|
*/
|
|
void updateSplitterHandles(QSplitter* splitter);
|
|
|
|
public:
|
|
/**
|
|
* Default Constructor
|
|
*/
|
|
CDockContainerWidget(CDockManager* DockManager, QWidget* parent = 0);
|
|
|
|
/**
|
|
* Virtual Destructor
|
|
*/
|
|
virtual ~CDockContainerWidget();
|
|
|
|
/**
|
|
* Adds dockwidget into the given area.
|
|
* If DockAreaWidget is not null, then the area parameter indicates the area
|
|
* into the DockAreaWidget. If DockAreaWidget is null, the Dockwidget will
|
|
* be dropped into the container.
|
|
* \return Returns the dock area widget that contains the new DockWidget
|
|
*/
|
|
CDockAreaWidget* addDockWidget(DockWidgetArea area, CDockWidget* Dockwidget,
|
|
CDockAreaWidget* DockAreaWidget = nullptr);
|
|
|
|
/**
|
|
* Removes dockwidget
|
|
*/
|
|
void removeDockWidget(CDockWidget* Dockwidget);
|
|
|
|
/**
|
|
* Returns the current zOrderIndex
|
|
*/
|
|
virtual unsigned int zOrderIndex() const;
|
|
|
|
/**
|
|
* This function returns true if this container widgets z order index is
|
|
* higher than the index of the container widget given in Other parameter
|
|
*/
|
|
bool isInFrontOf(CDockContainerWidget* Other) const;
|
|
|
|
/**
|
|
* Returns the dock area at the given global position or 0 if there is no
|
|
* dock area at this position
|
|
*/
|
|
CDockAreaWidget* dockAreaAt(const QPoint& GlobalPos) const;
|
|
|
|
/**
|
|
* Returns the dock area at the given Index or 0 if the index is out of
|
|
* range
|
|
*/
|
|
CDockAreaWidget* dockArea(int Index) const;
|
|
|
|
/**
|
|
* Returns the list of dock areas that are not closed
|
|
* If all dock widgets in a dock area are closed, the dock area will be closed
|
|
*/
|
|
QList<CDockAreaWidget*> openedDockAreas() const;
|
|
|
|
/**
|
|
* This function returns true if this dock area has only one single
|
|
* visible dock widget.
|
|
* A top level widget is a real floating widget. Only the isFloating()
|
|
* function of top level widgets may returns true.
|
|
*/
|
|
bool hasTopLevelDockWidget() const;
|
|
|
|
/**
|
|
* Returns the number of dock areas in this container
|
|
*/
|
|
int dockAreaCount() const;
|
|
|
|
/**
|
|
* Returns the number of visible dock areas
|
|
*/
|
|
int visibleDockAreaCount() const;
|
|
|
|
/**
|
|
* This function returns true, if this container is in a floating widget
|
|
*/
|
|
bool isFloating() const;
|
|
|
|
/**
|
|
* Dumps the layout for debugging purposes
|
|
*/
|
|
void dumpLayout();
|
|
|
|
/**
|
|
* This functions returns the dock widget features of all dock widget in
|
|
* this container.
|
|
* A bitwise and is used to combine the flags of all dock widgets. That
|
|
* means, if only dock widget does not support a certain flag, the whole
|
|
* dock are does not support the flag.
|
|
*/
|
|
CDockWidget::DockWidgetFeatures features() const;
|
|
|
|
/**
|
|
* If this dock container is in a floating widget, this function returns
|
|
* the floating widget.
|
|
* Else, it returns a nullptr.
|
|
*/
|
|
CFloatingDockContainer* floatingWidget() const;
|
|
|
|
/**
|
|
* Call this function to close all dock areas except the KeepOpenArea
|
|
*/
|
|
void closeOtherAreas(CDockAreaWidget* KeepOpenArea);
|
|
|
|
signals:
|
|
/**
|
|
* This signal is emitted if one or multiple dock areas has been added to
|
|
* the internal list of dock areas.
|
|
* If multiple dock areas are inserted, this signal is emitted only once
|
|
*/
|
|
void dockAreasAdded();
|
|
|
|
/**
|
|
* This signal is emitted if one or multiple dock areas has been removed
|
|
*/
|
|
void dockAreasRemoved();
|
|
|
|
/**
|
|
* This signal is emitted if a dock area is opened or closed via
|
|
* toggleView() function
|
|
*/
|
|
void dockAreaViewToggled(ads::CDockAreaWidget* DockArea, bool Open);
|
|
}; // class DockContainerWidget
|
|
} // namespace ads
|
|
//-----------------------------------------------------------------------------
|
|
#endif // DockContainerWidgetH
|