Cutelyst  3.5.0
Public Member Functions | Protected Member Functions | List of all members
Cutelyst::ActionChain Class Reference

Holds a chain of Cutelyst Actions. More...

#include <Cutelyst/ActionChain>

Inheritance diagram for Cutelyst::ActionChain:
Inheritance graph
[legend]

Public Member Functions

 ActionChain (const ActionList &chain, QObject *parent=nullptr)
 
ActionList chain () const noexcept
 
virtual qint8 numberOfCaptures () const noexcept 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
 
Controllercontroller () 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
 
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)
 
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 () const const
 
void dumpObjectInfo ()
 
void dumpObjectTree () const const
 
void dumpObjectTree ()
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, 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 QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
virtual int qt_metacall (QMetaObject::Call, int, void **)
 
virtual void * qt_metacast (const char *)
 
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)
 
QThreadthread () const const
 

Protected Member Functions

virtual bool doExecute (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)
 
- 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
 
QObjectsender () 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 *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
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, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

This class represents a chain of Cutelyst Actions. It behaves exactly like the action at the end of the chain except on dispatch it will execute all the actions in the chain in order.

Definition at line 23 of file actionchain.h.

Constructor & Destructor Documentation

◆ ActionChain()

ActionChain::ActionChain ( const ActionList chain,
QObject parent = nullptr 
)
explicit

Member Function Documentation

◆ chain()

ActionList ActionChain::chain ( ) const
noexcept

The action chain

Returns
a list of Cutelyst::Action objects encapsulated by this chain.

Definition at line 36 of file actionchain.cpp.

Referenced by ActionChain(), and doExecute().

◆ doExecute()

bool ActionChain::doExecute ( Context c)
overrideprotectedvirtual

◆ numberOfCaptures()

qint8 ActionChain::numberOfCaptures ( ) const
overridevirtualnoexcept

Reimplemented from Action::numberOfCaptures()

Reimplemented from Cutelyst::Action.

Definition at line 42 of file actionchain.cpp.