Contents

KTextTemplate::Node Class

class KTextTemplate::Node

Base class for all nodes. More...

Header: #include <KTextTemplate/Node>
CMake: find_package(KF6 REQUIRED COMPONENTS TextTemplate)
target_link_libraries(mytarget PRIVATE KF6::TextTemplate)
Inherits: QObject

Public Functions

Node(QObject *parent = {})
virtual void render(KTextTemplate::OutputStream *stream, KTextTemplate::Context *c) const = 0

Protected Functions

KTextTemplate::TemplateImpl *containerTemplate() const
void streamValueInContext(KTextTemplate::OutputStream *stream, const QVariant &input, KTextTemplate::Context *c) const

Detailed Description

The Node class can be implemented to make additional functionality available to Templates.

A node is represented in template markup as content surrounded by percent signed tokens.

text content
{% some_tag arg1 arg2 %}
  text content
{% some_other_tag arg1 arg2 %}
  text content
{% end_some_other_tag %}
text content

This is parsed into a tree of **%Node** objects by an implementation of AbstractNodeFactory. The **%Node** objects can then later be rendered by their render method.

Rendering a **%Node** will usually mean writing some output to the stream. The content written to the stream could be determined by the arguments to the tag, or by the content of child nodes between a start and end tag, or both.

See also FilterExpression.

Member Function Documentation

[explicit] Node::Node(QObject *parent = {})

Constructor.

parent The parent QObject

[protected] KTextTemplate::TemplateImpl *Node::containerTemplate() const

Returns a raw pointer to the Template this **%Node** is in.

[pure virtual] void Node::render(KTextTemplate::OutputStream *stream, KTextTemplate::Context *c) const

Reimplement this to render the template in the Context c.

This will also involve calling render on and child nodes.

[protected] void Node::streamValueInContext(KTextTemplate::OutputStream *stream, const QVariant &input, KTextTemplate::Context *c) const

Renders the value input in the Context c. This will involve escaping input if necessary.

This is only relevant to developing template tags.