Struct qt_core::QTimerEvent

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

The QTimerEvent class contains parameters that describe a timer event.

C++ class: QTimerEvent.

C++ documentation:

The QTimerEvent class contains parameters that describe a timer event.

Timer events are sent at regular intervals to objects that have started one or more timers. Each timer has a unique identifier. A timer is started with QObject::startTimer().

The QTimer class provides a high-level programming interface that uses signals instead of events. It also provides single-shot timers.

The event handler QObject::timerEvent() receives timer events.

Methods

impl QTimerEvent

pub unsafe fn copy_from(
    &mut self,
    other: impl CastInto<Ref<QTimerEvent>>
) -> MutRef<QTimerEvent>

The QTimerEvent class contains parameters that describe a timer event.

Calls C++ function: QTimerEvent& QTimerEvent::operator=(const QTimerEvent& other).

C++ documentation:

The QTimerEvent class contains parameters that describe a timer event.

Timer events are sent at regular intervals to objects that have started one or more timers. Each timer has a unique identifier. A timer is started with QObject::startTimer().

The QTimer class provides a high-level programming interface that uses signals instead of events. It also provides single-shot timers.

The event handler QObject::timerEvent() receives timer events.

pub unsafe fn new(timer_id: c_int) -> CppBox<QTimerEvent>

Constructs a timer event object with the timer identifier set to timerId.

Calls C++ function: [constructor] void QTimerEvent::QTimerEvent(int timerId).

C++ documentation:

Constructs a timer event object with the timer identifier set to timerId.

pub unsafe fn new_copy(
    other: impl CastInto<Ref<QTimerEvent>>
) -> CppBox<QTimerEvent>

The QTimerEvent class contains parameters that describe a timer event.

Calls C++ function: [constructor] void QTimerEvent::QTimerEvent(const QTimerEvent& other).

C++ documentation:

The QTimerEvent class contains parameters that describe a timer event.

Timer events are sent at regular intervals to objects that have started one or more timers. Each timer has a unique identifier. A timer is started with QObject::startTimer().

The QTimer class provides a high-level programming interface that uses signals instead of events. It also provides single-shot timers.

The event handler QObject::timerEvent() receives timer events.

pub unsafe fn timer_id(&self) -> c_int

Returns the unique timer identifier, which is the same identifier as returned from QObject::startTimer().

Calls C++ function: int QTimerEvent::timerId() const.

C++ documentation:

Returns the unique timer identifier, which is the same identifier as returned from QObject::startTimer().

Methods from Deref<Target = QEvent>

pub unsafe fn accept(&mut self)

Sets the accept flag of the event object, the equivalent of calling setAccepted(true).

Calls C++ function: void QEvent::accept().

C++ documentation:

Sets the accept flag of the event object, the equivalent of calling setAccepted(true).

Setting the accept parameter indicates that the event receiver wants the event. Unwanted events might be propagated to the parent widget.

See also ignore().

pub unsafe fn copy_from(
    &mut self,
    other: impl CastInto<Ref<QEvent>>
) -> MutRef<QEvent>

Calls C++ function: QEvent& QEvent::operator=(const QEvent& other).

pub unsafe fn ignore(&mut self)

Clears the accept flag parameter of the event object, the equivalent of calling setAccepted(false).

Calls C++ function: void QEvent::ignore().

C++ documentation:

Clears the accept flag parameter of the event object, the equivalent of calling setAccepted(false).

Clearing the accept parameter indicates that the event receiver does not want the event. Unwanted events might be propagated to the parent widget.

See also accept().

pub unsafe fn is_accepted(&self) -> bool

the accept flag of the event object

Calls C++ function: bool QEvent::isAccepted() const.

C++ documentation:

the accept flag of the event object

Setting the accept parameter indicates that the event receiver wants the event. Unwanted events might be propagated to the parent widget. By default, isAccepted() is set to true, but don't rely on this as subclasses may choose to clear it in their constructor.

For convenience, the accept flag can also be set with accept(), and cleared with ignore().

Access functions:

bool	isAccepted() const
void	setAccepted(bool accepted)

pub unsafe fn set_accepted(&mut self, accepted: bool)

the accept flag of the event object

Calls C++ function: void QEvent::setAccepted(bool accepted).

C++ documentation:

the accept flag of the event object

Setting the accept parameter indicates that the event receiver wants the event. Unwanted events might be propagated to the parent widget. By default, isAccepted() is set to true, but don't rely on this as subclasses may choose to clear it in their constructor.

For convenience, the accept flag can also be set with accept(), and cleared with ignore().

Access functions:

bool	isAccepted() const
void	setAccepted(bool accepted)

pub unsafe fn spontaneous(&self) -> bool

Returns true if the event originated outside the application (a system event); otherwise returns false.

Calls C++ function: bool QEvent::spontaneous() const.

C++ documentation:

Returns true if the event originated outside the application (a system event); otherwise returns false.

The return value of this function is not defined for paint events.

pub unsafe fn type_(&self) -> Type

Returns the event type.

Calls C++ function: QEvent::Type QEvent::type() const.

C++ documentation:

Returns the event type.

Trait Implementations

impl Deref for QTimerEvent

type Target = QEvent

The resulting type after dereferencing.

fn deref(&self) -> &QEvent

Calls C++ function: QEvent* static_cast<QEvent*>(QTimerEvent* ptr).

impl DerefMut for QTimerEvent

fn deref_mut(&mut self) -> &mut QEvent

Calls C++ function: QEvent* static_cast<QEvent*>(QTimerEvent* ptr).

impl StaticUpcast<QEvent> for QTimerEvent

unsafe fn static_upcast(ptr: Ptr<QTimerEvent>) -> Ptr<QEvent>

Calls C++ function: QEvent* static_cast<QEvent*>(QTimerEvent* ptr).

unsafe fn static_upcast_mut(ptr: MutPtr<QTimerEvent>) -> MutPtr<QEvent>

Calls C++ function: QEvent* static_cast<QEvent*>(QTimerEvent* ptr).

impl StaticDowncast<QTimerEvent> for QEvent

unsafe fn static_downcast(ptr: Ptr<QEvent>) -> Ptr<QTimerEvent>

Calls C++ function: QTimerEvent* static_cast<QTimerEvent*>(QEvent* ptr).

unsafe fn static_downcast_mut(ptr: MutPtr<QEvent>) -> MutPtr<QTimerEvent>

Calls C++ function: QTimerEvent* static_cast<QTimerEvent*>(QEvent* ptr).

impl DynamicCast<QTimerEvent> for QEvent

unsafe fn dynamic_cast(ptr: Ptr<QEvent>) -> Ptr<QTimerEvent>

Calls C++ function: QTimerEvent* dynamic_cast<QTimerEvent*>(QEvent* ptr).

unsafe fn dynamic_cast_mut(ptr: MutPtr<QEvent>) -> MutPtr<QTimerEvent>

Calls C++ function: QTimerEvent* dynamic_cast<QTimerEvent*>(QEvent* ptr).

impl CppDeletable for QTimerEvent

unsafe fn delete(&mut self)

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