Cutelyst  2.14.2
Public Member Functions | List of all members
Cutelyst::DispatchTypePath Class Referencefinal
Inheritance diagram for Cutelyst::DispatchTypePath:
Inheritance graph
[legend]

Public Member Functions

 DispatchTypePath (QObject *parent=nullptr)
 
virtual bool inUse () override
 
virtual QByteArray list () const override
 list the registered actions To be implemented by subclasses
 
virtual MatchType match (Context *c, const QString &path, const QStringList &args) const override
 
virtual bool registerAction (Action *action) override
 registerAction More...
 
virtual QString uriForAction (Action *action, const QStringList &captures) const override
 
- Public Member Functions inherited from Cutelyst::DispatchType
 DispatchType (QObject *parent=nullptr)
 
virtual ActionexpandAction (const Context *c, Action *action) const
 
virtual bool isLowPrecedence () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectList & children () const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const
 
bool disconnect (const QObject *receiver, const char *method) const
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArraydynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const
 
bool inherits (const char *className) const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const
 
bool isWindowType () const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const
 
QVariant property (const char *name) const
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval, Qt::TimerType timerType)
 
QThreadthread () const
 

Additional Inherited Members

- Public Types inherited from Cutelyst::DispatchType
enum  MatchType { NoMatch, PartialMatch, ExactMatch }
 
- 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)
 
- Protected Member Functions inherited from Cutelyst::DispatchType
void setupMatchedAction (Context *c, Action *action) const
 
- 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
 
int receivers (const char *signal) const
 
QObjectsender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

Definition at line 28 of file dispatchtypepath.h.

Constructor & Destructor Documentation

DispatchTypePath::DispatchTypePath ( QObject parent = nullptr)
explicit

Constructs a DispatchTypePath object with the given parent.

Definition at line 30 of file dispatchtypepath.cpp.

Member Function Documentation

bool DispatchTypePath::inUse ( )
overridevirtual

If false the dispatcher will be unregistered for performance reasons. This method can be used to prepare actions for dispatcher as in a Chain of Actions there is no garantee of registering order.

In the common case if the dispatcher has registered any action, or in some special case that it doesn't need actions it will return true.

Implements Cutelyst::DispatchType.

Definition at line 134 of file dispatchtypepath.cpp.

Cutelyst::DispatchType::MatchType DispatchTypePath::match ( Context c,
const QString path,
const QStringList args 
) const
overridevirtual

Return true if the dispatchType matches the given path

Implements Cutelyst::DispatchType.

Definition at line 77 of file dispatchtypepath.cpp.

References QString::isEmpty(), Cutelyst::Request::setArguments(), Cutelyst::Request::setMatch(), Cutelyst::DispatchType::setupMatchedAction(), and QList::size().

bool DispatchTypePath::registerAction ( Action action)
overridevirtual
Parameters
action
Returns

Reimplemented from Cutelyst::DispatchType.

Definition at line 117 of file dispatchtypepath.cpp.

References Cutelyst::Action::attributes().

QString DispatchTypePath::uriForAction ( Cutelyst::Action action,
const QStringList captures 
) const
overridevirtual

Get a URI part for an action Always returns NULL if captures is not empty since Path actions don't have captures

Implements Cutelyst::DispatchType.

Definition at line 140 of file dispatchtypepath.cpp.

References Cutelyst::Action::attributes(), QList::isEmpty(), QString::isEmpty(), and QString::startsWith().