|
1 /**************************************************************************** |
|
2 ** |
|
3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). |
|
4 ** All rights reserved. |
|
5 ** Contact: Nokia Corporation (qt-info@nokia.com) |
|
6 ** |
|
7 ** This file is part of the QtGui module of the Qt Toolkit. |
|
8 ** |
|
9 ** $QT_BEGIN_LICENSE:LGPL$ |
|
10 ** No Commercial Usage |
|
11 ** This file contains pre-release code and may not be distributed. |
|
12 ** You may use this file in accordance with the terms and conditions |
|
13 ** contained in the Technology Preview License Agreement accompanying |
|
14 ** this package. |
|
15 ** |
|
16 ** GNU Lesser General Public License Usage |
|
17 ** Alternatively, this file may be used under the terms of the GNU Lesser |
|
18 ** General Public License version 2.1 as published by the Free Software |
|
19 ** Foundation and appearing in the file LICENSE.LGPL included in the |
|
20 ** packaging of this file. Please review the following information to |
|
21 ** ensure the GNU Lesser General Public License version 2.1 requirements |
|
22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. |
|
23 ** |
|
24 ** In addition, as a special exception, Nokia gives you certain additional |
|
25 ** rights. These rights are described in the Nokia Qt LGPL Exception |
|
26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. |
|
27 ** |
|
28 ** If you have questions regarding the use of this file, please contact |
|
29 ** Nokia at qt-info@nokia.com. |
|
30 ** |
|
31 ** |
|
32 ** |
|
33 ** |
|
34 ** |
|
35 ** |
|
36 ** |
|
37 ** |
|
38 ** $QT_END_LICENSE$ |
|
39 ** |
|
40 ****************************************************************************/ |
|
41 |
|
42 #include "qstyleplugin.h" |
|
43 #include "qstyle.h" |
|
44 |
|
45 QT_BEGIN_NAMESPACE |
|
46 |
|
47 /*! |
|
48 \class QStylePlugin |
|
49 \brief The QStylePlugin class provides an abstract base for custom QStyle plugins. |
|
50 |
|
51 \ingroup plugins |
|
52 |
|
53 QStylePlugin is a simple plugin interface that makes it easy |
|
54 to create custom styles that can be loaded dynamically into |
|
55 applications using the QStyleFactory class. |
|
56 |
|
57 Writing a style plugin is achieved by subclassing this base class, |
|
58 reimplementing the pure virtual keys() and create() functions, and |
|
59 exporting the class using the Q_EXPORT_PLUGIN2() macro. See \l |
|
60 {How to Create Qt Plugins} for details. |
|
61 |
|
62 \sa QStyleFactory, QStyle |
|
63 */ |
|
64 |
|
65 /*! |
|
66 \fn QStringList QStylePlugin::keys() const |
|
67 |
|
68 Returns the list of style keys this plugin supports. |
|
69 |
|
70 These keys are usually the class names of the custom styles that |
|
71 are implemented in the plugin. |
|
72 |
|
73 \sa create() |
|
74 */ |
|
75 |
|
76 /*! |
|
77 \fn QStyle *QStylePlugin::create(const QString& key) |
|
78 |
|
79 Creates and returns a QStyle object for the given style \a key. |
|
80 If a plugin cannot create a style, it should return 0 instead. |
|
81 |
|
82 The style key is usually the class name of the required |
|
83 style. Note that the keys are case insensitive. For example: |
|
84 |
|
85 \snippet doc/src/snippets/qstyleplugin/main.cpp 0 |
|
86 \codeline |
|
87 \snippet doc/src/snippets/qstyleplugin/main.cpp 1 |
|
88 \snippet doc/src/snippets/qstyleplugin/main.cpp 2 |
|
89 |
|
90 \sa keys() |
|
91 */ |
|
92 |
|
93 /*! |
|
94 Constructs a style plugin with the given \a parent. |
|
95 |
|
96 Note that this constructor is invoked automatically by the |
|
97 Q_EXPORT_PLUGIN2() macro, so there is no need for calling it |
|
98 explicitly. |
|
99 */ |
|
100 QStylePlugin::QStylePlugin(QObject *parent) |
|
101 : QObject(parent) |
|
102 { |
|
103 } |
|
104 |
|
105 /*! |
|
106 Destroys the style plugin. |
|
107 |
|
108 Note that Qt destroys a plugin automatically when it is no longer |
|
109 used, so there is no need for calling the destructor explicitly. |
|
110 */ |
|
111 QStylePlugin::~QStylePlugin() |
|
112 { |
|
113 } |
|
114 |
|
115 QT_END_NAMESPACE |