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
QEventDispatcherWasm Class Reference

#include <qeventdispatcher_wasm_p.h>

+ Inheritance diagram for QEventDispatcherWasm:
+ Collaboration diagram for QEventDispatcherWasm:

Public Member Functions

 QEventDispatcherWasm ()
 
 ~QEventDispatcherWasm ()
 
bool processEvents (QEventLoop::ProcessEventsFlags flags) override
 Processes pending events that match flags until there are no more events to process.
 
void registerSocketNotifier (QSocketNotifier *notifier) override
 Registers notifier with the event loop.
 
void unregisterSocketNotifier (QSocketNotifier *notifier) override
 Unregisters notifier from the event dispatcher.
 
void registerTimer (Qt::TimerId timerId, Duration interval, Qt::TimerType timerType, QObject *object) override final
 
bool unregisterTimer (Qt::TimerId timerId) override final
 
bool unregisterTimers (QObject *object) override final
 Unregisters all the timers associated with the given object.
 
QList< TimerInfoV2timersForObject (QObject *object) const override final
 
Duration remainingTime (Qt::TimerId timerId) const override final
 Returns the remaining time of the timer with the given timerId.
 
void interrupt () override
 Interrupts event dispatching.
 
void wakeUp () override
 \threadsafe
 
virtual void onLoaded ()
 
- Public Member Functions inherited from QAbstractEventDispatcher
 QAbstractEventDispatcher (QObject *parent=nullptr)
 Constructs a new event dispatcher with the given parent.
 
 ~QAbstractEventDispatcher ()
 Destroys the event dispatcher.
 
Qt::TimerId registerTimer (Duration interval, Qt::TimerType timerType, QObject *object)
 
virtual void startingUp ()
 
virtual void closingDown ()
 
void installNativeEventFilter (QAbstractNativeEventFilter *filterObj)
 \variable QAbstractEventDispatcher::TimerInfoV2::timerId
 
void removeNativeEventFilter (QAbstractNativeEventFilter *filterObj)
 Removes the event filter filter from this object.
 
bool filterNativeEvent (const QByteArray &eventType, void *message, qintptr *result)
 Sends message through the event filters that were set by installNativeEventFilter().
 
- 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< 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.
 

Static Public Member Functions

static void runOnMainThread (std::function< void(void)> fn)
 
static void socketSelect (int timeout, int socket, bool waitForRead, bool waitForWrite, bool *selectForRead, bool *selectForWrite, bool *socketDisconnect)
 
static void registerStartupTask ()
 
static void completeStarupTask ()
 
static void callOnLoadedIfRequired ()
 
- Static Public Member Functions inherited from QAbstractEventDispatcher
static QAbstractEventDispatcherinstance (QThread *thread=nullptr)
 Returns a pointer to the event dispatcher object for the specified thread.
 
- 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

virtual bool processPostedEvents ()
 
- Protected Member Functions inherited from QAbstractEventDispatcher
 QAbstractEventDispatcher (QAbstractEventDispatcherPrivate &, QObject *parent)
 
- 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 Types inherited from QAbstractEventDispatcher
using Duration = std::chrono::nanoseconds
 A {std::chrono::duration} type that is used in various API in this class.
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- Signals inherited from QAbstractEventDispatcher
void aboutToBlock ()
 This signal is emitted before the event loop calls a function that could block.
 
void awake ()
 This signal is emitted after the event loop returns from a function that could block.
 
- 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.
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Detailed Description

Definition at line 35 of file qeventdispatcher_wasm_p.h.

Constructor & Destructor Documentation

◆ QEventDispatcherWasm()

QEventDispatcherWasm::QEventDispatcherWasm ( )

Definition at line 196 of file qeventdispatcher_wasm.cpp.

References callOnLoadedIfRequired(), lock, Q_ASSERT, and qCDebug.

+ Here is the call graph for this function:

◆ ~QEventDispatcherWasm()

QEventDispatcherWasm::~QEventDispatcherWasm ( )

Definition at line 235 of file qeventdispatcher_wasm.cpp.

References lock, qCDebug, and qWarning.

Member Function Documentation

◆ callOnLoadedIfRequired()

void QEventDispatcherWasm::callOnLoadedIfRequired ( )
static

Definition at line 925 of file qeventdispatcher_wasm.cpp.

