| 1 | /****************************************************************************
|
|---|
| 2 | **
|
|---|
| 3 | ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
|
|---|
| 4 | ** All rights reserved.
|
|---|
| 5 | ** Contact: Nokia Corporation ([email protected])
|
|---|
| 6 | **
|
|---|
| 7 | ** This file is part of the documentation of the Qt Toolkit.
|
|---|
| 8 | **
|
|---|
| 9 | ** $QT_BEGIN_LICENSE:LGPL$
|
|---|
| 10 | ** Commercial Usage
|
|---|
| 11 | ** Licensees holding valid Qt Commercial licenses may use this file in
|
|---|
| 12 | ** accordance with the Qt Commercial License Agreement provided with the
|
|---|
| 13 | ** Software or, alternatively, in accordance with the terms contained in
|
|---|
| 14 | ** a written agreement between you and Nokia.
|
|---|
| 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 | ** 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 have questions regarding the use of this file, please contact
|
|---|
| 37 | ** Nokia at [email protected].
|
|---|
| 38 | ** $QT_END_LICENSE$
|
|---|
| 39 | **
|
|---|
| 40 | ****************************************************************************/
|
|---|
| 41 |
|
|---|
| 42 | /*!
|
|---|
| 43 | \example designer/customwidgetplugin
|
|---|
| 44 | \title Custom Widget Plugin Example
|
|---|
| 45 |
|
|---|
| 46 | The Custom Widget example shows how to create a custom widget plugin for \QD.
|
|---|
| 47 |
|
|---|
| 48 | \image customwidgetplugin-example.png
|
|---|
| 49 |
|
|---|
| 50 | In this example, the custom widget used is based on the
|
|---|
| 51 | \l{widgets/analogclock}{Analog Clock example}, and does not provide any custom
|
|---|
| 52 | signals or slots.
|
|---|
| 53 |
|
|---|
| 54 | \section1 Preparation
|
|---|
| 55 |
|
|---|
| 56 | To provide a custom widget that can be used with \QD, we need to supply a
|
|---|
| 57 | self-contained implementation and provide a plugin interface. In this
|
|---|
| 58 | example, we reuse the \l{widgets/analogclock}{Analog Clock example} for
|
|---|
| 59 | convenience.
|
|---|
| 60 |
|
|---|
| 61 | Since custom widgets plugins rely on components supplied with \QD, the
|
|---|
| 62 | project file that we use needs to contain information about \QD's
|
|---|
| 63 | library components:
|
|---|
| 64 |
|
|---|
| 65 | \snippet examples/designer/customwidgetplugin/customwidgetplugin.pro 2
|
|---|
| 66 | \snippet examples/designer/customwidgetplugin/customwidgetplugin.pro 0
|
|---|
| 67 |
|
|---|
| 68 | The \c TEMPLATE variable's value makes \c qmake create the custom
|
|---|
| 69 | widget as a library. Later, we will ensure that the widget will be
|
|---|
| 70 | recognized as a plugin by Qt by using the Q_EXPORT_PLUGIN2() macro
|
|---|
| 71 | to export the relevant widget information.
|
|---|
| 72 |
|
|---|
| 73 | The \c CONFIG variable contains two values, \c designer and \c
|
|---|
| 74 | plugin:
|
|---|
| 75 |
|
|---|
| 76 | \list
|
|---|
| 77 |
|
|---|
| 78 | \o \c designer: Since custom widgets plugins rely on components
|
|---|
| 79 | supplied with \QD, this value ensures that our plugin links
|
|---|
| 80 | against \QD's library (\c libQtDesigner.so).
|
|---|
| 81 |
|
|---|
| 82 | \o \c plugin: We also need to ensure that \c qmake considers the
|
|---|
| 83 | custom widget a plugin library.
|
|---|
| 84 |
|
|---|
| 85 | \endlist
|
|---|
| 86 |
|
|---|
| 87 | When Qt is configured to build in both debug and release modes,
|
|---|
| 88 | \QD will be built in release mode. When this occurs, it is
|
|---|
| 89 | necessary to ensure that plugins are also built in release
|
|---|
| 90 | mode. For that reason we add the \c debug_and_release value to the
|
|---|
| 91 | \c CONFIG variable. Otherwise, if a plugin is built in a mode that
|
|---|
| 92 | is incompatible with \QD, it won't be loaded and
|
|---|
| 93 | installed.
|
|---|
| 94 |
|
|---|
| 95 | The header and source files for the widget are declared in the usual way,
|
|---|
| 96 | and we provide an implementation of the plugin interface so that \QD can
|
|---|
| 97 | use the custom widget:
|
|---|
| 98 |
|
|---|
| 99 | \snippet examples/designer/customwidgetplugin/customwidgetplugin.pro 3
|
|---|
| 100 |
|
|---|
| 101 | It is also important to ensure that the plugin is installed in a
|
|---|
|
|---|
