267 lines
8.5 KiB
C++
267 lines
8.5 KiB
C++
/*
|
|
This file is part of KDDockWidgets.
|
|
|
|
SPDX-FileCopyrightText: 2020 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
|
|
Author: Sérgio Martins <sergio.martins@kdab.com>
|
|
|
|
SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
|
|
|
|
Contact KDAB at <info@kdab.com> for commercial licensing options.
|
|
*/
|
|
|
|
/**
|
|
* @file
|
|
* @brief A widget that supports an arbitrary number of splitters (called Separators) in any
|
|
* combination of vertical/horizontal.
|
|
*
|
|
* This is a widget wrapper around the multisplitter layout (Layouting::Item)
|
|
*
|
|
* @author Sérgio Martins \<sergio.martins@kdab.com\>
|
|
*/
|
|
|
|
#ifndef KDDOCKWIDGETS_MULTISPLITTER_P_H
|
|
#define KDDOCKWIDGETS_MULTISPLITTER_P_H
|
|
|
|
#include "docks_export.h"
|
|
#include "multisplitter/Separator_p.h"
|
|
#include "QWidgetAdapter.h"
|
|
#include "KDDockWidgets.h"
|
|
#include "LayoutSaver_p.h"
|
|
|
|
|
|
namespace Layouting {
|
|
class Item;
|
|
class Separator;
|
|
class Widget_qwidget;
|
|
}
|
|
|
|
namespace KDDockWidgets {
|
|
|
|
class MainWindowBase;
|
|
class FloatingWindow;
|
|
class Frame;
|
|
class WindowBeingDragged;
|
|
|
|
/**
|
|
* MultiSplitter is simply a wrapper around Layouting::Item in which the hosted widgets are
|
|
* of class KDDockWidgets::Frame. The stuff in Layouting:: being agnostic and generic, not specific
|
|
* to KDDW.
|
|
*
|
|
* A MultiSplitter is like a QSplitter but supports mixing vertical and horizontal splitters in
|
|
* any combination.
|
|
*
|
|
* It supports adding a widget to the left/top/bottom/right of the whole MultiSplitter or adding
|
|
* relative to a single widget.
|
|
*/
|
|
class DOCKS_EXPORT MultiSplitter
|
|
: public LayoutGuestWidget
|
|
{
|
|
Q_OBJECT
|
|
public:
|
|
explicit MultiSplitter(QWidgetOrQuick *parent = nullptr);
|
|
~MultiSplitter() override;
|
|
bool isInMainWindow() const;
|
|
MainWindowBase* mainWindow() const;
|
|
FloatingWindow* floatingWindow() const;
|
|
|
|
/**
|
|
* @brief Adds a widget to this MultiSplitter.
|
|
*/
|
|
void addWidget(QWidgetOrQuick *widget, KDDockWidgets::Location location,
|
|
Frame *relativeTo = nullptr, DefaultSizeMode = DefaultSizeMode::Fair, AddingOption option = {});
|
|
|
|
/**
|
|
* Adds an entire MultiSplitter into this layout. The donor MultiSplitter will be deleted
|
|
* after all its Frames are stolen. All added Frames will preserve their original layout, so,
|
|
* if widgetFoo was at the left of widgetBar when in the donor splitter, then it will still be at left
|
|
* of widgetBar when the whole splitter is dropped into this one.
|
|
*/
|
|
void addMultiSplitter(MultiSplitter *splitter, KDDockWidgets::Location location,
|
|
Frame *relativeTo = nullptr, DefaultSizeMode = DefaultSizeMode::Fair);
|
|
|
|
/**
|
|
* @brief Removes an item from this MultiSplitter.
|
|
*/
|
|
void removeItem(Layouting::Item *item);
|
|
|
|
/**
|
|
* @brief Returns true if this layout contains the specified item.
|
|
*/
|
|
bool contains(const Layouting::Item *) const;
|
|
|
|
/**
|
|
* @brief Returns true if this layout contains the specified frame.
|
|
*/
|
|
bool contains(const Frame *) const;
|
|
|
|
/**
|
|
* @brief Returns the number of Item objects in this layout.
|
|
* This includes non-visible (placeholder) Items too.
|
|
* @sa visibleCount
|
|
*/
|
|
int count() const;
|
|
|
|
/**
|
|
* @brief Returns the number of visible Items in this layout.
|
|
* Which is @ref count minus @ref placeholderCount
|
|
* @sa count
|
|
*/
|
|
int visibleCount() const;
|
|
|
|
/**
|
|
* @brief Returns the number of placeholder items in this layout.
|
|
* This is the same as @ref count minus @ref visibleCount
|
|
* @sa count, visibleCount
|
|
*/
|
|
int placeholderCount() const;
|
|
|
|
/**
|
|
* @brief The list of items in this layout.
|
|
*/
|
|
const QVector<Layouting::Item*> items() const;
|
|
|
|
/**
|
|
* @brief Returns the root container item
|
|
*/
|
|
Layouting::ItemContainer *rootItem() const;
|
|
|
|
/**
|
|
* Called by the indicators, so they draw the drop rubber band at the correct place.
|
|
* The rect for the rubberband when dropping a widget at the specified location.
|
|
* Excludes the Separator thickness, result is actually smaller than what needed. In other words,
|
|
* the result will be exactly the same as the geometry the widget will get.
|
|
*/
|
|
QRect rectForDrop(const WindowBeingDragged *wbd, KDDockWidgets::Location location,
|
|
const Layouting::Item *relativeTo) const;
|
|
|
|
bool deserialize(const LayoutSaver::MultiSplitter &);
|
|
LayoutSaver::MultiSplitter serialize() const;
|
|
|
|
///@brief returns the list of separators
|
|
QVector<Layouting::Separator*> separators() const;
|
|
|
|
/**
|
|
* @brief Updates the min size of this layout.
|
|
*/
|
|
void updateSizeConstraints();
|
|
|
|
/**
|
|
* @brief setter for the contents size
|
|
* The "contents size" is just the size() of this layout. However, since resizing
|
|
* QWidgets is async and we need it to be sync. As sometimes adding widgets will increase
|
|
* the MultiSplitter size (due to widget's min-size constraints).
|
|
*/
|
|
void setLayoutSize(QSize);
|
|
|
|
/**
|
|
* @brief returns the contents width.
|
|
* Usually it's the same width as the respective parent MultiSplitter.
|
|
*/
|
|
int width() const { return size().width(); }
|
|
|
|
/**
|
|
* @brief returns the contents height.
|
|
* Usually it's the same height as the respective parent MultiSplitter.
|
|
*/
|
|
int height() const { return size().height(); }
|
|
|
|
/**
|
|
* @brief returns the layout's minimum size
|
|
* @ref setLayoutMinimumSize
|
|
*/
|
|
QSize layoutMinimumSize() const;
|
|
|
|
/**
|
|
* @brief getter for the size
|
|
*/
|
|
QSize size() const;
|
|
|
|
/// @brief Runs some sanity checks. Returns true if everything is OK
|
|
bool checkSanity() const;
|
|
|
|
/// @brief dumps the layout to stderr
|
|
void dumpLayout() const;
|
|
|
|
/**
|
|
* @brief returns the Item that holds @p frame in this layout
|
|
*/
|
|
Layouting::Item *itemForFrame(const Frame *frame) const;
|
|
|
|
/**
|
|
* @brief Returns this list of Frame objects contained in this layout
|
|
*/
|
|
QList<Frame*> frames() const;
|
|
|
|
/// @brief Returns the list of dock widgets contained in this layout
|
|
QVector<DockWidgetBase*> dockWidgets() const;
|
|
|
|
/// @brief restores the dockwidget @p dw to its previous position
|
|
void restorePlaceholder(DockWidgetBase *dw, Layouting::Item *, int tabIndex);
|
|
|
|
/// @brief See docs for MainWindowBase::layoutEqually()
|
|
void layoutEqually();
|
|
|
|
/// @brief overload that just resizes widgets within a sub-tree
|
|
void layoutEqually(Layouting::ItemContainer *);
|
|
|
|
Q_SIGNALS:
|
|
void visibleWidgetCountChanged(int count);
|
|
|
|
protected:
|
|
void onLayoutRequest() override;
|
|
bool onResize(QSize newSize) override;
|
|
private:
|
|
bool m_inResizeEvent = false;
|
|
|
|
friend class TestDocks;
|
|
|
|
/**
|
|
* @brief returns the frames contained in @p frameOrMultiSplitter
|
|
* If frameOrMultiSplitter is a Frame, it returns a list of 1 element, with that frame
|
|
* If frameOrMultiSplitter is a MultiSplitter then it returns a list of all frames it contains
|
|
*/
|
|
QList<Frame*> framesFrom(QWidgetOrQuick *frameOrMultiSplitter) const;
|
|
|
|
|
|
// For debug/hardening
|
|
bool validateInputs(QWidgetOrQuick *widget, KDDockWidgets::Location location,
|
|
const Frame *relativeToFrame, AddingOption option) const;
|
|
|
|
/**
|
|
* @brief Removes unneeded placeholder items when adding new frames.
|
|
*
|
|
* A floating frame A might have a placeholder in the main window (for example to remember its position on the Left),
|
|
* but then the user might attach it to the right, so the left placeholder is no longer need.
|
|
* Right before adding the frame to the right we remove the left placeholder, otherwise it's unrefed while we're adding
|
|
* causing a segfault. So what this does is making the unrefing happen a bit earlier.
|
|
*/
|
|
void unrefOldPlaceholders(const QList<Frame*> &framesBeingAdded) const;
|
|
|
|
/**
|
|
* @brief setter for the minimum size
|
|
* @ref minimumSize
|
|
*/
|
|
void setLayoutMinimumSize(QSize);
|
|
|
|
void setRootItem(Layouting::ItemContainer *);
|
|
|
|
/**
|
|
* @brief Like @ref availableLengthForDrop but just returns the total available width or height (depending on @p orientation)
|
|
* So no need to receive any location.
|
|
* @param orientation If Qt::Vertical then returns the available height. Width otherwise.
|
|
*/
|
|
int availableLengthForOrientation(Qt::Orientation orientation) const;
|
|
|
|
/**
|
|
* @brief Equivalent to @ref availableLengthForOrientation but returns for both orientations.
|
|
* width is for Qt::Vertical.
|
|
*/
|
|
QSize availableSize() const;
|
|
|
|
Layouting::ItemContainer *m_rootItem = nullptr;
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|