LayoutSaver.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_LAYOUTSAVER_H
#define KD_LAYOUTSAVER_H
 
#include "kddockwidgets/docks_export.h"
 
#include "kddockwidgets/KDDockWidgets.h"
 
QT_BEGIN_NAMESPACE
class QByteArray;
QT_END_NAMESPACE
 
class TestDocks;
 
namespace KDDockWidgets {
 
namespace Core {
class DockWidget;
}
 
class DOCKS_EXPORT LayoutSaver
{
public:
    explicit LayoutSaver(RestoreOptions options = RestoreOption_None);
 
    ~LayoutSaver();
 
    static bool restoreInProgress();
 
    bool saveToFile(const QString &jsonFilename);
 
    bool restoreFromFile(const QString &jsonFilename);
 
    QByteArray serializeLayout() const;
 
    bool restoreLayout(const QByteArray &);
 
    Vector<Core::DockWidget *> restoredDockWidgets() const;
 
    void setAffinityNames(const Vector<QString> &affinityNames);
 
    static Vector<QString> openedDockWidgetsInLayout(const QString &jsonFilename);
    static Vector<QString> openedDockWidgetsInLayout(const QByteArray &serialized);
 
    static Vector<QString> sideBarDockWidgetsInLayout(const QString &jsonFilename);
    static Vector<QString> sideBarDockWidgetsInLayout(const QByteArray &serialized);
 
    class Private;
    Private *dptr() const;
 
    struct Layout;
    struct MainWindow;
    struct FloatingWindow;
    struct DockWidget;
    struct Position;
    struct MultiSplitter;
    struct Group;
    struct Placeholder;
    struct ScalingInfo;
    struct ScreenInfo;
 
private:
    KDDW_DELETE_COPY_CTOR(LayoutSaver)
    friend class ::TestDocks;
 
    Private *const d;
};
}
 
#endif