Cutelyst::Component Class Reference

The Cutelyst Component base class. More...

#include <Cutelyst/Component>

Inheritance diagram for Cutelyst::Component:

Public Types
enum	Modifier {   None , OnlyExecute , BeforeExecute , AroundExecute ,   AfterExecute }

Public Member Functions
	Component (QObject *parent=nullptr)
bool	execute (Context *c)
virtual bool	init (Application *application, const QVariantHash &args)
virtual Modifiers	modifiers () const
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 ()
void	dumpObjectInfo () const const
void	dumpObjectTree ()
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, 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 QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName, QPrivateSignal)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_DISABLE_COPY (Class)
	Q_DISABLE_COPY_MOVE (Class)
	Q_DISABLE_MOVE (Class)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qFindChild (const QObject *obj, const QString &name)
QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)
QList< T >	qFindChildren (const QObject *obj, const QString &name)
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
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)
QThread *	thread () const const

Protected Member Functions
	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)
virtual bool	doExecute (Context *c)
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
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Friends
class	Controller

Additional Inherited Members
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 *context, Functor functor, 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)
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, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Public Attributes inherited from QObject
typedef	QObjectList
Properties inherited from QObject
	objectName

Detailed Description

This is the base class of a Cutelyst component

Definition at line 25 of file component.h.

Member Enumeration Documentation

Modifier

enum Cutelyst::Component::Modifier

This value defines which kind of modifiers should be executed

Definition at line 32 of file component.h.

Constructor & Destructor Documentation

Component() [1/2]

Component::Component ( QObject * parent = nullptr )

explicit

This is the base class for many Cutelyst objects, prividing access to name and reverse for actions, and modifiers to customize execution.

Definition at line 11 of file component.cpp.

References QObject::QObject(), and QObject::parent().

Referenced by Cutelyst::Action::Action(), Cutelyst::Action::Action(), Cutelyst::AuthenticationRealm::AuthenticationRealm(), Cutelyst::RoleACL::RoleACL(), Cutelyst::View::View(), Cutelyst::View::View(), applyRoles(), aroundExecute(), dispatcherReady(), execute(), name(), reverse(), setName(), and setReverse().

~Component()

Component::~Component ( )

overridevirtual

Definition at line 23 of file component.cpp.

Component() [2/2]

Component::Component ( ComponentPrivate * d, QObject * parent = nullptr )

explicitprotected

Definition at line 17 of file component.cpp.

References QObject::QObject(), and QObject::parent().

Member Function Documentation

afterExecute()

bool Component::afterExecute ( Context * c )

protectedvirtual

Reimplement this if you want to do processing after doExecute

Definition at line 121 of file component.cpp.

applyRoles()

void Component::applyRoles ( const QStack< Component * > & roles )

protected

Call this to install before, around and after roles

Definition at line 133 of file component.cpp.

References Component().

aroundExecute()

bool Component::aroundExecute ( Context * c, QStack< Component * > stack )

protectedvirtual

Reimplement this if you want to do processing around doExecute, you must call doExecute yourself then

Reimplemented in Cutelyst::RoleACL.

Definition at line 103 of file component.cpp.

References Component(), aroundExecute(), doExecute(), QStack::pop(), and QVector::size().

Referenced by aroundExecute(), Cutelyst::RoleACL::aroundExecute(), and execute().

beforeExecute()

bool Component::beforeExecute ( Context * c )

protectedvirtual

Reimplement this if you want to do processing before doExecute

Definition at line 97 of file component.cpp.

dispatcherReady()

bool Component::dispatcherReady ( const Dispatcher * dispatch, Controller * controller )

protectedvirtual

Called by dispatcher once it's done preparing actions

Subclasses might want to implement this to cache special actions, such as special methods for REST actions

Reimplemented in Cutelyst::RoleACL.

Definition at line 154 of file component.cpp.

References Component().

doExecute()

bool Component::doExecute ( Context * c )

protectedvirtual

Reimplement this for the main processing

Reimplemented in Cutelyst::Action, Cutelyst::ActionChain, Cutelyst::ActionREST, and Cutelyst::RenderView.

Definition at line 127 of file component.cpp.

Referenced by aroundExecute(), and execute().

execute()

bool Component::execute

(

Context *

c

)

Executes this component agains the Context

Definition at line 64 of file component.cpp.

References Component(), aroundExecute(), doExecute(), and QVector::push_front().

Referenced by Cutelyst::Context::execute().

init()

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

virtual

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 in Cutelyst::RenderView, and Cutelyst::RoleACL.

Definition at line 57 of file component.cpp.

Referenced by Cutelyst::RenderView::init(), and Cutelyst::Action::setupAction().

modifiers()

Component::Modifiers Component::modifiers ( ) const

virtual

Reimplement to return custom Modifiers, default is None

Reimplemented in Cutelyst::Action, Cutelyst::RoleACL, and Cutelyst::View.

Definition at line 28 of file component.cpp.

name()

QString Component::name

(

)

const

Returns the sub name of this Component.

Definition at line 33 of file component.cpp.

References Component().

Referenced by Cutelyst::AuthenticationRealm::AuthenticationRealm(), Cutelyst::ClearSilver::ClearSilver(), Cutelyst::CuteleeView::CuteleeView(), Cutelyst::GrantleeView::GrantleeView(), Cutelyst::View::View(), Cutelyst::View::View(), Cutelyst::ViewEmail::ViewEmail(), Cutelyst::ViewEmail::ViewEmail(), Cutelyst::ViewEmailTemplate::ViewEmailTemplate(), Cutelyst::ViewJson::ViewJson(), Cutelyst::Action::attribute(), Cutelyst::Context::execute(), Cutelyst::AuthenticationRealm::findUser(), Cutelyst::DispatchTypeChained::registerAction(), Cutelyst::View::render(), setName(), Cutelyst::ClearSilver::setWrapper(), Cutelyst::CuteleeView::setWrapper(), and Cutelyst::GrantleeView::setWrapper().

reverse()

QString Component::reverse

(

)

const

Returns the private name of this component.

Definition at line 45 of file component.cpp.

References Component().

Referenced by Cutelyst::Context::execute(), Cutelyst::DispatchTypeChained::match(), Cutelyst::DispatchTypeChained::registerAction(), Cutelyst::ClearSilver::render(), Cutelyst::CuteleeView::render(), Cutelyst::GrantleeView::render(), and setReverse().

setName()

void Component::setName

(

const QString &

name

)

Defines the sub name of this Component.

Definition at line 39 of file component.cpp.

References Component(), and name().

Referenced by Cutelyst::ActionChain::ActionChain(), Cutelyst::AuthenticationRealm::AuthenticationRealm(), Cutelyst::View::View(), and Cutelyst::View::View().

setReverse()

void Component::setReverse

(

const QString &

reverse

)

Defines the private name of this Component.

Definition at line 51 of file component.cpp.

References Component(), and reverse().

Referenced by Cutelyst::ActionChain::ActionChain().

Friends And Related Symbol Documentation

Controller

friend class Controller

friend

Definition at line 130 of file component.h.