From e5884643a2ec17678abcd4c9335e00feae7233f0 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Mon, 10 Dec 2018 14:51:47 +0100 Subject: Doc: Fix name of SelectionListModel QML type And also fix the the description to discuss QML types instead of the C++ types that they instantiate. Change-Id: I25c0ca4e6ec3b03b61f1b4ab7fb9124a34e03f6e Reviewed-by: Leena Miettinen --- .../qvirtualkeyboardselectionlistmodel.cpp | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/src/virtualkeyboard/qvirtualkeyboardselectionlistmodel.cpp b/src/virtualkeyboard/qvirtualkeyboardselectionlistmodel.cpp index 19c5ce19..bfecb978 100644 --- a/src/virtualkeyboard/qvirtualkeyboardselectionlistmodel.cpp +++ b/src/virtualkeyboard/qvirtualkeyboardselectionlistmodel.cpp @@ -57,18 +57,18 @@ public: }; /*! - \qmltype QVirtualKeyboardSelectionListModel + \qmltype SelectionListModel \instantiates QVirtualKeyboardSelectionListModel \inqmlmodule QtQuick.VirtualKeyboard \ingroup qtvirtualkeyboard-qml \brief Provides a data model for the selection lists. - The QVirtualKeyboardSelectionListModel is a data model for word candidates + The SelectionListModel is a data model for word candidates provided by the input method. - An instance of QVirtualKeyboardSelectionListModel cannot be created directly. - Instead, the QVirtualKeyboardInputEngine manages the instances and provides - access to the model by QVirtualKeyboardInputEngine::wordCandidateListModel + An instance of a SelectionListModel cannot be created directly. + Instead, the InputEngine manages the instances and provides + access to the model by InputEngine::wordCandidateListModel property. The model exposes the following data roles for the list delegate: @@ -229,7 +229,7 @@ int QVirtualKeyboardSelectionListModel::count() const return d->rowCount; } -/*! \qmlmethod void QVirtualKeyboardSelectionListModel::selectItem(int index) +/*! \qmlmethod void SelectionListModel::selectItem(int index) This method should be called when the user selects an item at position \a index from the list. @@ -317,7 +317,7 @@ void QVirtualKeyboardSelectionListModel::selectionListActiveItemChanged(QVirtual } /*! - \qmlsignal void QVirtualKeyboardSelectionListModel::activeItemChanged(int index) + \qmlsignal void SelectionListModel::activeItemChanged(int index) This signal is emitted when the active item in the list changes. The UI should react to this signal by highlighting the item at \a index in @@ -332,7 +332,7 @@ void QVirtualKeyboardSelectionListModel::selectionListActiveItemChanged(QVirtual */ /*! - \qmlsignal void QVirtualKeyboardSelectionListModel::itemSelected(int index) + \qmlsignal void SelectionListModel::itemSelected(int index) This signal is emitted when an item at \a index is selected by the user. */ -- cgit v1.2.3