diff options
Diffstat (limited to 'src/widgets/widgets/qdockarealayout_p.h')
| -rw-r--r-- | src/widgets/widgets/qdockarealayout_p.h | 308 |
1 files changed, 308 insertions, 0 deletions
diff --git a/src/widgets/widgets/qdockarealayout_p.h b/src/widgets/widgets/qdockarealayout_p.h new file mode 100644 index 0000000000..a341ad487b --- /dev/null +++ b/src/widgets/widgets/qdockarealayout_p.h @@ -0,0 +1,308 @@ +/**************************************************************************** +** +** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the QtGui module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** GNU Lesser General Public License Usage +** This file may be used under the terms of the GNU Lesser General Public +** License version 2.1 as published by the Free Software Foundation and +** appearing in the file LICENSE.LGPL included in the packaging of this +** file. Please review the following information to ensure the GNU Lesser +** General Public License version 2.1 requirements will be met: +** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU General +** Public License version 3.0 as published by the Free Software Foundation +** and appearing in the file LICENSE.GPL included in the packaging of this +** file. Please review the following information to ensure the GNU General +** Public License version 3.0 requirements will be met: +** http://www.gnu.org/copyleft/gpl.html. +** +** Other Usage +** Alternatively, this file may be used in accordance with the terms and +** conditions contained in a signed written agreement between you and Nokia. +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#ifndef QDOCKAREALAYOUT_P_H +#define QDOCKAREALAYOUT_P_H + +// +// W A R N I N G +// ------------- +// +// This file is not part of the Qt API. It exists purely as an +// implementation detail. This header file may change from version to +// version without notice, or even be removed. +// +// We mean it. +// + +#include "QtCore/qrect.h" +#include "QtCore/qpair.h" +#include "QtCore/qlist.h" +#include "QtCore/qvector.h" +#include "QtWidgets/qlayout.h" + +#ifndef QT_NO_DOCKWIDGET + +QT_BEGIN_NAMESPACE + +class QLayoutItem; +class QWidget; +class QLayoutItem; +class QDockAreaLayoutInfo; +class QPlaceHolderItem; +class QDockWidget; +class QMainWindow; +class QWidgetAnimator; +class QMainWindowLayout; +struct QLayoutStruct; +class QTabBar; + +// The classes in this file represent the tree structure that represents all the docks +// Also see the wiki internal documentation +// At the root of the tree is: QDockAreaLayout, which handles all 4 sides, so there is only one. +// For each side it has one QDockAreaLayoutInfo child. (See QDockAreaLayout::docks.) +// The QDockAreaLayoutInfo have QDockAreaLayoutItems as children (See QDockAreaLayoutInfo::item_list), +// which then has one QDockAreaLayoutInfo as a child. (QDockAreaLayoutItem::subInfo) or +// a widgetItem if this is a node of the tree (QDockAreaLayoutItem::widgetItem) +// +// A path indetifies uniquely one object in this tree, the first number being the side and all the following +// indexes into the QDockAreaLayoutInfo::item_list. + +struct QDockAreaLayoutItem +{ + enum ItemFlags { NoFlags = 0, GapItem = 1, KeepSize = 2 }; + + QDockAreaLayoutItem(QLayoutItem *_widgetItem = 0); + QDockAreaLayoutItem(QDockAreaLayoutInfo *_subinfo); + QDockAreaLayoutItem(QPlaceHolderItem *_placeHolderItem); + QDockAreaLayoutItem(const QDockAreaLayoutItem &other); + ~QDockAreaLayoutItem(); + + QDockAreaLayoutItem &operator = (const QDockAreaLayoutItem &other); + + bool skip() const; + QSize minimumSize() const; + QSize maximumSize() const; + QSize sizeHint() const; + bool expansive(Qt::Orientation o) const; + bool hasFixedSize(Qt::Orientation o) const; + + QLayoutItem *widgetItem; + QDockAreaLayoutInfo *subinfo; + QPlaceHolderItem *placeHolderItem; + int pos; + int size; + uint flags; +}; + +class Q_AUTOTEST_EXPORT QPlaceHolderItem +{ +public: + QPlaceHolderItem() : hidden(false), window(false) {} + QPlaceHolderItem(QWidget *w); + + QString objectName; + bool hidden, window; + QRect topLevelRect; +}; + +class Q_AUTOTEST_EXPORT QDockAreaLayoutInfo +{ +public: + QDockAreaLayoutInfo(); + QDockAreaLayoutInfo(const int *_sep, QInternal::DockPosition _dockPos, Qt::Orientation _o, + int tbhape, QMainWindow *window); + + QSize minimumSize() const; + QSize maximumSize() const; + QSize sizeHint() const; + QSize size() const; + + bool insertGap(const QList<int> &path, QLayoutItem *dockWidgetItem); + QLayoutItem *plug(const QList<int> &path); + QLayoutItem *unplug(const QList<int> &path); + enum TabMode { NoTabs, AllowTabs, ForceTabs }; + QList<int> gapIndex(const QPoint &pos, bool nestingEnabled, + TabMode tabMode) const; + void remove(const QList<int> &path); + void unnest(int index); + void split(int index, Qt::Orientation orientation, QLayoutItem *dockWidgetItem); + void tab(int index, QLayoutItem *dockWidgetItem); + QDockAreaLayoutItem &item(const QList<int> &path); + QDockAreaLayoutInfo *info(const QList<int> &path); + QDockAreaLayoutInfo *info(QWidget *widget); + + enum { // sentinel values used to validate state data + SequenceMarker = 0xfc, + TabMarker = 0xfa, + WidgetMarker = 0xfb + }; + void saveState(QDataStream &stream) const; + bool restoreState(QDataStream &stream, QList<QDockWidget*> &widgets, bool testing); + + void fitItems(); + bool expansive(Qt::Orientation o) const; + int changeSize(int index, int size, bool below); + QRect itemRect(int index) const; + QRect itemRect(const QList<int> &path) const; + QRect separatorRect(int index) const; + QRect separatorRect(const QList<int> &path) const; + + void clear(); + bool isEmpty() const; + bool hasFixedSize() const; + QList<int> findSeparator(const QPoint &pos) const; + int next(int idx) const; + int prev(int idx) const; + + QList<int> indexOf(QWidget *widget) const; + QList<int> indexOfPlaceHolder(const QString &objectName) const; + + void apply(bool animate); + + void paintSeparators(QPainter *p, QWidget *widget, const QRegion &clip, + const QPoint &mouse) const; + QRegion separatorRegion() const; + int separatorMove(int index, int delta); + + QLayoutItem *itemAt(int *x, int index) const; + QLayoutItem *takeAt(int *x, int index); + void deleteAllLayoutItems(); + + QMainWindowLayout *mainWindowLayout() const; + + const int *sep; + mutable QVector<QWidget*> separatorWidgets; + QInternal::DockPosition dockPos; + Qt::Orientation o; + QRect rect; + QMainWindow *mainWindow; + QList<QDockAreaLayoutItem> item_list; +#ifndef QT_NO_TABBAR + void updateSeparatorWidgets() const; + QSet<QWidget*> usedSeparatorWidgets() const; +#endif //QT_NO_TABBAR + +#ifndef QT_NO_TABBAR + quintptr currentTabId() const; + void setCurrentTab(QWidget *widget); + void setCurrentTabId(quintptr id); + QRect tabContentRect() const; + bool tabbed; + QTabBar *tabBar; + int tabBarShape; + + bool updateTabBar() const; + void setTabBarShape(int shape); + QSize tabBarMinimumSize() const; + QSize tabBarSizeHint() const; + + QSet<QTabBar*> usedTabBars() const; +#endif // QT_NO_TABBAR +}; + +class Q_AUTOTEST_EXPORT QDockAreaLayout +{ +public: + enum { EmptyDropAreaSize = 80 }; // when a dock area is empty, how "wide" is it? + + Qt::DockWidgetArea corners[4]; // use a Qt::Corner for indexing + QRect rect; + QLayoutItem *centralWidgetItem; + QMainWindow *mainWindow; + QRect centralWidgetRect; + QDockAreaLayout(QMainWindow *win); + QDockAreaLayoutInfo docks[4]; + int sep; // separator extent + bool fallbackToSizeHints; //determines if we should use the sizehint for the dock areas (true until the layout is restored or the central widget is set) + mutable QVector<QWidget*> separatorWidgets; + + bool isValid() const; + + enum { DockWidgetStateMarker = 0xfd }; + void saveState(QDataStream &stream) const; + bool restoreState(QDataStream &stream, const QList<QDockWidget*> &widgets, bool testing = false); + + QList<int> indexOfPlaceHolder(const QString &objectName) const; + QList<int> indexOf(QWidget *dockWidget) const; + QList<int> gapIndex(const QPoint &pos) const; + QList<int> findSeparator(const QPoint &pos) const; + + QDockAreaLayoutItem &item(const QList<int> &path); + QDockAreaLayoutInfo *info(const QList<int> &path); + const QDockAreaLayoutInfo *info(const QList<int> &path) const; + QDockAreaLayoutInfo *info(QWidget *widget); + QRect itemRect(const QList<int> &path) const; + QRect separatorRect(int index) const; + QRect separatorRect(const QList<int> &path) const; + + bool insertGap(const QList<int> &path, QLayoutItem *dockWidgetItem); + QLayoutItem *plug(const QList<int> &path); + QLayoutItem *unplug(const QList<int> &path); + void remove(const QList<int> &path); + + void fitLayout(); + + void clear(); + + QSize sizeHint() const; + QSize minimumSize() const; + + void addDockWidget(QInternal::DockPosition pos, QDockWidget *dockWidget, Qt::Orientation orientation); + bool restoreDockWidget(QDockWidget *dockWidget); + void splitDockWidget(QDockWidget *after, QDockWidget *dockWidget, + Qt::Orientation orientation); + void tabifyDockWidget(QDockWidget *first, QDockWidget *second); + + void apply(bool animate); + + void paintSeparators(QPainter *p, QWidget *widget, const QRegion &clip, + const QPoint &mouse) const; + QRegion separatorRegion() const; + int separatorMove(const QList<int> &separator, const QPoint &origin, const QPoint &dest); +#ifndef QT_NO_TABBAR + void updateSeparatorWidgets() const; +#endif //QT_NO_TABBAR + + QLayoutItem *itemAt(int *x, int index) const; + QLayoutItem *takeAt(int *x, int index); + void deleteAllLayoutItems(); + + void getGrid(QVector<QLayoutStruct> *ver_struct_list, + QVector<QLayoutStruct> *hor_struct_list); + void setGrid(QVector<QLayoutStruct> *ver_struct_list, + QVector<QLayoutStruct> *hor_struct_list); + + QRect gapRect(const QList<int> &path) const; + + void keepSize(QDockWidget *w); +#ifndef QT_NO_TABBAR + QSet<QTabBar*> usedTabBars() const; + QSet<QWidget*> usedSeparatorWidgets() const; +#endif //QT_NO_TABBAR + void styleChangedEvent(); +}; + +QT_END_NAMESPACE + +#endif // QT_NO_QDOCKWIDGET + +#endif // QDOCKAREALAYOUT_P_H |