ScrollingTemplate.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 <QJsonObject>
#include <QLatin1String>
#include <QList>
#include <QString>
#include <QUuid>
#include <QtGlobal>
 
namespace PhosphorZones {
 
inline constexpr qreal MinTemplateFraction = 0.05;
 
inline constexpr int MaxTemplateColumns = 16;
 
inline constexpr int DefaultWidthKindProportion = 0;
inline constexpr int DefaultWidthKindFixed = 1;
inline constexpr int DefaultWidthKindClientDecides = 2;
inline constexpr int DefaultWidthKindPreset = 3;
 
inline constexpr qreal FractionDedupeEpsilon = 0.01;
 
struct PHOSPHORZONES_EXPORT ScrollingTemplateColumn
{
    qreal width = 0.5;
    int display = 0;
 
    bool operator==(const ScrollingTemplateColumn&) const = default;
};
 
namespace TemplateJsonKeys {
inline constexpr QLatin1String Id{"id"};
inline constexpr QLatin1String IsSystem{"isSystem"};
inline constexpr QLatin1String SourcePath{"sourcePath"};
} // namespace TemplateJsonKeys
 
class PHOSPHORZONES_EXPORT ScrollingTemplate
{
public:
    QUuid id;
    QString name;
    QString description;
 
    QList<ScrollingTemplateColumn> columns;
 
    int defaultColumnWidthKind = DefaultWidthKindPreset;
    qreal defaultColumnWidthValue = 0.5; 
    int defaultColumnWidthPresetIndex = 1; 
    int defaultColumnDisplay = 0;
 
    QList<qreal> presetColumnWidths;
    QList<qreal> presetWindowHeights;
 
    bool isSystem = false;
    bool hasSystemOrigin = false;
    QString sourcePath;
 
    bool isValid() const
    {
        return !id.isNull() && !name.isEmpty();
    }
 
    bool normalize();
 
    static QList<qreal> normalizePresetList(QList<qreal> values);
 
    QJsonObject toJson() const;
    static ScrollingTemplate fromJson(const QJsonObject& json);
 
    bool operator==(const ScrollingTemplate&) const = default;
};
 
} // namespace PhosphorZones