Package trac :: Package web :: Module api :: Class ITemplateStreamFilter

Class ITemplateStreamFilter

    object --+    
             |    
core.Interface --+
                 |
                ITemplateStreamFilter

Transform the generated content by filtering the Genshi event stream
generated by the template, prior to its serialization.

:deprecated: the Genshi template filtering concept doesn't apply
             anymore to Jinja2 templates, please consider
             converting your plugins to perform browser-side
             modifications of the rendered page using JavaScript.
             This interface will be removed in Trac 1.5.1.

See :teo:`TracDev/PortingFromGenshiToJinja#ReplacingITemplateStreamFilter`
for details.

Instance Methods

filter_stream(req, method, filename, stream, data)
Return a filtered Genshi event stream, or the original unfiltered stream if no match.

source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties
Inherited from `object`: `__class__`

Method Details

filter_stream(req, method, filename, stream, data)

source code

Return a filtered Genshi event stream, or the original unfiltered stream if no match.

req is the current request object, method is the Genshi render method (xml, xhtml or text), filename is the filename of the template to be rendered, stream is the event stream and data is the data for the current template.

See the Genshi documentation for more information.