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

#include <cutelee/template.h>

Inheritance diagram for Cutelee::Template:

Public Member Functions
Engine const *	engine () const

Error	error () const

QString	errorString () const

QString	render (Context *c) const

OutputStream *	render (OutputStream stream, Context c) const

Detailed Description

All Templates are created through the Cutelee::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 std::shared_ptr<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.

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();
  }
}

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

Author: Stephen Kelly steve.nosp@m.ire@.nosp@m.gmail.nosp@m..com

Definition at line 94 of file template.h.

Member Function Documentation

◆ engine()

Engine const * Template::engine ( ) const

Returns the Engine that created this Template.

Definition at line 134 of file template.cpp.

◆ error()

Error Template::error ( ) const

Returns an error code for the error encountered.

Definition at line 122 of file template.cpp.

◆ errorString()

QString Template::errorString ( ) const

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

Definition at line 128 of file template.cpp.

◆ render() [1/2]

QString Template::render ( Context * c ) const

Renders the Template to a string given the Context c.

Definition at line 74 of file template.cpp.

◆ render() [2/2]

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

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

Definition at line 83 of file template.cpp.

References Cutelee::Context::renderContext().