xref: /OK3568_Linux_fs/app/forlinx/DWKeyboard/include/selectionlistmodel.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /****************************************************************************
2*4882a593Smuzhiyun **
3*4882a593Smuzhiyun ** Copyright (C) 2016 The Qt Company Ltd.
4*4882a593Smuzhiyun ** Contact: https://www.qt.io/licensing/
5*4882a593Smuzhiyun **
6*4882a593Smuzhiyun ** This file is part of the Qt Virtual Keyboard module of the Qt Toolkit.
7*4882a593Smuzhiyun **
8*4882a593Smuzhiyun ** $QT_BEGIN_LICENSE:GPL$
9*4882a593Smuzhiyun ** Commercial License Usage
10*4882a593Smuzhiyun ** Licensees holding valid commercial Qt licenses may use this file in
11*4882a593Smuzhiyun ** accordance with the commercial license agreement provided with the
12*4882a593Smuzhiyun ** Software or, alternatively, in accordance with the terms contained in
13*4882a593Smuzhiyun ** a written agreement between you and The Qt Company. For licensing terms
14*4882a593Smuzhiyun ** and conditions see https://www.qt.io/terms-conditions. For further
15*4882a593Smuzhiyun ** information use the contact form at https://www.qt.io/contact-us.
16*4882a593Smuzhiyun **
17*4882a593Smuzhiyun ** GNU General Public License Usage
18*4882a593Smuzhiyun ** Alternatively, this file may be used under the terms of the GNU
19*4882a593Smuzhiyun ** General Public License version 3 or (at your option) any later version
20*4882a593Smuzhiyun ** approved by the KDE Free Qt Foundation. The licenses are as published by
21*4882a593Smuzhiyun ** the Free Software Foundation and appearing in the file LICENSE.GPL3
22*4882a593Smuzhiyun ** included in the packaging of this file. Please review the following
23*4882a593Smuzhiyun ** information to ensure the GNU General Public License requirements will
24*4882a593Smuzhiyun ** be met: https://www.gnu.org/licenses/gpl-3.0.html.
25*4882a593Smuzhiyun **
26*4882a593Smuzhiyun ** $QT_END_LICENSE$
27*4882a593Smuzhiyun **
28*4882a593Smuzhiyun ****************************************************************************/
29*4882a593Smuzhiyun 
30*4882a593Smuzhiyun #ifndef SELECTIONLISTMODEL_H
31*4882a593Smuzhiyun #define SELECTIONLISTMODEL_H
32*4882a593Smuzhiyun 
33*4882a593Smuzhiyun #include <QAbstractListModel>
34*4882a593Smuzhiyun #include "dwkeyboard_global.h"
35*4882a593Smuzhiyun 
36*4882a593Smuzhiyun namespace QtVirtualKeyboard {
37*4882a593Smuzhiyun 
38*4882a593Smuzhiyun class AbstractInputMethod;
39*4882a593Smuzhiyun class InputEngine;
40*4882a593Smuzhiyun class SelectionListModelPrivate;
41*4882a593Smuzhiyun 
42*4882a593Smuzhiyun class DWKEYBOARDSHARED_EXPORT SelectionListModel : public QAbstractListModel
43*4882a593Smuzhiyun {
44*4882a593Smuzhiyun     Q_OBJECT
45*4882a593Smuzhiyun     Q_ENUMS(Type)
46*4882a593Smuzhiyun     Q_ENUMS(Role)
47*4882a593Smuzhiyun     Q_DECLARE_PRIVATE(SelectionListModel)
48*4882a593Smuzhiyun 
49*4882a593Smuzhiyun     explicit SelectionListModel(QObject *parent = 0);
50*4882a593Smuzhiyun 
51*4882a593Smuzhiyun public:
52*4882a593Smuzhiyun     enum Type
53*4882a593Smuzhiyun     {
54*4882a593Smuzhiyun         WordCandidateList = 0
55*4882a593Smuzhiyun     };
56*4882a593Smuzhiyun     enum Role
57*4882a593Smuzhiyun     {
58*4882a593Smuzhiyun         DisplayRole = Qt::DisplayRole,
59*4882a593Smuzhiyun         WordCompletionLengthRole = Qt::UserRole + 1
60*4882a593Smuzhiyun     };
61*4882a593Smuzhiyun 
62*4882a593Smuzhiyun     ~SelectionListModel();
63*4882a593Smuzhiyun     void setDataSource(AbstractInputMethod *dataSource, Type type);
64*4882a593Smuzhiyun     AbstractInputMethod *dataSource() const;
65*4882a593Smuzhiyun     int rowCount(const QModelIndex &parent = QModelIndex()) const;
66*4882a593Smuzhiyun     QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const;
67*4882a593Smuzhiyun     QHash<int,QByteArray> roleNames() const;
68*4882a593Smuzhiyun 
69*4882a593Smuzhiyun     Q_INVOKABLE void selectItem(int index);
70*4882a593Smuzhiyun     Q_INVOKABLE QVariant dataAt(int index, int role = Qt::DisplayRole) const;
71*4882a593Smuzhiyun 
72*4882a593Smuzhiyun signals:
73*4882a593Smuzhiyun     void activeItemChanged(int index);
74*4882a593Smuzhiyun     void itemSelected(int index);
75*4882a593Smuzhiyun 
76*4882a593Smuzhiyun protected slots:
77*4882a593Smuzhiyun     void selectionListChanged(int type);
78*4882a593Smuzhiyun     void selectionListActiveItemChanged(int type, int index);
79*4882a593Smuzhiyun 
80*4882a593Smuzhiyun private:
81*4882a593Smuzhiyun     friend class InputEngine;
82*4882a593Smuzhiyun };
83*4882a593Smuzhiyun 
84*4882a593Smuzhiyun } // namespace QtVirtualKeyboard
85*4882a593Smuzhiyun 
86*4882a593Smuzhiyun Q_DECLARE_METATYPE(QtVirtualKeyboard::SelectionListModel::Type)
87*4882a593Smuzhiyun Q_DECLARE_METATYPE(QtVirtualKeyboard::SelectionListModel::Role)
88*4882a593Smuzhiyun 
89*4882a593Smuzhiyun #endif // SELECTIONLISTMODEL_H
90