Cutelyst::RenderView Class Reference

Sensible default end action. More...

#include <Cutelyst/Actions/RenderView/RenderView>

Inheritance diagram for Cutelyst::RenderView:

Public Member Functions
	RenderView (QObject *parent=nullptr)
virtual bool	init (Application *application, const QVariantHash &args) override
Public Member Functions inherited from Cutelyst::Action
	Action (QObject *parent=nullptr)
QString	attribute (const QString &name, const QString &defaultValue=QString()) const
QMap< QString, QString >	attributes () const
QString	className () const
Controller *	controller () const
bool	dispatch (Context *c)
virtual bool	match (int numberOfArgs) const
virtual bool	matchCaptures (int numberOfCaptures) const
virtual Modifiers	modifiers () const override
QString	ns () const
virtual qint8	numberOfArgs () const
virtual qint8	numberOfCaptures () const
void	setAttributes (const QMap< QString, QString > &attributes)
Public Member Functions inherited from Cutelyst::Component
	Component (QObject *parent=nullptr)
bool	execute (Context *c)
QString	name () const
QString	reverse () const
void	setName (const QString &name)
void	setReverse (const QString &reverse)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
bool	blockSignals (bool block)
const QObjectList &	children () const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const
bool	disconnect (const QObject *receiver, const char *method) const
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const
QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const
bool	inherits (const char *className) const
void	installEventFilter (QObject *filterObj)
bool	isWidgetType () const
bool	isWindowType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
QString	objectName () const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const
QVariant	property (const char *name) const
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval, Qt::TimerType timerType)
QThread *	thread () const

Protected Member Functions
virtual bool	doExecute (Cutelyst::Context *c) override
Protected Member Functions inherited from Cutelyst::Action
	Action (ActionPrivate *ptr, QObject *parent=nullptr)
	A derived class using pimpl should call this constructor, to reduce the number of memory allocations.
void	setController (Controller *controller)
void	setMethod (const QMetaMethod &method)
void	setupAction (const QVariantHash &args, Application *app)
Protected Member Functions inherited from Cutelyst::Component
	Component (ComponentPrivate *d, QObject *parent=nullptr)
	A derived class using pimpl should call this constructor, to reduce the number of memory allocations.
virtual bool	afterExecute (Context *c)
void	applyRoles (const QStack< Component * > &roles)
virtual bool	aroundExecute (Context *c, QStack< Component * > stack)
virtual bool	beforeExecute (Context *c)
virtual bool	dispatcherReady (const Dispatcher *dispatch, Controller *controller)
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
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Public Types inherited from Cutelyst::Component
enum	Modifier {   None, OnlyExecute, BeforeExecute, AroundExecute,   AfterExecute }
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 *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
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, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Properties inherited from QObject
	objectName

Detailed Description

This action implements a sensible default end action, which will forward to the first available view or a custom one, unless c->res()->status() is a 3xx code (redirection, not modified, etc.), 204 (no content), HEAD methods, or c->res()->body() has already been set.

If you have more than one view, you can specify which one to use with the :View(view_name) attribute or one set with c->setView() otherwise this module simply calls c->view() with no argument.

The RenderView action allows to easily call a renderer without including it's header and add implementation code, all that is needed is an anotation to the Controller's method:

class Users : public Cutelyst::Controller
{
public:
  C_ATTR(End, :ActionClass(RenderView))
  void End(Context *c);
};

The above will render with the default view added to Cutelyst::Application, if you want it to render with another view just add the View(name) keyword:

...
  C_ATTR(End, :ActionClass(RenderView) :View(ajax_view))
  void End(Context *c);
...

Definition at line 28 of file renderview.h.

Constructor & Destructor Documentation

RenderView::RenderView ( QObject *  parent = nullptr )

explicit

Constructs a RenderView object with the given

• parent.

Definition at line 65 of file renderview.cpp.

References QString::fromLatin1().

Member Function Documentation

bool RenderView::doExecute ( Cutelyst::Context *  c )

overrideprotectedvirtual

Execute this action against

Reimplemented from Cutelyst::Action.

Definition at line 80 of file renderview.cpp.

References Cutelyst::Response::contentType(), Cutelyst::Context::customView(), Cutelyst::Action::doExecute(), Cutelyst::Context::forward(), Cutelyst::Response::hasBody(), QString::isEmpty(), Cutelyst::Context::res(), Cutelyst::Response::setContentType(), Cutelyst::Response::setStatus(), and Cutelyst::Response::status().

bool RenderView::init ( Cutelyst::Application *  application, const QVariantHash &  args  )

overridevirtual

Reimplemented from Plugin::init()

Reimplemented from Cutelyst::Component.

Definition at line 70 of file renderview.cpp.

References Cutelyst::Action::attributes(), Cutelyst::Component::init(), and Cutelyst::Application::view().