A QObject wrapper around LayoutSaver so it can be used in QML. Use it from QML, like: LayoutSaver { id: saver } For C++, just use KDDockWidgets::LayoutSaver directly. More...

#include <LayoutSaverInstantiator.h>

Inheritance diagram for KDDockWidgets::LayoutSaverInstantiator:

[legend]

Collaboration diagram for KDDockWidgets::LayoutSaverInstantiator:

[legend]

Signals
void	affinitiesChanged ()

Public Member Functions
	LayoutSaverInstantiator (QObject *parent=nullptr)

	~LayoutSaverInstantiator () override

QVector< QString >	affinities () const

Q_INVOKABLE bool	restoreFromFile (const QString &jsonFilename)

Q_INVOKABLE bool	saveToFile (const QString &jsonFilename)

void	setAffinities (const QVector< QString > &)

Public Member Functions inherited from QObject
	QObject (QObject *parent)

virtual	~QObject ()

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo ()

void	dumpObjectInfo () const const

void	dumpObjectTree ()

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_DISABLE_COPY (Class)

	Q_DISABLE_COPY_MOVE (Class)

	Q_DISABLE_MOVE (Class)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qFindChild (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)

QList< T >	qFindChildren (const QObject *obj, const QString &name)

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)

QThread *	thread () const const

Public Member Functions inherited from KDDockWidgets::LayoutSaver
	LayoutSaver (RestoreOptions options=RestoreOption_None)
	Constructor. Construction on the stack is suggested.

	~LayoutSaver ()
	Destructor.

Private *	dptr () const

Vector< Core::DockWidget * >	restoredDockWidgets () const
	returns a list of dock widgets which were restored since the last restoreLayout() or restoreFromFile()

bool	restoreFromFile (const QString &jsonFilename)
	restores the layout from a JSON file

bool	restoreLayout (const QByteArray &)
	restores the layout from a byte array All MainWindows and DockWidgets should have been created before calling this function.

bool	saveToFile (const QString &jsonFilename)
	saves the layout to JSON file

QByteArray	serializeLayout () const
	saves the layout into a byte array

void	setAffinityNames (const Vector< QString > &affinityNames)
	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 `affinityNames`.

Properties
QVector< QString >	affinities

Properties inherited from QObject
	objectName

Additional Inherited Members
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Static Public Member Functions inherited from KDDockWidgets::LayoutSaver
static Vector< QString >	openedDockWidgetsInLayout (const QByteArray &serialized)

static Vector< QString >	openedDockWidgetsInLayout (const QString &jsonFilename)
	Returns the list of opened dock widgets in the specified layout.

static bool	restoreInProgress ()
	returns whether a restore (restoreLayout) is in progress

static Vector< QString >	sideBarDockWidgetsInLayout (const QByteArray &serialized)

static Vector< QString >	sideBarDockWidgetsInLayout (const QString &jsonFilename)

Public Attributes inherited from QObject
typedef	QObjectList

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Detailed Description

A QObject wrapper around LayoutSaver so it can be used in QML. Use it from QML, like: LayoutSaver { id: saver } For C++, just use KDDockWidgets::LayoutSaver directly.

Definition at line 33 of file LayoutSaverInstantiator.h.