Struct qt_3d_input::QMouseHandler

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

Provides a means of being notified about mouse events when attached to a QMouseDevice instance.

C++ class: Qt3DInput::QMouseHandler.

C++ documentation:

Provides a means of being notified about mouse events when attached to a QMouseDevice instance.

Note: QMouseHandler components shouldn't be shared, not respecting that condition will most likely result in undefined behaviors.

Methods

impl QMouseHandler

pub fn slot_set_source_device(&self) -> Receiver<(*mut QMouseDevice,)>

Sets the mouse device of the QMouseHandler instance to mouseDevice.

Returns a built-in Qt slot Qt3DInput::QMouseHandler::setSourceDevice that can be passed to qt_core::Signal::connect.

C++ documentation:

Sets the mouse device of the QMouseHandler instance to mouseDevice.

Note: Setter function for property sourceDevice.

See also sourceDevice().

pub fn source_device_changed(&self) -> Signal<(*mut QMouseDevice,)>

Holds the current mouse source device of the QMouseHandler instance.

Returns a built-in Qt signal Qt3DInput::QMouseHandler::sourceDeviceChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds the current mouse source device of the QMouseHandler instance.

Access functions:

QMouseDevice *	sourceDevice() const
void	setSourceDevice(QMouseDevice *mouseDevice)

Notifier signal:

void	sourceDeviceChanged(QMouseDevice *mouseDevice)

pub fn contains_mouse_changed(&self) -> Signal<(bool,)>

Holds true if the QMouseHandler currently contains the mouse.

Returns a built-in Qt signal Qt3DInput::QMouseHandler::containsMouseChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

Holds true if the QMouseHandler currently contains the mouse.

Note: In this context, contains mean that the ray originating from the mouse is intersecting with the Qt3DCore::QEntity that aggregates the current QMouseHandler instance component.

Access functions:

bool	containsMouse() const

Notifier signal:

void	containsMouseChanged(bool containsMouse)

pub fn clicked(&self) -> Signal<(*mut QMouseEvent,)>

This signal is emitted when a mouse button is clicked with the event details being contained within mouse

Returns a built-in Qt signal Qt3DInput::QMouseHandler::clicked that can be passed to qt_core::Signal::connect.

C++ documentation:

This signal is emitted when a mouse button is clicked with the event details being contained within mouse

pub fn double_clicked(&self) -> Signal<(*mut QMouseEvent,)>

This signal is emitted when a mouse button is double clicked with the event details being contained within mouse

Returns a built-in Qt signal Qt3DInput::QMouseHandler::doubleClicked that can be passed to qt_core::Signal::connect.

C++ documentation:

This signal is emitted when a mouse button is double clicked with the event details being contained within mouse

pub fn entered(&self) -> Signal<()>

Returns a built-in Qt signal Qt3DInput::QMouseHandler::entered that can be passed to qt_core::Signal::connect.

pub fn exited(&self) -> Signal<()>

Returns a built-in Qt signal Qt3DInput::QMouseHandler::exited that can be passed to qt_core::Signal::connect.

pub fn pressed(&self) -> Signal<(*mut QMouseEvent,)>

This signal is emitted when a mouse button is pressed with the event details being contained within mouse

Returns a built-in Qt signal Qt3DInput::QMouseHandler::pressed that can be passed to qt_core::Signal::connect.

C++ documentation:

This signal is emitted when a mouse button is pressed with the event details being contained within mouse

pub fn released(&self) -> Signal<(*mut QMouseEvent,)>

This signal is emitted when a mouse button is released with the event details being contained within mouse

Returns a built-in Qt signal Qt3DInput::QMouseHandler::released that can be passed to qt_core::Signal::connect.

C++ documentation:

This signal is emitted when a mouse button is released with the event details being contained within mouse

pub fn press_and_hold(&self) -> Signal<(*mut QMouseEvent,)>

This signal is emitted when a mouse button is pressed and held down with the event details being contained within mouse

