Salome HOME
Issue #1854 Recover feature control update
[modules/shaper.git] / src / ModuleBase / ModuleBase_PagedContainer.h
index 59730cd7d4e1afa822aaf3e7dac463b2522e78dc..863390897e1a7833eeed9bf71db9faf85fba6e93 100644 (file)
@@ -1,3 +1,4 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
 /*
  * ModuleBase_PagedContainer.h
  *
@@ -21,30 +22,52 @@ class MODULEBASE_EXPORT ModuleBase_PagedContainer : public ModuleBase_ModelWidge
 {
   Q_OBJECT
  public:
-  ModuleBase_PagedContainer(QWidget* theParent, const Config_WidgetAPI* theData,
-                           const std::string& theParentId);
+   /// A constructor
+   /// \param theParent a parent widget
+   /// \param theData a data of the widget
+  ModuleBase_PagedContainer(QWidget* theParent, const Config_WidgetAPI* theData);
   virtual ~ModuleBase_PagedContainer();
 
+  /// Add a new page
+  /// \param theWidget a page object
+  /// \param theName a name of the page
+  /// \param theCaseId an Id of the page
+  /// \param theIcon aqn Icon of the page
   virtual int addPage( ModuleBase_PageBase* theWidget,
                        const QString& theName,
                        const QString& theCaseId,
                        const QPixmap& theIcon );
 
-  // ModuleBase_ModelWidget
+  /// Redefinition of virtual function
   virtual QList<QWidget*> getControls() const;
+
+  /// Redefinition of virtual function
   virtual bool focusTo();
+
+  /// Redefinition of virtual function
   virtual void setHighlighted(bool isHighlighted);
+
+  /// Redefinition of virtual function
   virtual void enableFocusProcessing();
 
  protected:
+   /// Returns index of current page
   virtual int currentPageIndex() const = 0;
+
+  /// Set current page by index
   virtual void setCurrentPageIndex(int ) = 0;
-  // ModuleBase_ModelWidget
+
+  /// Redefinition of virtual function
   virtual void activateCustom();
-  virtual bool storeValueCustom() const;
+
+  /// Redefinition of virtual function
+  virtual bool storeValueCustom();
+
+  /// Redefinition of virtual function
   virtual bool restoreValueCustom();
 
  protected slots:
+   /// A slot called on page change
   void onPageChanged();
 
  private: