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={}) const
ParamsMultiMap	attributes () const noexcept
QString	className () const
Controller *	controller () const
bool	dispatch (Context *c)
virtual bool	match (int numberOfArgs) const noexcept
virtual bool	matchCaptures (int numberOfCaptures) const noexcept
virtual Modifiers	modifiers () const override
QString	ns () const noexcept
virtual qint8	numberOfArgs () const noexcept
virtual qint8	numberOfCaptures () const noexcept
void	setAttributes (const ParamsMultiMap &attributes)
Public Member Functions inherited from Cutelyst::Component
	Component (QObject *parent=nullptr)
bool	execute (Context *c)
virtual bool	init (Application *application, const QVariantHash &args)
virtual Modifiers	modifiers () const
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 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
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.
virtual bool	doExecute (Context *c) override
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)
virtual bool	doExecute (Context *c)
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
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 *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

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 15 of file renderview.h.

Constructor & Destructor Documentation

RenderView()

RenderView::RenderView ( QObject *  parent = nullptr )

explicit

Constructs a RenderView object with the given

• parent.

Definition at line 50 of file renderview.cpp.

References Cutelyst::Action::className(), QString::fromLatin1(), QObject::metaObject(), and QObject::setObjectName().

Member Function Documentation

doExecute()

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

overrideprotectedvirtual

Execute this action against

Reimplemented from Cutelyst::Action.

Definition at line 67 of file renderview.cpp.

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

init()

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

overridevirtual

Reimplemented from Plugin::init()

Reimplemented from Cutelyst::Component.

Definition at line 56 of file renderview.cpp.

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