abstractview.cpp 13.5 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 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

#include "abstractview.h"

#include "model.h"
#include "model_p.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);
}

75
ModelNode AbstractView::createModelNode(const TypeName &typeName,
76 77
                            int majorVersion,
                            int minorVersion,
78 79
                            const QList<QPair<PropertyName, QVariant> > &propertyList,
                            const QList<QPair<PropertyName, QVariant> > &auxPropertyList,
80 81
                            const QString &nodeSource,
                            ModelNode::NodeSourceType nodeSourceType)
82
{
83
    return ModelNode(model()->d->createNode(typeName, majorVersion, minorVersion, propertyList, auxPropertyList, nodeSource, nodeSourceType), model(), this);
84 85 86 87 88 89 90 91 92 93 94
}


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

*/

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


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

*/

ModelNode AbstractView::rootModelNode()
{
    Q_ASSERT(model());
hjk's avatar
hjk committed
107
    return  ModelNode(model()->d->rootNode(), model(), this);
108 109 110 111 112 113 114 115 116 117 118
}

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

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

119
WidgetInfo AbstractView::createWidgetInfo(QWidget *widget,
120
                                          WidgetInfo::ToolBarWidgetFactoryInterface *toolBarWidgetFactory,
121 122 123 124 125 126 127 128
                                          const QString &uniqueId,
                                          WidgetInfo::PlacementHint placementHint,
                                          int placementPriority,
                                          const QString &tabName)
{
    WidgetInfo widgetInfo;

    widgetInfo.widget = widget;
129
    widgetInfo.toolBarWidgetFactory = toolBarWidgetFactory;
130 131 132 133 134 135 136 137
    widgetInfo.uniqueId = uniqueId;
    widgetInfo.placementHint = placementHint;
    widgetInfo.placementPriority = placementPriority;
    widgetInfo.tabName = tabName;

    return widgetInfo;
}

138 139 140 141 142 143 144 145 146 147 148 149 150 151
/*!
\name Model related functions
\{
*/

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

Marco Bubke's avatar
Marco Bubke committed
152 153 154 155 156
bool AbstractView::isAttached() const
{
    return model();
}

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
/*!
\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
*/
//\}

260
void AbstractView::auxiliaryDataChanged(const ModelNode &/*node*/, const PropertyName &/*name*/, const QVariant &/*data*/)
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
{

}

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;
277
    foreach (const Internal::InternalNode::Pointer &node, nodeList)
278 279 280 281 282 283 284 285
        newNodeList.append(ModelNode(node, view->model(), view));

    return newNodeList;
}

QList<Internal::InternalNode::Pointer> toInternalNodeList(const QList<ModelNode> &nodeList)
{
    QList<Internal::InternalNode::Pointer> newNodeList;
286
    foreach (const ModelNode &node, nodeList)
287 288 289 290 291 292 293 294 295 296 297
        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
298
    model()->d->setSelectedNodes(toInternalNodeList(selectedNodeList));
299 300 301 302 303 304 305
}

/*!
\brief clears the selection
*/
void AbstractView::clearSelectedModelNodes()
{
hjk's avatar
hjk committed
306
    model()->d->clearSelectedNodes();
307 308 309 310 311 312 313 314
}

