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
QQmlThreadPrivate Class Reference
+ Inheritance diagram for QQmlThreadPrivate:
+ Collaboration diagram for QQmlThreadPrivate:

Public Types

typedef QFieldList< QQmlThread::Message, &QQmlThread::Message::next > MessageList
 
- Public Types inherited from QThread
enum  Priority {
  IdlePriority , LowestPriority , LowPriority , NormalPriority ,
  HighPriority , HighestPriority , TimeCriticalPriority , InheritPriority
}
 

Public Member Functions

 QQmlThreadPrivate (QQmlThread *)
 
QMutexmutex ()
 
void lock ()
 
void unlock ()
 
void wait ()
 
void wakeOne ()
 
void triggerMainEvent ()
 
void triggerThreadEvent ()
 
void mainEvent ()
 
void threadEvent ()
 
- Public Member Functions inherited from QThread
 QThread (QObject *parent=nullptr)
 
 ~QThread ()
 
void setPriority (Priority priority)
 
Priority priority () const
 
bool isFinished () const
 
bool isRunning () const
 
void requestInterruption ()
 
bool isInterruptionRequested () const
 
void setStackSize (uint stackSize)
 
uint stackSize () const
 
QAbstractEventDispatchereventDispatcher () const
 
void setEventDispatcher (QAbstractEventDispatcher *eventDispatcher)
 
bool event (QEvent *event) override
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
 
int loopLevel () const
 
bool isCurrentThread () const
 
bool wait (QDeadlineTimer deadline=QDeadlineTimer(QDeadlineTimer::Forever))
 
bool wait (unsigned long time)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. time is the time to wait in milliseconds.
 
- 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 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< QStringbindableObjectName ()
 
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).
 
QThreadthread () 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 >
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 >
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 QObjectListchildren () 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< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () 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 Attributes

QQmlThreadq
 
bool m_threadProcessing
 
bool m_mainProcessing
 
bool m_shutdown
 
bool m_mainThreadWaiting
 
MessageList threadList
 
MessageList mainList
 
QQmlThread::Message * mainSync
 

Protected Member Functions

bool event (QEvent *) override
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
 
- Protected Member Functions inherited from QThread
virtual void run ()
 
int exec ()
 
 QThread (QThreadPrivate &dd, QObject *parent=nullptr)
 
- Protected Member Functions inherited from QObject
QObjectsender () 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)
 

Additional Inherited Members

- Public Slots inherited from QThread
void start (Priority=InheritPriority)
 
void terminate ()
 
void exit (int retcode=0)
 
void quit ()
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- Signals inherited from QThread
void started (QPrivateSignal)
 
void finished (QPrivateSignal)
 
- 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 QThread
static Qt::HANDLE currentThreadId () noexcept Q_DECL_PURE_FUNCTION
 
static QThreadcurrentThread ()
 
static bool isMainThread ()
 
static int idealThreadCount () noexcept
 
static void yieldCurrentThread ()
 
template<typename Function , typename... Args>
static QThreadcreate (Function &&f, Args &&... args)
 
static void sleep (unsigned long)
 
static void msleep (unsigned long)
 
static void usleep (unsigned long)
 
static void sleep (std::chrono::nanoseconds nsec)
 
- 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)
 
- Static Protected Member Functions inherited from QThread
static void setTerminationEnabled (bool enabled=true)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Detailed Description

Definition at line 18 of file qqmlthread.cpp.

Member Typedef Documentation

◆ MessageList

typedef QFieldList<QQmlThread::Message, &QQmlThread::Message::next> QQmlThreadPrivate::MessageList

Definition at line 35 of file qqmlthread.cpp.

Constructor & Destructor Documentation

◆ QQmlThreadPrivate()

QQmlThreadPrivate::QQmlThreadPrivate ( QQmlThread * q)

Definition at line 92 of file qqmlthread.cpp.

References QStringLiteral, QObject::setObjectName(), and QThread::setStackSize().

+ Here is the call graph for this function:

Member Function Documentation

◆ event()

bool QQmlThreadPrivate::event ( QEvent * e)
overrideprotectedvirtual

This virtual function receives events to an object and should return true if the event e was recognized and processed.

The event() function can be reimplemented to customize the behavior of an object.

Make sure you call the parent event class implementation for all the events you did not handle.

Example:

