Sensible default end action. More...

#include <Cutelyst/Actions/RenderView/RenderView>

Inheritance diagram for Cutelyst::RenderView:

[legend]

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)

QString	name () const

QString	reverse () const

void	setName (const QString &name)

void	setReverse (const QString &reverse)

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)

Additional Inherited Members
Public Types inherited from Cutelyst::Component
enum	Modifier { None , OnlyExecute , BeforeExecute , AroundExecute , AfterExecute }

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::Action(), and Cutelyst::Action::className().

Referenced by doExecute(), and init().

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 RenderView(), Cutelyst::Response::contentType(), Cutelyst::Context::customView(), Cutelyst::Action::doExecute(), Cutelyst::Context::forward(), Cutelyst::Response::hasBody(), 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 RenderView(), Cutelyst::Action::attributes(), Cutelyst::Component::init(), and Cutelyst::Application::view().

Public Member Functions