Struct qt_core::q_state_machine::SignalEvent

#[repr(C)]
pub struct SignalEvent { /* private fields */ }

The SignalEvent class represents a Qt signal event.

C++ class: QStateMachine::SignalEvent.

C++ documentation:

The SignalEvent class represents a Qt signal event.

A signal event is generated by a QStateMachine in response to a Qt signal. The QSignalTransition class provides a transition associated with a signal event. QStateMachine::SignalEvent is part of The State Machine Framework.

The sender() function returns the object that generated the signal. The signalIndex() function returns the index of the signal. The arguments() function returns the arguments of the signal.

Implementations

impl SignalEvent

pub unsafe fn arguments(&self) -> CppBox<QListOfQVariant>

Returns the arguments of the signal.

Calls C++ function: QList<QVariant> QStateMachine::SignalEvent::arguments() const.

C++ documentation:

Returns the arguments of the signal.

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

The SignalEvent class represents a Qt signal event.

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

C++ documentation:

The SignalEvent class represents a Qt signal event.

A signal event is generated by a QStateMachine in response to a Qt signal. The QSignalTransition class provides a transition associated with a signal event. QStateMachine::SignalEvent is part of The State Machine Framework.

The sender() function returns the object that generated the signal. The signalIndex() function returns the index of the signal. The arguments() function returns the arguments of the signal.

pub unsafe fn new( sender: impl CastInto<Ptr<QObject>>, signal_index: c_int, arguments: impl CastInto<Ref<QListOfQVariant>> ) -> CppBox<SignalEvent>

Calls C++ function: [constructor] void QStateMachine::SignalEvent::SignalEvent(QObject* sender, int signalIndex, const QList<QVariant>& arguments).

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

The SignalEvent class represents a Qt signal event.

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

C++ documentation:

The SignalEvent class represents a Qt signal event.

A signal event is generated by a QStateMachine in response to a Qt signal. The QSignalTransition class provides a transition associated with a signal event. QStateMachine::SignalEvent is part of The State Machine Framework.

The sender() function returns the object that generated the signal. The signalIndex() function returns the index of the signal. The arguments() function returns the arguments of the signal.

pub unsafe fn sender(&self) -> QPtr<QObject>

Returns the object that emitted the signal.

Calls C++ function: QObject* QStateMachine::SignalEvent::sender() const.

C++ documentation:

Returns the object that emitted the signal.

See also QObject::sender().

pub unsafe fn signal_index(&self) -> c_int

Returns the index of the signal.

Calls C++ function: int QStateMachine::SignalEvent::signalIndex() const.

C++ documentation:

Returns the index of the signal.

See also QMetaObject::indexOfSignal() and QMetaObject::method().

Methods from Deref<Target = QEvent>

pub unsafe fn accept(&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(&self, other: impl CastInto<Ref<QEvent>>) -> Ref<QEvent>

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

pub unsafe fn ignore(&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(&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 CppDeletable for SignalEvent

unsafe fn delete(&self)

Destroys this SignalEvent.

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

C++ documentation:

Destroys this SignalEvent.

impl Deref for SignalEvent

fn deref(&self) -> &QEvent

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

type Target = QEvent

The resulting type after dereferencing.

impl DynamicCast<SignalEvent> for QEvent

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

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

impl StaticDowncast<SignalEvent> for QEvent

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

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

impl StaticUpcast<QEvent> for SignalEvent

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

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