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 "qscreendriverplugin_qws.h"
43
44 QT_BEGIN_NAMESPACE
45
46 #ifndef QT_NO_LIBRARY
47
48 /*!
49 \class QScreenDriverPlugin
50 \ingroup plugins
51 \ingroup qws
52
53 \brief The QScreenDriverPlugin class is an abstract base class for
54 screen driver plugins in Qt for Embedded Linux.
55
56 Note that this class is only available in \l{Qt for Embedded Linux}.
57
58 \l{Qt for Embedded Linux} provides ready-made drivers for several screen
59 protocols, see the \l{Qt for Embedded Linux Display Management}{display
60 management} documentation for details. Custom screen drivers can be
61 implemented by subclassing the QScreen class and creating a screen
62 driver plugin.
63
64 A screen driver plugin can be created by subclassing
65 QScreenDriverPlugin and reimplementing the pure virtual keys() and
66 create() functions. By exporting the derived class using the
67 Q_EXPORT_PLUGIN2() macro, The default implementation of the
68 QScreenDriverFactory class will automatically detect the plugin
69 and load the driver into the server application at run-time. See
70 \l{How to Create Qt Plugins} for details.
71
72 \sa QScreen, QScreenDriverFactory
73 */
74
75 /*!
76 \fn QStringList QScreenDriverPlugin::keys() const
77
78 Implement this function to return the list of valid keys, i.e. the
79 screen drivers supported by this plugin.
80
81 \l{Qt for Embedded Linux} provides ready-made drivers for several screen
82 protocols, see the \l{Qt for Embedded Linux Display Management}{display
83 management} documentation for details.
84
85 \sa create()
86 */
87
88 /*!
89 Constructs a screen driver plugin with the given \a parent.
90
91 Note that this constructor is invoked automatically by the
92 Q_EXPORT_PLUGIN2() macro, so there is no need for calling it
93 explicitly.
94 */
QScreenDriverPlugin(QObject * parent)95 QScreenDriverPlugin::QScreenDriverPlugin(QObject *parent)
96 : QObject(parent)
97 {
98 }
99
100 /*!
101 Destroys this screen driver plugin.
102
103 Note that Qt destroys a plugin automatically when it is no longer
104 used, so there is no need for calling the destructor explicitly.
105 */
~QScreenDriverPlugin()106 QScreenDriverPlugin::~QScreenDriverPlugin()
107 {
108 }
109
110
111 /*!
112 \fn QScreen* QScreenDriverPlugin::create(const QString &key, int displayId)
113
114 Implement this function to create a driver matching the type
115 specified by the given \a key and \a displayId parameters. Note
116 that keys are case-insensitive.
117
118 \sa keys()
119 */
120
121 #endif // QT_NO_LIBRARY
122
123 QT_END_NAMESPACE
124