Warning: That file was not part of the compilation database. It may have many parsing errors.

1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the Qt Virtual Keyboard module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:GPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU
19** General Public License version 3 or (at your option) any later version
20** approved by the KDE Free Qt Foundation. The licenses are as published by
21** the Free Software Foundation and appearing in the file LICENSE.GPL3
22** included in the packaging of this file. Please review the following
23** information to ensure the GNU General Public License requirements will
24** be met: https://www.gnu.org/licenses/gpl-3.0.html.
25**
26** $QT_END_LICENSE$
27**
28****************************************************************************/
29
30#ifndef QVIRTUALKEYBOARDSELECTIONLISTMODEL_H
31#define QVIRTUALKEYBOARDSELECTIONLISTMODEL_H
32
33#include <QAbstractListModel>
34#include <QtVirtualKeyboard/qvirtualkeyboard_global.h>
35
36QT_BEGIN_NAMESPACE
37
38class QVirtualKeyboardAbstractInputMethod;
39class QVirtualKeyboardInputEngine;
40class QVirtualKeyboardSelectionListModelPrivate;
41
42class QVIRTUALKEYBOARD_EXPORT QVirtualKeyboardSelectionListModel : public QAbstractListModel
43{
44 Q_OBJECT
45 Q_DECLARE_PRIVATE(QVirtualKeyboardSelectionListModel)
46 Q_PROPERTY(int count READ count NOTIFY countChanged)
47
48 explicit QVirtualKeyboardSelectionListModel(QObject *parent = nullptr);
49
50public:
51 enum class Type
52 {
53 WordCandidateList = 0
54 };
55 Q_ENUM(Type)
56
57 enum class Role
58 {
59 Display = Qt::DisplayRole,
60 DisplayRole = Display,
61 WordCompletionLength = Qt::UserRole + 1,
62 WordCompletionLengthRole = WordCompletionLength,
63 Dictionary,
64 CanRemoveSuggestion
65 };
66 Q_ENUM(Role)
67
68 enum class DictionaryType
69 {
70 Default = 0,
71 User
72 };
73 Q_ENUM(DictionaryType)
74
75 ~QVirtualKeyboardSelectionListModel();
76 void setDataSource(QVirtualKeyboardAbstractInputMethod *dataSource, Type type);
77 QVirtualKeyboardAbstractInputMethod *dataSource() const;
78 int rowCount(const QModelIndex &parent = QModelIndex()) const override;
79 QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;
80 QHash<int,QByteArray> roleNames() const override;
81
82 int count() const;
83
84 Q_INVOKABLE void selectItem(int index);
85 Q_INVOKABLE void removeItem(int index);
86 Q_INVOKABLE QVariant dataAt(int index, Role role = Role::Display) const;
87
88Q_SIGNALS:
89 void countChanged();
90 void activeItemChanged(int index);
91 void itemSelected(int index);
92
93protected Q_SLOTS:
94 void selectionListChanged(Type type);
95 void selectionListActiveItemChanged(Type type, int index);
96
97private:
98 friend class QVirtualKeyboardInputEngine;
99};
100
101QT_END_NAMESPACE
102
103Q_DECLARE_METATYPE(QVirtualKeyboardSelectionListModel::Type)
104Q_DECLARE_METATYPE(QVirtualKeyboardSelectionListModel::Role)
105Q_DECLARE_METATYPE(QVirtualKeyboardSelectionListModel::DictionaryType)
106
107#endif // QVIRTUALKEYBOARDSELECTIONLISTMODEL_H
108

Warning: That file was not part of the compilation database. It may have many parsing errors.

Provided by KDAB

Privacy Policy
Learn to use CMake with our Intro Training
Find out more

source code of qtvirtualkeyboard/src/virtualkeyboard/qvirtualkeyboardselectionlistmodel.h