/*!
\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
315
    return toModelNodeList(model()->d->selectedNodes());
316 317 318 319 320 321 322 323
}

/*!
\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
324
    model()->d->selectNode(node.internalNode());
325 326 327 328 329 330 331 332
}

/*!
\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
333
    model()->d->deselectNode(node.internalNode());
334 335 336 337
}

ModelNode AbstractView::modelNodeForId(const QString &id)
{
hjk's avatar
hjk committed
338
    return ModelNode(model()->d->nodeForId(id), model(), this);
339 340 341 342
}

bool AbstractView::hasId(const QString &id) const
{
hjk's avatar
hjk committed
343
    return model()->d->hasId(id);
344 345
}

346 347
ModelNode AbstractView::modelNodeForInternalId(qint32 internalId)
{
hjk's avatar
hjk committed
348
     return ModelNode(model()->d->nodeForInternalId(internalId), model(), this);
349 350
}

351
bool AbstractView::hasModelNodeForInternalId(qint32 internalId) const
352
{
hjk's avatar
hjk committed
353
    return model()->d->hasNodeForInternalId(internalId);
354 355
}

356 357 358 359 360
QmlModelView *AbstractView::toQmlModelView()
{
    return qobject_cast<QmlModelView*>(this);
}

361 362
NodeInstanceView *AbstractView::nodeInstanceView() const
{
363
    if (model())
hjk's avatar
hjk committed
364
        return model()->d->nodeInstanceView();
365
    else
366 367 368
        return 0;
}

369 370
RewriterView *AbstractView::rewriterView() const
{
371
    if (model())
hjk's avatar
hjk committed
372
        return model()->d->rewriterView();
373
    else
374 375 376
        return 0;
}

377 378 379 380 381 382 383 384 385 386
void AbstractView::resetView()
{
    if (!model())
        return;
    Model *currentModel = model();

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

387 388 389 390 391 392 393 394 395 396
bool AbstractView::hasWidget() const
{
    return false;
}

WidgetInfo AbstractView::widgetInfo()
{
    return createWidgetInfo();
}

Marco Bubke's avatar
Marco Bubke committed
397
QList<ModelNode> AbstractView::allModelNodes() const
398
{
hjk's avatar
hjk committed
399
   return toModelNodeList(model()->d->allNodes());
400 401 402 403 404 405 406 407 408 409 410 411 412 413
}

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
414
    model()->d->notifyCustomNotification(this, identifier, nodeList, data);
415 416
}

417
void AbstractView::emitInstancePropertyChange(const QList<QPair<ModelNode, PropertyName> > &propertyList)
418
{
419
    if (model() && nodeInstanceView() == this)
hjk's avatar
hjk committed
420
        model()->d->notifyInstancePropertyChange(propertyList);
421 422
}

423 424 425
void AbstractView::emitInstancesCompleted(const QVector<ModelNode> &nodeVector)
{
    if (model() && nodeInstanceView() == this)
hjk's avatar
hjk committed
426
        model()->d->notifyInstancesCompleted(nodeVector);
427 428
}

429
void AbstractView::emitInstanceInformationsChange(const QMultiHash<ModelNode, InformationName> &informationChangeHash)
430 431
{
    if (model() && nodeInstanceView() == this)
hjk's avatar
hjk committed
432
        model()->d->notifyInstancesInformationsChange(informationChangeHash);
433 434 435 436 437
}

void AbstractView::emitInstancesRenderImageChanged(const QVector<ModelNode> &nodeVector)
{
    if (model() && nodeInstanceView() == this)
hjk's avatar
hjk committed
438
        model()->d->notifyInstancesRenderImageChanged(nodeVector);
439 440 441 442 443
}

void AbstractView::emitInstancesPreviewImageChanged(const QVector<ModelNode> &nodeVector)
{
    if (model() && nodeInstanceView() == this)
hjk's avatar
hjk committed
444
        model()->d->notifyInstancesPreviewImageChanged(nodeVector);
445 446 447 448 449
}

void AbstractView::emitInstancesChildrenChanged(const QVector<ModelNode> &nodeVector)
{
    if (model() && nodeInstanceView() == this)
hjk's avatar
hjk committed
450
        model()->d->notifyInstancesChildrenChanged(nodeVector);
451 452 453 454 455
}

void AbstractView::emitRewriterBeginTransaction()
{
    if (model())
hjk's avatar
hjk committed
456
        model()->d->notifyRewriterBeginTransaction();
457 458
}

459 460 461 462 463 464 465 466 467
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
468
        model()->d->notifyInstanceToken(token, number, nodeVector);
469 470
}

471 472 473
void AbstractView::emitRewriterEndTransaction()
{
    if (model())
hjk's avatar
hjk committed
474
        model()->d->notifyRewriterEndTransaction();
475 476
}

Marco Bubke's avatar
Marco Bubke committed
477
void AbstractView::setAcutalStateNode(const ModelNode &node)
478
{
Marco Bubke's avatar
Marco Bubke committed
479
    Internal::WriteLocker locker(m_model.data());
480
    if (model())
hjk's avatar
hjk committed
481
        model()->d->notifyActualStateChanged(node);
482 483
}

484
void AbstractView::changeRootNodeType(const TypeName &type, int majorVersion, int minorVersion)
485 486 487
{
    Internal::WriteLocker locker(m_model.data());

hjk's avatar
hjk committed
488
    m_model.data()->d->changeRootNodeType(type, majorVersion, minorVersion);
489 490
}

Marco Bubke's avatar
Marco Bubke committed
491 492
ModelNode AbstractView::actualStateNode() const
{
493
    if (model())
hjk's avatar
hjk committed
494
        return ModelNode(m_model.data()->d->actualStateNode(), m_model.data(), const_cast<AbstractView*>(this));
495 496

    return ModelNode();
Marco Bubke's avatar
Marco Bubke committed
497 498
}

499
} // namespace QmlDesigner