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

#include <renderview.h>

Inheritance diagram for Cutelyst::RenderView:
Inheritance graph

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
 name More...
QString reverse () const
 name More...
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)

Protected Attributes

RenderViewPrivate * d_ptr
- Protected Attributes inherited from Cutelyst::Action
ActionPrivate * d_ptr
- Protected Attributes inherited from Cutelyst::Component
ComponentPrivate * d_ptr

Additional Inherited Members

- Public Types inherited from Cutelyst::Component
enum  Modifier {
  None, OnlyExecute, BeforeExecute, AroundExecute,

Detailed Description

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

Member Function Documentation

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

Execute this action against

Reimplemented from Cutelyst::Action.

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

A Does class is always attached to an action, if this method returns false the application will fail to start. Often useful if the user misconfigured the settings

Reimplemented from Cutelyst::Component.