KTextTemplate::Variable Class

A container for static variables defined in Templates. More...

Header:	`#include <KTextTemplate/Variable>`
CMake:	`find_package(KF6 REQUIRED COMPONENTS TextTemplate)` `target_link_libraries(mytarget PRIVATE KF6::TextTemplate)`

List of all members, including inherited members

Public Functions

	Variable()
	Variable(const QString &var)
bool	isConstant() const
bool	isLocalized() const
bool	isTrue(KTextTemplate::Context *c) const
bool	isValid() const
QVariant	literal() const
QStringList	lookups() const
QVariant	resolve(KTextTemplate::Context *c) const

Detailed Description

This class is only relevant to Template tag authors.

When processing a template tag in a AbstractNodeFactory implementation, it will sometimes make sense to process arguments to the tag as KTextTemplate::Variables. Note that usually they should be processed as FilterExpression objects instead.

Arguments to the tag can be used to construct Variables, which may then be resolved into the objects they represent in the given Context in the render stage.

Member Function Documentation

Variable::Variable()

Constructs an invalid Variable

`[explicit]` Variable::Variable(const QString &var)

Creates a Variable represented by the given var

bool Variable::isConstant() const

Returns whether this Variable is a constant in the Template. A constant is represented as a static string in the template

Text content
{% some_tag "constant" variable %}

bool Variable::isLocalized() const

Returns whether this variable is localized, that is, if it is wrapped with _().

bool Variable::isTrue(KTextTemplate::Context *c) const

Returns whether this Variable evaluates to true with the Context c.

bool Variable::isValid() const

Returns whether this Variable is valid.

QVariant Variable::literal() const

Returns whether this variable is a literal string or number. A literal Variable does not have any lookup components.

QStringList Variable::lookups() const

Returns the lookup components of this Variable.

QVariant Variable::resolve(KTextTemplate::Context *c) const

Resolves this Variable with the Context c.

Contents