diff options
| author | Colin Ogilvie <colin.ogilvie@kdab.com> | 2016-05-26 12:42:42 +0100 |
|---|---|---|
| committer | Jani Heikkinen <jani.heikkinen@qt.io> | 2016-06-03 06:27:56 +0000 |
| commit | 56593e2414c9c530f7abd4d7ea636b5cd2fda26f (patch) | |
| tree | 17ed08884c438610575f2623c4dad4a4370b0139 /src/input/frontend/qactioninput.cpp | |
| parent | bbb264ad66ca590513dc297821aed26d39d32008 (diff) | |
More doc for input Module
Task-number: QTBUG-46037
Change-Id: Ifc90bdc84bfd44e29e9287c1e7d24108b36e900d
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
Diffstat (limited to 'src/input/frontend/qactioninput.cpp')
| -rw-r--r-- | src/input/frontend/qactioninput.cpp | 36 |
1 files changed, 12 insertions, 24 deletions
diff --git a/src/input/frontend/qactioninput.cpp b/src/input/frontend/qactioninput.cpp index 421836719..5bee62cb9 100644 --- a/src/input/frontend/qactioninput.cpp +++ b/src/input/frontend/qactioninput.cpp @@ -86,19 +86,6 @@ QActionInputPrivate::QActionInputPrivate() \since 5.7 */ - -/*! - \qmlproperty AbstractPhysicalDevice ActionInput::sourceDevice - - The current source device of the ActionInput. -*/ - -/*! - \qmlproperty list<int> Qt3D.Input::ActionInput::buttons - - The Buttons that can trigger this Action. -*/ - /*! Constructs a new QActionInput instance with \a parent. */ @@ -130,13 +117,13 @@ QVector<int> QActionInput::buttons() const The current source device of the QActionInput. */ /*! - \fn QActionInput::sourceDeviceChanged() + \fn QActionInput::sourceDeviceChanged(QAbstractPhysicalDevice *sourceDevice) - This signal is emitted when the source device ascociated with the action input is changed. + This signal is emitted when the source device associated with the action input is changed to \a sourceDevice. */ /*! - \qmlproperty QAbstractPhysicalDevice Qt3D.Input::ActionInput::sourceDevice + \qmlproperty AbstractPhysicalDevice Qt3D.Input::ActionInput::sourceDevice The current source device of the ActionInput */ @@ -144,7 +131,7 @@ QVector<int> QActionInput::buttons() const /*! \qmlsignal Qt3D.Input::ActionInput::sourceDeviceChanged() - This signal is emitted when the source device ascociated with the action input is changed. + This signal is emitted when the source device associated with the action input is changed. The corresponding handler is \c onSourceDeviceChanged */ @@ -178,27 +165,28 @@ QAbstractPhysicalDevice *QActionInput::sourceDevice() const } /*! - \fn QAbstractPhysicalDevice::buttonsChanged() + \fn QActionInput::buttonsChanged(const QVector<int> &buttons) - This signal is emitted when the buttons ascociated with the action input is changed. + This signal is emitted when the buttons associated with the action input is changed. + The buttons changed are \a buttons */ /*! - \qmlproperty QVariantList Qt3D.Input::ActionInput::buttons + \qmlproperty list<int> Qt3D.Input::ActionInput::buttons - The Buttons that can trigger this Action + The Buttons that can trigger this Action. */ /*! - \qmlsignal Qt3D.Input::ActionInput::buttonsChanged() + \qmlsignal Qt3D.Input::ActionInput::buttonsChanged(const QVector<int> &buttons) - This signal is emitted when the buttons ascociated with the action input is changed. + This signal is emitted when the buttons associated with the action input is changed. The corresponding handler is \c onbuttonsChanged */ /*! - Set the buttons to trigger the QActionInput instance. + Set the buttons to trigger the QActionInput instance to \a buttons. */ void QActionInput::setButtons(const QVector<int> &buttons) { |