grantleeview.h

/*
 * SPDX-FileCopyrightText: (C) 2013-2022 Daniel Nicoletti <dantti12@gmail.com>
 * SPDX-License-Identifier: BSD-3-Clause
 */
#ifndef GRANTLEE_VIEW_H
#define GRANTLEE_VIEW_H
 
#include <Cutelyst/View>
 
#include <QLocale>
#include <QObject>
#include <QStringList>
#include <QVector>
 
class QTranslator;
 
namespace Grantlee {
class Engine;
}
 
namespace Cutelyst {
 
class GrantleeViewPrivate;
class CUTELYST_VIEW_GRANTLEE_EXPORT GrantleeView final : public View
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(GrantleeView)
public:
    explicit GrantleeView(QObject *parent = nullptr, const QString &name = QString());
 
    Q_PROPERTY(QStringList includePaths READ includePaths WRITE setIncludePaths NOTIFY changed)
    QStringList includePaths() const;

    void setIncludePaths(const QStringList &paths);
 
    Q_PROPERTY(
        QString templateExtension READ templateExtension WRITE setTemplateExtension NOTIFY changed)
    QString templateExtension() const;

    void setTemplateExtension(const QString &extension);
 
    Q_PROPERTY(QString wrapper READ wrapper WRITE setWrapper NOTIFY changed)
 
    
    QString wrapper() const;

    void setWrapper(const QString &name);
 
    Q_PROPERTY(bool cache READ isCaching WRITE setCache NOTIFY changed)
    bool isCaching() const;

    void setCache(bool enable);

    Grantlee::Engine *engine() const;

    void preloadTemplates();
 
    QByteArray render(Context *c) const final;

    void addTranslator(const QLocale &locale, QTranslator *translator);

    void addTranslator(const QString &locale, QTranslator *translator);

    void addTranslationCatalog(const QString &path, const QString &catalog);

    void addTranslationCatalogs(const QHash<QString, QString> &catalogs);

    QVector<QLocale> loadTranslationsFromDir(const QString &filename,
                                             const QString &directory,
                                             const QString &prefix = QStringLiteral("."),
                                             const QString &suffix = QStringLiteral(".qm"));
 
Q_SIGNALS:
    void changed();
};
 
} // namespace Cutelyst
 
#endif // GRANTLEE_VIEW_H