Layout.h

Go to the documentation of this file.

/*
  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.
*/
 
#ifndef KDDOCKWIDGETS_LAYOUT_P_H
#define KDDOCKWIDGETS_LAYOUT_P_H
 
#pragma once
 
#include "kddockwidgets/core/View.h"
#include "kddockwidgets/docks_export.h"
#include "kddockwidgets/KDDockWidgets.h"
#include "kddockwidgets/LayoutSaver.h"
#include "kddockwidgets/QtCompat_p.h"
 
namespace KDDockWidgets {
 
namespace Core {
class LayoutingHost;
class Group;
class FloatingWindow;
class DockWidget;
class MainWindow;
class Item;
class ItemContainer;
class Separator;
 
class DOCKS_EXPORT Layout : public Controller
{
    Q_OBJECT
public:
    explicit Layout(ViewType, View *);
    ~Layout();
 
    bool isInMainWindow(bool honourNesting = false) const;
 
    Core::MainWindow *mainWindow(bool honourNesting = false) const;
 
    Core::FloatingWindow *floatingWindow() const;
 
    Size layoutMinimumSize() const;
 
    Size layoutMaximumSizeHint() const;
 
    int layoutWidth() const
    {
        return layoutSize().width();
    }
 
    int layoutHeight() const
    {
        return layoutSize().height();
    }
 
    Size layoutSize() const;
 
    bool checkSanity() const;
 
    void clearLayout();
 
    void dumpLayout() const;
 
    void setLayoutSize(Size);
 
 
    void restorePlaceholder(Core::DockWidget *dw, Core::Item *, int tabIndex);
 
    Vector<Core::Item *> items() const;
 
    bool containsItem(const Core::Item *) const;
 
    bool containsGroup(const Core::Group *) const;
 
    int count() const;
 
    int visibleCount() const;
 
    int placeholderCount() const;
 
    Core::Item *itemForGroup(const Core::Group *group) const;
 
    Vector<Core::Group *> groups() const;
 
    Vector<Core::DockWidget *> dockWidgets() const;
 
    void removeItem(Core::Item *item);
 
    void updateSizeConstraints();
 
    virtual bool deserialize(const LayoutSaver::MultiSplitter &);
    LayoutSaver::MultiSplitter serialize() const;
 
    Core::DropArea *asDropArea() const;
    Core::MDILayout *asMDILayout() const;
 
    void viewAboutToBeDeleted();
 
    Core::ItemContainer *rootItem() const;
 
    void onCloseEvent(CloseEvent *);
 
    LayoutingHost *asLayoutingHost() const;
    static Layout *fromLayoutingHost(LayoutingHost *);
 
    class Private;
    Layout::Private *d_ptr();
 
protected:
    void setRootItem(Core::ItemContainer *root);
    void setLayoutMinimumSize(Size);
 
    void unrefOldPlaceholders(const Vector<Core::Group *> &groupsBeingAdded) const;
 
    Vector<Core::Group *> groupsFrom(View *groupOrMultiSplitter) const;
 
private:
    Private *const d;
    bool onResize(Size newSize);
};
 
}
 
}
 
#endif