A helper class for subscribing to log messages matching a particular pattern, with the ability to change the pattern at runtime. More...
Inheritance diagram for swift::misc::CLogSubscriber:
Public Member Functions | |
| CLogSubscriber (QObject *parent=nullptr) | |
| Default constructor, for when you're not interested in messages and just want to control the console output. | |
| template<typename T , typename F > | |
| CLogSubscriber (T *parent, F slot) | |
| Construct a subscriber which forwards messages to the given slot of parent. | |
| void | changeSubscription (const CLogPattern &pattern) |
| Change the pattern which you want to subscribe to. More... | |
| void | unsubscribe () |
| Unsubscribe from all messages. More... | |
| 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... | |
 Public Member Functions inherited from QObject | |
| QBindable< QString > | bindableObjectName () |
| 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 | |
| T | qobject_cast (QObject *object) |
| T | 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< QByteArray > | dynamicPropertyNames () 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 |
| QObject * | parent () const const |
| QString | objectName () const const |
| QThread * | thread () const const |
| QVariant | property (const char *name) const const |
| T | findChild (QAnyStringView name, Qt::FindChildOptions options) const const |
| T | 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 QMetaObject * | metaObject () const const |
| const QObjectList & | children () const const |
| void | dumpObjectInfo () const const |
| void | dumpObjectTree () const const |
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 | |
| 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) |
| virtual void | timerEvent (QTimerEvent *event) |
| QObject * | sender () const const |
| bool | isSignalConnected (const QMetaMethod &signal) const const |
| int | receivers (const char *signal) const const |
| int | senderSignalIndex () const const |
| Properties inherited from QObject | |
| objectName | |
Detailed Description
A helper class for subscribing to log messages matching a particular pattern, with the ability to change the pattern at runtime.
Also provides a thread-safe API for interacting with the CLogHandler.
Definition at line 219 of file loghandler.h.
Member Function Documentation
◆ changeSubscription()
| void swift::misc::CLogSubscriber::changeSubscription | ( | const CLogPattern & | pattern | ) |
Change the pattern which you want to subscribe to.
- Remarks
- This function is thread safe. If not called from the main thread, it will run asynchronously.
◆ enableConsoleOutput()
| void swift::misc::CLogSubscriber::enableConsoleOutput | ( | bool | enable | ) |
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.
- Remarks
- This function is thread safe. If not called from the main thread, it will run asynchronously.
◆ inheritConsoleOutput()
| void swift::misc::CLogSubscriber::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.
This is the default, but can be used to reverse the effect of calling enableConsoleOutput.
- Remarks
- This function is thread safe. If not called from the main thread, it will run asynchronously.
◆ unsubscribe()
| void swift::misc::CLogSubscriber::unsubscribe | ( | ) |
Unsubscribe from all messages.
- Remarks
- This function is thread safe. If not called from the main thread, it will run asynchronously.
The documentation for this class was generated from the following file:
- src/misc/loghandler.h
