Phosphor
Qt6 / Wayland library suite for window-management tools
Loading...
Searching...
No Matches
LayoutUtils.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: 2026 fuddlesworth
2// SPDX-License-Identifier: LGPL-2.1-or-later
3
4#pragma once
5
6#include "phosphorzones_export.h"
7#include <QFlags>
8#include <QHash>
9#include <QJsonObject>
10#include <QList>
11#include <QRectF>
12#include <QString>
13#include <QStringList>
14#include <QVariantList>
15#include <QVariantMap>
16#include <QVector>
17
18namespace PhosphorZones {
19
21class Layout;
22class Zone;
23
30enum class ZoneField {
31 None = 0,
32 Name = 1 << 0,
33 Appearance = 1 << 1,
34
37};
38Q_DECLARE_FLAGS(ZoneFields, ZoneField)
39Q_DECLARE_OPERATORS_FOR_FLAGS(ZoneFields)
40
41
52namespace LayoutUtils {
53
54// ═══════════════════════════════════════════════════════════════════════════
55// Allow-list serialization (shared by Layout, LayoutAdaptor, EditorController)
56// ═══════════════════════════════════════════════════════════════════════════
57
61PHOSPHORZONES_EXPORT void serializeAllowLists(QJsonObject& json, const QStringList& screens, const QList<int>& desktops,
62 const QStringList& activities);
63
67PHOSPHORZONES_EXPORT void deserializeAllowLists(const QJsonObject& json, QStringList& screens, QList<int>& desktops,
68 QStringList& activities);
69
70// ═══════════════════════════════════════════════════════════════════════════
71// Zone conversion utilities
72// ═══════════════════════════════════════════════════════════════════════════
73
90PHOSPHORZONES_EXPORT QVariantList zonesToVariantList(Layout* layout, ZoneFields fields = ZoneField::Minimal,
91 const QRectF& referenceGeometry = QRectF(),
92 qreal screenScale = 0.0);
93
100PHOSPHORZONES_EXPORT QVariantMap layoutToVariantMap(Layout* layout, ZoneFields zoneFields = ZoneField::Minimal);
101
102PHOSPHORZONES_EXPORT void sortZonesByNumber(QVector<Zone*>& zones);
103PHOSPHORZONES_EXPORT QHash<QString, int> buildZonePositionMap(Layout* layout);
104
115PHOSPHORZONES_EXPORT QHash<QString, int> buildGlobalZonePositionMap(const QList<Layout*>& layouts);
116
130PHOSPHORZONES_EXPORT bool layoutHoldsZones(const Layout* layout, const QStringList& zoneIds);
131
139PHOSPHORZONES_EXPORT bool contextLayoutHoldsZones(const IZoneLayoutRegistry* registry, const QString& screenId,
140 int virtualDesktop, const QString& activity,
141 const QStringList& zoneIds);
142
154PHOSPHORZONES_EXPORT QStringList sameNumberedZones(const QStringList& zoneIds, const Layout* target,
155 const QHash<QString, int>& positions);
156
177PHOSPHORZONES_EXPORT int reissueTakenZoneIds(QJsonObject& layoutJson, const QList<Layout*>& loaded);
178
179} // namespace LayoutUtils
180
181} // namespace PhosphorZones
Enumeration + mutation surface for the in-memory zone-layout catalog.
Definition IZoneLayoutRegistry.h:51
Represents a collection of zones that form a layout.
Definition Layout.h:42
Represents a single zone within a layout.
Definition Zone.h:47
Zone/layout primitive utilities — pure Layout / Zone operations.
Definition LayoutUtils.h:52
PHOSPHORZONES_EXPORT void serializeAllowLists(QJsonObject &json, const QStringList &screens, const QList< int > &desktops, const QStringList &activities)
Serialize visibility allow-lists to JSON (only writes non-empty lists).
PHOSPHORZONES_EXPORT bool contextLayoutHoldsZones(const IZoneLayoutRegistry *registry, const QString &screenId, int virtualDesktop, const QString &activity, const QStringList &zoneIds)
layoutHoldsZones() against the layout registry resolves for the (screenId, virtualDesktop,...
PHOSPHORZONES_EXPORT QHash< QString, int > buildZonePositionMap(Layout *layout)
PHOSPHORZONES_EXPORT QVariantMap layoutToVariantMap(Layout *layout, ZoneFields zoneFields=ZoneField::Minimal)
Convert a layout to a QVariantMap (metadata + zones).
PHOSPHORZONES_EXPORT QHash< QString, int > buildGlobalZonePositionMap(const QList< Layout * > &layouts)
Build a global zoneId → position map merged across every layout in layouts.
PHOSPHORZONES_EXPORT QStringList sameNumberedZones(const QStringList &zoneIds, const Layout *target, const QHash< QString, int > &positions)
The slot remembered zoneIds take in target, the layout a context runs now: the zones themselves when ...
PHOSPHORZONES_EXPORT void deserializeAllowLists(const QJsonObject &json, QStringList &screens, QList< int > &desktops, QStringList &activities)
Deserialize visibility allow-lists from JSON (clears output params first).
PHOSPHORZONES_EXPORT int reissueTakenZoneIds(QJsonObject &layoutJson, const QList< Layout * > &loaded)
Give a layout document's zones ids no other layout holds (F552), and a zone with no id one of its own...
PHOSPHORZONES_EXPORT bool layoutHoldsZones(const Layout *layout, const QStringList &zoneIds)
Does layout hold EVERY zone in zoneIds?
PHOSPHORZONES_EXPORT QVariantList zonesToVariantList(Layout *layout, ZoneFields fields=ZoneField::Minimal, const QRectF &referenceGeometry=QRectF(), qreal screenScale=0.0)
Convert all zones in a layout to QVariantList.
PHOSPHORZONES_EXPORT void sortZonesByNumber(QVector< Zone * > &zones)
Definition IWindowTrackingService.h:24
ZoneField
Flags controlling which zone fields to include in conversion (OCP-compliant).
Definition LayoutUtils.h:30
@ Minimal
Id, ZoneNumber, RelativeGeometry only (for previews).
Definition LayoutUtils.h:35
@ Name
Include zone name.
Definition LayoutUtils.h:32
@ None
Definition LayoutUtils.h:31
@ Appearance
Include colors, opacities, border properties.
Definition LayoutUtils.h:33
@ Full
All fields (for overlay rendering).
Definition LayoutUtils.h:36