swift
Public Slots | Signals | Public Member Functions | Protected Member Functions | Friends | List of all members
swift::misc::CLogPatternHandler Class Reference

A class for subscribing to log messages which match particular patterns. More...

Inheritance diagram for swift::misc::CLogPatternHandler:
[legend]

Public Slots

void enableConsoleOutput (bool enable)
 Enable or disable the default Qt handler for messages which match the relevant pattern. More...
 
void inheritConsoleOutput ()
 The policy of whether to enable or disable the default Qt handler for messages which match the relevant pattern will be inherited from the base CLogHandler, or from another CLogPatternHandler which matches a superset of the messages which this one matches. More...
 

Signals

void messageLogged (const swift::misc::CStatusMessage &message)
 Emitted when a message is logged which matches the relevant pattern. More...
 

Public Member Functions

template<typename T , typename F >
QMetaObject::Connection subscribe (T *receiver, F slot)
 Convenience method to connect the messageLogged signal to a slot in the given receiver object.
 
template<typename F >
QMetaObject::Connection subscribe (F slot)
 Convenience method to connect the messageLogged signal to a functor.
 
- Public Member Functions inherited from QObject
QBindable< QStringbindableObjectName ()
 
 QObject (QObject *parent)
 
 QT_NO_CONTEXTLESS_CONNECT QT_NO_CONTEXTLESS_CONNECT
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
 Q_CLASSINFO (Name, Value)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUMS (...)
 
 Q_ENUM_NS (...)
 
 Q_FLAG (...)
 
 Q_FLAGS (...)
 
 Q_FLAG_NS (...)
 
 Q_GADGET Q_GADGET
 
 Q_GADGET_EXPORT (EXPORT_MACRO)
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_MOC_INCLUDE Q_MOC_INCLUDE
 
 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
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
bool blockSignals (bool block)
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
bool moveToThread (QThread *targetThread)
 
bool setProperty (const char *name, QVariant &&value)
 
bool setProperty (const char *name, const QVariant &value)
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::nanoseconds interval, Qt::TimerType timerType)
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
void installEventFilter (QObject *filterObj)
 
void killTimer (Qt::TimerId id)
 
void killTimer (int id)
 
void objectNameChanged (const QString &objectName)
 
void removeEventFilter (QObject *obj)
 
void setObjectName (QAnyStringView name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
QList< QByteArraydynamicPropertyNames () const const
 
QList< T > findChildren (QAnyStringView name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
QObjectparent () const const
 
QString objectName () const const
 
QThreadthread () const const
 
QVariant property (const char *name) const const
 
findChild (QAnyStringView name, Qt::FindChildOptions options) const const
 
findChild (Qt::FindChildOptions options) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool inherits (const char *className) const const
 
bool isQuickItemType () const const
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
bool signalsBlocked () const const
 
virtual const QMetaObjectmetaObject () const const
 
const QObjectListchildren () const const
 
void dumpObjectInfo () const const
 
void dumpObjectTree () const const
 

Protected Member Functions

void connectNotify (const QMetaMethod &signal)
 
void disconnectNotify (const QMetaMethod &signal)
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void customEvent (QEvent *event)
 
virtual void timerEvent (QTimerEvent *event)
 
QObjectsender () const const
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
int senderSignalIndex () const const
 

Friends

class CLogHandler
 

Additional Inherited Members

- Public Types inherited from QObject
enum  TimerId
 
- Static Public Member Functions inherited from QObject
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)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction 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, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
bool disconnect (const QMetaObject::Connection &connection)
 
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)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
 Invalid
 
- Properties inherited from QObject
 objectName
 

Detailed Description

A class for subscribing to log messages which match particular patterns.

See also
CLogHandler::handlerForPattern

Definition at line 113 of file loghandler.h.

Member Function Documentation

◆ connectNotify()

void swift::misc::CLogPatternHandler::connectNotify ( const QMetaMethod signal)
inlineprotectedvirtual

Reimplemented from QObject.

Definition at line 183 of file loghandler.h.

◆ disconnectNotify()

void swift::misc::CLogPatternHandler::disconnectNotify ( const QMetaMethod signal)
inlineprotectedvirtual

Reimplemented from QObject.

Definition at line 192 of file loghandler.h.

◆ enableConsoleOutput

void swift::misc::CLogPatternHandler::enableConsoleOutput ( bool  enable)
inlineslot

Enable or disable the default Qt handler for messages which match the relevant pattern.

The setting of this property in one CLogPatternHandler can override the setting in another CLogPatternHandler or the base CLogHandler, if this handler's pattern is a subset of the other handler's pattern. Which is to say, more specific patterns can override less specific patterns.

Definition at line 125 of file loghandler.h.

◆ inheritConsoleOutput

void swift::misc::CLogPatternHandler::inheritConsoleOutput ( )
inlineslot

The policy of whether to enable or disable the default Qt handler for messages which match the relevant pattern will be inherited from the base CLogHandler, or from another CLogPatternHandler which matches a superset of the messages which this one matches.

This is the default, but can be used to reverse the effect of calling enableConsoleOutput.

Definition at line 140 of file loghandler.h.

◆ messageLogged

void swift::misc::CLogPatternHandler::messageLogged ( const swift::misc::CStatusMessage message)
signal

Emitted when a message is logged which matches the relevant pattern.

When all slots are disconnected from this signal, the CLogPatternHandler could be deleted.

Note that if a message matches more than one handler's pattern, then this signal will be emitted for all of those handlers, so if a slot is connected to all of them then it will be called multiple times. Use the methods CStatusMessage::markAsHandledBy() and CStatusMessage::wasHandledBy() to detect this case in the slot and avoid multiple handlings of the same message. Caveat: for this to work, the slot must take its argument by non-const reference, and be connected by Qt::DirectConnection (i.e. the receiver is in the same thread as the CLogHandler).


The documentation for this class was generated from the following file: