Struct qt_core::QEventLoopLocker

#[repr(C)]
pub struct QEventLoopLocker { /* fields omitted */ }

The QEventLoopLocker class provides a means to quit an event loop when it is no longer needed.

C++ class: QEventLoopLocker.

C++ documentation:

The QEventLoopLocker class provides a means to quit an event loop when it is no longer needed.

The QEventLoopLocker operates on particular objects - either a QCoreApplication instance, a QEventLoop instance or a QThread instance.

This makes it possible to, for example, run a batch of jobs with an event loop and exit that event loop after the last job is finished. That is accomplished by keeping a QEventLoopLocker with each job instance.

The variant which operates on QCoreApplication makes it possible to finish asynchronously running jobs after the last gui window has been closed. This can be useful for example for running a job which uploads data to a network.

Methods

impl QEventLoopLocker

pub unsafe fn new() -> CppBox<QEventLoopLocker>

Creates an event locker operating on the QCoreApplication.

Calls C++ function: [constructor] void QEventLoopLocker::QEventLoopLocker().

C++ documentation:

Creates an event locker operating on the QCoreApplication.

The application will quit when there are no more QEventLoopLockers operating on it.

See also QCoreApplication::quit() and QCoreApplication::isQuitLockEnabled().

pub unsafe fn from_q_event_loop(
    loop_: impl CastInto<MutPtr<QEventLoop>>
) -> CppBox<QEventLoopLocker>

Creates an event locker operating on the loop.

Calls C++ function: [constructor] void QEventLoopLocker::QEventLoopLocker(QEventLoop* loop).

C++ documentation:

Creates an event locker operating on the loop.

This particular QEventLoop will quit when there are no more QEventLoopLockers operating on it.

See also QEventLoop::quit().

pub unsafe fn from_q_thread(
    thread: impl CastInto<MutPtr<QThread>>
) -> CppBox<QEventLoopLocker>

Creates an event locker operating on the thread.

Calls C++ function: [constructor] void QEventLoopLocker::QEventLoopLocker(QThread* thread).

C++ documentation:

Creates an event locker operating on the thread.

This particular QThread will quit when there are no more QEventLoopLockers operating on it.

See also QThread::quit().

Trait Implementations

impl CppDeletable for QEventLoopLocker

unsafe fn delete(&mut self)

Destroys this event loop locker object

Calls C++ function: [destructor] void QEventLoopLocker::~QEventLoopLocker().

C++ documentation:

Destroys this event loop locker object