LayoutUtils.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <phosphorzones_export.h>
#include <QFlags>
#include <QHash>
#include <QJsonObject>
#include <QList>
#include <QRectF>
#include <QString>
#include <QStringList>
#include <QVariantList>
#include <QVariantMap>
#include <QVector>
 
namespace PhosphorZones {
 
class Layout;
class Zone;
 
enum class ZoneField {
    None = 0,
    Name = 1 << 0, 
    Appearance = 1 << 1, 
 
    Minimal = None, 
    Full = Name | Appearance 
};
Q_DECLARE_FLAGS(ZoneFields, ZoneField)
Q_DECLARE_OPERATORS_FOR_FLAGS(ZoneFields)
 
 
namespace LayoutUtils {
 
// ═══════════════════════════════════════════════════════════════════════════
// Allow-list serialization (shared by Layout, LayoutAdaptor, EditorController)
// ═══════════════════════════════════════════════════════════════════════════
 
PHOSPHORZONES_EXPORT void serializeAllowLists(QJsonObject& json, const QStringList& screens, const QList<int>& desktops,
                                              const QStringList& activities);
 
PHOSPHORZONES_EXPORT void deserializeAllowLists(const QJsonObject& json, QStringList& screens, QList<int>& desktops,
                                                QStringList& activities);
 
// ═══════════════════════════════════════════════════════════════════════════
// Zone conversion utilities
// ═══════════════════════════════════════════════════════════════════════════
 
PHOSPHORZONES_EXPORT QVariantList zonesToVariantList(Layout* layout, ZoneFields fields = ZoneField::Minimal,
                                                     const QRectF& referenceGeometry = QRectF());
 
PHOSPHORZONES_EXPORT QVariantMap layoutToVariantMap(Layout* layout, ZoneFields zoneFields = ZoneField::Minimal);
 
PHOSPHORZONES_EXPORT void sortZonesByNumber(QVector<Zone*>& zones);
PHOSPHORZONES_EXPORT QHash<QString, int> buildZonePositionMap(Layout* layout);
 
PHOSPHORZONES_EXPORT QHash<QString, int> buildGlobalZonePositionMap(const QList<Layout*>& layouts);
 
} // namespace LayoutUtils
 
} // namespace PhosphorZones