Salome HOME
Command New Document provided
[modules/shaper.git] / src / XGUI / XGUI_ObjectsBrowser.h
index dff46d5aeb5ae6a7948adcf2842321041b8bb6b5..0d1043c0f3f3734b3cee40abb3165529f24fdf61 100644 (file)
@@ -8,27 +8,37 @@
 
 class XGUI_DocumentDataModel;
 
-class XGUI_ObjectsBrowser : public QTreeView
+/**\class XGUI_ObjectsBrowser
+ * \ingroup GUI
+ * \brief Object browser window object. Represents data tree of current data structure
+ */
+ class XGUI_ObjectsBrowser : public QTreeView
 {
   Q_OBJECT
 public:
   XGUI_ObjectsBrowser(QWidget* theParent);
   virtual ~XGUI_ObjectsBrowser();
 
+  //! Returns Model which provides access to data objects
   XGUI_DocumentDataModel* dataModel() const { return myDocModel; }
 
+  //! Returns list of currently selected features
   QFeatureList selectedData() const { return mySelectedData; }
 
 signals:
+  //! Emited when selection is changed
   void selectionChanged();
 
 
 private slots:
+  //! Called when selection in Data Tree is changed
   void onSelectionChanged(const QItemSelection& theSelected, const QItemSelection& theDeselected);
 
 private:
+  //! Internal model
   XGUI_DocumentDataModel* myDocModel;
 
+  //! List of currently selected data
   QFeatureList mySelectedData;
 };