abstractview.cpp 12.4 KB
Newer Older
1 2 3 4
/**************************************************************************
**
** This file is part of Qt Creator
**
hjk's avatar
hjk committed
5
** Copyright (c) 2012 Nokia Corporation and/or its subsidiary(-ies).
6
**
Eike Ziller's avatar
Eike Ziller committed
7
** Contact: http://www.qt-project.org/
8 9 10 11
**
**
** GNU Lesser General Public License Usage
**
hjk's avatar
hjk committed
12 13 14 15 16 17
** 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.
18
**
con's avatar
con committed
19
** In addition, as a special exception, Nokia gives you certain additional
hjk's avatar
hjk committed
20
** rights. These rights are described in the Nokia Qt LGPL Exception
con's avatar
con committed
21 22
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
23 24 25 26 27
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
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
**
**************************************************************************/

#include "abstractview.h"

#include "model.h"
#include "model_p.h"
#include "nodeproperty.h"
#include "bindingproperty.h"
#include "internalnode_p.h"
#include <qmlmodelview.h>

namespace QmlDesigner {


/*!
\class QmlDesigner::AbstractView
\ingroup CoreModel
\brief An abstract interface views and editors can implement to be notified about model changes.

\see QmlDesigner::WidgetQueryView, QmlDesigner::NodeInstanceView
*/

AbstractView::~AbstractView()
{
    if (m_model)
        m_model.data()->detachView(this, Model::DoNotNotifyView);
}

/*!
\brief sets the view of the model. this is handled automatically by AbstractView::modelAttached.
\param model new Model
*/
void AbstractView::setModel(Model *model)
{
    Q_ASSERT(model != 0);
    if (model == m_model.data())
        return;

    if (m_model)
        m_model.data()->detachView(this);

    m_model = model;
}

RewriterTransaction AbstractView::beginRewriterTransaction()
{
    return RewriterTransaction(this);
}

ModelNode AbstractView::createModelNode(const QString &typeString,
                            int majorVersion,
                            int minorVersion,
81
                            const QList<QPair<QString, QVariant> > &propertyList,
82 83 84
                            const QList<QPair<QString, QVariant> > &auxPropertyList,
                            const QString &nodeSource,
                            ModelNode::NodeSourceType nodeSourceType)
85
{
hjk's avatar
hjk committed
86
    return ModelNode(model()->d->createNode(typeString, majorVersion, minorVersion, propertyList, auxPropertyList, nodeSource, nodeSourceType), model(), this);
87 88 89 90 91 92 93 94 95 96 97
}


/*! \brief returns the root model node
\return constant root model node

*/

const ModelNode AbstractView::rootModelNode() const
{
    Q_ASSERT(model());
hjk's avatar
hjk committed
98
    return ModelNode(model()->d->rootNode(), model(), const_cast<AbstractView*>(this));
99 100 101 102 103 104 105 106 107 108 109
}


/*! \brief returns the root model node
\return root model node

*/

ModelNode AbstractView::rootModelNode()
{
    Q_ASSERT(model());
hjk's avatar
hjk committed
110
    return  ModelNode(model()->d->rootNode(), model(), this);
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 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
}

/*!
\brief sets the reference to model to a null pointer

*/
void AbstractView::removeModel()
{
    m_model.clear();
}

/*!
\name Model related functions
\{
*/

/*!
\brief returns the model
\return the model of the view
*/
Model* AbstractView::model() const
{
    return m_model.data();
}

/*!
\brief is called if a view is being attached to a model
\param model which is being attached
The default implementation is setting the reference of the model to the view.
\see Model::attachView
*/
void AbstractView::modelAttached(Model *model)
{
    setModel(model);
}

/*!
\brief is called before a view is being detached from a model
\param model which is being detached

This is not called if Model::detachViewWithOutNotification is used! The default implementation
is removing the reference to the model from the view.

\see Model::detachView
*/
void AbstractView::modelAboutToBeDetached(Model *)
{
    removeModel();
}

//\}


/*!
\name Property related functions
\{
 */

/*!
\fn void QmlDesigner::AbstractView::propertyAdded(const ModelNode &, const AbstractProperty &)
\brief node notifies about that this property is added
\param node node to which the property is added
\param property added property
*/


/*!
\fn void AbstractView::propertyValueChanged(const ModelNode &, const AbstractProperty& , const QVariant& , const QVariant& )
\brief this notifies about that the value of this proeprty will be changes
\param node node of the property
\param property changed property
\param newValue the variant of the new value
\param oldValue the variant of the old value
*/
//\}

/*!
\name Node related functions
\{
 */

/*!
\fn void AbstractView::nodeCreated(const ModelNode &)
\brief this function is called if a new node was created
\param createdNode created node
*/


/*!
\fn AbstractView::fileUrlChanged(const QUrl &oldBaseUrl, const QUrl &newBaseUrl)
\brief Called when the file url (e.g. needed to to resolve relative paths against) has changed
\param oldBaseUrl old search path
\param newBaseUrl new search path
*/
void AbstractView::fileUrlChanged(const QUrl &/*oldUrl*/, const QUrl &/*newUrl*/)
{
}

/*!
\fn void AbstractView::nodeAboutToBeRemoved(const ModelNode &)
\brief this is called if a node will be removed
\param removedNode to be removed node
*/

/*!
\brief this is called after a propererty was removed
\param propertyList removed property list
*/
void AbstractView::propertiesRemoved(const QList<AbstractProperty>& /*propertyList*/)
{
}

/*!
\fn void AbstractView::nodeReparented(const ModelNode &, const ModelNode &, const ModelNode &)
\brief this is called if a node was reparented
\param node the parent for this node will be changed
\param oldParent old parent of the node
\param newParent new parent of the node
*/

/*!
\fn void QmlDesigner::AbstractView::selectedNodesChanged(const QList< ModelNode > &, const QList< ModelNode > &)
\brief this function is called if the selection was changed
\param selectedNodeList the new selection list
\param lastSelectedNodeList the old selection list
*/
//\}

void AbstractView::auxiliaryDataChanged(const ModelNode &/*node*/, const QString &/*name*/, const QVariant &/*data*/)
{

}

void AbstractView::customNotification(const AbstractView * /*view*/, const QString & /*identifier*/, const QList<ModelNode> & /*nodeList*/, const QList<QVariant> & /*data*/)
{
}

QList<ModelNode> AbstractView::toModelNodeList(const QList<Internal::InternalNode::Pointer> &nodeList) const
{
    return QmlDesigner::toModelNodeList(nodeList, const_cast<AbstractView*>(this));
}

QList<ModelNode> toModelNodeList(const QList<Internal::InternalNode::Pointer> &nodeList, AbstractView *view)
{
    QList<ModelNode> newNodeList;
    foreach(const Internal::InternalNode::Pointer &node, nodeList)
        newNodeList.append(ModelNode(node, view->model(), view));

    return newNodeList;
}

QList<Internal::InternalNode::Pointer> toInternalNodeList(const QList<ModelNode> &nodeList)
{
    QList<Internal::InternalNode::Pointer> newNodeList;
    foreach(const ModelNode &node, nodeList)
        newNodeList.append(node.internalNode());

    return newNodeList;
}

/*!
\brief set this list nodes to the actual selected nodes
\param focusNodeList list the selected nodes
*/
void AbstractView::setSelectedModelNodes(const QList<ModelNode> &selectedNodeList)
{
hjk's avatar
hjk committed
277
    model()->d->setSelectedNodes(toInternalNodeList(selectedNodeList));
278 279 280 281 282 283 284
}

/*!
\brief clears the selection
*/
void AbstractView::clearSelectedModelNodes()
{
hjk's avatar
hjk committed
285
    model()->d->clearSelectedNodes();
286 287 288 289 290 291 292 293
}

/*!
\brief set this list nodes to the actual selected nodes
\return list the selected nodes
*/
QList<ModelNode> AbstractView::selectedModelNodes() const
{
hjk's avatar
hjk committed
294
    return toModelNodeList(model()->d->selectedNodes());
295 296 297 298 299 300 301 302
}

/*!
\brief adds a node to the selection list
\param node to be added to the selection list
*/
void AbstractView::selectModelNode(const ModelNode &node)
{
hjk's avatar
hjk committed
303
    model()->d->selectNode(node.internalNode());
304 305 306 307 308 309 310 311
}

/*!
\brief removes a node from the selection list
\param node to be removed from the selection list
*/
void AbstractView::deselectModelNode(const ModelNode &node)
{
hjk's avatar
hjk committed
312
    model()->d->deselectNode(node.internalNode());
313 314 315 316
}

ModelNode AbstractView::modelNodeForId(const QString &id)
{
hjk's avatar
hjk committed
317
    return ModelNode(model()->d->nodeForId(id), model(), this);
318 319 320 321
}

bool AbstractView::hasId(const QString &id) const
{
hjk's avatar
hjk committed
322
    return model()->d->hasId(id);
323 324
}

325 326
ModelNode AbstractView::modelNodeForInternalId(qint32 internalId)
{
hjk's avatar
hjk committed
327
     return ModelNode(model()->d->nodeForInternalId(internalId), model(), this);
328 329
}

330
bool AbstractView::hasModelNodeForInternalId(qint32 internalId) const
331
{
hjk's avatar
hjk committed
332
    return model()->d->hasNodeForInternalId(internalId);
333 334
}

335 336 337 338 339
QmlModelView *AbstractView::toQmlModelView()
{
    return qobject_cast<QmlModelView*>(this);
}

340 341 342
NodeInstanceView *AbstractView::nodeInstanceView() const
{
    if (model()) {
hjk's avatar
hjk committed
343
        return model()->d->nodeInstanceView();
344 345 346 347 348
    } else {
        return 0;
    }
}

349 350 351
RewriterView *AbstractView::rewriterView() const
{
    if (model()) {
hjk's avatar
hjk committed
352
        return model()->d->rewriterView();
353 354 355 356 357
    } else {
        return 0;
    }
}

358 359 360 361 362 363 364 365 366 367
void AbstractView::resetView()
{
    if (!model())
        return;
    Model *currentModel = model();

    currentModel->detachView(this);
    currentModel->attachView(this);
}

368 369
QList<ModelNode> AbstractView::allModelNodes()
{
hjk's avatar
hjk committed
370
   return toModelNodeList(model()->d->allNodes());
371 372 373 374 375 376 377 378 379 380 381 382 383 384
}

void AbstractView::emitCustomNotification(const QString &identifier)
{
    emitCustomNotification(identifier, QList<ModelNode>());
}

void AbstractView::emitCustomNotification(const QString &identifier, const QList<ModelNode> &nodeList)
{
    emitCustomNotification(identifier, nodeList, QList<QVariant>());
}

void AbstractView::emitCustomNotification(const QString &identifier, const QList<ModelNode> &nodeList, const QList<QVariant> &data)
{
hjk's avatar
hjk committed
385
    model()->d->notifyCustomNotification(this, identifier, nodeList, data);
386 387
}

388 389
void AbstractView::emitInstancePropertyChange(const QList<QPair<ModelNode, QString> > &propertyList)
{
390
    if (model() && nodeInstanceView() == this)
hjk's avatar
hjk committed
391
        model()->d->notifyInstancePropertyChange(propertyList);
392 393
}

394 395 396
void AbstractView::emitInstancesCompleted(const QVector<ModelNode> &nodeVector)
{
    if (model() && nodeInstanceView() == this)
hjk's avatar
hjk committed
397
        model()->d->notifyInstancesCompleted(nodeVector);
398 399
}

400
void AbstractView::emitInstanceInformationsChange(const QMultiHash<ModelNode, InformationName> &informationChangeHash)
401 402
{
    if (model() && nodeInstanceView() == this)
hjk's avatar
hjk committed
403
        model()->d->notifyInstancesInformationsChange(informationChangeHash);
404 405 406 407 408
}

void AbstractView::emitInstancesRenderImageChanged(const QVector<ModelNode> &nodeVector)
{
    if (model() && nodeInstanceView() == this)
hjk's avatar
hjk committed
409
        model()->d->notifyInstancesRenderImageChanged(nodeVector);
410 411 412 413 414
}

void AbstractView::emitInstancesPreviewImageChanged(const QVector<ModelNode> &nodeVector)
{
    if (model() && nodeInstanceView() == this)
hjk's avatar
hjk committed
415
        model()->d->notifyInstancesPreviewImageChanged(nodeVector);
416 417 418 419 420
}

void AbstractView::emitInstancesChildrenChanged(const QVector<ModelNode> &nodeVector)
{
    if (model() && nodeInstanceView() == this)
hjk's avatar
hjk committed
421
        model()->d->notifyInstancesChildrenChanged(nodeVector);
422 423 424 425 426
}

void AbstractView::emitRewriterBeginTransaction()
{
    if (model())
hjk's avatar
hjk committed
427
        model()->d->notifyRewriterBeginTransaction();
428 429
}

430 431 432 433 434 435 436 437 438
void AbstractView::sendTokenToInstances(const QString &token, int number, const QVector<ModelNode> &nodeVector)
{
    if (nodeInstanceView())
        nodeInstanceView()->sendToken(token, number, nodeVector);
}

void AbstractView::emitInstanceToken(const QString &token, int number, const QVector<ModelNode> &nodeVector)
{
    if (nodeInstanceView())
hjk's avatar
hjk committed
439
        model()->d->notifyInstanceToken(token, number, nodeVector);
440 441
}

442 443 444
void AbstractView::emitRewriterEndTransaction()
{
    if (model())
hjk's avatar
hjk committed
445
        model()->d->notifyRewriterEndTransaction();
446 447
}

Marco Bubke's avatar
Marco Bubke committed
448
void AbstractView::setAcutalStateNode(const ModelNode &node)
449
{
Marco Bubke's avatar
Marco Bubke committed
450
    Internal::WriteLocker locker(m_model.data());
451
    if (model())
hjk's avatar
hjk committed
452
        model()->d->notifyActualStateChanged(node);
453 454
}

455 456 457 458
void AbstractView::changeRootNodeType(const QString &type, int majorVersion, int minorVersion)
{
    Internal::WriteLocker locker(m_model.data());

hjk's avatar
hjk committed
459
    m_model.data()->d->changeRootNodeType(type, majorVersion, minorVersion);
460 461
}

Marco Bubke's avatar
Marco Bubke committed
462 463
ModelNode AbstractView::actualStateNode() const
{
464
    if (model())
hjk's avatar
hjk committed
465
        return ModelNode(m_model.data()->d->actualStateNode(), m_model.data(), const_cast<AbstractView*>(this));
466 467

    return ModelNode();
Marco Bubke's avatar
Marco Bubke committed
468 469
}

470
} // namespace QmlDesigner