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 "qdecorationplugin_qws.h"
43 #include "qdecoration_qws.h"
44
45 QT_BEGIN_NAMESPACE
46
47 /*!
48 \class QDecorationPlugin
49 \ingroup qws
50 \ingroup plugins
51
52 \brief The QDecorationPlugin class is an abstract base class for
53 window decoration plugins in Qt for Embedded Linux.
54
55 Note that this class is only available in \l{Qt for Embedded Linux}.
56
57 \l{Qt for Embedded Linux} provides three ready-made decoration styles: \c
58 Default, \c Styled and \c Windows. Custom decorations can be
59 implemented by subclassing the QDecoration class and creating a
60 decoration plugin.
61
62 A decoration plugin can be created by subclassing
63 QDecorationPlugin and implementing the pure virtual keys() and
64 create() functions. By exporting the derived class using the
65 Q_EXPORT_PLUGIN2() macro, the default implementation of the
66 QDecorationFactory class will automatically detect the plugin and
67 load the driver into the application at run-time. See \l{How to
68 Create Qt Plugins} for details.
69
70 To actually apply a decoration, use the
71 QApplication::qwsSetDecoration() function.
72
73 \sa QDecoration, QDecorationFactory
74 */
75
76 /*!
77 \fn QStringList QDecorationPlugin::keys() const
78
79 Returns the list of valid keys, i.e., the decorations supported by
80 this plugin.
81
82 \sa create()
83 */
84
85 /*!
86 \fn QDecoration *QDecorationPlugin::create(const QString &key)
87
88 Creates a decoration matching the given \a key. Note that keys are
89 case-insensitive.
90
91 \sa keys()
92 */
93
94 /*!
95 Constructs a decoration plugin with the given \a parent.
96
97 Note that this constructor is invoked automatically by the
98 Q_EXPORT_PLUGIN2() macro, so there is no need for calling it
99 explicitly.
100 */
QDecorationPlugin(QObject * parent)101 QDecorationPlugin::QDecorationPlugin(QObject *parent)
102 : QObject(parent)
103 {
104 }
105
106 /*!
107 Destroys the decoration plugin.
108
109 Note that Qt destroys a plugin automatically when it is no longer
110 used, so there is no need for calling the destructor explicitly.
111 */
~QDecorationPlugin()112 QDecorationPlugin::~QDecorationPlugin()
113 {
114 }
115
116 QT_END_NAMESPACE
117