summaryrefslogtreecommitdiffstats
path: root/src/input/frontend/qmousedevice.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/input/frontend/qmousedevice.cpp')
-rw-r--r--src/input/frontend/qmousedevice.cpp63
1 files changed, 40 insertions, 23 deletions
diff --git a/src/input/frontend/qmousedevice.cpp b/src/input/frontend/qmousedevice.cpp
index d5cdc9478..56d3731ce 100644
--- a/src/input/frontend/qmousedevice.cpp
+++ b/src/input/frontend/qmousedevice.cpp
@@ -45,35 +45,43 @@
QT_BEGIN_NAMESPACE
namespace Qt3DInput {
+
/*! \internal */
QMouseDevicePrivate::QMouseDevicePrivate()
: QAbstractPhysicalDevicePrivate()
, m_sensitivity(0.1f)
{
}
-/*!
- * \qmltype MouseDevice
- * \instantiates Qt3DInput::QMouseDevice
- * \inqmlmodule Qt3D.Input
- * \since 5.5
- * \brief Delegates mouse events to the attached MouseHandler objects.
- * \TODO
- * \sa MouseHandler
- */
/*!
- * \class Qt3DInput::QMouseDevice
- * \inmodule Qt3DInput
- *
- * \brief QMouseDevice is in charge of dispatching mouse events to
- * attached QMouseHandler objects.
- *
- * \since 5.5
- * \sa QMouseHandler
+ \qmltype MouseDevice
+ \instantiates Qt3DInput::QMouseDevice
+ \inqmlmodule Qt3D.Input
+ \since 5.5
+ \brief Delegates mouse events to the attached MouseHandler objects.
+
+ A MouseDevice delegates mouse events from physical mouse device to
+ MouseHandler objects. The sensitivity of the mouse can be controlled
+ with the \l MouseDevice::sensitivity property, which specifies the rate
+ in which the logical mouse coordinates change in response to physical
+ movement of the mouse.
+
+ \sa MouseHandler
*/
/*!
- \qmlproperty real MouseDevice::sensitivity
+ \class Qt3DInput::QMouseDevice
+ \inmodule Qt3DInput
+ \since 5.5
+ \brief Delegates mouse events to the attached MouseHandler objects.
+
+ A QMouseDevice delegates mouse events from physical mouse device to
+ QMouseHandler objects. The sensitivity of the mouse can be controlled
+ with the \l QMouseDevice::sensitivity property, which specifies the rate
+ in which the logical mouse coordinates change in response to physical
+ movement of the mouse.
+
+ \sa QMouseHandler
*/
/*!
@@ -90,6 +98,20 @@ QMouseDevicePrivate::QMouseDevicePrivate()
*/
/*!
+ \qmlproperty real MouseDevice::sensitivity
+
+ Holds the current sensitivity of the mouse device.
+ Default is 0.1.
+ */
+
+/*!
+ \property Qt3DInput::QMouseDevice::sensitivity
+
+ Holds the sensitivity of the mouse device.
+ Default is 0.1.
+ */
+
+/*!
Constructs a new QMouseDevice instance with parent \a parent.
*/
QMouseDevice::QMouseDevice(QNode *parent)
@@ -165,11 +187,6 @@ int QMouseDevice::axisIdentifier(const QString &name) const
return -1;
}
-/*!
- \property Qt3DInput::QMouseDevice::sensitivity
-
- The sensitivity of the device.
- */
float QMouseDevice::sensitivity() const
{
Q_D(const QMouseDevice);