Struct qt_gui::QHoverEvent

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

The QHoverEvent class contains parameters that describe a mouse event.

C++ class: QHoverEvent.

C++ documentation:

The QHoverEvent class contains parameters that describe a mouse event.

Mouse events occur when a mouse cursor is moved into, out of, or within a widget, and if the widget has the Qt::WA_Hover attribute.

The function pos() gives the current cursor position, while oldPos() gives the old mouse position.

There are a few similarities between the events QEvent::HoverEnter and QEvent::HoverLeave, and the events QEvent::Enter and QEvent::Leave. However, they are slightly different because we do an update() in the event handler of HoverEnter and HoverLeave.

QEvent::HoverMove is also slightly different from QEvent::MouseMove. Let us consider a top-level window A containing a child B which in turn contains a child C (all with mouse tracking enabled):

Now, if you move the cursor from the top to the bottom in the middle of A, you will get the following QEvent::MouseMove events:

1. A::MouseMove
2. B::MouseMove
3. C::MouseMove

You will get the same events for QEvent::HoverMove, except that the event always propagates to the top-level regardless whether the event is accepted or not. It will only stop propagating with the Qt::WA_NoMousePropagation attribute.

In this case the events will occur in the following way:

1. A::HoverMove
2. A::HoverMove, B::HoverMove
3. A::HoverMove, B::HoverMove, C::HoverMove

Implementations

impl QHoverEvent

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

The QHoverEvent class contains parameters that describe a mouse event.

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

C++ documentation:

The QHoverEvent class contains parameters that describe a mouse event.

Mouse events occur when a mouse cursor is moved into, out of, or within a widget, and if the widget has the Qt::WA_Hover attribute.

The function pos() gives the current cursor position, while oldPos() gives the old mouse position.

There are a few similarities between the events QEvent::HoverEnter and QEvent::HoverLeave, and the events QEvent::Enter and QEvent::Leave. However, they are slightly different because we do an update() in the event handler of HoverEnter and HoverLeave.

QEvent::HoverMove is also slightly different from QEvent::MouseMove. Let us consider a top-level window A containing a child B which in turn contains a child C (all with mouse tracking enabled):

Now, if you move the cursor from the top to the bottom in the middle of A, you will get the following QEvent::MouseMove events:

1. A::MouseMove
2. B::MouseMove
3. C::MouseMove

You will get the same events for QEvent::HoverMove, except that the event always propagates to the top-level regardless whether the event is accepted or not. It will only stop propagating with the Qt::WA_NoMousePropagation attribute.

In this case the events will occur in the following way:

1. A::HoverMove
2. A::HoverMove, B::HoverMove
3. A::HoverMove, B::HoverMove, C::HoverMove

pub unsafe fn new_4a( type_: Type, pos: impl CastInto<Ref<QPointF>>, old_pos: impl CastInto<Ref<QPointF>>, modifiers: QFlags<KeyboardModifier> ) -> CppBox<QHoverEvent>

Constructs a hover event object.

Calls C++ function: [constructor] void QHoverEvent::QHoverEvent(QEvent::Type type, const QPointF& pos, const QPointF& oldPos, QFlags<Qt::KeyboardModifier> modifiers = …).

C++ documentation:

Constructs a hover event object.

The type parameter must be QEvent::HoverEnter, QEvent::HoverLeave, or QEvent::HoverMove.

The pos is the current mouse cursor's position relative to the receiving widget, while oldPos is its previous such position. modifiers hold the state of all keyboard modifiers at the time of the event.

pub unsafe fn new_3a( type_: Type, pos: impl CastInto<Ref<QPointF>>, old_pos: impl CastInto<Ref<QPointF>> ) -> CppBox<QHoverEvent>

Constructs a hover event object.

Calls C++ function: [constructor] void QHoverEvent::QHoverEvent(QEvent::Type type, const QPointF& pos, const QPointF& oldPos).

C++ documentation:

Constructs a hover event object.

The type parameter must be QEvent::HoverEnter, QEvent::HoverLeave, or QEvent::HoverMove.

The pos is the current mouse cursor's position relative to the receiving widget, while oldPos is its previous such position. modifiers hold the state of all keyboard modifiers at the time of the event.

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

The QHoverEvent class contains parameters that describe a mouse event.

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

C++ documentation:

The QHoverEvent class contains parameters that describe a mouse event.

Mouse events occur when a mouse cursor is moved into, out of, or within a widget, and if the widget has the Qt::WA_Hover attribute.

The function pos() gives the current cursor position, while oldPos() gives the old mouse position.

There are a few similarities between the events QEvent::HoverEnter and QEvent::HoverLeave, and the events QEvent::Enter and QEvent::Leave. However, they are slightly different because we do an update() in the event handler of HoverEnter and HoverLeave.

QEvent::HoverMove is also slightly different from QEvent::MouseMove. Let us consider a top-level window A containing a child B which in turn contains a child C (all with mouse tracking enabled):

Now, if you move the cursor from the top to the bottom in the middle of A, you will get the following QEvent::MouseMove events:

