1 // Copyright (C) 2014-2019 CEA/DEN, EDF R&D
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #include "XGUI_ObjectsBrowser.h"
21 #include "XGUI_Tools.h"
22 #include "XGUI_DataModel.h"
24 #include <ModelAPI_Data.h>
25 #include <ModelAPI_Session.h>
26 #include <ModelAPI_Document.h>
27 #include <ModelAPI_Tools.h>
29 #include <ModuleBase_Tools.h>
30 #include <ModuleBase_ITreeNode.h>
32 #include <XGUI_Workshop.h>
38 #include <QMouseEvent>
40 #include <QStyledItemDelegate>
41 #include <QMessageBox>
42 #include <QApplication>
48 /// Width of second column (minimum acceptable = 27)
49 #define FIRST_COL_WIDTH 20
50 #define SECOND_COL_WIDTH 30
55 * Tree item delegate for definition of data in column items editor
57 class XGUI_TreeViewItemDelegate: public QStyledItemDelegate
61 /// \param theParent a parent of the delegate
62 XGUI_TreeViewItemDelegate(XGUI_DataTree* theParent):QStyledItemDelegate(theParent),
63 myTreedView(theParent) {}
65 /// Set data for item editor (name of the item)
66 /// \param editor a widget of editor
67 /// \param index the tree item index
68 virtual void setEditorData ( QWidget* editor, const QModelIndex& index ) const
70 QLineEdit* aEditor = dynamic_cast<QLineEdit*>(editor);
72 XGUI_DataModel* aModel = myTreedView->dataModel();
73 ObjectPtr aObj = aModel->object(index);
74 if (aObj.get() != NULL) {
75 aEditor->setText(aObj->data()->name().c_str());
79 QStyledItemDelegate::setEditorData(editor, index);
83 XGUI_DataTree* myTreedView;
87 XGUI_DataTree::XGUI_DataTree(QWidget* theParent)
88 : QTreeView(theParent)
90 setHeaderHidden(true);
92 setEditTriggers(QAbstractItemView::NoEditTriggers);
93 setSelectionBehavior(QAbstractItemView::SelectRows);
94 setSelectionMode(QAbstractItemView::ExtendedSelection);
96 setItemDelegateForColumn(1, new XGUI_TreeViewItemDelegate(this));
98 connect(this, SIGNAL(doubleClicked(const QModelIndex&)),
99 SLOT(onDoubleClick(const QModelIndex&)));
102 XGUI_DataTree::~XGUI_DataTree()
106 XGUI_DataModel* XGUI_DataTree::dataModel() const
108 return static_cast<XGUI_DataModel*>(model());
111 void XGUI_DataTree::contextMenuEvent(QContextMenuEvent* theEvent)
113 emit contextMenuRequested(theEvent);
116 void XGUI_DataTree::commitData(QWidget* theEditor)
118 static int aEntrance = 0;
119 if (aEntrance == 0) {
120 // We have to check number of enter and exit of this function because it can be called
121 // recursively by Qt in order to avoid double modifying of a data
123 QLineEdit* aEditor = dynamic_cast<QLineEdit*>(theEditor);
125 QString aName = aEditor->text();
126 QModelIndexList aIndexList = selectionModel()->selectedIndexes();
127 XGUI_DataModel* aModel = dataModel();
128 ObjectPtr aObj = aModel->object(aIndexList.first());
130 if (XGUI_Tools::canRename(aObj, aName)) {
131 SessionPtr aMgr = ModelAPI_Session::get();
132 aMgr->startOperation("Rename");
133 aObj->data()->setName(qPrintable(aName));
134 aMgr->finishOperation();
141 void XGUI_DataTree::clear()
143 dataModel()->clear();
147 void XGUI_DataTree::resizeEvent(QResizeEvent* theEvent)
149 QTreeView::resizeEvent(theEvent);
150 QSize aSize = theEvent->size();
151 if (aSize.isValid()) {
152 setColumnWidth(0, FIRST_COL_WIDTH);
153 setColumnWidth(1, aSize.width() - SECOND_COL_WIDTH - FIRST_COL_WIDTH - 10);
154 setColumnWidth(2, SECOND_COL_WIDTH);
159 void XGUI_DataTree::mousePressEvent(QMouseEvent* theEvent)
161 QTreeView::mousePressEvent(theEvent);
162 if (theEvent->button() != Qt::MidButton)
164 QModelIndex aInd = indexAt(theEvent->pos());
166 QString("r=%1 c=%2 p=%3").arg(aInd.row()).arg(aInd.column()).arg((long)aInd.internalPointer());
168 QModelIndex aPar = aInd.parent();
170 QString("r=%1 c=%2 p=%3").arg(aPar.row()).arg(aPar.column()).arg((long)aPar.internalPointer());
171 QToolTip::showText(theEvent->globalPos(), aTxt + '\n' + aTxt1);
175 void XGUI_DataTree::mouseReleaseEvent(QMouseEvent* theEvent)
177 QTreeView::mouseReleaseEvent(theEvent);
179 if (theEvent->button() != Qt::MidButton)
181 QToolTip::hideText();
183 if (theEvent->button() == Qt::LeftButton) {
184 QModelIndex aInd = indexAt(theEvent->pos());
185 if (aInd.column() == 0)
186 processEyeClick(aInd);
190 void XGUI_DataTree::processHistoryChange(const QModelIndex& theIndex)
192 SessionPtr aMgr = ModelAPI_Session::get();
193 // When operation is opened then we can not change history
194 if (aMgr->isOperation())
196 XGUI_DataModel* aModel = dataModel();
197 if (aModel->flags(theIndex) == 0)
199 ObjectPtr aObj = aModel->object(theIndex);
201 DocumentPtr aDoc = aMgr->activeDocument();
203 std::string aOpName = tr("History change").toStdString();
205 if (aObj->document() != aDoc)
207 aMgr->startOperation(aOpName);
208 aDoc->setCurrentFeature(std::dynamic_pointer_cast<ModelAPI_Feature>(aObj), true);
209 aMgr->finishOperation();
211 // Ignore clicks on folders outside current document
212 if ((theIndex.internalId() == 0) && (aDoc != aMgr->moduleDocument()))
213 // Clicked folder under root but active document is another
215 if ((theIndex.internalId() != 0) && (aDoc != aModel->document(theIndex)))
216 // Cliced not on active document folder
219 aMgr->startOperation(aOpName);
220 aDoc->setCurrentFeature(FeaturePtr(), true);
221 aMgr->finishOperation();
223 QModelIndex aParent = theIndex.parent();
224 int aSize = aModel->rowCount(aParent);
225 for (int i = 0; i < aSize; i++) {
226 update(aModel->index(i, 0, aParent));
227 update(aModel->index(i, 1, aParent));
228 update(aModel->index(i, 2, aParent));
232 void XGUI_DataTree::processEyeClick(const QModelIndex& theIndex)
234 XGUI_DataModel* aModel = dataModel();
235 ObjectPtr aObj = aModel->object(theIndex);
237 ResultPtr aResObj = std::dynamic_pointer_cast<ModelAPI_Result>(aObj);
238 XGUI_ObjectsBrowser* aObjBrowser = qobject_cast<XGUI_ObjectsBrowser*>(parent());
240 std::set<ObjectPtr> anObjects;
241 anObjects.insert(aResObj);
243 bool hasHiddenState = aModel->hasHiddenState(theIndex);
244 if (aObjBrowser && hasHiddenState && !aObjBrowser->workshop()->prepareForDisplay(anObjects))
246 if (hasHiddenState) { // #issue 2335(hide all faces then show solid problem)
247 if (aResObj->isDisplayed())
248 aResObj->setDisplayed(false);
249 aResObj->setDisplayed(true);
252 aResObj->setDisplayed(!aResObj->isDisplayed());
253 Events_Loop::loop()->flush(Events_Loop::eventByName(EVENT_OBJECT_TO_REDISPLAY));
256 // Update list of selected objects because this event happens after
257 // selection event in object browser
259 aObjBrowser->onSelectionChanged();
264 void XGUI_DataTree::onDoubleClick(const QModelIndex& theIndex)
266 switch (theIndex.column()) {
268 processHistoryChange(theIndex);
274 //********************************************************************
275 //********************************************************************
276 //********************************************************************
277 XGUI_ActiveDocLbl::XGUI_ActiveDocLbl(const QString& theText, QWidget* theParent )
278 : QLabel(theText, theParent),
279 myPreSelectionStyle(""),
281 mySelectionStyle(""),
286 void XGUI_ActiveDocLbl::setTreeView(QTreeView* theView)
288 myTreeView = theView;
289 setFont(myTreeView->font());
291 QPalette aPalet = myTreeView->palette();
292 QColor aHighlight = aPalet.highlight().color();
293 QColor aHighlightText = aPalet.highlightedText().color();
295 myPreSelectionStyle = "QLabel {background-color: ";
296 myPreSelectionStyle += aHighlight.lighter(170).name() + "}";
297 //myPreSelectionStyle += "qlineargradient(x1:0, y1:0, x2:0, y2:1, stop:0 white, stop:1 " +
298 // aHighlight.lighter(170).name() + ");";
299 //myPreSelectionStyle += "border: 1px solid lightblue; border-radius: 2px }";
301 QString aName = aPalet.color(QPalette::Base).name();
302 myNeutralStyle = "QLabel { border: 1px solid " + aName + " }";
305 #if (!defined HAVE_SALOME) && (defined WIN32)
306 mySelectionStyle = "QLabel {background-color: ";
307 mySelectionStyle += "rgb(205, 232, 255); ";
308 //mySelectionStyle += "qlineargradient(x1:0, y1:0, x2:0, y2:1, stop:0 rgb(236, 245, 255)";
309 //mySelectionStyle += ", stop:1 rgb(208, 229, 255));";
310 //mySelectionStyle += "border: 1px solid rgb(132, 172, 221); border-radius: 2px }";
311 mySelectionStyle += "border: 1px solid rgb(153, 209, 255) }";
313 mySelectionStyle = "QLabel {background-color: " + aHighlight.name();
314 mySelectionStyle += "; color : " + aHighlightText.name() + "}";
317 myTreeView->viewport()->installEventFilter(this);
321 #if (!defined HAVE_SALOME) && (defined WIN32)
322 bool XGUI_ActiveDocLbl::event(QEvent* theEvent)
324 switch (theEvent->type()) {
327 setStyleSheet(myPreSelectionStyle);
331 setStyleSheet(myNeutralStyle);
334 return QLabel::event(theEvent);
338 bool XGUI_ActiveDocLbl::eventFilter(QObject* theObj, QEvent* theEvent)
340 if (theObj == myTreeView->viewport()) {
341 if (theEvent->type() == QEvent::MouseButtonRelease)
344 return QLabel::eventFilter(theObj, theEvent);
347 static bool MYClearing = false;
348 void XGUI_ActiveDocLbl::mouseReleaseEvent( QMouseEvent* e)
352 setStyleSheet(mySelectionStyle);
353 // We can not block signals because on
354 // clear selection the View state will not be updated
355 myTreeView->clearSelection();
356 QLabel::mouseReleaseEvent(e);
360 void XGUI_ActiveDocLbl::unselect()
363 myIsSelected = false;
364 setStyleSheet(myNeutralStyle);
369 //********************************************************************
370 //********************************************************************
371 //********************************************************************
372 XGUI_ObjectsBrowser::XGUI_ObjectsBrowser(QWidget* theParent, XGUI_Workshop* theWorkshop)
373 : QWidget(theParent), myDocModel(0), myWorkshop(theWorkshop)
375 QVBoxLayout* aLayout = new QVBoxLayout(this);
376 ModuleBase_Tools::zeroMargins(aLayout);
377 aLayout->setSpacing(0);
379 QWidget* aLabelWgt = new QWidget(this);
380 aLabelWgt->setAutoFillBackground(true);
382 aLayout->addWidget(aLabelWgt);
383 QHBoxLayout* aLabelLay = new QHBoxLayout(aLabelWgt);
384 ModuleBase_Tools::zeroMargins(aLabelLay);
385 aLabelLay->setSpacing(0);
387 QLabel* aLbl = new QLabel(aLabelWgt);
388 aLbl->setPixmap(QPixmap(":pictures/assembly.png"));
390 // Do not paint background of the label (in order to show icon)
391 aLbl->setAutoFillBackground(false);
393 aLabelLay->addWidget(aLbl);
395 SessionPtr aMgr = ModelAPI_Session::get();
396 DocumentPtr aDoc = aMgr->moduleDocument();
398 myActiveDocLbl = new XGUI_ActiveDocLbl(tr("Part set"), aLabelWgt);
399 // myActiveDocLbl->setReadOnly(true);
400 // myActiveDocLbl->setFrame(false);
401 myActiveDocLbl->setContextMenuPolicy(Qt::CustomContextMenu);
403 aLabelLay->addWidget(myActiveDocLbl);
404 aLabelLay->setStretch(1, 1);
406 myTreeView = new XGUI_DataTree(this);
407 myTreeView->setFrameShape(QFrame::NoFrame);
408 aLayout->addWidget(myTreeView);
410 QPalette aTreePalet = myTreeView->palette();
411 QColor aTreeBack = aTreePalet.color(QPalette::Base);
414 aPalet.setColor(QPalette::Base, aTreeBack);
415 aPalet.setColor(QPalette::Window, aTreeBack);
416 aLabelWgt->setPalette(aPalet);
418 myDocModel = new XGUI_DataModel(this);
419 connect(myDocModel, SIGNAL(modelAboutToBeReset()), SLOT(onBeforeReset()));
420 connect(myDocModel, SIGNAL(treeRebuilt()), SLOT(onAfterModelReset()));
422 connect(myTreeView, SIGNAL(contextMenuRequested(QContextMenuEvent*)), this,
423 SLOT(onContextMenuRequested(QContextMenuEvent*)));
426 //***************************************************
427 XGUI_ObjectsBrowser::~XGUI_ObjectsBrowser()
431 void XGUI_ObjectsBrowser::initialize(ModuleBase_ITreeNode* theRoot)
433 //myDocModel->setXMLReader(theReader);
434 myDocModel->setRoot(theRoot);
435 myTreeView->setModel(myDocModel);
437 // It has to be done after setting of model
438 myActiveDocLbl->setTreeView(myTreeView);
440 QItemSelectionModel* aSelMod = myTreeView->selectionModel();
441 connect(aSelMod, SIGNAL(selectionChanged(const QItemSelection&, const QItemSelection&)),
442 this, SLOT(onSelectionChanged(const QItemSelection&, const QItemSelection&)));
445 //***************************************************
446 void XGUI_ObjectsBrowser::onContextMenuRequested(QContextMenuEvent* theEvent)
448 QModelIndexList aIndexes;
449 QObjectPtrList aSelectedData = selectedObjects(&aIndexes);
450 bool toEnable = false;
452 if (aSelectedData.size() == 1) {
453 QModelIndex aSelected = myTreeView->indexAt(theEvent->pos());
454 if (!aIndexes.contains(aSelected))
455 return; // menu is called on non selected item
457 Qt::ItemFlags aFlags = dataModel()->flags(aIndexes.first());
458 toEnable = ((aFlags & Qt::ItemIsEditable) != 0);
460 foreach(QAction* aCmd, actions()) {
461 aCmd->setEnabled(toEnable);
463 emit contextMenuRequested(theEvent);
466 //***************************************************
467 void XGUI_ObjectsBrowser::onLabelContextMenuRequested(const QPoint& thePnt)
469 myTreeView->selectionModel()->clearSelection();
470 //Empty feature pointer means that selected root document
471 foreach(QAction* aCmd, actions()) {
472 aCmd->setEnabled(true);
474 QContextMenuEvent aEvent(QContextMenuEvent::Mouse, thePnt, myActiveDocLbl->mapToGlobal(thePnt));
475 emit contextMenuRequested(&aEvent);
478 //***************************************************
479 void XGUI_ObjectsBrowser::onEditItem()
481 QObjectPtrList aSelectedData = selectedObjects();
482 if (aSelectedData.size() > 0) {
483 ObjectPtr anObject = aSelectedData.first();
484 if (anObject.get()) { // Selection happens in TreeView
485 // check whether the object can be renamed. There should not be parts which are not loaded
486 std::set<FeaturePtr> aFeatures;
487 aFeatures.insert(ModelAPI_Feature::feature(anObject));
488 if (!XGUI_Tools::canRemoveOrRename((QWidget*)parent(), aFeatures))
491 // Find index which corresponds the feature
493 foreach(QModelIndex aIdx, selectedIndexes()) {
494 if (aIdx.column() == 1) {
495 ObjectPtr aFea = dataModel()->object(aIdx);
496 if (dataModel()->object(aIdx)->isSame(anObject)) {
502 if (aIndex.isValid()) {
503 myTreeView->setCurrentIndex(aIndex);
504 myTreeView->edit(aIndex);
511 //***************************************************
512 QModelIndexList XGUI_ObjectsBrowser::expandedItems(const QModelIndex& theParent) const
514 QModelIndexList aIndexes;
516 for (int i = 0; i < myDocModel->rowCount(theParent); i++) {
517 aIndex = myDocModel->index(i, 0, theParent);
518 if (myDocModel->hasChildren(aIndex)) {
519 if (myTreeView->isExpanded(aIndex)) {
520 aIndexes.append(aIndex);
521 QModelIndexList aSubIndexes = expandedItems(aIndex);
522 if (!aSubIndexes.isEmpty())
523 aIndexes.append(aSubIndexes);
530 //***************************************************
531 void XGUI_ObjectsBrowser::rebuildDataTree()
533 myDocModel->root()->update();
534 myDocModel->rebuildDataTree();
538 //***************************************************
539 void XGUI_ObjectsBrowser::setObjectsSelected(const QObjectPtrList& theObjects)
541 QItemSelectionModel* aSelectModel = myTreeView->selectionModel();
542 QModelIndexList aIndexes = aSelectModel->selectedIndexes();
543 if (theObjects.size() == 0) {
544 bool aIsBlock = aSelectModel->blockSignals(true);
545 aSelectModel->clear();
546 aSelectModel->blockSignals(aIsBlock);
547 foreach(QModelIndex aIdx, aIndexes) {
548 myTreeView->update(aIdx);
554 QModelIndexList aUnselect;
555 QObjectPtrList aToSelect = theObjects;
556 QHash<qint64, ObjectPtr> aNotChanged;
557 foreach(QModelIndex aIdx, aIndexes) {
558 aObject = myDocModel->object(aIdx);
560 if (aToSelect.contains(aObject)) {
561 aNotChanged.insert((qint64)aObject.get(), aObject);
563 aUnselect.append(aIdx);
567 aUnselect.append(aIdx);
571 foreach(ObjectPtr aObj, aNotChanged)
572 aToSelect.removeAll(aObj);
574 bool aIsBlock = aSelectModel->blockSignals(true);
575 foreach(QModelIndex aIdx, aUnselect) {
576 aSelectModel->select(aIdx, QItemSelectionModel::Deselect);
577 myTreeView->update(aIdx);
580 QModelIndex aIndex0, aIndex1, aIndex2, aCurrent;
581 foreach(ObjectPtr aFeature, aToSelect) {
582 aIndex1 = myDocModel->objectIndex(aFeature, 1);
583 if (aIndex1.isValid()) {
584 if (!aCurrent.isValid())
586 aIndex0 = myDocModel->objectIndex(aFeature, 0);
587 aIndex2 = myDocModel->objectIndex(aFeature, 2);
588 aSelectModel->select(aIndex1, QItemSelectionModel::Select | QItemSelectionModel::Rows);
589 myTreeView->update(aIndex0);
590 myTreeView->update(aIndex1);
591 myTreeView->update(aIndex2);
594 aSelectModel->setCurrentIndex(aCurrent, QItemSelectionModel::NoUpdate);
595 aSelectModel->blockSignals(aIsBlock);
598 //***************************************************
599 void XGUI_ObjectsBrowser::ensureVisible(const ObjectPtr theObject)
601 QModelIndex aIndex = myDocModel->objectIndex(theObject);
602 if (aIndex.isValid()) {
603 QModelIndex aParent = aIndex.parent();
604 while (aParent.isValid()) {
605 myTreeView->expand(aParent);
606 aParent = aParent.parent();
608 myTreeView->scrollTo(aIndex);
612 //***************************************************
613 void XGUI_ObjectsBrowser::clearContent()
618 //***************************************************
619 void XGUI_ObjectsBrowser::onSelectionChanged(const QItemSelection& theSelected,
620 const QItemSelection& theDeselected)
622 onSelectionChanged();
625 //***************************************************
626 void XGUI_ObjectsBrowser::onSelectionChanged()
628 emit selectionChanged();
631 //***************************************************
632 QObjectPtrList XGUI_ObjectsBrowser::selectedObjects(QModelIndexList* theIndexes) const
634 QObjectPtrList aList;
635 QModelIndexList aIndexes = selectedIndexes();
636 XGUI_DataModel* aModel = dataModel();
638 foreach(QModelIndex aIdx, aIndexes) {
639 if (aIdx.column() == 1) {
640 ObjectPtr aObject = aModel->object(aIdx);
642 aList.append(aObject);
644 theIndexes->append(aIdx);
651 void XGUI_ObjectsBrowser::onBeforeReset()
653 myExpandedItems = expandedItems();
656 void XGUI_ObjectsBrowser::onAfterModelReset()
658 foreach(QModelIndex aIndex, myExpandedItems) {
659 if (myTreeView->dataModel()->hasIndex(aIndex))
660 myTreeView->setExpanded(aIndex, true);
664 std::list<bool> XGUI_ObjectsBrowser::getStateForDoc(DocumentPtr theDoc) const
666 std::list<bool> aStates;
667 XGUI_DataModel* aModel = dataModel();
668 QModelIndex aRootIdx = aModel->documentRootIndex(theDoc);
669 int aNbChild = aModel->rowCount(aRootIdx);
670 for (int i = 0; i < aNbChild; i++) {
671 QModelIndex aIdx = aModel->index(i, 0, aRootIdx);
672 aStates.push_back(myTreeView->isExpanded(aIdx));
677 void XGUI_ObjectsBrowser::setStateForDoc(DocumentPtr theDoc, const std::list<bool>& theStates)
679 if (theStates.size() == 0)
681 XGUI_DataModel* aModel = dataModel();
682 QModelIndex aRootIdx = aModel->documentRootIndex(theDoc);
683 int aNbChild = aModel->rowCount(aRootIdx);
685 std::list<bool>::const_iterator aIt;
687 for (aIt = theStates.cbegin(); aIt != theStates.cend(); aIt++, i++) {
690 QModelIndex aIdx = aModel->index(i, 0, aRootIdx);
691 myTreeView->setExpanded(aIdx, (*aIt));
695 void XGUI_ObjectsBrowser::updateAllIndexes(int theColumn, const QModelIndex& theParent)
697 int aNb = myDocModel->rowCount(theParent);
698 for (int i = 0; i < aNb; i++) {
699 QModelIndex aIdx = myDocModel->index(i, theColumn, theParent);
700 if (aIdx.isValid() && myDocModel->hasIndex(aIdx)) {
701 myTreeView->update(aIdx);
702 if (myTreeView->isExpanded(aIdx))
703 updateAllIndexes(theColumn, aIdx);
708 QMap<ObjectPtr, bool> XGUI_ObjectsBrowser::getFoldersState(DocumentPtr theDoc) const
710 QMap<ObjectPtr, bool> aMap;
712 int aNb = theDoc->size(ModelAPI_Folder::group());
714 for (int i = 0; i < aNb; i++) {
715 aObj = theDoc->object(ModelAPI_Folder::group(), i);
716 QModelIndex aIdx = myDocModel->objectIndex(aObj, 0);
717 aMap[aObj] = myTreeView->isExpanded(aIdx);
722 void XGUI_ObjectsBrowser::setFoldersState(const QMap<ObjectPtr, bool>& theStates)
724 QMap<ObjectPtr, bool>::const_iterator aIt;
725 for (aIt = theStates.constBegin(); aIt != theStates.constEnd(); aIt++) {
726 QModelIndex aIdx = myDocModel->objectIndex(aIt.key(), 0);
727 myTreeView->setExpanded(aIdx, aIt.value());