core/DropArea.h

Go to the documentation of this file.

/*
  This file is part of KDDockWidgets.
 
  SPDX-FileCopyrightText: 2019 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.
*/
 
#ifndef KD_DROP_AREA_P_H
#define KD_DROP_AREA_P_H
#pragma once
 
#include "kddockwidgets/docks_export.h"
#include "kddockwidgets/KDDockWidgets.h"
#include "kddockwidgets/core/Layout.h"
 
class TestQtWidgets;
class TestDocks;
 
namespace KDDockWidgets {
 
namespace Core {
 
class Group;
class Draggable;
class DockWidget;
class Separator;
class DropIndicatorOverlay;
class LayoutingSeparator;
struct WindowBeingDragged;
 
class DOCKS_EXPORT DropArea : public Layout
{
    Q_OBJECT
public:
    explicit DropArea(View *parent, MainWindowOptions options, bool isMDIWrapper = false);
    ~DropArea();
 
    void removeHover();
    DropLocation hover(WindowBeingDragged *draggedWindow, Point globalPos);
    bool drop(WindowBeingDragged *droppedWindow, Point globalPos);
    Vector<Core::Group *> groups() const;
 
    Core::Item *centralFrame() const;
    DropIndicatorOverlay *dropIndicatorOverlay() const;
    void addDockWidget(DockWidget *dw, KDDockWidgets::Location location, DockWidget *relativeTo,
                       const InitialOption &initialOption = {});
    void _addDockWidget(DockWidget *dw, KDDockWidgets::Location location, Item *relativeTo,
                        const InitialOption &initialOption);
 
    bool containsDockWidget(DockWidget *) const;
 
    bool hasSingleFloatingGroup() const;
 
    bool hasSingleGroup() const;
 
    Vector<QString> affinities() const;
    void layoutParentContainerEqually(DockWidget *);
 
    bool isMDIWrapper() const;
 
    Core::DockWidget *mdiDockWidgetWrapper() const;
 
    static Core::Group *createCentralGroup(MainWindowOptions options);
 
    void addWidget(View *widget, KDDockWidgets::Location location,
                   Core::Item *relativeToItem = nullptr,
                   const InitialOption &option = DefaultSizeMode::Fair);
 
    void addMultiSplitter(Core::DropArea *splitter, KDDockWidgets::Location location,
                          Core::Group *relativeToGroup = nullptr,
                          const InitialOption &option = DefaultSizeMode::Fair);
 
    Rect rectForDrop(const WindowBeingDragged *wbd, KDDockWidgets::Location location,
                     const Core::Item *relativeTo) const;
 
    bool deserialize(const LayoutSaver::MultiSplitter &) override;
 
    Vector<Core::LayoutingSeparator *> separators() const;
 
    void layoutEqually();
 
    void layoutEqually(Core::ItemBoxContainer *);
 
    int numSideBySide_recursive(Qt::Orientation) const;
 
    Core::ItemBoxContainer *rootItem() const;
 
    DropLocation currentDropLocation() const;
#if defined(DOCKS_DEVELOPER_MODE) || defined(KDDW_FRONTEND_FLUTTER)
public:
#else
private:
#endif
    KDDW_DELETE_COPY_CTOR(DropArea)
    friend class Core::MainWindow;
    friend class Core::Group;
    friend class Core::FloatingWindow;
    friend class DropIndicatorOverlay;
    friend class AnimatedIndicators;
 
    // For debug/hardening
    bool validateInputs(View *widget, KDDockWidgets::Location location,
                        const Core::Item *relativeToItem, const InitialOption &option) const;
 
 
    void setRootItem(Core::ItemBoxContainer *);
 
    int availableLengthForOrientation(Qt::Orientation orientation) const;
 
    Size availableSize() const;
 
    template<typename T>
    bool validateAffinity(T *, Core::Group *acceptingGroup = nullptr) const;
    bool drop(WindowBeingDragged *draggedWindow, Core::Group *acceptingGroup, DropLocation);
    bool drop(View *droppedwindow, KDDockWidgets::Location location,
              Core::Group *relativeTo);
    Core::Group *groupContainingPos(Point globalPos) const;
    Core::Group *centralGroup() const;
    void updateFloatingActions();
 
    class Private;
    Private *const d;
};
}
}
 
#endif