1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://www.qt.io/licensing/
5 **
6 ** This file is part of the QtGui module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
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 http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 or version 3 as published by the Free
20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22 ** following information to ensure the GNU Lesser General Public License
23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 **
26 ** As a special exception, The Qt Company gives you certain additional
27 ** rights. These rights are described in The Qt Company LGPL Exception
28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 **
30 ** GNU General Public License Usage
31 ** Alternatively, this file may be used under the terms of the GNU
32 ** General Public License version 3.0 as published by the Free Software
33 ** Foundation and appearing in the file LICENSE.GPL included in the
34 ** packaging of this file.  Please review the following information to
35 ** ensure the GNU General Public License version 3.0 requirements will be
36 ** met: http://www.gnu.org/copyleft/gpl.html.
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41 
42 #include "qkbddriverplugin_qws.h"
43 
44 #ifndef QT_NO_LIBRARY
45 
46 #include "qkbd_qws.h"
47 
48 QT_BEGIN_NAMESPACE
49 
50 /*!
51     \class QKbdDriverPlugin
52     \ingroup plugins
53     \ingroup qws
54 
55     \brief The QKbdDriverPlugin class is an abstract base class for
56     keyboard driver plugins in Qt for Embedded Linux.
57 
58     Note that this class is only available in \l{Qt for Embedded Linux}.
59 
60     \l{Qt for Embedded Linux} provides ready-made drivers for several keyboard
61     protocols, see the \l{Qt for Embedded Linux Character Input}{character
62     input} documentation for details. Custom keyboard drivers can be
63     implemented by subclassing the QWSKeyboardHandler class and
64     creating a keyboard driver plugin.
65 
66     A keyboard driver plugin can be created by subclassing
67     QKbdDriverPlugin and reimplementing the pure virtual keys() and
68     create() functions. By exporting the derived class using the
69     Q_EXPORT_PLUGIN2() macro, the default implementation of the
70     QKbdDriverFactory class will automatically detect the plugin and
71     load the driver into the server application at run-time. See
72     \l{How to Create Qt Plugins} for details.
73 
74     \sa QKbdDriverFactory, QWSKeyboardHandler
75 */
76 
77 /*!
78     \fn QStringList QKbdDriverPlugin::keys() const
79 
80     Implement this function to return the list of valid keys, i.e. the
81     keyboard drivers supported by this plugin.
82 
83     \l{Qt for Embedded Linux} provides ready-made drivers for several keyboard
84     protocols, see the \l{Qt for Embedded Linux Character Input}{character
85     input} documentation for details.
86 
87     \sa create()
88 */
89 
90 /*!
91     Constructs a keyboard driver plugin with the given \a parent.
92 
93     Note that this constructor is invoked automatically by the
94     Q_EXPORT_PLUGIN2() macro, so there is no need for calling it
95     explicitly.
96 */
QKbdDriverPlugin(QObject * parent)97 QKbdDriverPlugin::QKbdDriverPlugin(QObject *parent)
98     : QObject(parent)
99 {
100 }
101 
102 /*!
103     Destroys the keyboard driver plugin.
104 
105     Note that Qt destroys a plugin automatically when it is no longer
106     used, so there is no need for calling the destructor explicitly.
107 */
~QKbdDriverPlugin()108 QKbdDriverPlugin::~QKbdDriverPlugin()
109 {
110 }
111 
112 /*!
113     \fn QScreen *QKbdDriverPlugin::create(const QString &key, const QString &device)
114 
115     Implement this function to create a driver matching the type
116     specified by the given \a key and \a device parameters. Note that
117     keys are case-insensitive.
118 
119     \sa keys()
120 */
121 
122 QT_END_NAMESPACE
123 
124 #endif // QT_NO_LIBRARY
125