QWinEventNotifier Class
The QWinEventNotifier class provides support for the Windows Wait functions. More...
| Header: | #include <QWinEventNotifier> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Core) target_link_libraries(mytarget PRIVATE Qt6::Core) |
| qmake: | QT += core |
| Inherits: | QObject |
Public Functions
| QWinEventNotifier(QObject *parent = nullptr) | |
| QWinEventNotifier(QWinEventNotifier::HANDLE hEvent, QObject *parent = nullptr) | |
| virtual | ~QWinEventNotifier() |
| QWinEventNotifier::HANDLE | handle() const |
| bool | isEnabled() const |
| void | setHandle(QWinEventNotifier::HANDLE hEvent) |
Public Slots
| void | setEnabled(bool enable) |
Signals
| void | activated(QWinEventNotifier::HANDLE hEvent) |
Reimplemented Protected Functions
| virtual bool | event(QEvent *e) override |
Detailed Description
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.
Member Function Documentation
[explicit] QWinEventNotifier::QWinEventNotifier(QObject *parent = nullptr)
Constructs an event notifier with the given parent.
[explicit] QWinEventNotifier::QWinEventNotifier(QWinEventNotifier::HANDLE hEvent, QObject *parent = 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.
See also setEnabled() and isEnabled().
[virtual noexcept] QWinEventNotifier::~QWinEventNotifier()
Destroys this notifier.
[private signal] void QWinEventNotifier::activated(QWinEventNotifier::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.
See also handle().
[override virtual protected] bool QWinEventNotifier::event(QEvent *e)
Reimplements: QObject::event(QEvent *e).
QWinEventNotifier::HANDLE QWinEventNotifier::handle() const
Returns the HANDLE that has been registered in the notifier.
See also setHandle().
bool QWinEventNotifier::isEnabled() const
Returns true if the notifier is enabled; otherwise returns false.
See also setEnabled().
[slot] void QWinEventNotifier::setEnabled(bool enable)
If enable is true, the notifier is enabled; otherwise the notifier is disabled.
See also isEnabled() and activated().
void QWinEventNotifier::setHandle(QWinEventNotifier::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.
See also handle() and setEnabled().