QWinEventNotifier Class
The QWinEventNotifier class provides support for the Windows Wait functions. 更多...
| 头文件: | #include <QWinEventNotifier> |
| qmake: | QT += core |
| 开始支持版本: | Qt 5.0 |
| 基类: | QObject |
公有函数
| QWinEventNotifier(QObject *parent = Q_NULLPTR) | |
| QWinEventNotifier(HANDLE hEvent, QObject *parent = Q_NULLPTR) | |
| ~QWinEventNotifier() | |
| HANDLE | handle() const |
| bool | isEnabled() const |
| void | setHandle(HANDLE hEvent) |
- 32 个公有函数继承自 QObject
公有槽函数
| void | setEnabled(bool enable) |
- 1 个公有槽函数继承自 QObject
信号
| void | activated(HANDLE hEvent) |
- 2 个信号继承自 QObject
重新实现的受保护函数
| virtual bool | event(QEvent *e) |
- 9 个受保护的函数继承自 QObject
其他继承的成员
详细描述
The QWinEventNotifier class provides support for the Windows Wait functions.
The QWinEventNotifier class makes it possible to use the wait functions on windows in a asynchronous manner. With this class, you can register a HANDLE to an event and get notification when that event becomes signalled. The state of the event is not modified in the process so if it is a manual reset event you will need to reset it after the notification.
Once you have created a event object using Windows API such as CreateEvent() or OpenEvent(), you can create an event notifier to monitor the event handle. If the event notifier is enabled, it will emit the activated() signal whenever the corresponding event object is signalled.
The setEnabled() function allows you to disable as well as enable the event notifier. It is generally advisable to explicitly enable or disable the event notifier. A disabled notifier does nothing when the event object is signalled (the same effect as not creating the event notifier). Use the isEnabled() function to determine the notifier's current status.
Finally, you can use the setHandle() function to register a new event object, and the handle() function to retrieve the event handle.
Further information: Although the class is called QWinEventNotifier, it can be used for certain other objects which are so-called synchronization objects, such as Processes, Threads, Waitable timers.
Warning: This class is only available on Windows.
成员函数
QWinEventNotifier::QWinEventNotifier(QObject *parent = Q_NULLPTR)
Constructs an event notifier with the given parent.
QWinEventNotifier::QWinEventNotifier(HANDLE hEvent, QObject *parent = Q_NULLPTR)
Constructs an event notifier with the given parent. It enables the notifier, and watches for the event hEvent.
The notifier is enabled by default, i.e. it emits the activated() signal whenever the corresponding event is signalled. However, it is generally advisable to explicitly enable or disable the event notifier.
参见 setEnabled() and isEnabled().
QWinEventNotifier::~QWinEventNotifier()
Destroys this notifier.
[signal] void QWinEventNotifier::activated(HANDLE hEvent)
This signal is emitted whenever the event notifier is enabled and the corresponding HANDLE is signalled.
The state of the event is not modified in the process, so if it is a manual reset event, you will need to reset it after the notification.
The object is passed in the hEvent parameter.
Note: This is a private signal. It can be used in signal connections but cannot be emitted by the user.
参见 handle().
[virtual protected] bool QWinEventNotifier::event(QEvent *e)
Reimplemented from QObject::event().
HANDLE QWinEventNotifier::handle() const
Returns the HANDLE that has been registered in the notifier.
参见 setHandle().
bool QWinEventNotifier::isEnabled() const
Returns true if the notifier is enabled; otherwise returns false.
参见 setEnabled().
[slot] void QWinEventNotifier::setEnabled(bool enable)
If enable is true, the notifier is enabled; otherwise the notifier is disabled.
参见 isEnabled() and activated().
void QWinEventNotifier::setHandle(HANDLE hEvent)
Register the HANDLE hEvent. The old HANDLE will be automatically unregistered.
Note: The notifier will be disabled as a side effect and needs to be re-enabled.
参见 handle() and setEnabled().