Base class for all nodes. More...

#include <cutelee/node.h>

Inheritance diagram for Cutelee::Node:

[legend]

Public Member Functions
	Node (QObject *parent={})

	~Node () override

virtual void	render (OutputStream stream, Context c) const =0

Public Member Functions inherited from QObject
	QObject (QObject *parent)

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo ()

void	dumpObjectInfo () const const

void	dumpObjectTree ()

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_DISABLE_COPY (Class)

	Q_DISABLE_COPY_MOVE (Class)

	Q_DISABLE_MOVE (Class)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qFindChild (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)

QList< T >	qFindChildren (const QObject *obj, const QString &name)

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)

QThread *	thread () const const

Protected Member Functions
TemplateImpl *	containerTemplate () const

void	streamValueInContext (OutputStream stream, const QVariant &input, Cutelee::Context c) const

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Public Attributes inherited from QObject
typedef	QObjectList

Properties inherited from QObject
	objectName

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; Tags

Author: Stephen Kelly steve.nosp@m.ire@.nosp@m.gmail.nosp@m..com

Definition at line 77 of file node.h.

Constructor & Destructor Documentation

◆ Node()

Node::Node ( QObject * parent = {} )

explicit

Constructor.

Parameters

parent The parent QObject

Definition at line 84 of file node.cpp.

◆ ~Node()

Node::~Node ( )

override

Destructor.

Definition at line 86 of file node.cpp.

Member Function Documentation

◆ containerTemplate()

Template * Node::containerTemplate ( ) const

protected

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

Definition at line 107 of file node.cpp.

References QObject::parent().

Referenced by MediaFinderNode::render(), IncludeNode::render(), and ConstantIncludeNode::render().

◆ render()

virtual void Cutelee::Node::render	(	OutputStream *	stream,
		Context *	c
	)		const

pure virtual

Reimplement this to render the template in the Context c.

This will also involve calling render on and child nodes.

Implemented in TestLibraryTag, AutoescapeNode, CommentNode, CycleNode, DebugNode, FilterNode, FirstOfNode, ForNode, IfNode, IfChangedNode, IfEqualNode, LoadNode, MediaFinderNode, NowNode, RangeNode, RegroupNode, SpacelessNode, TemplateTagNode, WidthRatioNode, WithNode, I18nNode, I18nVarNode, I18ncNode, I18ncVarNode, I18ncpNode, I18ncpVarNode, I18npNode, I18npVarNode, L10nFileSizeNode, L10nFileSizeVarNode, L10nMoneyNode, L10nMoneyVarNode, WithLocaleNode, BlockNode, ExtendsNode, IncludeNode, ConstantIncludeNode, and ScriptableNode.

◆ streamValueInContext()

void Node::streamValueInContext	(	OutputStream *	stream,
		const QVariant &	input,
		Cutelee::Context *	c
	)		const

protected

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

This is only relevant to developing template tags.

Definition at line 88 of file node.cpp.

References Cutelee::getSafeString(), Cutelee::SafeString::isSafe(), QString::number(), QVariant::userType(), and QVariant::value().

Referenced by MediaFinderNode::render(), I18nNode::render(), I18ncNode::render(), I18ncpNode::render(), I18npNode::render(), L10nFileSizeNode::render(), and L10nMoneyNode::render().

Public Member Functions

Protected Member Functions

Additional Inherited Members