X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FXGUI%2FXGUI_ObjectsBrowser.h;h=93cc131be4f458eb27428306fca6400e2696549f;hb=4b713fff3138a7cea908a85b58ed90cf99cfacd1;hp=05a539566d5a8bdd438314ae52c8a61a8f94b4bc;hpb=3985b767e74385e51d1b503d2c97d3bb1e3f6faa;p=modules%2Fshaper.git

diff --git a/src/XGUI/XGUI_ObjectsBrowser.h b/src/XGUI/XGUI_ObjectsBrowser.h
index 05a539566..93cc131be 100644
--- a/src/XGUI/XGUI_ObjectsBrowser.h
+++ b/src/XGUI/XGUI_ObjectsBrowser.h
@@ -1,3 +1,4 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
 
 #ifndef XGUI_ObjectsBrowser_H
 #define XGUI_ObjectsBrowser_H
@@ -6,6 +7,7 @@
 #include <ModuleBase_Definitions.h>
 #include <ModelAPI_Object.h>
 #include <ModelAPI_ResultPart.h>
+#include <ModelAPI_Events.h>
 
 #include <QWidget>
 #include <QTreeView>
@@ -13,98 +15,150 @@
 class XGUI_DocumentDataModel;
 class QLineEdit;
 
-
-class XGUI_DataTree: public QTreeView
+/**
+* \ingroup GUI
+* Implementation of Data Tree object for Object Browser
+*/
+class XGUI_DataTree : public QTreeView
 {
-  Q_OBJECT
-public:
+Q_OBJECT
+ public:
+   /// Constructor
+   /// \param theParent a parent widget
   XGUI_DataTree(QWidget* theParent);
   virtual ~XGUI_DataTree();
 
   //! Returns list of currently selected objects
-  QList<ObjectPtr> selectedObjects() const { return mySelectedData; }
+  QObjectPtrList selectedObjects() const
+  {
+    return mySelectedData;
+  }
 
+  /// Returns current data model
   XGUI_DocumentDataModel* dataModel() const;
 
 signals:
   //! Emited when selection is changed
   void selectionChanged();
-  void activePartChanged(ObjectPtr thePart); 
- 
+
+  //! Emited when active part changed
+  void activePartChanged(ObjectPtr thePart);
+
   //! Emited on context menu request
   void contextMenuRequested(QContextMenuEvent* theEvent);
 
-protected slots:
+public slots:
+  /// Clear content of data tree
+  virtual void clear();
+
+ protected slots:
+   /// Commit modified data (used for renaming of objects)
   virtual void commitData(QWidget* theEditor);
 
-protected:
+ protected:
+   /// Redefinition of virtual method
   virtual void mouseDoubleClickEvent(QMouseEvent* theEvent);
+
+   /// Redefinition of virtual method
   virtual void contextMenuEvent(QContextMenuEvent* theEvent);
 
-private slots:
+ private slots:
   //! Called when selection in Data Tree is changed
   void onSelectionChanged(const QItemSelection& theSelected, const QItemSelection& theDeselected);
 
-private:
+ private:
   //! List of currently selected data
-  QList<ObjectPtr> mySelectedData;
+  QObjectPtrList mySelectedData;
 };
 
-
 /**\class XGUI_ObjectsBrowser
  * \ingroup GUI
  * \brief Object browser window object. Represents data tree of current data structure
  */
- class XGUI_EXPORT XGUI_ObjectsBrowser : public QWidget
+class XGUI_EXPORT XGUI_ObjectsBrowser : public QWidget
 {
-  Q_OBJECT
-public:
+Q_OBJECT
+ public:
+   /// Constructor
+   /// \param theParent a parent widget
   XGUI_ObjectsBrowser(QWidget* theParent);
   virtual ~XGUI_ObjectsBrowser();
 
   //! Returns Model which provides access to data objects
-  XGUI_DocumentDataModel* dataModel() const { return myDocModel; }
+  XGUI_DocumentDataModel* dataModel() const
+  {
+    return myDocModel;
+  }
 
   //! Returns list of currently selected objects
-  QList<ObjectPtr> selectedObjects() const { return myObjectsList; }
+  QObjectPtrList selectedObjects() const
+  {
+    return myObjectsList;
+  }
 
-  void setObjectsSelected(const QList<ObjectPtr>& theObjects);
+  /// Set selected list of objects
+  /// \param theObjects list of objects to select
+  void setObjectsSelected(const QObjectPtrList& theObjects);
 
   //! Returns currently selected indexes
-  QModelIndexList selectedIndexes() const { return myTreeView->selectionModel()->selectedIndexes(); }
+  QModelIndexList selectedIndexes() const
+  {
+    return myTreeView->selectionModel()->selectedIndexes();
+  }
 
   //! Returns TreeView widget
-  XGUI_DataTree* treeView() const { return myTreeView; }
+  XGUI_DataTree* treeView() const
+  {
+    return myTreeView;
+  }
 
   //! Activates currently selected part. Signal activePartChanged will not be sent
   void activatePart(const ResultPartPtr& thePart);
 
+  /// Rebuild data tree
   void rebuildDataTree();
 
+  /// Process application event
+  /// \param theMessage an event message
+  void processEvent(const std::shared_ptr<Events_Message>& theMessage);
+
+  /// Resets the object browser into initial state
+  void clearContent();
+
 signals:
   //! Emited when selection is changed
   void selectionChanged();
 
   //! Emited when current active document is changed
-  void activePartChanged(ObjectPtr thePart); 
- 
+  void activePartChanged(ObjectPtr thePart);
+
   //! Emited on context menu request
   void contextMenuRequested(QContextMenuEvent* theEvent);
 
-protected:
+ protected:
+   /// Redefinition of virtual method
   virtual bool eventFilter(QObject* obj, QEvent* theEvent);
 
-private slots:
+ private slots:
+   /// Activate part
+   /// \param thePart a part to activate
   void onActivePartChanged(ObjectPtr thePart);
+
+  /// Show context menu
+  /// \param theEvent a context menu event
   void onContextMenuRequested(QContextMenuEvent* theEvent);
+
+  /// Show context menu on upper label
+  /// \param thePnt a position of context menu
   void onLabelContextMenuRequested(const QPoint& thePnt);
 
   //! Called on Edit command request
   void onEditItem();
 
+  /// Process selection changed event
   void onSelectionChanged();
 
-private:
+ private:
   void closeDocNameEditing(bool toSave);
 
   //! Internal model
@@ -113,7 +167,7 @@ private:
   QLineEdit* myActiveDocLbl;
   XGUI_DataTree* myTreeView;
 
-  QList<ObjectPtr> myObjectsList;
+  QObjectPtrList myObjectsList;
 };
 
-#endif
\ No newline at end of file
+#endif