summaryrefslogtreecommitdiffstats
path: root/src/input
diff options
context:
space:
mode:
Diffstat (limited to 'src/input')
-rw-r--r--src/input/q3dkeyevent.cpp91
-rw-r--r--src/input/qinputaspect.cpp6
-rw-r--r--src/input/qkeyboardcontroller.cpp19
-rw-r--r--src/input/qkeyboardinput.cpp186
4 files changed, 302 insertions, 0 deletions
diff --git a/src/input/q3dkeyevent.cpp b/src/input/q3dkeyevent.cpp
index c0de3a293..bb1990955 100644
--- a/src/input/q3dkeyevent.cpp
+++ b/src/input/q3dkeyevent.cpp
@@ -42,6 +42,22 @@ namespace Qt3D {
//Qt6: Move this into a QtQmlGui module and merge it with QQuickKeyEvent
+/*!
+ \class Qt3D::Q3DKeyEvent
+ \inmodule Qt3DInput
+ \since 5.5
+*/
+
+/*!
+ \qmltype KeyEvent
+ \inqmlmodule Qt3D.Input
+ \instantiates Qt3D::Q3DKeyEvent
+ \since 5.5
+
+ The KeyEvent QML type cannot be directly created. Objects of this type
+ are used as signal parameters in KeyboardInput.
+*/
+
Q3DKeyEvent::Q3DKeyEvent(QEvent::Type type, int key, Qt::KeyboardModifiers modifiers, const QString &text, bool autorep, ushort count)
: QObject()
, m_event(type, key, modifiers, text, autorep, count)
@@ -56,6 +72,81 @@ Q3DKeyEvent::Q3DKeyEvent(const QKeyEvent &ke)
m_event.setAccepted(false);
}
+/*!
+ \qmlproperty int Qt3D.Input::KeyEvent::key
+ \readonly
+
+ This property holds the code of the key that was pressed or released.
+
+ See \l [CPP] {Qt::Key}{Qt.Key} for the list of keyboard codes.
+
+ \sa {QtQuick::KeyEvent::key}{KeyEvent.key}
+*/
+
+/*!
+ \qmlproperty string Qt3D.Input::KeyEvent::text
+ \readonly
+
+ This property holds the Unicode text that the key generated. The text
+ returned can be an empty string in cases where modifier keys, such as
+ Shift, Control, Alt, and Meta, are being pressed or released. In such
+ cases \l key will contain a valid value.
+*/
+
+/*!
+ \qmlproperty int Qt3D.Input::KeyEvent::modifiers
+ \readonly
+
+ This property holds the keyboard modifier flags that existed immediately
+ before the event occurred.
+
+ \sa {QtQuick::KeyEvent::modifiers}{KeyEvent.modifiers}
+*/
+
+/*!
+ \qmlproperty bool Qt3D.Input::KeyEvent::isAutoRepeat
+ \readonly
+
+ Holds whether this event comes from an auto-repeating key.
+*/
+
+/*!
+ \qmlproperty int Qt3D.Input::KeyEvent::count
+ \readonly
+
+ Holds the number of keys involved in this event. If \l text is not empty,
+ this is simply the length of the string.
+*/
+
+/*!
+ \qmlproperty quint32 Qt3D.Input::KeyEvent::nativeScanCodei
+ \readonly
+
+ This property contains the native scan code of the key that was pressed.
+ It is passed through from QKeyEvent unchanged.
+
+ \sa QKeyEvent::nativeScanCode()
+*/
+
+/*!
+ \qmlproperty bool Qt3D.Input::KeyEvent::accepted
+
+ Setting \e accepted to \c true prevents the key event from being propagated
+ to the item's parent.
+
+ Generally, if the item acts on the key event then it should be accepted so
+ that ancestor items do not also respond to the same event.
+*/
+
+/*!
+ \qmlmethod bool Qt3D.Input::KeyEvent::matches(StandardKey key)
+
+ Returns \c true if the key event matches the given standard key; otherwise
+ returns \c false.
+
+ \sa QKeySequence::StandardKey
+*/
+
} // Qt3D
QT_END_NAMESPACE
diff --git a/src/input/qinputaspect.cpp b/src/input/qinputaspect.cpp
index fc7fb8e8c..c16f06dc3 100644
--- a/src/input/qinputaspect.cpp
+++ b/src/input/qinputaspect.cpp
@@ -62,6 +62,12 @@ QInputAspectPrivate::QInputAspectPrivate()
m_aspectType = QAbstractAspect::AspectOther;
}
+/*!
+ \class Qt3D::QInputAspect
+ \inmodule Qt3DInput
+ \since 5.5
+*/
+
QInputAspect::QInputAspect(QObject *parent)
: QAbstractAspect(*new QInputAspectPrivate, parent)
{
diff --git a/src/input/qkeyboardcontroller.cpp b/src/input/qkeyboardcontroller.cpp
index 69e93b479..25b9b30ed 100644
--- a/src/input/qkeyboardcontroller.cpp
+++ b/src/input/qkeyboardcontroller.cpp
@@ -53,11 +53,30 @@ QKeyboardControllerPrivate::QKeyboardControllerPrivate()
{
}
+/*!
+ \class Qt3D::QKeyboardController
+ \inmodule Qt3DInput
+ \since 5.5
+*/
+
+/*!
+ \qmltype KeyboardController
+ \inqmlmodule Qt3D.Input
+ \since 5.5
+ \instantiates Qt3D::QKeyboardController
+ \inherits Node
+*/
+
QKeyboardController::QKeyboardController(QNode *parent)
: QNode(*new QKeyboardControllerPrivate, parent)
{
}
+/*!
+ \qmlproperty KeyboardInput Qt3D.Input::KeyboardController::activeInput
+ \readonly
+*/
+
QKeyboardInput *QKeyboardController::activeInput() const
{
Q_D(const QKeyboardController);
diff --git a/src/input/qkeyboardinput.cpp b/src/input/qkeyboardinput.cpp
index e7030799d..bf80abecf 100644
--- a/src/input/qkeyboardinput.cpp
+++ b/src/input/qkeyboardinput.cpp
@@ -56,6 +56,20 @@ QKeyboardInputPrivate::QKeyboardInputPrivate()
}
/*!
+ \class Qt3D::QKeyboardInput
+ \inmodule Qt3DInput
+ \since 5.5
+*/
+
+/*!
+ \qmltype KeyboardInput
+ \inqmlmodule Qt3D.Input
+ \instantiates Qt3D::QKeyboardInput
+ \inherits Component3D
+ \since 5.5
+*/
+
+/*!
Constructs a new QKeyboardInput instance with parent \a parent.
*/
QKeyboardInput::QKeyboardInput(QNode *parent)
@@ -167,6 +181,10 @@ void QKeyboardInput::keyEvent(Q3DKeyEvent *event)
}
/*!
+ \qmlproperty KeyboardController Qt3D.Input::KeyboardInput::controller
+*/
+
+/*!
Sets the keyboard controller to \a controller. Without a valid controller,
the QKeyboardInput won't receive any event.
*/
@@ -193,6 +211,10 @@ QKeyboardController *QKeyboardInput::controller() const
}
/*!
+ \qmlproperty bool Qt3D.Input::KeyboardInput::focus
+*/
+
+/*!
\returns the current focus.
*/
bool QKeyboardInput::focus() const
@@ -213,6 +235,170 @@ void QKeyboardInput::setFocus(bool focus)
}
}
+/*!
+ \qmlsignal Qt3D.Input::KeyboardInput::digit0Pressed(KeyEvent event)
+*/
+
+/*!
+ \qmlsignal Qt3D.Input::KeyboardInput::digit1Pressed(KeyEvent event)
+*/
+
+/*!
+ \qmlsignal Qt3D.Input::KeyboardInput::digit2Pressed(KeyEvent event)
+*/
+
+/*!
+ \qmlsignal Qt3D.Input::KeyboardInput::digit3Pressed(KeyEvent event)
+*/
+
+/*!
+ \qmlsignal Qt3D.Input::KeyboardInput::digit4Pressed(KeyEvent event)
+*/
+
+/*!
+ \qmlsignal Qt3D.Input::KeyboardInput::digit5Pressed(KeyEvent event)
+*/
+
+/*!
+ \qmlsignal Qt3D.Input::KeyboardInput::digit6Pressed(KeyEvent event)
+*/
+
+/*!
+ \qmlsignal Qt3D.Input::KeyboardInput::digit7Pressed(KeyEvent event)
+*/
+
+/*!
+ \qmlsignal Qt3D.Input::KeyboardInput::digit8Pressed(KeyEvent event)
+*/
+
+/*!
+ \qmlsignal Qt3D.Input::KeyboardInput::digit9Pressed(KeyEvent event)
+*/
+
+/*!
+ \qmlsignal Qt3D.Input::KeyboardInput::leftPressed(KeyEvent event)
+*/
+
+/*!
+ \qmlsignal Qt3D.Input::KeyboardInput::rightPressed(KeyEvent event)
+*/
+
+/*!
+ \qmlsignal Qt3D.Input::KeyboardInput::upPressed(KeyEvent event)
+*/
+
+/*!
+ \qmlsignal Qt3D.Input::KeyboardInput::downPressed(KeyEvent event)
+*/
+
+/*!
+ \qmlsignal Qt3D.Input::KeyboardInput::tabPressed(KeyEvent event)
+*/
+
+/*!
+ \qmlsignal Qt3D.Input::KeyboardInput::backtabPressed(KeyEvent event)
+*/
+
+/*!
+ \qmlsignal Qt3D.Input::KeyboardInput::asteriskPressed(KeyEvent event)
+*/
+
+/*!
+ \qmlsignal Qt3D.Input::KeyboardInput::numberSignPressed(KeyEvent event)
+*/
+
+/*!
+ \qmlsignal Qt3D.Input::KeyboardInput::backtabPressed(KeyEvent event)
+*/
+
+/*!
+ qmlsignal Qt3D.Input::KeyboardInput::escapePressed(KeyEvent event)
+*/
+
+/*!
+ qmlsignal Qt3D.Input::KeyboardInput::returnPressed(KeyEvent event)
+*/
+
+/*!
+ qmlsignal Qt3D.Input::KeyboardInput::enterPressed(KeyEvent event)
+*/
+
+/*!
+ qmlsignal Qt3D.Input::KeyboardInput::deletePressed(KeyEvent event)
+*/
+
+/*!
+ qmlsignal Qt3D.Input::KeyboardInput::spacePressed(KeyEvent event)
+*/
+
+/*!
+ qmlsignal Qt3D.Input::KeyboardInput::backPressed(KeyEvent event)
+*/
+
+/*!
+ qmlsignal Qt3D.Input::KeyboardInput::cancelPressed(KeyEvent event)
+*/
+
+/*!
+ qmlsignal Qt3D.Input::KeyboardInput::selectPressed(KeyEvent event)
+*/
+
+/*!
+ qmlsignal Qt3D.Input::KeyboardInput::yesPressed(KeyEvent event)
+*/
+
+/*!
+ qmlsignal Qt3D.Input::KeyboardInput::noPressed(KeyEvent event)
+*/
+
+/*!
+ qmlsignal Qt3D.Input::KeyboardInput::context1Pressed(KeyEvent event)
+*/
+
+/*!
+ qmlsignal Qt3D.Input::KeyboardInput::context2Pressed(KeyEvent event)
+*/
+
+/*!
+ qmlsignal Qt3D.Input::KeyboardInput::context3Pressed(KeyEvent event)
+*/
+
+/*!
+ qmlsignal Qt3D.Input::KeyboardInput::context4Pressed(KeyEvent event)
+*/
+
+/*!
+ qmlsignal Qt3D.Input::KeyboardInput::callPressed(KeyEvent event)
+*/
+
+/*!
+ qmlsignal Qt3D.Input::KeyboardInput::hangupPressed(KeyEvent event)
+*/
+
+/*!
+ qmlsignal Qt3D.Input::KeyboardInput::flipPressed(KeyEvent event)
+*/
+
+/*!
+ qmlsignal Qt3D.Input::KeyboardInput::menuPressed(KeyEvent event)
+*/
+
+/*!
+ qmlsignal Qt3D.Input::KeyboardInput::volumeUpPressed(KeyEvent event)
+*/
+
+/*!
+ qmlsignal Qt3D.Input::KeyboardInput::volumeDownPressed(KeyEvent event)
+*/
+
+/*!
+ qmlsignal Qt3D.Input::KeyboardInput::pressed(KeyEvent event)
+*/
+
+/*!
+ qmlsignal Qt3D.Input::KeyboardInput::released(KeyEvent event)
+*/
+
} // Qt3D
QT_END_NAMESPACE