Cutelyst  2.14.2
Signals | Public Member Functions | Properties | List of all members
Cutelyst::ViewEmailTemplate Class Referencefinal

#include <viewemailtemplate.h>

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

Signals

void changedProp ()
 
- Signals inherited from Cutelyst::ViewEmail
void changed ()
 

Public Member Functions

 ViewEmailTemplate (QObject *parent, const QString &name=QString())
 Constructs a new ViewEmailTemplate object with the given parent and name.
 
QString defaultView () const
 
virtual QByteArray render (Context *c) const override
 
void setDefaultView (const QString &view)
 
void setTemplatePrefix (const QString &prefix)
 
QString templatePrefix () const
 
- Public Member Functions inherited from Cutelyst::ViewEmail
 ViewEmail (QObject *parent, const QString &name=QString())
 Constructs a new ViewEmail object with the given parent and name.
 
bool async () const
 
QByteArray defaultCharset () const
 
QByteArray defaultContentType () const
 
QByteArray defaultEncoding () const
 
AuthMethod senderAuthMethod () const
 
ConnectionType senderConnectionType () const
 
QString senderHost () const
 
QString senderPassword () const
 
int senderPort () const
 
QString senderUser () const
 
void setAsync (bool enable)
 
void setDefaultCharset (const QByteArray &charset)
 
void setDefaultContentType (const QByteArray &contentType)
 
void setDefaultEncoding (const QByteArray &encoding)
 
void setSenderAuthMethod (AuthMethod method)
 
void setSenderConnectionType (ConnectionType ct)
 
void setSenderHost (const QString &host)
 
void setSenderPassword (const QString &password)
 
void setSenderPort (int port)
 
void setSenderUser (const QString &user)
 
void setStashKey (const QString &stashKey)
 
QString stashKey () const
 
- Public Member Functions inherited from Cutelyst::View
 View (QObject *parent, const QString &name)
 
virtual Modifiers modifiers () const override
 
void setMinimalSizeToDeflate (qint32 minSize=-1)
 
- 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
 
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
 

Properties

QString defaultView
 
QString templatePrefix
 
- Properties inherited from Cutelyst::ViewEmail
bool async
 
QByteArray defaultCharset
 
QByteArray defaultContentType
 
QByteArray defaultEncoding
 
QString stashKey
 
- Properties inherited from QObject
 objectName
 

Additional Inherited Members

- Public Types inherited from Cutelyst::ViewEmail
enum  AuthMethod { AuthNone, AuthPlain, AuthLogin, AuthCramMd5 }
 
enum  ConnectionType { TcpConnection, SslConnection, TlsConnection }
 
- 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)
 
- Protected Member Functions inherited from Cutelyst::ViewEmail
 ViewEmail (ViewEmailPrivate *d, QObject *parent, const QString &name=QString())
 Constructs a new ViewEmail object using the private class, parent and name.
 
- Protected Member Functions inherited from Cutelyst::View
 View (ViewPrivate *d, QObject *parent, const QString &name)
 A derived class using pimpl should call this constructor, to reduce the number of memory allocations.
 
- 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
 
int receivers (const char *signal) const
 
QObjectsender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

ViewEmailTemplate is a Cutelyst::View handler that renders stash data using another view and send the result via e-mail.

Definition at line 31 of file viewemailtemplate.h.

Member Function Documentation

QString Cutelyst::ViewEmailTemplate::defaultView ( ) const

Returns the default view used to render the templates.

QByteArray ViewEmailTemplate::render ( Context c) const
overridevirtual
void ViewEmailTemplate::setDefaultView ( const QString view)

Defines the default view used to render the templates. If none is specified neither here nor in the stash Cutelysts default view is used. Warning: if you don't tell Cutelyst explicit which of your views should be its default one, this class may choose the wrong one!

Definition at line 58 of file viewemailtemplate.cpp.

void ViewEmailTemplate::setTemplatePrefix ( const QString prefix)

Defines the optional prefix to look somewhere under the existing configured template paths.

Definition at line 45 of file viewemailtemplate.cpp.

QString Cutelyst::ViewEmailTemplate::templatePrefix ( ) const

Returns the optional prefix to look somewhere under the existing configured template paths.