Struct QGraphicsSceneMouseEvent

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

The QGraphicsSceneMouseEvent class provides mouse events in the graphics view framework.

C++ class: QGraphicsSceneMouseEvent.

C++ documentation:

The QGraphicsSceneMouseEvent class provides mouse events in the graphics view framework.

When a QGraphicsView receives a QMouseEvent, it translates it to a QGraphicsSceneMouseEvent. The event is then forwarded to the QGraphicsScene associated with the view. If the event is not handled by the scene, the view may use it, e.g., for the DragMode.

In addition to containing the item, scene, and screen coordinates of the event (as pos(), scenePos(), and screenPos()), mouse events also contain the coordinates of the previous mouse event received by the view. These can be retrieved with lastPos(), lastScreenPos(), and lastScenePos().

Implementations

impl QGraphicsSceneMouseEvent

pub unsafe fn button(&self) -> MouseButton

Returns the mouse button (if any) that caused the event.

Calls C++ function: Qt::MouseButton QGraphicsSceneMouseEvent::button() const.

C++ documentation:

Returns the mouse button (if any) that caused the event.

See also buttons() and modifiers().

pub unsafe fn button_down_pos(&self, button: MouseButton) -> CppBox<QPointF>

Returns the mouse cursor position in item coordinates where the specified button was clicked.

Calls C++ function: QPointF QGraphicsSceneMouseEvent::buttonDownPos(Qt::MouseButton button) const.

C++ documentation:

Returns the mouse cursor position in item coordinates where the specified button was clicked.

See also buttonDownScenePos(), buttonDownScreenPos(), and pos().

pub unsafe fn button_down_scene_pos( &self, button: MouseButton, ) -> CppBox<QPointF>

Returns the mouse cursor position in scene coordinates where the specified button was clicked.

Calls C++ function: QPointF QGraphicsSceneMouseEvent::buttonDownScenePos(Qt::MouseButton button) const.

C++ documentation:

Returns the mouse cursor position in scene coordinates where the specified button was clicked.

See also buttonDownPos(), buttonDownScreenPos(), and scenePos().

pub unsafe fn button_down_screen_pos( &self, button: MouseButton, ) -> CppBox<QPoint>

Returns the mouse cursor position in screen coordinates where the specified button was clicked.

Calls C++ function: QPoint QGraphicsSceneMouseEvent::buttonDownScreenPos(Qt::MouseButton button) const.

C++ documentation:

Returns the mouse cursor position in screen coordinates where the specified button was clicked.

See also screenPos(), buttonDownPos(), and buttonDownScenePos().

pub unsafe fn buttons(&self) -> QFlags<MouseButton>

Returns the combination of mouse buttons that were pressed at the time the event was sent.

Calls C++ function: QFlags<Qt::MouseButton> QGraphicsSceneMouseEvent::buttons() const.

C++ documentation:

Returns the combination of mouse buttons that were pressed at the time the event was sent.

See also button() and modifiers().

pub unsafe fn flags(&self) -> QFlags<MouseEventFlag>

Returns the mouse event flags.

Calls C++ function: QFlags<Qt::MouseEventFlag> QGraphicsSceneMouseEvent::flags() const.

C++ documentation:

Returns the mouse event flags.

The mouse event flags provide additional information about a mouse event.

This function was introduced in Qt 5.4.

See also Qt::MouseEventFlag and QMouseEvent::flags().

pub unsafe fn last_pos(&self) -> CppBox<QPointF>

Returns the last recorded mouse cursor position in item coordinates.

Calls C++ function: QPointF QGraphicsSceneMouseEvent::lastPos() const.

C++ documentation:

Returns the last recorded mouse cursor position in item coordinates.

See also lastScenePos(), lastScreenPos(), and pos().

pub unsafe fn last_scene_pos(&self) -> CppBox<QPointF>

Returns the last recorded mouse cursor position in scene coordinates. The last recorded position is the position of the previous mouse event received by the view that created the event.

Calls C++ function: QPointF QGraphicsSceneMouseEvent::lastScenePos() const.

C++ documentation:

Returns the last recorded mouse cursor position in scene coordinates. The last recorded position is the position of the previous mouse event received by the view that created the event.

See also lastPos(), lastScreenPos(), and scenePos().

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