class MyClass : public QWidget
{
public:
MyClass(QWidget *parent = nullptr);
bool event(QEvent* ev) override
{
if (ev->type() == QEvent::PolishRequest) {
// overwrite handling of PolishRequest if any
doThings();
return true;
} else if (ev->type() == QEvent::Show) {
// complement handling of Show if any
doThings2();
return true;
}
// Make sure the rest of events are handled
return QWidget::event(ev);
}
};
See also
installEventFilter(), timerEvent(), QCoreApplication::sendEvent(), QCoreApplication::postEvent()

Reimplemented from QObject.

Definition at line 102 of file qqmlthread.cpp.

References QThread::event(), threadEvent(), QEvent::type(), and QEvent::User.

+ Here is the call graph for this function:

◆ lock()

void QQmlThreadPrivate::lock ( )
inline

Definition at line 25 of file qqmlthread.cpp.

References QMutex::lock().

Referenced by QQmlThread::lock(), mainEvent(), QQmlThread::shutdown(), and threadEvent().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mainEvent()

void QQmlThreadPrivate::mainEvent ( )

Definition at line 109 of file qqmlthread.cpp.

References QFieldList< N, nextMember >::isEmpty(), lock(), m_mainProcessing, mainList, mainSync, QFieldList< N, nextMember >::takeFirst(), unlock(), and wakeOne().

+ Here is the call graph for this function:

◆ mutex()

QMutex & QQmlThreadPrivate::mutex ( )
inline

Definition at line 24 of file qqmlthread.cpp.

Referenced by QQmlThread::mutex().

+ Here is the caller graph for this function:

◆ threadEvent()

void QQmlThreadPrivate::threadEvent ( )

Definition at line 136 of file qqmlthread.cpp.

References QFieldList< N, nextMember >::first(), QFieldList< N, nextMember >::isEmpty(), lock(), m_shutdown, m_threadProcessing, QThread::quit(), QFieldList< N, nextMember >::takeFirst(), threadList, unlock(), and wakeOne().

Referenced by event().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ triggerMainEvent()

void QQmlThreadPrivate::triggerMainEvent ( )

Definition at line 68 of file qqmlthread.cpp.

References QCoreApplication::postEvent(), Q_ASSERT, and QEvent::User.

+ Here is the call graph for this function:

◆ triggerThreadEvent()

void QQmlThreadPrivate::triggerThreadEvent ( )

Definition at line 77 of file qqmlthread.cpp.

References QCoreApplication::postEvent(), Q_ASSERT, and QEvent::User.

Referenced by QQmlThread::shutdown().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ unlock()

void QQmlThreadPrivate::unlock ( )
inline

Definition at line 26 of file qqmlthread.cpp.

References QMutex::unlock().

Referenced by mainEvent(), QQmlThread::shutdown(), threadEvent(), and QQmlThread::unlock().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ wait()

void QQmlThreadPrivate::wait ( )
inline

Definition at line 27 of file qqmlthread.cpp.

References QWaitCondition::wait().

Referenced by QQmlThread::wait(), and QQmlThread::waitForNextMessage().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ wakeOne()

void QQmlThreadPrivate::wakeOne ( )
inline

Definition at line 28 of file qqmlthread.cpp.

References QWaitCondition::wakeOne().

Referenced by mainEvent(), threadEvent(), and QQmlThread::wakeOne().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ m_mainProcessing

bool QQmlThreadPrivate::m_mainProcessing

Definition at line 31 of file qqmlthread.cpp.

Referenced by mainEvent().

◆ m_mainThreadWaiting

bool QQmlThreadPrivate::m_mainThreadWaiting

Definition at line 33 of file qqmlthread.cpp.

Referenced by QQmlThread::waitForNextMessage().

◆ m_shutdown

bool QQmlThreadPrivate::m_shutdown

Definition at line 32 of file qqmlthread.cpp.

Referenced by QQmlThread::isShutdown(), QQmlThread::shutdown(), and threadEvent().

◆ m_threadProcessing

bool QQmlThreadPrivate::m_threadProcessing

Definition at line 30 of file qqmlthread.cpp.

Referenced by threadEvent().

◆ mainList

MessageList QQmlThreadPrivate::mainList

Definition at line 37 of file qqmlthread.cpp.

Referenced by QQmlThread::discardMessages(), and mainEvent().

◆ mainSync

QQmlThread::Message* QQmlThreadPrivate::mainSync

◆ q

QQmlThread* QQmlThreadPrivate::q

Definition at line 22 of file qqmlthread.cpp.

◆ threadList

MessageList QQmlThreadPrivate::threadList

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