1 // Copyright (C) 2014-2017 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
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #ifndef XGUI_ObjectsBrowser_H
22 #define XGUI_ObjectsBrowser_H
25 #include <ModuleBase_Definitions.h>
26 #include <ModelAPI_Object.h>
27 #include <ModelAPI_ResultPart.h>
28 #include <ModelAPI_Events.h>
29 #include <ModelAPI_Folder.h>
36 class ModuleBase_IDocumentDataModel;
38 class Config_DataModelReader;
41 //#define DEBUG_INDXES
45 * Implementation of root label in Object Browser
47 class XGUI_ActiveDocLbl: public QLabel
52 /// \param theText a text
53 /// \param theParent a parent widget
54 XGUI_ActiveDocLbl(const QString& theText, QWidget* theParent );
57 /// \param theView a view
58 void setTreeView(QTreeView* theView);
61 QTreeView* treePalette() const { return myTreeView;}
63 #if (!defined HAVE_SALOME) && (defined WIN32)
64 virtual bool event(QEvent* theEvent);
73 virtual void mouseReleaseEvent( QMouseEvent* e);
76 bool eventFilter(QObject* theObj, QEvent* theEvent);
79 QString myPreSelectionStyle;
80 QString myNeutralStyle;
81 QString mySelectionStyle;
83 QTreeView* myTreeView;
90 * Implementation of Data Tree object for Object Browser
92 class XGUI_DataTree : public QTreeView
97 /// \param theParent a parent widget
98 XGUI_DataTree(QWidget* theParent);
100 virtual ~XGUI_DataTree();
102 /// Returns current data model
103 XGUI_DataModel* dataModel() const;
106 //! Emited on context menu request
107 void contextMenuRequested(QContextMenuEvent* theEvent);
110 /// Clear content of data tree
111 virtual void clear();
114 /// Commit modified data (used for renaming of objects)
115 virtual void commitData(QWidget* theEditor);
117 /// A slot which is called on mouse double click
118 void onDoubleClick(const QModelIndex&);
121 /// Redefinition of virtual method
122 virtual void contextMenuEvent(QContextMenuEvent* theEvent);
124 /// Redefinition of virtual method
125 virtual void resizeEvent(QResizeEvent* theEvent);
127 /// Redefinition of virtual method
128 virtual void mouseReleaseEvent(QMouseEvent* theEvent);
131 virtual void mousePressEvent(QMouseEvent* theEvent);
135 /// Process a history change request
136 /// \param theIndex a clicked data index
137 void processHistoryChange(const QModelIndex& theIndex);
139 /// Process a visibility change request
140 /// \param theIndex a clicked data index
141 void processEyeClick(const QModelIndex& theIndex);
144 /**\class XGUI_ObjectsBrowser
146 * \brief Object browser window object. Represents data tree of current data structure
148 class XGUI_EXPORT XGUI_ObjectsBrowser : public QWidget
153 /// \param theParent a parent widget
154 XGUI_ObjectsBrowser(QWidget* theParent, XGUI_Workshop* theWorkshop);
155 virtual ~XGUI_ObjectsBrowser();
157 //! Returns Model which provides access to data objects
158 XGUI_DataModel* dataModel() const
163 //! Returns list of currently selected objects
164 //! \param theIndexes - output list of corresponded indexes (can be NULL)
165 QObjectPtrList selectedObjects(QModelIndexList* theIndexes = 0) const;
167 /// Set selected list of objects
168 /// \param theObjects list of objects to select
169 void setObjectsSelected(const QObjectPtrList& theObjects);
171 //! Scroll TreeView to make given object visible
172 //! \param theObject object to make it visible
173 void ensureVisible(const ObjectPtr theObject);
175 //! Returns currently selected indexes
176 QModelIndexList selectedIndexes() const
178 return myTreeView->selectionModel()->selectedIndexes();
181 //! Returns TreeView widget
182 XGUI_DataTree* treeView() const
187 /// Returns active doc label object
188 QLabel* activeDocLabel() const { return myActiveDocLbl; }
190 /// Rebuild data tree
191 void rebuildDataTree();
193 /// Resets the object browser into initial state
196 /// Set XML reader object for data model
197 /// \param theReader the reader object
198 void setXMLReader(Config_DataModelReader* theReader);
200 /// Returns list of folders opened state for the given document
201 /// \param theDoc the document
202 /// \return list of booleans with state expanded or not
203 std::list<bool> getStateForDoc(DocumentPtr theDoc) const;
205 /// Set folders opened state for the given document
206 /// \param theDoc the document
207 /// \param theStates list of booleans with state expanded or not
208 void setStateForDoc(DocumentPtr theDoc, const std::list<bool>& theStates);
210 /// Returns current workshop
211 XGUI_Workshop* workshop() const { return myWorkshop; }
213 void onSelectionChanged();
215 /// Updates all items of object browser
216 /// \param theColumn - column of items
217 /// \param theParent - a parent item (by default from root)
218 void updateAllIndexes(int theColumn = 0, const QModelIndex& theParent = QModelIndex());
220 QMap<ObjectPtr, bool> getFoldersState(DocumentPtr theDoc) const;
222 void setFoldersState(const QMap<ObjectPtr, bool>& theStates);
225 //! Called on Edit command request
229 //! Emited when selection is changed
230 void selectionChanged();
232 //! Emited on context menu request
233 void contextMenuRequested(QContextMenuEvent* theEvent);
235 //! Segnal is emitted when user cliks by mouse in header label of object browser
236 void headerMouseDblClicked(const QModelIndex&);
239 /// Show context menu
240 /// \param theEvent a context menu event
241 void onContextMenuRequested(QContextMenuEvent* theEvent);
243 /// Show context menu on upper label
244 /// \param thePnt a position of context menu
245 void onLabelContextMenuRequested(const QPoint& thePnt);
247 //! Called when selection in Data Tree is changed
248 void onSelectionChanged(const QItemSelection& theSelected, const QItemSelection& theDeselected);
250 void onBeforeReset();
252 void onAfterModelReset();
255 QModelIndexList expandedItems(const QModelIndex& theParent = QModelIndex()) const;
258 XGUI_DataModel* myDocModel;
259 XGUI_ActiveDocLbl* myActiveDocLbl;
260 XGUI_DataTree* myTreeView;
261 XGUI_Workshop* myWorkshop;
263 /// A field to store expanded items before model reset
264 QModelIndexList myExpandedItems;