diff options
author | Tomi Korpipää <tomi.korpipaa@theqtcompany.com> | 2016-05-25 07:00:50 +0300 |
---|---|---|
committer | Sean Harmer <sean.harmer@kdab.com> | 2016-05-25 19:52:23 +0000 |
commit | e7171fea8981c695274746449d98f1243e1f6a0b (patch) | |
tree | a4ffb6997aafef10e3665570f91a18241221d5fa /src/input/frontend/qkeyboarddevice.cpp | |
parent | 78ce47be07d077f26a1542c8cd84b8f788834e1a (diff) |
Add doc skeleton for Qt3DInput
Conflicts:
src/input/frontend/qanalogaxisinput.cpp
src/input/frontend/qaxis.cpp
src/input/frontend/qaxissetting.cpp
src/input/frontend/qbuttonaxisinput.cpp
src/input/frontend/qinputsettings.cpp
src/input/frontend/qmousedevice.cpp
Change-Id: Ic3e06179f745520d9c49af8d8242af360cbd20d8
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
Diffstat (limited to 'src/input/frontend/qkeyboarddevice.cpp')
-rw-r--r-- | src/input/frontend/qkeyboarddevice.cpp | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/src/input/frontend/qkeyboarddevice.cpp b/src/input/frontend/qkeyboarddevice.cpp index e2ade6efb..dd0a1df9a 100644 --- a/src/input/frontend/qkeyboarddevice.cpp +++ b/src/input/frontend/qkeyboarddevice.cpp @@ -203,17 +203,22 @@ QKeyboardDevicePrivate::QKeyboardDevicePrivate() /*! \class Qt3DInput::QKeyboardDevice \inmodule Qt3DInput + \brief A QKeyboardDevice class. \since 5.5 */ /*! \qmltype KeyboardDevice \inqmlmodule Qt3D.Input + \brief QML frontend for QKeyboardDevice C++ class. \since 5.5 \instantiates Qt3DInput::QKeyboardDevice \inherits Node */ +/*! + Constructs a new QKeyboardDevice instance with \a parent. + */ QKeyboardDevice::QKeyboardDevice(QNode *parent) : QAbstractPhysicalDevice(*new QKeyboardDevicePrivate, parent) { @@ -228,40 +233,68 @@ QKeyboardDevice::~QKeyboardDevice() \qmlproperty KeyboardHandler Qt3D.Input::KeyboardDevice::activeInput \readonly */ + +/*! + \property QKeyboardDevice::activeInput + + Holds the active QKeyboardHandler of the device. + */ QKeyboardHandler *QKeyboardDevice::activeInput() const { Q_D(const QKeyboardDevice); return d->m_activeInput; } +/*! + \return the axis count. + + \note Currently always returns zero. + */ int QKeyboardDevice::axisCount() const { return 0; } +/*! + \return the button count. + */ int QKeyboardDevice::buttonCount() const { Q_D(const QKeyboardDevice); return d->m_keyNames.size(); } +/*! + \return the axis names. + + \note Currently always returns empty QStringList. + */ QStringList QKeyboardDevice::axisNames() const { return QStringList(); } +/*! + \return the button names. + */ QStringList QKeyboardDevice::buttonNames() const { Q_D(const QKeyboardDevice); return d->m_keyNames; } +/*! + \return the axisIdentifier matching the \a name. + */ int QKeyboardDevice::axisIdentifier(const QString &name) const { Q_UNUSED(name); return 0; } +/*! + \return the buttonIdentifier matching the \a name. + */ int QKeyboardDevice::buttonIdentifier(const QString &name) const { Q_D(const QKeyboardDevice); |