118 lines
3.0 KiB
C++
118 lines
3.0 KiB
C++
/*
|
|
This file is part of KDDockWidgets.
|
|
|
|
SPDX-FileCopyrightText: 2019-2021 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
|
|
|
|
/**
|
|
* @file
|
|
* @brief Class to save and restore dockwidget layouts.
|
|
*
|
|
* @author Sérgio Martins \<sergio.martins@kdab.com\>
|
|
*/
|
|
|
|
#include "docks_export.h"
|
|
|
|
#include "KDDockWidgets.h"
|
|
|
|
QT_BEGIN_NAMESPACE
|
|
class QByteArray;
|
|
QT_END_NAMESPACE
|
|
|
|
class TestDocks;
|
|
|
|
namespace KDDockWidgets {
|
|
|
|
class DockWidgetBase;
|
|
|
|
class DOCKS_EXPORT LayoutSaver
|
|
{
|
|
public:
|
|
///@brief Constructor. Construction on the stack is suggested.
|
|
explicit LayoutSaver(RestoreOptions options = RestoreOption_None);
|
|
|
|
///@brief Destructor.
|
|
~LayoutSaver();
|
|
|
|
///@brief returns whether a restore (@ref restoreLayout) is in progress
|
|
static bool restoreInProgress();
|
|
|
|
/**
|
|
* @brief saves the layout to JSON file
|
|
* @param jsonFilename the filename where the layout will be saved to
|
|
* @return true on success
|
|
*/
|
|
bool saveToFile(const QString &jsonFilename);
|
|
|
|
/**
|
|
* @brief restores the layout from a JSON file
|
|
* @param jsonFilename the filename containing a saved layout
|
|
* @return true on success
|
|
*/
|
|
bool restoreFromFile(const QString &jsonFilename);
|
|
|
|
/**
|
|
* @brief saves the layout into a byte array
|
|
*/
|
|
QByteArray serializeLayout() const;
|
|
|
|
/**
|
|
* @brief restores the layout from a byte array
|
|
* All MainWindows and DockWidgets should have been created before calling
|
|
* this function.
|
|
*
|
|
* If not all DockWidgets can be created beforehand then make sure to set
|
|
* a DockWidget factory via Config::setDockWidgetFactoryFunc()
|
|
*
|
|
* @sa Config::setDockWidgetFactoryFunc()
|
|
*
|
|
* @return true on success
|
|
*/
|
|
bool restoreLayout(const QByteArray &);
|
|
|
|
/**
|
|
* @brief returns a list of dock widgets which were restored since the last
|
|
* @ref restoreLayout() or @ref restoreFromFile()
|
|
*
|
|
* Useful since some dock widgets can be new, and hence not be included in the last saved layout.
|
|
*/
|
|
QVector<DockWidgetBase *> restoredDockWidgets() const;
|
|
|
|
|
|
/**
|
|
* @brief Sets the list of affinity names for which restore and save will be applied on.
|
|
* Allows to save/restore only a subset of the windows.
|
|
* Empty by default, all windows are subject to save/restore.
|
|
* Any window with empty affinity will also be subject to save/restore, regardless of @p affinityNames.
|
|
*/
|
|
void setAffinityNames(const QStringList &affinityNames);
|
|
|
|
struct Layout;
|
|
struct MainWindow;
|
|
struct FloatingWindow;
|
|
struct DockWidget;
|
|
struct Position;
|
|
struct MultiSplitter;
|
|
struct Frame;
|
|
struct Placeholder;
|
|
struct ScalingInfo;
|
|
struct ScreenInfo;
|
|
private:
|
|
Q_DISABLE_COPY(LayoutSaver)
|
|
friend class ::TestDocks;
|
|
|
|
class Private;
|
|
Private *const d;
|
|
};
|
|
}
|
|
|
|
#endif
|