ScrollingTemplateSource.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 <PhosphorLayoutApi/ILayoutSource.h>
#include <PhosphorLayoutApi/ILayoutSourceFactory.h>
#include <PhosphorZones/ScrollingTemplate.h>
 
#include <memory>
 
namespace PhosphorZones {
 
class ScrollingTemplateStore;
 
PHOSPHORZONES_EXPORT PhosphorLayout::LayoutPreview previewFromScrollingTemplate(const ScrollingTemplate& templ,
                                                                                bool verticalAxis = false);
 
class PHOSPHORZONES_EXPORT ScrollingTemplateSource : public PhosphorLayout::ILayoutSource
{
    Q_OBJECT
 
public:
    explicit ScrollingTemplateSource(ScrollingTemplateStore* store, QObject* parent = nullptr);
    ~ScrollingTemplateSource() override;
 
    QVector<PhosphorLayout::LayoutPreview> availableLayouts() const override;
    PhosphorLayout::LayoutPreview previewAt(const QString& id, int windowCount, const QSize& canvas) override;
 
private:
    ScrollingTemplateStore* m_store = nullptr;
};
 
class PHOSPHORZONES_EXPORT ScrollingTemplateSourceFactory : public PhosphorLayout::ILayoutSourceFactory
{
public:
    explicit ScrollingTemplateSourceFactory(ScrollingTemplateStore* store);
    ~ScrollingTemplateSourceFactory() override;
 
    QString name() const override;
    std::unique_ptr<PhosphorLayout::ILayoutSource> create() override;
 
private:
    ScrollingTemplateStore* m_store = nullptr;
};
 
PHOSPHORZONES_EXPORT void ensureScrollingTemplateSourceProviderLinked();
 
} // namespace PhosphorZones