QAbstractEventDispatcher Class

成员函数文档

[explicit] QAbstractEventDispatcher::QAbstractEventDispatcher(QObject *parent = nullptr)

使用给定的parent 构建一个新的事件分发器。

[virtual noexcept] QAbstractEventDispatcher::~QAbstractEventDispatcher()

销毁事件分发器。

[signal] void QAbstractEventDispatcher::aboutToBlock()

在事件循环调用可能导致阻塞的函数之前，会发出此信号。

另请参阅 awake()。

[signal] void QAbstractEventDispatcher::awake()

当事件循环从一个可能阻塞的函数返回后，会发出此信号。

另请参阅 wakeUp() 和aboutToBlock()。

bool QAbstractEventDispatcher::filterNativeEvent(const QByteArray &eventType, void *message, qintptr *result)

将message 通过由installNativeEventFilter()设置的事件过滤器进行处理。一旦某个事件过滤器返回true ，该函数立即返回true ；否则返回false，表示应继续处理该事件。

QAbstractEventDispatcher 的子类必须对从系统接收的所有消息调用此函数，以确保与应用程序中可能使用的任何扩展兼容。事件类型eventType 取决于运行时选择的平台插件，可用于将消息强制转换为正确的类型。result 指针仅在 Windows 上使用，对应于 LRESULT 指针。

请注意，message 的类型取决于平台。详情请参阅QAbstractNativeEventFilter 。

另请参阅 installNativeEventFilter() 和QAbstractNativeEventFilter::nativeEventFilter()。

void QAbstractEventDispatcher::installNativeEventFilter(QAbstractNativeEventFilter *filterObj)

为应用程序接收的所有原生事件安装一个事件过滤器filterObj 。

事件过滤器 `filterObj ` 通过其 `nativeEventFilter()` 函数接收事件，该函数会在所有线程接收事件时被调用。

如果事件应被过滤（即在此情况下被阻止），则nativeEventFilter()函数应返回true。若要允许Qt继续正常处理，则应返回false：此时原生事件将被转换为QEvent ，并由标准的Qt XMLevent 过滤机制处理，例如QObject::installEventFilter()。

如果安装了多个事件过滤器，最后安装的过滤器将首先被激活。

为了实现最大的可移植性，应尽可能使用QEvent 对象和QObject::installEventFilter()。

另请参阅 QObject::installEventFilter()。

[static] QAbstractEventDispatcher *QAbstractEventDispatcher::instance(QThread *thread = nullptr)

返回指向指定thread 的事件分发器对象的指针。如果thread 为nullptr ，则使用当前线程。如果指定线程不存在事件分发器，则该函数返回nullptr 。

注意：如果 Qt 在构建时未启用线程支持，则会忽略thread 参数。

[pure virtual] void QAbstractEventDispatcher::interrupt()

中断事件分发。事件分发器将尽快从processEvents()中返回。

[pure virtual] bool QAbstractEventDispatcher::processEvents(QEventLoop::ProcessEventsFlags flags)

处理与flags 匹配的待处理事件，直到没有更多事件需要处理为止。如果处理了一个事件，则返回true ；否则返回false 。

如果存在一个长时间运行的操作，并且希望通过使用QEventLoop::ExcludeUserInputEvents 标志来显示其进度，同时禁止用户输入，则此函数特别有用。

如果在flags 中设置了QEventLoop::WaitForMoreEvents 标志，则该函数的行为如下：

• 如果有可用事件，该函数会在处理完这些事件后返回。
• 如果没有可用事件，该函数将等待直至有更多事件可用，并在处理完新出现的事件后返回。

如果在flags 中未设置QEventLoop::WaitForMoreEvents 标志，且没有可用事件，则本函数将立即返回。

注意：该函数不会连续处理事件；它会在处理完所有可用事件后返回。

[pure virtual] void QAbstractEventDispatcher::registerSocketNotifier(QSocketNotifier *notifier)

将notifier 注册到事件循环中。子类必须实现此方法，以便将套接字通知器绑定到另一个事件循环中。

