1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\page qtdesigner-components.html
\title Creating and Using Components for Qt Designer
\ingroup best-practices
\tableofcontents
\section1 Creating Custom Widget Plugins
When implementing a custom widget plugin for \QD, you must
subclass QDesignerCustomWidgetInterface to expose your custom
widget to \QD. A single custom widget plugin is built as a
separate library. If you want to include several custom widget
plugins in the same library, you must in addition subclass
QDesignerCustomWidgetCollectionInterface.
To provide your custom widget plugin with the expected behavior
and functionality within \QD's workspace you can subclass the
associated extension classes:
The QDesignerContainerExtension class allows you to add pages to a
custom multi-page container. The QDesignerTaskMenuExtension class
allows you to add custom menu entries to \QD's task menu. The
QDesignerMemberSheetExtension class allows you to manipulate a
widget's member functions which is displayed when configuring
connections using \QD's mode for editing signals and slots. And
finally, the QDesignerPropertySheetExtension class allows you to
manipulate a widget's properties which is displayed in \QD's
property editor.
\image qtdesignerextensions.png
In \QD the extensions are not created until they are required. For
that reason, when implementing extensions, you must also subclass
QExtensionFactory, i.e create a class that is able to make
instances of your extensions. In addition, you must make \QD's
extension manager register your factory; the extension manager
controls the construction of extensions as they are required, and
you can access it through QDesignerFormEditorInterface and
QExtensionManager.
For a complete example creating a custom widget plugin with an
extension, see the \l {designer/taskmenuextension}{Task Menu
Extension} or \l {designer/containerextension}{Container
Extension} examples.
\section1 Retrieving Access to \QD Components
The purpose of the classes mentioned in this section is to provide
access to \QD's components, managers and workspace, and they are
not intended to be instantiated directly.
\QD is composed by several components. It has an action editor, a
property editor, widget box and object inspector which you can
view in its workspace.
\image qtdesignerscreenshot.png
\QD also has an object that works behind the scene; it contains
the logic that integrates all of \QD's components into a coherent
application. You can access this object, using the
QDesignerFormEditorInterface, to retrieve interfaces to \QD's
components:
\list
\o QDesignerActionEditorInterface
\o QDesignerObjectInspectorInterface
\o QDesignerPropertyEditorInterface
\o QDesignerWidgetBoxInterface
\endlist
In addition, you can use QDesignerFormEditorInterface to retrieve
interfaces to \QD's extension manager (QExtensionManager) and form
window manager (QDesignerFormWindowManagerInterface). The
extension manager controls the construction of extensions as they
are required, while the form window manager controls the form
windows appearing in \QD's workspace.
Once you have an interface to \QD's form window manager
(QDesignerFormWindowManagerInterface), you also have access to all
the form windows currently appearing in \QD's workspace: The
QDesignerFormWindowInterface class allows you to query and
manipulate the form windows, and it provides an interface to the
form windows' cursors. QDesignerFormWindowCursorInterface is a
convenience class allowing you to query and modify a given form
window's widget selection, and in addition modify the properties
of all the form's widgets.
\section1 Creating User Interfaces at Run-Time
The \c QtDesigner module contains the QFormBuilder class that
provides a mechanism for dynamically creating user interfaces at
run-time, based on UI files created with \QD. This class is
typically used by custom components and applications that embed
\QD. Standalone applications that need to dynamically generate
user interfaces at run-time use the QUiLoader class, found in
the QtUiTools module.
For a complete example using QUiLoader, see
the \l {designer/calculatorbuilder}{Calculator Builder example}.
\sa {Qt Designer Manual}, {QtUiTools Module}
*/
|