Returns the last recorded mouse cursor position in screen coordinates. The last recorded position is the position of the previous mouse event received by the view that created the event.

Calls C++ function: QPoint QGraphicsSceneMouseEvent::lastScreenPos() const.

C++ documentation:

Returns the last recorded mouse cursor position in screen coordinates. The last recorded position is the position of the previous mouse event received by the view that created the event.

See also lastPos(), lastScenePos(), and screenPos().

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

Returns the keyboard modifiers in use at the time the event was sent.

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

C++ documentation:

Returns the keyboard modifiers in use at the time the event was sent.

See also buttons() and button().

pub unsafe fn new_1a(type_: Type) -> CppBox<QGraphicsSceneMouseEvent>

Calls C++ function: [constructor] void QGraphicsSceneMouseEvent::QGraphicsSceneMouseEvent(QEvent::Type type = …).

pub unsafe fn new_0a() -> CppBox<QGraphicsSceneMouseEvent>

The QGraphicsSceneMouseEvent class provides mouse events in the graphics view framework.

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

C++ documentation:

The QGraphicsSceneMouseEvent class provides mouse events in the graphics view framework.

When a QGraphicsView receives a QMouseEvent, it translates it to a QGraphicsSceneMouseEvent. The event is then forwarded to the QGraphicsScene associated with the view. If the event is not handled by the scene, the view may use it, e.g., for the DragMode.

In addition to containing the item, scene, and screen coordinates of the event (as pos(), scenePos(), and screenPos()), mouse events also contain the coordinates of the previous mouse event received by the view. These can be retrieved with lastPos(), lastScreenPos(), and lastScenePos().

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

Returns the mouse cursor position in item coordinates.

Calls C++ function: QPointF QGraphicsSceneMouseEvent::pos() const.

C++ documentation:

Returns the mouse cursor position in item coordinates.

See also scenePos(), screenPos(), and lastPos().

pub unsafe fn scene_pos(&self) -> CppBox<QPointF>

Returns the mouse cursor position in scene coordinates.

Calls C++ function: QPointF QGraphicsSceneMouseEvent::scenePos() const.

C++ documentation:

Returns the mouse cursor position in scene coordinates.

See also pos(), screenPos(), and lastScenePos().

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

Returns the mouse cursor position in screen coordinates.

Calls C++ function: QPoint QGraphicsSceneMouseEvent::screenPos() const.

C++ documentation:

Returns the mouse cursor position in screen coordinates.

See also pos(), scenePos(), and lastScreenPos().

pub unsafe fn set_button(&self, button: MouseButton)

Calls C++ function: void QGraphicsSceneMouseEvent::setButton(Qt::MouseButton button).

pub unsafe fn set_button_down_pos( &self, button: MouseButton, pos: impl CastInto<Ref<QPointF>>, )

Calls C++ function: void QGraphicsSceneMouseEvent::setButtonDownPos(Qt::MouseButton button, const QPointF& pos).

pub unsafe fn set_button_down_scene_pos( &self, button: MouseButton, pos: impl CastInto<Ref<QPointF>>, )

Calls C++ function: void QGraphicsSceneMouseEvent::setButtonDownScenePos(Qt::MouseButton button, const QPointF& pos).

pub unsafe fn set_button_down_screen_pos( &self, button: MouseButton, pos: impl CastInto<Ref<QPoint>>, )

Calls C++ function: void QGraphicsSceneMouseEvent::setButtonDownScreenPos(Qt::MouseButton button, const QPoint& pos).

pub unsafe fn set_buttons(&self, buttons: QFlags<MouseButton>)

Calls C++ function: void QGraphicsSceneMouseEvent::setButtons(QFlags<Qt::MouseButton> buttons).

pub unsafe fn set_flags(&self, arg1: QFlags<MouseEventFlag>)

Calls C++ function: void QGraphicsSceneMouseEvent::setFlags(QFlags<Qt::MouseEventFlag> arg1).

pub unsafe fn set_last_pos(&self, pos: impl CastInto<Ref<QPointF>>)

Calls C++ function: void QGraphicsSceneMouseEvent::setLastPos(const QPointF& pos).

pub unsafe fn set_last_scene_pos(&self, pos: impl CastInto<Ref<QPointF>>)