1. A::MouseMove
2. B::MouseMove
3. C::MouseMove

You will get the same events for QEvent::HoverMove, except that the event always propagates to the top-level regardless whether the event is accepted or not. It will only stop propagating with the Qt::WA_NoMousePropagation attribute.

In this case the events will occur in the following way:

1. A::HoverMove
2. A::HoverMove, B::HoverMove
3. A::HoverMove, B::HoverMove, C::HoverMove

pub unsafe fn old_pos(&self) -> CppBox<QPoint>

Returns the previous position of the mouse cursor, relative to the widget that received the event. If there is no previous position, oldPos() will return the same position as pos().

Calls C++ function: QPoint QHoverEvent::oldPos() const.

C++ documentation:

Returns the previous position of the mouse cursor, relative to the widget that received the event. If there is no previous position, oldPos() will return the same position as pos().

On QEvent::HoverEnter events, this position will always be QPoint(-1, -1).

See also pos().

pub unsafe fn old_pos_f(&self) -> Ref<QPointF>

Returns the previous position of the mouse cursor, relative to the widget that received the event. If there is no previous position, oldPosF() will return the same position as posF().

Calls C++ function: const QPointF& QHoverEvent::oldPosF() const.

C++ documentation:

Returns the previous position of the mouse cursor, relative to the widget that received the event. If there is no previous position, oldPosF() will return the same position as posF().

On QEvent::HoverEnter events, this position will always be QPointF(-1, -1).

See also posF().

pub unsafe fn pos(&self) -> CppBox<QPoint>

Returns the position of the mouse cursor, relative to the widget that received the event.

Calls C++ function: QPoint QHoverEvent::pos() const.

C++ documentation:

Returns the position of the mouse cursor, relative to the widget that received the event.

On QEvent::HoverLeave events, this position will always be QPoint(-1, -1).

See also oldPos().

pub unsafe fn pos_f(&self) -> Ref<QPointF>

Returns the position of the mouse cursor, relative to the widget that received the event.

Calls C++ function: const QPointF& QHoverEvent::posF() const.

C++ documentation:

Returns the position of the mouse cursor, relative to the widget that received the event.

On QEvent::HoverLeave events, this position will always be QPointF(-1, -1).

See also oldPosF().

Methods from Deref<Target = QInputEvent>

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

The QInputEvent class is the base class for events that describe user input.

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

C++ documentation:

The QInputEvent class is the base class for events that describe user input.

pub unsafe fn modifiers(&self) -> QFlags<KeyboardModifier>

Returns the keyboard modifier flags that existed immediately before the event occurred.

Calls C++ function: QFlags<Qt::KeyboardModifier> QInputEvent::modifiers() const.

C++ documentation:

Returns the keyboard modifier flags that existed immediately before the event occurred.

See also QGuiApplication::keyboardModifiers().

pub unsafe fn set_modifiers(&self, amodifiers: QFlags<KeyboardModifier>)

Calls C++ function: void QInputEvent::setModifiers(QFlags<Qt::KeyboardModifier> amodifiers).

pub unsafe fn set_timestamp(&self, atimestamp: c_ulong)

Calls C++ function: void QInputEvent::setTimestamp(unsigned long atimestamp).

pub unsafe fn timestamp(&self) -> c_ulong

Returns the window system's timestamp for this event. It will normally be in milliseconds since some arbitrary point in time, such as the time when the system was started.

Calls C++ function: unsigned long QInputEvent::timestamp() const.

C++ documentation:

Returns the window system’s timestamp for this event. It will normally be in milliseconds since some arbitrary point in time, such as the time when the system was started.

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 QHoverEvent

unsafe fn delete(&self)

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

impl Deref for QHoverEvent

fn deref(&self) -> &QInputEvent

Calls C++ function: QInputEvent* static_cast<QInputEvent*>(QHoverEvent* ptr).

type Target = QInputEvent

The resulting type after dereferencing.

impl DynamicCast<QHoverEvent> for QEvent

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

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

impl DynamicCast<QHoverEvent> for QInputEvent

unsafe fn dynamic_cast(ptr: Ptr<QInputEvent>) -> Ptr<QHoverEvent>

Calls C++ function: QHoverEvent* dynamic_cast<QHoverEvent*>(QInputEvent* ptr).

impl StaticDowncast<QHoverEvent> for QEvent

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

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

impl StaticDowncast<QHoverEvent> for QInputEvent

unsafe fn static_downcast(ptr: Ptr<QInputEvent>) -> Ptr<QHoverEvent>

Calls C++ function: QHoverEvent* static_cast<QHoverEvent*>(QInputEvent* ptr).

impl StaticUpcast<QEvent> for QHoverEvent

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

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

impl StaticUpcast<QInputEvent> for QHoverEvent

unsafe fn static_upcast(ptr: Ptr<QHoverEvent>) -> Ptr<QInputEvent>

Calls C++ function: QInputEvent* static_cast<QInputEvent*>(QHoverEvent* ptr).