ISLEman
Classes | Public Member Functions | Friends | List of all members
TemplateEngine Class Reference

Engine to create templates and template contexts. More...

#include <template.h>

Classes

class  Private
 Private data of the template engine. More...
 

Public Member Functions

 TemplateEngine ()
 Create a template engine. More...
 
 ~TemplateEngine ()
 Destroys the template engine. More...
 
TemplateContextcreateContext () const
 Creates a new context that can be using to render a template. More...
 
void destroyContext (TemplateContext *ctx)
 Destroys a context created via createContext(). More...
 
TemplateloadByName (const QCString &fileName, int fromLine)
 Creates a new template whose contents are in a file. More...
 
void unload (Template *t)
 Indicates that template t is no longer needed. More...
 
void printIncludeContext (const char *fileName, int line) const
 Prints the current template file include stack.
 
void setTemplateDir (const char *dirName)
 Sets the search directory where to look for template files.
 

Friends

class TemplateNodeBlock
 
class TemplateNodeCreate
 

Detailed Description

Engine to create templates and template contexts.

Constructor & Destructor Documentation

§ TemplateEngine()

TemplateEngine::TemplateEngine ( )

Create a template engine.

§ ~TemplateEngine()

TemplateEngine::~TemplateEngine ( )

Destroys the template engine.

Member Function Documentation

§ createContext()

TemplateContext * TemplateEngine::createContext ( ) const

Creates a new context that can be using to render a template.

See also
Template::render()

§ destroyContext()

void TemplateEngine::destroyContext ( TemplateContext ctx)

Destroys a context created via createContext().

Parameters
[in]ctxThe context.

§ loadByName()

Template * TemplateEngine::loadByName ( const QCString fileName,
int  fromLine 
)

Creates a new template whose contents are in a file.

Parameters
[in]fileNameThe name of the file containing the template data
[in]fromLineThe line number of the statement that triggered the load
Returns
the new template, the engine will keep ownership of the object.

§ unload()

void TemplateEngine::unload ( Template t)

Indicates that template t is no longer needed.

The engine may decide to delete it.


The documentation for this class was generated from the following files: