Sensible default end action that forwards to a View. More...

Inheritance diagram for Cutelyst::RenderView:

[legend]

Public Member Functions
	RenderView (QObject *parent=nullptr)
bool	init (Application *application, const QVariantHash &args) override
Public Member Functions inherited from Cutelyst::Action
	Action (QObject *parent=nullptr)
virtual	~Action () override=default
QString	attribute (const QString &name, const QString &defaultValue={}) const
ParamsMultiMap	attributes () const noexcept
QString	className () const noexcept
Controller *	controller () const noexcept
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
virtual qint8	numberOfCaptures () const
void	setAttributes (const ParamsMultiMap &attributes)
Public Member Functions inherited from Cutelyst::Component
	Component (QObject *parent=nullptr)
virtual	~Component () override
bool	execute (Context *c)
QString	name () const noexcept
QString	reverse () const noexcept
void	setName (const QString &name)
void	setReverse (const QString &reverse)

Protected Member Functions
bool	doExecute (Cutelyst::Context *c) override
Protected Member Functions inherited from Cutelyst::Action
	Action (ActionPrivate ptr, QObject parent=nullptr)
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)
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(name) attribute or one set with c->setCustomView() otherwise this module simply calls c->view() with no argument what will return the default View.

The RenderView action allows to easily call a renderer without including it’s header and add implementation code, all that is needed is an annotation 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 without a name, 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);
...

See also: View

Logging category: cutelyst.renderview
Logging with Cutelyst

Definition at line 14 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 59 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

This will forward execution to either a custom view or to a view set as method attribute via :View(name) or to the default view.

If the Content-Type header of the Response has not been already set, it will be set to 'text/html; charset=utf-8'.

If the Request is a HEAD request or if the Response::body() has already been set, this will do nothing and will return true. The same is true for when the Response::status() has already been set to 204 (no content) or 3xx.

Reimplemented from Cutelyst::Action.

Definition at line 75 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::req, Cutelyst::Context::res(), Cutelyst::Response::setContentType(), Cutelyst::Response::setStatus(), and Cutelyst::Response::status().

◆ init()

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

overridevirtual

Initializes the RenderView action by looking for a view name in the method attributes. The default view will be used if no :View(name) has been declard on the method attributes.

Reimplemented from Cutelyst::Component.

Definition at line 65 of file renderview.cpp.

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

Public Member Functions