LayoutPreview.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <PhosphorLayoutApi/AlgorithmMetadata.h>
#include <PhosphorLayoutApi/AspectRatioClass.h>
 
#include <QRectF>
#include <QString>
#include <QVector>
 
#include <optional>
 
namespace PhosphorLayout {
 
inline constexpr int DefaultPreviewWindowCount = 4;
 
struct LayoutPreview
{
    static constexpr int UnlimitedZoneCount = 0;
 
    QString id;
 
    QString displayName;
 
    QString description;
 
    QVector<QRectF> zones;
 
    QVector<int> zoneNumbers;
 
    int zoneCount = 0;
 
    bool recommended = true;
 
    qreal referenceAspectRatio = 0.0;
 
    AspectRatioClass aspectRatioClass = AspectRatioClass::Any;
 
    QString sectionKey;
    QString sectionLabel;
    int sectionOrder = 0;
 
    bool autoAssign = false;
 
    bool isSystem = false;
 
    bool isScrollingTemplate = false;
 
    std::optional<AlgorithmMetadata> algorithm;
 
    int masterCount = 1;
 
    bool isAutotile() const noexcept
    {
        return algorithm.has_value();
    }
 
    bool isValid() const noexcept
    {
        // Negative zoneCount has no meaning in either bounded or unlimited
        // semantics — reject it explicitly so a stray negative doesn't
        // sneak past the > 0 bounded check below.
        if (zoneCount < UnlimitedZoneCount) {
            return false;
        }
        if (zoneCount > UnlimitedZoneCount && zones.size() != zoneCount) {
            return false;
        }
        if (!zoneNumbers.isEmpty() && zoneNumbers.size() != zones.size()) {
            return false;
        }
        return true;
    }
};
 
} // namespace PhosphorLayout