torstenandCopilot
124fbb4de8
- Replace QCheckBox::stateChanged with checkStateChanged in: - lts_dialog.cpp - simple_esri_layer.cpp (2 occurrences) - layer_control_widget.cpp - symbol_dialog.cpp - Replace LocationViewshed with ExploratoryLocationViewshed (ArcGIS SDK v300): - viewshed_analysis.h/.cpp - ViewshedLocation.h/.cpp - function_dialog.cpp (include) - Update ViewshedLocation member variable type to ExploratoryLocationViewshed Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
151 lines
3.3 KiB
C++
151 lines
3.3 KiB
C++
/*
|
|
This file is part of the KTextTemplate library
|
|
|
|
SPDX-FileCopyrightText: 2009, 2010 Stephen Kelly <steveire@gmail.com>
|
|
|
|
SPDX-License-Identifier: LGPL-2.1-or-later
|
|
|
|
*/
|
|
|
|
#ifndef KTEXTTEMPLATE_TEMPLATE_H
|
|
#define KTEXTTEMPLATE_TEMPLATE_H
|
|
|
|
#include "exception.h"
|
|
#include "ktexttemplate_export.h"
|
|
#include "node.h"
|
|
|
|
#include <QSharedPointer>
|
|
#include <QStringList>
|
|
|
|
namespace KTextTemplate
|
|
{
|
|
class Context;
|
|
class Engine;
|
|
class TemplateImpl;
|
|
class OutputStream;
|
|
|
|
#ifdef K_DOXYGEN
|
|
#define TemplateImpl Template
|
|
#else
|
|
typedef QSharedPointer<TemplateImpl> Template;
|
|
#endif
|
|
|
|
class TemplatePrivate;
|
|
|
|
/// @headerfile template.h <KTextTemplate/Template>
|
|
|
|
/**
|
|
@brief The **%Template** class is a tree of nodes which may be rendered.
|
|
|
|
All Templates are created through the KTextTemplate::Engine class.
|
|
A **%Template** is created by parsing some text markup passed into the Engine,
|
|
or by reading it from a file.
|
|
|
|
Note that **%Template** is actually a typedef for a
|
|
<tt>QSharedPointer<TemplateImpl></tt>, so all of its members should be
|
|
accessed with <tt>operator->()</tt>.
|
|
|
|
The result of parsing is a **%Template** object which can be rendered multiple
|
|
times with multiple different Contexts.
|
|
|
|
@code
|
|
auto engine = getEngine();
|
|
auto t = engine->newTemplate(
|
|
"{{ name }} is aged {{ age }}",
|
|
"simple template" );
|
|
if ( t->error() )
|
|
{
|
|
// Tokenizing or parsing error, or couldn't find custom tags or filters.
|
|
qDebug() << t->errorString();
|
|
return;
|
|
}
|
|
QTextStream textStream( stdout );
|
|
OutputStream stream( textStream );
|
|
|
|
for ( ... )
|
|
{
|
|
Context c;
|
|
// ... c.insert
|
|
t->render( stream, c );
|
|
|
|
if (t->error())
|
|
{
|
|
// Rendering error.
|
|
qDebug() << t->errorString();
|
|
}
|
|
}
|
|
@endcode
|
|
|
|
If there is an error in parsing or rendering, the @ref error and @ref
|
|
errorString methods can be used to check the source of the error.
|
|
|
|
@author Stephen Kelly <steveire@gmail.com>
|
|
*/
|
|
class KTEXTTEMPLATE_EXPORT TemplateImpl : public QObject
|
|
{
|
|
Q_OBJECT
|
|
public:
|
|
~TemplateImpl() override;
|
|
|
|
/**
|
|
Renders the **%Template** to a string given the Context @p c.
|
|
*/
|
|
QString render(Context *c) const;
|
|
|
|
/**
|
|
Renders the **%Template** to the OutputStream @p stream given the Context c.
|
|
*/
|
|
OutputStream *render(OutputStream *stream, Context *c) const;
|
|
|
|
#ifndef K_DOXYGEN
|
|
/**
|
|
@internal
|
|
*/
|
|
NodeList nodeList() const;
|
|
|
|
/**
|
|
@internal
|
|
*/
|
|
void setNodeList(const NodeList &list);
|
|
#endif
|
|
|
|
/**
|
|
Returns an error code for the error encountered.
|
|
*/
|
|
Error error() const;
|
|
|
|
/**
|
|
Returns more information to developers in the form of a string.
|
|
*/
|
|
QString errorString() const;
|
|
|
|
/**
|
|
Returns the Engine that created this **%Template**.
|
|
*/
|
|
Engine const *engine() const;
|
|
|
|
#ifndef K_DOXYGEN
|
|
protected:
|
|
TemplateImpl(Engine const *engine, QObject *parent = {});
|
|
TemplateImpl(Engine const *engine, bool smartTrim, QObject *parent = {});
|
|
|
|
void setContent(const QString &templateString);
|
|
#endif
|
|
|
|
private:
|
|
// Don't allow setting the parent on a Template, which is memory managed as
|
|
// a QSharedPointer.
|
|
using QObject::setParent;
|
|
|
|
private:
|
|
Q_DECLARE_PRIVATE(Template)
|
|
TemplatePrivate *const d_ptr;
|
|
#ifndef K_DOXYGEN
|
|
friend class Engine;
|
|
friend class Parser;
|
|
#endif
|
|
};
|
|
}
|
|
|
|
#endif
|