abstractview.h 8.72 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
class QMLDESIGNERCORE_EXPORT AbstractView : public QObject
62 63 64
{
    Q_OBJECT
public:
65
    Q_FLAGS(PropertyChangeFlag PropertyChangeFlags)
66 67 68 69 70
    typedef QWeakPointer<AbstractView> Pointer;

    enum PropertyChangeFlag {
      NoAdditionalChanges = 0x0,
      PropertiesAdded = 0x1,
71
      EmptyPropertiesRemoved = 0x2
72
    };
73
    Q_DECLARE_FLAGS(PropertyChangeFlags, PropertyChangeFlag)
74 75 76 77 78 79
    AbstractView(QObject *parent = 0)
            : QObject(parent) {}

    virtual ~AbstractView();

    Model* model() const;
Marco Bubke's avatar
Marco Bubke committed
80
    bool isAttached() const;
81 82 83

    RewriterTransaction beginRewriterTransaction();

84
    ModelNode createModelNode(const TypeName &typeName,
85 86
                         int majorVersion,
                         int minorVersion,
87
                         const PropertyListType &propertyList = PropertyListType(),
88 89
                         const PropertyListType &auxPropertyList = PropertyListType(),
                         const QString &nodeSource = QString(),
90
                         ModelNode::NodeSourceType nodeSourceType = ModelNode::NodeWithoutSource);
91 92 93 94 95 96 97 98 99 100 101 102 103 104

    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;

105 106 107
    ModelNode modelNodeForInternalId(qint32 internalId);
    bool hasModelNodeForInternalId(qint32 internalId) const;

Marco Bubke's avatar
Marco Bubke committed
108
    QList<ModelNode> allModelNodes() const;
109 110 111 112 113

    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);

114
    void emitInstancePropertyChange(const QList<QPair<ModelNode, PropertyName> > &propertyList);
115
    void emitInstancesCompleted(const QVector<ModelNode> &nodeList);
116
    void emitInstanceInformationsChange(const QMultiHash<ModelNode, InformationName> &informationChangeHash);
117 118 119 120 121
    void emitInstancesRenderImageChanged(const QVector<ModelNode> &nodeList);
    void emitInstancesPreviewImageChanged(const QVector<ModelNode> &nodeList);
    void emitInstancesChildrenChanged(const QVector<ModelNode> &nodeList);
    void emitRewriterBeginTransaction();
    void emitRewriterEndTransaction();
122
    void emitInstanceToken(const QString &token, int number, const QVector<ModelNode> &nodeVector);
123

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

126 127 128 129 130 131
    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;
132
    virtual void nodeAboutToBeReparented(const ModelNode &node, const NodeAbstractProperty &newPropertyParent, const NodeAbstractProperty &oldPropertyParent, AbstractView::PropertyChangeFlags propertyChange) = 0;
133 134 135 136 137 138
    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;
139
    virtual void rootNodeTypeChanged(const QString &type, int majorVersion, int minorVersion) = 0;
140

141
    virtual void instancePropertyChange(const QList<QPair<ModelNode, PropertyName> > &propertyList) = 0;
142
    virtual void instancesCompleted(const QVector<ModelNode> &completedNodeList) = 0;
143
    virtual void instanceInformationsChange(const QMultiHash<ModelNode, InformationName> &informationChangeHash) = 0;
144 145 146
    virtual void instancesRenderImageChanged(const QVector<ModelNode> &nodeList) = 0;
    virtual void instancesPreviewImageChanged(const QVector<ModelNode> &nodeList) = 0;
    virtual void instancesChildrenChanged(const QVector<ModelNode> &nodeList) = 0;
147 148
    virtual void instancesToken(const QString &tokenName, int tokenNumber, const QVector<ModelNode> &nodeVector) = 0;

149
    virtual void nodeSourceChanged(const ModelNode &modelNode, const QString &newNodeSource) = 0;
150

151 152
    virtual void rewriterBeginTransaction() = 0;
    virtual void rewriterEndTransaction() = 0;
153

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

156 157 158 159 160
    virtual void selectedNodesChanged(const QList<ModelNode> &selectedNodeList,
                                      const QList<ModelNode> &lastSelectedNodeList) = 0;

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

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

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

165
    virtual void auxiliaryDataChanged(const ModelNode &node, const PropertyName &name, const QVariant &data);
166 167 168

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

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

171 172
    QmlModelView *toQmlModelView();

173
    void changeRootNodeType(const TypeName &type, int majorVersion, int minorVersion);
174

175
    NodeInstanceView *nodeInstanceView() const;
176
    RewriterView *rewriterView() const;
177

Marco Bubke's avatar
Marco Bubke committed
178 179 180
    void setAcutalStateNode(const ModelNode &node);
    ModelNode actualStateNode() const;

181 182
    void resetView();

Marco Bubke's avatar
Marco Bubke committed
183 184
    virtual QWidget *widget() = 0;

185 186 187 188 189 190 191 192 193 194 195 196
protected:
    void setModel(Model * model);
    void removeModel();

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


private:
    QWeakPointer<Model> m_model;
};

197 198
QMLDESIGNERCORE_EXPORT QList<Internal::InternalNodePointer> toInternalNodeList(const QList<ModelNode> &nodeList);
QMLDESIGNERCORE_EXPORT QList<ModelNode> toModelNodeList(const QList<Internal::InternalNodePointer> &nodeList, AbstractView *view);
199 200 201 202

}

#endif // ABSTRACTVIEW_H