Calls C++ function: void QGraphicsSceneMouseEvent::setLastScenePos(const QPointF& pos).

pub unsafe fn set_last_screen_pos(&self, pos: impl CastInto<Ref<QPoint>>)

Calls C++ function: void QGraphicsSceneMouseEvent::setLastScreenPos(const QPoint& pos).

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

Calls C++ function: void QGraphicsSceneMouseEvent::setModifiers(QFlags<Qt::KeyboardModifier> modifiers).

pub unsafe fn set_pos(&self, pos: impl CastInto<Ref<QPointF>>)

Calls C++ function: void QGraphicsSceneMouseEvent::setPos(const QPointF& pos).

pub unsafe fn set_scene_pos(&self, pos: impl CastInto<Ref<QPointF>>)

Calls C++ function: void QGraphicsSceneMouseEvent::setScenePos(const QPointF& pos).

pub unsafe fn set_screen_pos(&self, pos: impl CastInto<Ref<QPoint>>)

Calls C++ function: void QGraphicsSceneMouseEvent::setScreenPos(const QPoint& pos).

pub unsafe fn set_source(&self, source: MouseEventSource)

Calls C++ function: void QGraphicsSceneMouseEvent::setSource(Qt::MouseEventSource source).

pub unsafe fn source(&self) -> MouseEventSource

Returns information about the mouse event source.

Calls C++ function: Qt::MouseEventSource QGraphicsSceneMouseEvent::source() const.

C++ documentation:

Returns information about the mouse event source.

The mouse event source can be used to distinguish between genuine and artificial mouse events. The latter are events that are synthesized from touch events by the operating system or Qt itself.

This function was introduced in Qt 5.4.

See also Qt::MouseEventSource and QMouseEvent::source().

Methods from Deref<Target = QGraphicsSceneEvent>

pub unsafe fn set_widget(&self, widget: impl CastInto<Ptr<QWidget>>)

Calls C++ function: void QGraphicsSceneEvent::setWidget(QWidget* widget).

pub unsafe fn widget(&self) -> QPtr<QWidget>

Returns the widget where the event originated, or 0 if the event originates from another application.

Calls C++ function: QWidget* QGraphicsSceneEvent::widget() const.

C++ documentation:

Returns the widget where the event originated, or 0 if the event originates from another application.

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 QGraphicsSceneMouseEvent

unsafe fn delete(&self)

Destroys the event.

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

C++ documentation:

Destroys the event.

impl Deref for QGraphicsSceneMouseEvent

fn deref(&self) -> &QGraphicsSceneEvent

Calls C++ function: QGraphicsSceneEvent* static_cast<QGraphicsSceneEvent*>(QGraphicsSceneMouseEvent* ptr).

type Target = QGraphicsSceneEvent

The resulting type after dereferencing.

impl DynamicCast<QGraphicsSceneMouseEvent> for QEvent

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

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

impl DynamicCast<QGraphicsSceneMouseEvent> for QGraphicsSceneEvent

unsafe fn dynamic_cast( ptr: Ptr<QGraphicsSceneEvent>, ) -> Ptr<QGraphicsSceneMouseEvent>

Calls C++ function: QGraphicsSceneMouseEvent* dynamic_cast<QGraphicsSceneMouseEvent*>(QGraphicsSceneEvent* ptr).

impl StaticDowncast<QGraphicsSceneMouseEvent> for QEvent

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

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

impl StaticDowncast<QGraphicsSceneMouseEvent> for QGraphicsSceneEvent

unsafe fn static_downcast( ptr: Ptr<QGraphicsSceneEvent>, ) -> Ptr<QGraphicsSceneMouseEvent>

Calls C++ function: QGraphicsSceneMouseEvent* static_cast<QGraphicsSceneMouseEvent*>(QGraphicsSceneEvent* ptr).

impl StaticUpcast<QEvent> for QGraphicsSceneMouseEvent

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

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

impl StaticUpcast<QGraphicsSceneEvent> for QGraphicsSceneMouseEvent

unsafe fn static_upcast( ptr: Ptr<QGraphicsSceneMouseEvent>, ) -> Ptr<QGraphicsSceneEvent>

Calls C++ function: QGraphicsSceneEvent* static_cast<QGraphicsSceneEvent*>(QGraphicsSceneMouseEvent* ptr).