HappyDoc Generated Documentation Class: ITALESEngine

HappyDoc3-r3_1 / happydoclib / docset / docset_TAL / TAL / ITALES.py / ITALESEngine 

Render-time interface provided by a TALES implementation.

The TAL interpreter uses this interface to TALES to support evaluation of the compiled expressions returned by ITALESCompiler.compile().

Base Classes   

ITALESEngine
  Interface

Methods   
  endScope 
endScope ()

Pop one scope from the stack of open scopes.

  beginScope 
beginScope ()

Push a new scope onto the stack of open scopes.

  setGlobal 
setGlobal ( name,  value )

Set a global variable.

The variable will be named name and have the value value.

  createErrorInfo 
createErrorInfo ( exception,  ( )

Returns an ITALESErrorInfo object.

The returned object is used to provide information about the error condition for the on-error handler.

  evaluate 
evaluate ( compiled_expression )

Evaluate an arbitrary expression.

No constraints are imposed on the return value.

  setRepeat 
setRepeat ( name,  compiled_expression )
  setSourceFile 
setSourceFile ( filename )

Inform the engine of the name of the current source file.

This is used to allow the evaluation engine to report execution errors so that site developers can more easily locate the offending expression.

  evaluateValue 
evaluateValue ( compiled_expression )

Evaluate an arbitrary expression.

No constraints are imposed on the return value.

  getCompiler 
getCompiler ()

Return an object that supports ITALESCompiler.

  getDefault 
getDefault ()

Return the value of the default TALES expression.

Checking a value for a match with default should be done using the is operator in Python.

  evaluateText 
evaluateText ( compiled_expression )

Evaluate an expression that must return text.

The returned text should be suitable for direct inclusion in the output: any HTML or XML escaping or quoting is the responsibility of the expression itself.

  evaluateBoolean 
evaluateBoolean ( compiled_expression )

Evaluate an expression that must return a Boolean value.

  evaluateStructure 
evaluateStructure ( compiled_expression )

Evaluate an expression that must return a structured document fragment.

The result of evaluating compiled_expression must be a string containing a parsable HTML or XML fragment. Any TAL markup cnotained in the result string will be interpreted.

  setLocal 
setLocal ( name,  value )

Set a local variable in the current scope.

The variable will be named name and have the value value.

  setPosition 
setPosition ( ( )

Inform the engine of the current position in the source file.

This is used to allow the evaluation engine to report execution errors so that site developers can more easily locate the offending expression.

  translate 
translate (
        domain,
        msgid,
        mapping,
        )

See ITranslationService.translate()

  evaluateMacro 
evaluateMacro ( compiled_expression )

Evaluate an expression that must return a macro program.


This document was automatically generated Tue Dec 5 08:30:42 2006 by HappyDoc version 3.1