Returns a built-in Qt signal Qt3DInput::QMouseHandler::pressAndHold that can be passed to qt_core::Signal::connect.

C++ documentation:

This signal is emitted when a mouse button is pressed and held down with the event details being contained within mouse

pub fn position_changed(&self) -> Signal<(*mut QMouseEvent,)>

This signal is emitted when the mouse position changes with the event details being contained within mouse

Returns a built-in Qt signal Qt3DInput::QMouseHandler::positionChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

This signal is emitted when the mouse position changes with the event details being contained within mouse

pub fn wheel(&self) -> Signal<(*mut QWheelEvent,)>

This signal is emitted when the mouse wheel is used with the event details being contained within wheel

Returns a built-in Qt signal Qt3DInput::QMouseHandler::wheel that can be passed to qt_core::Signal::connect.

C++ documentation:

This signal is emitted when the mouse wheel is used with the event details being contained within wheel

pub unsafe fn contains_mouse(&self) -> bool

Holds true if the QMouseHandler currently contains the mouse.

Calls C++ function: bool Qt3DInput::QMouseHandler::containsMouse() const.

C++ documentation:

Holds true if the QMouseHandler currently contains the mouse.

Note: In this context, contains mean that the ray originating from the mouse is intersecting with the Qt3DCore::QEntity that aggregates the current QMouseHandler instance component.

Access functions:

bool	containsMouse() const

Notifier signal:

void	containsMouseChanged(bool containsMouse)

pub unsafe fn meta_object(&self) -> Ptr<QMetaObject>

Calls C++ function: virtual const QMetaObject* Qt3DInput::QMouseHandler::metaObject() const.

pub unsafe fn new_1a(parent: impl CastInto<Ptr<QNode>>) -> QBox<QMouseHandler>

Constructs a new QMouseHandler instance with parent parent.

Calls C++ function: [constructor] void Qt3DInput::QMouseHandler::QMouseHandler(Qt3DCore::QNode* parent = …).

C++ documentation:

Constructs a new QMouseHandler instance with parent parent.

pub unsafe fn new_0a() -> QBox<QMouseHandler>

Provides a means of being notified about mouse events when attached to a QMouseDevice instance.

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

C++ documentation:

Provides a means of being notified about mouse events when attached to a QMouseDevice instance.

Note: QMouseHandler components shouldn't be shared, not respecting that condition will most likely result in undefined behaviors.

pub unsafe fn qt_metacall(
    &self,
    arg1: Call,
    arg2: c_int,
    arg3: *mut *mut c_void
) -> c_int

Calls C++ function: virtual int Qt3DInput::QMouseHandler::qt_metacall(QMetaObject::Call arg1, int arg2, void** arg3).

pub unsafe fn qt_metacast(&self, arg1: *const c_char) -> *mut c_void

Calls C++ function: virtual void* Qt3DInput::QMouseHandler::qt_metacast(const char* arg1).

pub unsafe fn set_source_device(
    &self,
    mouse_device: impl CastInto<Ptr<QMouseDevice>>
)

Sets the mouse device of the QMouseHandler instance to mouseDevice.

Calls C++ function: [slot] void Qt3DInput::QMouseHandler::setSourceDevice(Qt3DInput::QMouseDevice* mouseDevice).

C++ documentation:

Sets the mouse device of the QMouseHandler instance to mouseDevice.

Note: Setter function for property sourceDevice.

See also sourceDevice().

pub unsafe fn source_device(&self) -> QPtr<QMouseDevice>

Holds the current mouse source device of the QMouseHandler instance.

Calls C++ function: Qt3DInput::QMouseDevice* Qt3DInput::QMouseHandler::sourceDevice() const.

C++ documentation:

Holds the current mouse source device of the QMouseHandler instance.

Access functions:

QMouseDevice *	sourceDevice() const
void	setSourceDevice(QMouseDevice *mouseDevice)

Notifier signal:

void	sourceDeviceChanged(QMouseDevice *mouseDevice)

