source: trunk/src/gui/styles/qstyleplugin.cpp@ 104

Last change on this file since 104 was 2, checked in by Dmitry A. Kuminov, 16 years ago

Initially imported qt-all-opensource-src-4.5.1 from Trolltech.

File size: 3.8 KB
Line 
1/****************************************************************************
2**
3** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
4** Contact: Qt Software Information ([email protected])
5**
6** This file is part of the QtGui module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial Usage
10** Licensees holding valid Qt Commercial licenses may use this file in
11** accordance with the Qt Commercial License Agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and Nokia.
14**
15** GNU Lesser General Public License Usage
16** Alternatively, this file may be used under the terms of the GNU Lesser
17** General Public License version 2.1 as published by the Free Software
18** Foundation and appearing in the file LICENSE.LGPL included in the
19** packaging of this file. Please review the following information to
20** ensure the GNU Lesser General Public License version 2.1 requirements
21** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
22**
23** In addition, as a special exception, Nokia gives you certain
24** additional rights. These rights are described in the Nokia Qt LGPL
25** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
26** package.
27**
28** GNU General Public License Usage
29** Alternatively, this file may be used under the terms of the GNU
30** General Public License version 3.0 as published by the Free Software
31** Foundation and appearing in the file LICENSE.GPL included in the
32** packaging of this file. Please review the following information to
33** ensure the GNU General Public License version 3.0 requirements will be
34** met: http://www.gnu.org/copyleft/gpl.html.
35**
36** If you are unsure which license is appropriate for your use, please
37** contact the sales department at [email protected].
38** $QT_END_LICENSE$
39**
40****************************************************************************/
41
42#include "qstyleplugin.h"
43#include "qstyle.h"
44
45QT_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*/
100QStylePlugin::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*/
111QStylePlugin::~QStylePlugin()
112{
113}
114
115QT_END_NAMESPACE
Note: See TracBrowser for help on using the repository browser.