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 ()
	~TemplateEngine ()
TemplateContext *	createContext () const
void	destroyContext (TemplateContext *ctx)
Template *	loadByName (const QCString &fileName, int fromLine)
void	unload (Template *t)
void	printIncludeContext (const char *fileName, int line) const

Private Member Functions
void	enterBlock (const QCString &fileName, const QCString &blockName, int line)
void	leaveBlock ()
void	setOutputExtension (const char *extension)
QCString	outputExtension () const

Private Attributes
Private *	p

Friends
class	TemplateNodeBlock
class	TemplateNodeCreate

Detailed Description

Engine to create templates and template contexts.

Definition at line 559 of file template.h.

Constructor & Destructor Documentation

TemplateEngine::TemplateEngine

(

)

Create a template engine.

Definition at line 4951 of file template.cpp.

{
  p = new Private(this);
}

TemplateEngine::~TemplateEngine

(

)

Destroys the template engine.

Definition at line 4956 of file template.cpp.

{
  delete p;
}

Member Function Documentation

TemplateContext * TemplateEngine::createContext

(

)

const

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

See also

Template::render()

Definition at line 4961 of file template.cpp.

{
  return new TemplateContextImpl(this);
}

void TemplateEngine::destroyContext

(

TemplateContext *

ctx

)

Destroys a context created via createContext().

Parameters

[in]

ctx

The context.

Definition at line 4966 of file template.cpp.

{
  delete ctx;
}

void TemplateEngine::enterBlock ( const QCString &  fileName, const QCString &  blockName, int  line  )

private

Definition at line 4981 of file template.cpp.

{
  p->enterBlock(fileName,blockName,line);
}

void TemplateEngine::leaveBlock ( )

private

Definition at line 4986 of file template.cpp.

{
  p->leaveBlock();
}

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

Creates a new template whose contents are in a file.

Parameters

[in]	fileName	The name of the file containing the template data
[in]	fromLine	The line number of the statement that triggered the load

Returns

the new template, the engine will keep ownership of the object.

Definition at line 4971 of file template.cpp.

{
  return p->loadByName(fileName,line);
}

QCString TemplateEngine::outputExtension ( ) const

private

Returns the output extension, set via setOutputExtension()

Definition at line 5001 of file template.cpp.

{
  return p->outputExtension();
}

void TemplateEngine::printIncludeContext	(	const char *	fileName,
		int	line
	)		const

Prints the current template file include stack

Definition at line 4991 of file template.cpp.

{
  p->printIncludeContext(fileName,line);
}

void TemplateEngine::setOutputExtension ( const char *  extension )

private

Sets the extension of the output file. This is used to control the format of 'special' tags in the template

Definition at line 4996 of file template.cpp.

{
  p->setOutputExtension(extension);
}

void TemplateEngine::unload

(

Template *

t

)

Indicates that template t is no longer needed. The engine may decide to delete it.

Definition at line 4976 of file template.cpp.

{
  p->unload(t);
}

Friends And Related Function Documentation

friend class TemplateNodeBlock

friend

Definition at line 594 of file template.h.

friend class TemplateNodeCreate

friend

Definition at line 595 of file template.h.

Member Data Documentation

Private* TemplateEngine::p

private

Definition at line 608 of file template.h.

---

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

• doxygen-1.8.11/src/template.h
• doxygen-1.8.11/src/template.cpp