abstractview.h 9.48 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
2
**
3
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
7
**
hjk's avatar
hjk committed
8
9
10
11
12
13
14
** 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.
15
16
**
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17
18
19
20
21
22
23
24
25
** 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
con's avatar
con committed
26
27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
28
****************************************************************************/
29
30
31
32

#ifndef ABSTRACTVIEW_H
#define ABSTRACTVIEW_H

33
#include <qmldesignercorelib_global.h>
34
35
36
37
38

#include <model.h>
#include <modelnode.h>
#include <abstractproperty.h>
#include <rewritertransaction.h>
39
#include <commondefines.h>
40
41
42

#include <QObject>

43
QT_BEGIN_NAMESPACE
44
class QStyle;
45
QT_END_NAMESPACE
46
47
48
49
50
51
52
53
54
55
56
57

namespace QmlDesigner {
    namespace Internal {
        class InternalNode;
        typedef QSharedPointer<InternalNode> InternalNodePointer;
        typedef QWeakPointer<InternalNode> InternalNodeWeakPointer;
    }
}

namespace QmlDesigner {

class QmlModelView;
58
class NodeInstanceView;
59
class RewriterView;
60

61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
struct WidgetInfo {
    enum PlacementHint {
        NoPane,
        LeftPane,
        RightPane,
        TopPane, // not used
        BottomPane, // not used
        CentralPane // not used
    };

