Cutelyst  1.11.0
Public Member Functions | Protected Member Functions | List of all members
Cutelyst::RenderView Class Reference

Sensible default end action. More...

#include <Cutelyst/Actions/RenderView/RenderView>

Inheritance diagram for Cutelyst::RenderView:
Inheritance graph
[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=QString()) const
 
QMap< QString, QString > attributes () const
 
QString className () const
 
Controllercontroller () 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)
 

Protected Member Functions

virtual bool doExecute (Cutelyst::Context *c) override
 
- Protected Member Functions inherited from Cutelyst::Action
void setController (Controller *controller)
 
void setMethod (const QMetaMethod &method)
 
void setupAction (const QVariantHash &args, Application *app)
 
- Protected Member Functions inherited from Cutelyst::Component
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 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.

Member Function Documentation

bool RenderView::doExecute ( Cutelyst::Context c)
overrideprotectedvirtual
bool RenderView::init ( Cutelyst::Application application,
const QVariantHash &  args 
)
overridevirtual

Reimplemented from Plugin::init()

Reimplemented from Cutelyst::Component.

Definition at line 76 of file renderview.cpp.

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