pub unsafe fn static_meta_object() -> Ref<QMetaObject>

Returns a reference to the staticMetaObject field.

pub unsafe fn tr(
    s: *const c_char,
    c: *const c_char,
    n: c_int
) -> CppBox<QString>

Calls C++ function: static QString Qt3DInput::QMouseHandler::tr(const char* s, const char* c, int n).

pub unsafe fn tr_utf8(
    s: *const c_char,
    c: *const c_char,
    n: c_int
) -> CppBox<QString>

Calls C++ function: static QString Qt3DInput::QMouseHandler::trUtf8(const char* s, const char* c, int n).

Trait Implementations

impl CppDeletable for QMouseHandler

unsafe fn delete(&self)

Destroys the instance of QMouseHandler.

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

C++ documentation:

Destroys the instance of QMouseHandler.

impl Deref for QMouseHandler

type Target = QComponent

The resulting type after dereferencing.

fn deref(&self) -> &QComponent

Calls C++ function: Qt3DCore::QComponent* static_cast<Qt3DCore::QComponent*>(Qt3DInput::QMouseHandler* ptr).

impl DynamicCast<QMouseHandler> for QComponent

unsafe fn dynamic_cast(ptr: Ptr<QComponent>) -> Ptr<QMouseHandler>

Calls C++ function: Qt3DInput::QMouseHandler* dynamic_cast<Qt3DInput::QMouseHandler*>(Qt3DCore::QComponent* ptr).

impl DynamicCast<QMouseHandler> for QNode

unsafe fn dynamic_cast(ptr: Ptr<QNode>) -> Ptr<QMouseHandler>

Calls C++ function: Qt3DInput::QMouseHandler* dynamic_cast<Qt3DInput::QMouseHandler*>(Qt3DCore::QNode* ptr).

impl DynamicCast<QMouseHandler> for QObject

unsafe fn dynamic_cast(ptr: Ptr<QObject>) -> Ptr<QMouseHandler>

Calls C++ function: Qt3DInput::QMouseHandler* dynamic_cast<Qt3DInput::QMouseHandler*>(QObject* ptr).

impl StaticDowncast<QMouseHandler> for QComponent

unsafe fn static_downcast(ptr: Ptr<QComponent>) -> Ptr<QMouseHandler>

Calls C++ function: Qt3DInput::QMouseHandler* static_cast<Qt3DInput::QMouseHandler*>(Qt3DCore::QComponent* ptr).

impl StaticDowncast<QMouseHandler> for QNode

unsafe fn static_downcast(ptr: Ptr<QNode>) -> Ptr<QMouseHandler>

Calls C++ function: Qt3DInput::QMouseHandler* static_cast<Qt3DInput::QMouseHandler*>(Qt3DCore::QNode* ptr).

impl StaticDowncast<QMouseHandler> for QObject

unsafe fn static_downcast(ptr: Ptr<QObject>) -> Ptr<QMouseHandler>

Calls C++ function: Qt3DInput::QMouseHandler* static_cast<Qt3DInput::QMouseHandler*>(QObject* ptr).

impl StaticUpcast<QComponent> for QMouseHandler

unsafe fn static_upcast(ptr: Ptr<QMouseHandler>) -> Ptr<QComponent>

Calls C++ function: Qt3DCore::QComponent* static_cast<Qt3DCore::QComponent*>(Qt3DInput::QMouseHandler* ptr).

impl StaticUpcast<QNode> for QMouseHandler

unsafe fn static_upcast(ptr: Ptr<QMouseHandler>) -> Ptr<QNode>

Calls C++ function: Qt3DCore::QNode* static_cast<Qt3DCore::QNode*>(Qt3DInput::QMouseHandler* ptr).

impl StaticUpcast<QObject> for QMouseHandler

unsafe fn static_upcast(ptr: Ptr<QMouseHandler>) -> Ptr<QObject>

Calls C++ function: QObject* static_cast<QObject*>(Qt3DInput::QMouseHandler* ptr).