src/plugins/qmldesigner/designercore/include/qmlobjectnode.h

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (info@qt.nokia.com)
   8 **
   9 **
  10 ** GNU Lesser General Public License Usage
  11 **
  12 ** This file may be used under the terms of the GNU Lesser General Public
  13 ** License version 2.1 as published by the Free Software Foundation and
  14 ** appearing in the file LICENSE.LGPL included in the packaging of this file.
  15 ** Please review the following information to ensure the GNU Lesser General
  16 ** Public License version 2.1 requirements will be met:
  17 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  18 **
  19 ** In addition, as a special exception, Nokia gives you certain additional
  20 ** rights. These rights are described in the Nokia Qt LGPL Exception
  21 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  22 **
  23 ** Other Usage
  24 **
  25 ** Alternatively, this file may be used in accordance with the terms and
  26 ** conditions contained in a signed written agreement between you and Nokia.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **************************************************************************/
  32
  33 #ifndef FXOBJECTNODE_H
  34 #define FXOBJECTNODE_H
  35
  36 #include <corelib_global.h>
  37 #include "qmlmodelnodefacade.h"
  38 #include "qmlstate.h"
  39 #include "qmlchangeset.h"
  40
  41 #include <nodeinstance.h>
  42
  43 namespace QmlDesigner {
  44
  45 class QmlItemNode;
  46 class QmlPropertyChanges;
  47
  48 class CORESHARED_EXPORT QmlObjectNode : public QmlModelNodeFacade
  49 {
  50 public:
  51     QmlObjectNode() : QmlModelNodeFacade() {}
  52     QmlObjectNode(const ModelNode &modelNode)  : QmlModelNodeFacade(modelNode) {}
  53
  54     bool hasNodeParent() const;
  55     bool hasInstanceParent() const;
  56     void setParentProperty(const NodeAbstractProperty &parentProeprty);
  57     QmlObjectNode instanceParent() const;
  58
  59     void setId(const QString &id);
  60     QString id() const;
  61     QString validId();
  62
  63     QmlModelState currentState() const;
  64     void setVariantProperty(const QString &name, const QVariant &value);
  65     void setBindingProperty(const QString &name, const QString &expression);
  66     NodeAbstractProperty nodeAbstractProperty(const QString &name) const;
  67     NodeProperty nodeProperty(const QString &name) const;
  68     NodeListProperty nodeListProperty(const QString &name) const;
  69
  70     QVariant instanceValue(const QString &name) const;
  71     QString instanceType(const QString &name) const;
  72
  73     bool hasProperty(const QString &name) const;
  74     bool hasBindingProperty(const QString &name) const;
  75     bool instanceHasBinding(const QString &name) const;
  76     bool propertyAffectedByCurrentState(const QString &name) const;
  77     QVariant modelValue(const QString &name) const;
  78     QString expression(const QString &name) const;
  79     bool isInBaseState() const;
  80     QmlPropertyChanges propertyChangeForCurrentState() const;
  81
  82     virtual bool canReparent() const;
  83
  84     bool isRootModelNode() const;
  85
  86     void destroy();
  87
  88     QList<QmlModelState> allAffectingStates() const;
  89     QList<QmlModelStateOperation> allAffectingStatesOperations() const;
  90
  91     void removeVariantProperty(const QString &name);
  92
  93     void setParent(QmlObjectNode newParent);
  94
  95     QmlItemNode toQmlItemNode() const;
  96
  97     bool isAncestorOf(const QmlObjectNode &objectNode) const;
  98
  99     bool hasDefaultProperty() const;
 100     QString defaultProperty() const;
 101
 102     static  QVariant instanceValue(const ModelNode &modelNode, const QString &name);
 103
 104 protected:
 105     NodeInstance nodeInstance() const;
 106     QmlObjectNode nodeForInstance(const NodeInstance &instance) const;
 107
 108 protected:
 109     QList<QmlModelState> allDefinedStates() const;
 110 };
 111
 112 CORESHARED_EXPORT uint qHash(const QmlObjectNode &node);
 113 CORESHARED_EXPORT QList<ModelNode> toModelNodeList(const QList<QmlObjectNode> &fxObjectNodeList);
 114 CORESHARED_EXPORT QList<QmlObjectNode> toQmlObjectNodeList(const QList<ModelNode> &modelNodeList);
 115 }// QmlDesigner
 116
 117 #endif // FXOBJECTNODE_H