[since 6.8] void QAbstractEventDispatcher::registerTimer(Qt::TimerId timerId, QAbstractEventDispatcher::Duration interval, Qt::TimerType timerType, QObject *object)

为给定的object 注册一个定时器，其timerId 、interval 和timerType 参数均已指定。

该函数在 Qt 6.8 中引入。

另请参阅 unregisterTimer() 和timersForObject()。

[pure virtual] void QAbstractEventDispatcher::registerTimer(int timerId, qint64 interval, Qt::TimerType timerType, QObject *object)

为给定的object ，注册一个定时器，其timerId 、interval 和timerType 分别为指定值。

[since 6.8] Qt::TimerId QAbstractEventDispatcher::registerTimer(QAbstractEventDispatcher::Duration interval, Qt::TimerType timerType, QObject *object)

使用指定的interval 和timerType 为给定的object 注册一个定时器，并返回该定时器的ID。

该函数在 Qt 6.8 中引入。

[pure virtual] QList<QAbstractEventDispatcher::TimerInfo> QAbstractEventDispatcher::registeredTimers(QObject *object) const

返回object 中已注册的定时器列表。TimerInfo结构体包含timerId 、interval 和timerType 这三个成员。

另请参阅 Qt::TimerType 。

[pure virtual] int QAbstractEventDispatcher::remainingTime(int timerId)

返回给定timerId 的剩余时间（单位为毫秒）。如果计时器处于非活动状态，则返回值为-1；如果计时器已过期，则返回值为0。

另请参阅 ` Qt::TimerType`。

QAbstractEventDispatcher::Duration QAbstractEventDispatcher::remainingTime(Qt::TimerId timerId) const

返回指定timerId 对应的计时器剩余时间。如果计时器处于非活动状态，返回值将为负数。如果计时器已过期，返回值将为0。

另请参阅 Qt::TimerType 、registerTimer() 和unregisterTimer()。

void QAbstractEventDispatcher::removeNativeEventFilter(QAbstractNativeEventFilter *filter)

从该对象中移除事件过滤器filter 。如果未安装此类事件过滤器，则该请求将被忽略。

当该对象被销毁时，其所有事件过滤器都会被自动移除。

移除事件过滤器始终是安全的，即使在事件过滤器激活期间也是如此（也就是说，即使是在nativeEventFilter() 函数内部也是如此）。

另请参阅 installNativeEventFilter() 和QAbstractNativeEventFilter 。

[since 6.8] QList<QAbstractEventDispatcher::TimerInfoV2> QAbstractEventDispatcher::timersForObject(QObject *object) const

返回object 中已注册的定时器列表。TimerInfoV2 结构体包含timerId 、interval 和timerType 成员。

该函数在 Qt 6.8 中引入。

另请参阅 Qt::TimerType 、registerTimer() 以及unregisterTimer()。

[pure virtual] void QAbstractEventDispatcher::unregisterSocketNotifier(QSocketNotifier *notifier)

将notifier 从事件分发器中注销。子类必须重写此方法，以便将套接字通知器绑定到另一个事件循环中。重写时必须调用基类的实现。

[since 6.8] bool QAbstractEventDispatcher::unregisterTimer(Qt::TimerId timerId)

取消注册指定timerId 的定时器。成功时返回true ；否则返回false 。

该函数在 Qt 6.8 中引入。

另请参阅 registerTimer() 和unregisterTimers()。

[pure virtual] bool QAbstractEventDispatcher::unregisterTimer(int timerId)

取消注册指定timerId 的定时器。成功时返回true ；否则返回false 。

另请参阅 registerTimer() 和unregisterTimers()。

[pure virtual] bool QAbstractEventDispatcher::unregisterTimers(QObject *object)

注销与给定的object 关联的所有定时器。如果所有定时器均已成功移除，则返回true ；否则返回false 。

另请参阅 unregisterTimer() 和registeredTimers()。

[pure virtual] void QAbstractEventDispatcher::wakeUp()

唤醒事件循环。

注意：此函数是线程安全的。

另请参阅 awake()。