References Q_ASSERT.

Referenced by QEventDispatcherWasm(), and completeStarupTask().

+ Here is the caller graph for this function:

◆ completeStarupTask()

void QEventDispatcherWasm::completeStarupTask ( )
static

Definition at line 919 of file qeventdispatcher_wasm.cpp.

References callOnLoadedIfRequired().

Referenced by QWasmFontDatabase::endFontDatabaseStartupTask().

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

◆ interrupt()

void QEventDispatcherWasm::interrupt ( )
overridevirtual

Interrupts event dispatching.

The event dispatcher will return from processEvents() as soon as possible.

Implements QAbstractEventDispatcher.

Definition at line 434 of file qeventdispatcher_wasm.cpp.

References wakeUp().

+ Here is the call graph for this function:

◆ onLoaded()

void QEventDispatcherWasm::onLoaded ( )
virtual

Reimplemented in QWasmEventDispatcher.

Definition at line 939 of file qeventdispatcher_wasm.cpp.

Referenced by QWasmEventDispatcher::onLoaded().

+ Here is the caller graph for this function:

◆ processEvents()

bool QEventDispatcherWasm::processEvents ( QEventLoop::ProcessEventsFlags flags)
overridevirtual

Processes pending events that match flags until there are no more events to process.

Returns true if an event was processed; otherwise returns false.

This function is especially useful if you have a long running operation, and want to show its progress without allowing user input by using the QEventLoop::ExcludeUserInputEvents flag.

If the QEventLoop::WaitForMoreEvents flag is set in flags, the behavior of this function is as follows:

\list

  • If events are available, this function returns after processing them.
  • If no events are available, this function will wait until more are available and return after processing newly available events.

\endlist

If the QEventLoop::WaitForMoreEvents flag is not set in flags, and no events are available, this function will return immediately.

{Note:} This function does not process events continuously; it returns after all available events are processed.

Implements QAbstractEventDispatcher.

Definition at line 287 of file qeventdispatcher_wasm.cpp.

References QEventLoop::ApplicationExec, QAbstractEventDispatcher::awake(), QEventLoop::DialogExec, emit, lock, processPostedEvents(), qCDebug, and QEventLoop::WaitForMoreEvents.

+ Here is the call graph for this function:

◆ processPostedEvents()

bool QEventDispatcherWasm::processPostedEvents ( )
protectedvirtual

Reimplemented in QWasmEventDispatcher.

Definition at line 595 of file qeventdispatcher_wasm.cpp.

References QCoreApplication::sendPostedEvents().

Referenced by processEvents(), and QWasmEventDispatcher::processPostedEvents().

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

◆ registerSocketNotifier()

void QEventDispatcherWasm::registerSocketNotifier ( QSocketNotifier * notifier)
overridevirtual

Registers notifier with the event loop.

Note
processEvents() only processes events queued before the function is called. Events that are posted while the function runs will be queued until a later round of event processing. This only applies to posted Qt events. For timers and system level events, the situation is unknown.

Subclasses must implement this method to tie a socket notifier into another event loop.

Implements QAbstractEventDispatcher.

Definition at line 332 of file qeventdispatcher_wasm.cpp.

References LOCK_GUARD, notifier, and runOnMainThread().

+ Here is the call graph for this function:

◆ registerStartupTask()

void QEventDispatcherWasm::registerStartupTask ( )
static

Definition at line 914 of file qeventdispatcher_wasm.cpp.

Referenced by QWasmFontDatabase::beginFontDatabaseStartupTask().

+ Here is the caller graph for this function:

◆ registerTimer()

void QEventDispatcherWasm::registerTimer ( Qt::TimerId timerId,
Duration interval,
Qt::TimerType timerType,
QObject * object )
finaloverridevirtual
Since
6.8

Register a timer with the specified timerId, interval, and timerType for the given object.

See also
unregisterTimer(), timersForObject()

Implements QAbstractEventDispatcher.

Definition at line 358 of file qeventdispatcher_wasm.cpp.

References QThread::currentThread(), qCDebug, qToUnderlying(), qWarning, QTimerInfoList::registerTimer(), and QObject::thread().

+ Here is the call graph for this function:

◆ remainingTime()

