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
|
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Designer 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$
**
****************************************************************************/
#include "script_p.h"
QT_BEGIN_NAMESPACE
/*!
\class QDesignerScriptExtension
\brief The QDesignerScriptExtension class allows you to generate a
per-widget \l{QtScript} {Qt Script} snippet to be executed while
building the form.
\internal
\inmodule QtDesigner
\since 4.3
On saving the form, the extension is queried for a script snippet
to be associated with the widget while saving the UI file.
This script is then run after creating the widget by \l uic or
QUiLoader.
As opposed to \l QDesignerCustomWidgetInterface::codeTemplate(),
it allows for applying an internal state of the widget
that can be manipulated using \QD.
Such a state might for example be the contents of a custom item view widget,
for which an editor is provided by the QDesignerTaskMenuExtension.
While saving the form, the state is serialized as a QVariantMap of
\QD-supported properties, which is stored in the UI file. This is
handled by data() and setData().
For item view contents, there might be for example a key that determines
the number of items and other keys that contain the actual items following
a naming scheme (\c numItems, \c item1, \c item2, ...).
On saving, script() is invoked, which should return a script snippet that
applies the state to the widget while building the form.
\sa {Creating Custom Widgets for Qt Designer#Using Qt Script to Aid in Building Forms}{Creating Custom Widgets for Qt Designer}, QtScript
*/
/*!
Destroys the extension.
*/
QDesignerScriptExtension::~QDesignerScriptExtension()
{
}
/*!
\fn virtual QString QDesignerScriptExtension::script() const
Returns a script snippet to be associated with the widget.
*/
/*!
\fn virtual QVariantMap QDesignerScriptExtension::data() const
Returns a map of variants describing the internal state to be
stored in the UI file.
*/
/*!
\fn virtual void QDesignerScriptExtension::setData(const QVariantMap &data)
Applies the internal state stored in \a data to the widget while loading a form.
*/
QT_END_NAMESPACE
|
