Grantlee  5.1.0
Public Member Functions | List of all members
Grantlee::Template Class Reference

The Template class is a tree of nodes which may be rendered. More...

#include <grantlee/template.h>

Inheritance diagram for Grantlee::Template:
Inheritance graph

Public Member Functions

Engine const * engine () const
Error error () const
QString errorString () const
QString render (Context *c) const
OutputStreamrender (OutputStream *stream, Context *c) const
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent)
 QObject (QObject *parent, const char *name)
bool blockSignals (bool block)
QObjectchild (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList & children () const
const char * className () const
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void deleteLater ()
void destroyed (QObject *obj)
bool disconnect (const QObject *receiver, const char *method)
bool disconnect (const char *signal, const QObject *receiver, const char *method)
void dumpObjectInfo ()
void dumpObjectTree ()
QList< QByteArraydynamicPropertyNames () const
virtual bool event (QEvent *e)
virtual bool eventFilter (QObject *watched, QEvent *event)
findChild (const QString &name) const
QList< T > findChildren (const QRegExp &regExp) const
QList< T > findChildren (const QString &name) const
bool inherits (const char *className) const
void insertChild (QObject *object)
void installEventFilter (QObject *filterObj)
bool isA (const char *className) const
bool isWidgetType () const
void killTimer (int id)
virtual const QMetaObjectmetaObject () const
void moveToThread (QThread *targetThread)
const char * name () const
const char * name (const char *defaultName) const
QString objectName () const
QObjectparent () const
QVariant property (const char *name) const
void removeChild (QObject *object)
void removeEventFilter (QObject *obj)
void setName (const char *name)
void setObjectName (const QString &name)
void setParent (QObject *parent)
bool setProperty (const char *name, const QVariant &value)
bool signalsBlocked () const
int startTimer (int interval)
QThreadthread () const

Additional Inherited Members

- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
QString tr (const char *sourceText, const char *disambiguation, int n)
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void childEvent (QChildEvent *event)
virtual void connectNotify (const char *signal)
virtual void customEvent (QEvent *event)
virtual void disconnectNotify (const char *signal)
int receivers (const char *signal) const
QObjectsender () const
virtual void timerEvent (QTimerEvent *event)
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
- Properties inherited from QObject

Detailed Description

All Templates are created through the Grantlee::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 QSharedPointer<TemplateImpl>, so all of its members should be accessed with operator->().

The result of parsing is a Template object which can be rendered multiple times with multiple different Contexts.

Engine *engine = getEngine();
Template 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();
QTextStream textStream( stdout );
OutputStream stream( textStream );
for ( ... )
Context c;
// ... c.insert
t->render( stream, c );
if (t->error())
// Rendering error.
qDebug() << t->errorString();

If there is an error in parsing or rendering, the error and errorString methods can be used to check the source of the error.

Stephen Kelly

Definition at line 94 of file template.h.

Member Function Documentation

Engine const* Grantlee::Template::engine ( ) const

Returns the Engine that created this Template.

Error Grantlee::Template::error ( ) const

Returns an error code for the error encountered.

QString Grantlee::Template::errorString ( ) const

Returns more information to developers in the form of a string.

QString Grantlee::Template::render ( Context c) const

Renders the template to a string given the Context c.

OutputStream* Grantlee::Template::render ( OutputStream stream,
Context c 
) const

Renders the Template to the OutputStream stream given the Context c.