QEventDispatcherWasm::Duration QEventDispatcherWasm::remainingTime ( Qt::TimerId timerId) const
finaloverridevirtual

Returns the remaining time of the timer with the given timerId.

If the timer is inactive, the returned value will be negative. If the timer is overdue, the returned value will be 0.

See also
Qt::TimerType, registerTimer(), unregisterTimer()

Implements QAbstractEventDispatcher.

Definition at line 429 of file qeventdispatcher_wasm.cpp.

References QTimerInfoList::remainingDuration().

+ Here is the call graph for this function:

◆ runOnMainThread()

void QEventDispatcherWasm::runOnMainThread ( std::function< void(void)> fn)
static

Definition at line 967 of file qeventdispatcher_wasm.cpp.

Referenced by QNetworkReplyWasmImplPrivate::doSendRequest(), registerSocketNotifier(), and unregisterSocketNotifier().

+ Here is the caller graph for this function:

◆ socketSelect()

void QEventDispatcherWasm::socketSelect ( int timeout,
int socket,
bool waitForRead,
bool waitForWrite,
bool * selectForRead,
bool * selectForWrite,
bool * socketDisconnect )
static

Definition at line 889 of file qeventdispatcher_wasm.cpp.

References QThread::currentThread(), QAbstractEventDispatcher::instance(), qWarning, socket, and waitForWrite().

+ Here is the call graph for this function:

◆ timersForObject()

QList< QAbstractEventDispatcher::TimerInfoV2 > QEventDispatcherWasm::timersForObject ( QObject * object) const
finaloverridevirtual
Since
6.8

Returns a list of registered timers for object. The TimerInfoV2 struct has timerId, interval, and timerType members.

See also
Qt::TimerType, registerTimer(), unregisterTimer()

Implements QAbstractEventDispatcher.

Definition at line 417 of file qeventdispatcher_wasm.cpp.

References qWarning, and QTimerInfoList::registeredTimers().

+ Here is the call graph for this function:

◆ unregisterSocketNotifier()

void QEventDispatcherWasm::unregisterSocketNotifier ( QSocketNotifier * notifier)
overridevirtual

Unregisters notifier from the event dispatcher.

Subclasses must reimplement this method to tie a socket notifier into another event loop. Reimplementations must call the base implementation.

Implements QAbstractEventDispatcher.

Definition at line 342 of file qeventdispatcher_wasm.cpp.

References it, LOCK_GUARD, notifier, and runOnMainThread().

+ Here is the call graph for this function:

◆ unregisterTimer()

bool QEventDispatcherWasm::unregisterTimer ( Qt::TimerId timerId)
finaloverridevirtual
Since
6.8

Unregisters the timer with the given timerId. Returns true if successful; otherwise returns false.

See also
registerTimer(), unregisterTimers()

Implements QAbstractEventDispatcher.

Definition at line 376 of file qeventdispatcher_wasm.cpp.

References QThread::currentThread(), qCDebug, qToUnderlying(), qWarning, QObject::thread(), and QTimerInfoList::unregisterTimer().

+ Here is the call graph for this function:

◆ unregisterTimers()

bool QEventDispatcherWasm::unregisterTimers ( QObject * object)
finaloverridevirtual

Unregisters all the timers associated with the given object.

Returns true if all timers were successfully removed; otherwise returns false.

See also
unregisterTimer(), registeredTimers()

Implements QAbstractEventDispatcher.

Definition at line 396 of file qeventdispatcher_wasm.cpp.

References QThread::currentThread(), qCDebug, qWarning, QObject::thread(), and QTimerInfoList::unregisterTimers().

+ Here is the call graph for this function:

◆ wakeUp()

void QEventDispatcherWasm::wakeUp ( )
overridevirtual

\threadsafe

Wakes up the event loop.

\omit

FIXME - QTBUG-70229

On Unix and Glib event dispatchers, if the dispatcher is already awake when this function is called, it is ensured that the current iteration won't block waiting for more events, but will instead do another event loop iteration.

TODO - does other event dispatchers behave the same?

\endomit

See also
awake()

Implements QAbstractEventDispatcher.

Definition at line 440 of file qeventdispatcher_wasm.cpp.

References qstdweb::haveJspi(), LOCK_GUARD, and wasBlocked.

Referenced by interrupt().

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

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