    QString uniqueId;
    QString tabName;
    QWidget *widget;
    int placementPriority;
    PlacementHint placementHint;
};


79
class QMLDESIGNERCORE_EXPORT AbstractView : public QObject
80
81
82
{
    Q_OBJECT
public:
83
    Q_FLAGS(PropertyChangeFlag PropertyChangeFlags)
84
85
86
87
88
    typedef QWeakPointer<AbstractView> Pointer;

    enum PropertyChangeFlag {
      NoAdditionalChanges = 0x0,
      PropertiesAdded = 0x1,
89
      EmptyPropertiesRemoved = 0x2
90
    };
91
    Q_DECLARE_FLAGS(PropertyChangeFlags, PropertyChangeFlag)
92
93
94
95
96
97
    AbstractView(QObject *parent = 0)
            : QObject(parent) {}

    virtual ~AbstractView();

    Model* model() const;
Marco Bubke's avatar
Marco Bubke committed
98
    bool isAttached() const;
99
100
101

    RewriterTransaction beginRewriterTransaction();

102
    ModelNode createModelNode(const TypeName &typeName,
103
104
                         int majorVersion,
                         int minorVersion,
105
                         const PropertyListType &propertyList = PropertyListType(),
106
107
                         const PropertyListType &auxPropertyList = PropertyListType(),
                         const QString &nodeSource = QString(),
108
                         ModelNode::NodeSourceType nodeSourceType = ModelNode::NodeWithoutSource);
109
110
111
112
113
114
115
116
117
118
119
120
121
122

    const ModelNode rootModelNode() const;
    ModelNode rootModelNode();

    void setSelectedModelNodes(const QList<ModelNode> &selectedNodeList);
    void selectModelNode(const ModelNode &node);
    void deselectModelNode(const ModelNode &node);
    void clearSelectedModelNodes();

    QList<ModelNode> selectedModelNodes() const;

    ModelNode modelNodeForId(const QString &id);
    bool hasId(const QString &id) const;

123
124
125
    ModelNode modelNodeForInternalId(qint32 internalId);
    bool hasModelNodeForInternalId(qint32 internalId) const;

Marco Bubke's avatar
Marco Bubke committed
126
    QList<ModelNode> allModelNodes() const;
127
128
129
130
131

    void emitCustomNotification(const QString &identifier);
    void emitCustomNotification(const QString &identifier, const QList<ModelNode> &nodeList);
    void emitCustomNotification(const QString &identifier, const QList<ModelNode> &nodeList, const QList<QVariant> &data);

132
    void emitInstancePropertyChange(const QList<QPair<ModelNode, PropertyName> > &propertyList);
133
    void emitInstancesCompleted(const QVector<ModelNode> &nodeList);
134
    void emitInstanceInformationsChange(const QMultiHash<ModelNode, InformationName> &informationChangeHash);
135
136
137
138
139
    void emitInstancesRenderImageChanged(const QVector<ModelNode> &nodeList);
    void emitInstancesPreviewImageChanged(const QVector<ModelNode> &nodeList);
    void emitInstancesChildrenChanged(const QVector<ModelNode> &nodeList);
    void emitRewriterBeginTransaction();
    void emitRewriterEndTransaction();
140
    void emitInstanceToken(const QString &token, int number, const QVector<ModelNode> &nodeVector);
141

142
143
    void sendTokenToInstances(const QString &token, int number, const QVector<ModelNode> &nodeVector);

144
145
146
147
148
149
    virtual void modelAttached(Model *model);
    virtual void modelAboutToBeDetached(Model *model);

    virtual void nodeCreated(const ModelNode &createdNode) = 0;
    virtual void nodeAboutToBeRemoved(const ModelNode &removedNode) = 0;
    virtual void nodeRemoved(const ModelNode &removedNode, const NodeAbstractProperty &parentProperty, PropertyChangeFlags propertyChange) = 0;
150
    virtual void nodeAboutToBeReparented(const ModelNode &node, const NodeAbstractProperty &newPropertyParent, const NodeAbstractProperty &oldPropertyParent, AbstractView::PropertyChangeFlags propertyChange) = 0;
151
152
153
154
155
156
    virtual void nodeReparented(const ModelNode &node, const NodeAbstractProperty &newPropertyParent, const NodeAbstractProperty &oldPropertyParent, AbstractView::PropertyChangeFlags propertyChange) = 0;
    virtual void nodeIdChanged(const ModelNode& node, const QString& newId, const QString& oldId) = 0;
    virtual void propertiesAboutToBeRemoved(const QList<AbstractProperty>& propertyList) = 0;
    virtual void propertiesRemoved(const QList<AbstractProperty>& propertyList) = 0;
    virtual void variantPropertiesChanged(const QList<VariantProperty>& propertyList, PropertyChangeFlags propertyChange) = 0;
    virtual void bindingPropertiesChanged(const QList<BindingProperty>& propertyList, PropertyChangeFlags propertyChange) = 0;
157
    virtual void rootNodeTypeChanged(const QString &type, int majorVersion, int minorVersion) = 0;
158

159
    virtual void instancePropertyChange(const QList<QPair<ModelNode, PropertyName> > &propertyList) = 0;
160
    virtual void instancesCompleted(const QVector<ModelNode> &completedNodeList) = 0;
161
    virtual void instanceInformationsChange(const QMultiHash<ModelNode, InformationName> &informationChangeHash) = 0;
162
163
164
    virtual void instancesRenderImageChanged(const QVector<ModelNode> &nodeList) = 0;
    virtual void instancesPreviewImageChanged(const QVector<ModelNode> &nodeList) = 0;
    virtual void instancesChildrenChanged(const QVector<ModelNode> &nodeList) = 0;
165
166
    virtual void instancesToken(const QString &tokenName, int tokenNumber, const QVector<ModelNode> &nodeVector) = 0;

167
    virtual void nodeSourceChanged(const ModelNode &modelNode, const QString &newNodeSource) = 0;
168

169
170
    virtual void rewriterBeginTransaction() = 0;
    virtual void rewriterEndTransaction() = 0;
171

172
173
    virtual void actualStateChanged(const ModelNode &node) = 0; // base state is a invalid model node

174
175
176
177
178
    virtual void selectedNodesChanged(const QList<ModelNode> &selectedNodeList,
                                      const QList<ModelNode> &lastSelectedNodeList) = 0;

    virtual void fileUrlChanged(const QUrl &oldUrl, const QUrl &newUrl);

179
    virtual void nodeOrderChanged(const NodeListProperty &listProperty, const ModelNode &movedNode, int oldIndex) = 0;
180

181
    virtual void importsChanged(const QList<Import> &addedImports, const QList<Import> &removedImports) = 0;
182

183
    virtual void auxiliaryDataChanged(const ModelNode &node, const PropertyName &name, const QVariant &data);
184
185
186

    virtual void customNotification(const AbstractView *view, const QString &identifier, const QList<ModelNode> &nodeList, const QList<QVariant> &data);

Marco Bubke's avatar
Marco Bubke committed
187
188
    virtual void scriptFunctionsChanged(const ModelNode &node, const QStringList &scriptFunctionList) = 0;

189
190
    QmlModelView *toQmlModelView();

191
    void changeRootNodeType(const TypeName &type, int majorVersion, int minorVersion);
192

193
    NodeInstanceView *nodeInstanceView() const;
194
    RewriterView *rewriterView() const;
195

Marco Bubke's avatar
Marco Bubke committed
196
197
198
    void setAcutalStateNode(const ModelNode &node);
    ModelNode actualStateNode() const;

199
200
    void resetView();

201
    virtual bool hasWidget() const;
Marco Bubke's avatar
Marco Bubke committed
202
    virtual QWidget *widget() = 0;
203
    virtual WidgetInfo widgetInfo();
Marco Bubke's avatar
Marco Bubke committed
204

205
206
207
protected:
    void setModel(Model * model);
    void removeModel();
208
209
210
211
212
    static WidgetInfo createWidgetInfo(QWidget *widget = 0,
                                       const QString &uniqueId = QString(),
                                       WidgetInfo::PlacementHint placementHint = WidgetInfo::NoPane,
                                       int placementPriority = 0,
                                       const QString &tabName = QString());
213
214
215
216
217
218
219
220
221

private: //functions
    QList<ModelNode> toModelNodeList(const QList<Internal::InternalNodePointer> &nodeList) const;


private:
    QWeakPointer<Model> m_model;
};

222
223
QMLDESIGNERCORE_EXPORT QList<Internal::InternalNodePointer> toInternalNodeList(const QList<ModelNode> &nodeList);
QMLDESIGNERCORE_EXPORT QList<ModelNode> toModelNodeList(const QList<Internal::InternalNodePointer> &nodeList, AbstractView *view);
224
225
226
227

}

#endif // ABSTRACTVIEW_H