Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Properties | List of all members
QQmlLoggingCategory Class Reference

#include <qqmlloggingcategory_p.h>

+ Inheritance diagram for QQmlLoggingCategory:
+ Collaboration diagram for QQmlLoggingCategory:

Public Types

enum  DefaultLogLevel {
  Debug = QtDebugMsg , Info = QtInfoMsg , Warning = QtWarningMsg , Critical = QtCriticalMsg ,
  Fatal = QtFatalMsg
}
 

Public Member Functions

 Q_ENUM (DefaultLogLevel)
 
 QQmlLoggingCategory (QObject *parent=nullptr)
 \qmltype LoggingCategory\inqmlmodule QtQml
 
virtual ~QQmlLoggingCategory ()
 
DefaultLogLevel defaultLogLevel () const
 
void setDefaultLogLevel (DefaultLogLevel defaultLogLevel)
 
QString name () const
 
void setName (const QString &name)
 
QLoggingCategory * category () const
 
void classBegin () override
 Invoked after class creation, but before any properties have been set.
 
void componentComplete () override
 Invoked after the root component that caused this instantiation has completed construction.
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
 
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QString > bindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThread * thread () const
 Returns the thread in which the object lives.
 
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
void killTimer (Qt::TimerId id)
 
template<typename T >
T findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
T findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectList & children () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArray > dynamicPropertyNames () const
 
QBindingStorage * bindingStorage ()
 
const QBindingStorage * bindingStorage () const
 
QObject * parent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 
- Public Member Functions inherited from QQmlParserStatus
 QQmlParserStatus ()
 
virtual ~QQmlParserStatus ()
 

Properties

QString name
 
DefaultLogLevel defaultLogLevel
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
 
- Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
 
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
 
template<typename Func1 , typename Func2 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
 
template<typename Func1 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
 
- Protected Member Functions inherited from QObject
QObject * sender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
 
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr
 
- Related Symbols inherited from QObject
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 
 
 
 \macro Q_CLASSINFO(Name, Value)
 

Detailed Description

Definition at line 30 of file qqmlloggingcategory_p.h.

Member Enumeration Documentation

◆ DefaultLogLevel

enum QQmlLoggingCategory::DefaultLogLevel
Enumerator
Debug 
Info 
Warning 
Critical 
Fatal 

Definition at line 41 of file qqmlloggingcategory_p.h.

Constructor & Destructor Documentation

◆ QQmlLoggingCategory()

QQmlLoggingCategory::QQmlLoggingCategory ( QObject * parent = nullptr)

\qmltype LoggingCategory\inqmlmodule QtQml

Defines a logging category in QML.

Since
5.8

A logging category can be passed to console.log() and friends as the first argument. If supplied to the logger the LoggingCategory's name will be used as logging category. Otherwise the default logging category will be used.

\qml import QtQuick

Item { LoggingCategory { id: category name: "com.qt.category" defaultLogLevel: LoggingCategory.Warning }

Component.onCompleted: { console.log(category, "log message"); console.warn(category, "warning message"); } } \endqml

By default this outputs only {com.qt.category: warning message}. The {log message} is suppressed due to the \l{defaultLogLevel}. You can, however, configure log levels for QML logging categories the same way you can configure them for \l{QLoggingCategory::configuring-categories}{QLoggingCategory}.

Note
As the creation of objects is expensive, it is encouraged to put the needed LoggingCategory definitions into a singleton and import this where needed.
See also
QLoggingCategory

\qmlproperty string QtQml::LoggingCategory::name

Holds the name of the logging category.

Note
This property needs to be set when declaring the LoggingCategory and cannot be changed later.
See also
QLoggingCategory::categoryName()

\qmlproperty enumeration QtQml::LoggingCategory::defaultLogLevel

Since
5.12

Holds the default log level of the logging category. By default it is created with the LoggingCategory.Debug log level.

The following enumeration values are available: \list

  • LoggingCategory.Debug
  • LoggingCategory.Info
  • LoggingCategory.Warning
  • LoggingCategory.Critical
  • LoggingCategory.Fatal \endlist

They mirror the values of the \l{QtMsgType} enumeration.

Note
This property needs to be set when declaring the LoggingCategory and cannot be changed later.
See also
QtMsgType

Definition at line 85 of file qqmlloggingcategory.cpp.

◆ ~QQmlLoggingCategory()

QQmlLoggingCategory::~QQmlLoggingCategory ( )
virtual

Definition at line 91 of file qqmlloggingcategory.cpp.

Member Function Documentation

◆ category()

QLoggingCategory * QQmlLoggingCategory::category ( ) const

Definition at line 105 of file qqmlloggingcategory.cpp.

Referenced by componentComplete().

+ Here is the caller graph for this function:

◆ classBegin()

void QQmlLoggingCategory::classBegin ( )
overridevirtual

Invoked after class creation, but before any properties have been set.

Implements QQmlParserStatus.

Definition at line 110 of file qqmlloggingcategory.cpp.

◆ componentComplete()

void QQmlLoggingCategory::componentComplete ( )
overridevirtual

Invoked after the root component that caused this instantiation has completed construction.

At this point all static values and binding values have been assigned to the class.

Implements QQmlParserStatus.

Definition at line 114 of file qqmlloggingcategory.cpp.

References category(), QByteArray::constData(), QByteArray::isNull(), and qmlWarning().

+ Here is the call graph for this function:

◆ defaultLogLevel()

QQmlLoggingCategory::DefaultLogLevel QQmlLoggingCategory::defaultLogLevel ( ) const

Definition at line 100 of file qqmlloggingcategory.cpp.

◆ name()

QString QQmlLoggingCategory::name ( ) const

Definition at line 95 of file qqmlloggingcategory.cpp.

References QString::fromUtf8().

+ Here is the call graph for this function:

◆ Q_ENUM()

QQmlLoggingCategory::Q_ENUM ( DefaultLogLevel )

◆ setDefaultLogLevel()

void QQmlLoggingCategory::setDefaultLogLevel ( DefaultLogLevel defaultLogLevel)

Definition at line 125 of file qqmlloggingcategory.cpp.

References defaultLogLevel, and qmlWarning().

+ Here is the call graph for this function:

◆ setName()

void QQmlLoggingCategory::setName ( const QString & name)

Definition at line 138 of file qqmlloggingcategory.cpp.

References qmlWarning().

+ Here is the call graph for this function:

Property Documentation

◆ defaultLogLevel

DefaultLogLevel QQmlLoggingCategory::defaultLogLevel
readwrite

Definition at line 36 of file qqmlloggingcategory_p.h.

Referenced by setDefaultLogLevel().

◆ name

QString QQmlLoggingCategory::name
readwrite

Definition at line 35 of file qqmlloggingcategory_p.h.

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