X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModuleBase%2FModuleBase_PagedContainer.h;h=b98055fc9dcb640713822ed18b6097cc5041b809;hb=8cd56d486b6e96b8814002f9f0f4acadd6cea11b;hp=b31f0c5709e5374132215bfb68c66789cd55ee71;hpb=41695176c748943485f8844fea6e89cef9a0b6f5;p=modules%2Fshaper.git

diff --git a/src/ModuleBase/ModuleBase_PagedContainer.h b/src/ModuleBase/ModuleBase_PagedContainer.h
index b31f0c570..b98055fc9 100644
--- a/src/ModuleBase/ModuleBase_PagedContainer.h
+++ b/src/ModuleBase/ModuleBase_PagedContainer.h
@@ -13,34 +13,62 @@
 
 class ModuleBase_PageBase;
 
+/**
+* \ingroup GUI
+* This is an abstract interface to be used for not model container widget such as switch or tool box.
+*/
 class MODULEBASE_EXPORT ModuleBase_PagedContainer : public ModuleBase_ModelWidget
 {
   Q_OBJECT
  public:
+   /// A constructor
+   /// \param theParent a parent widget
+   /// \param theData a data of the widget
+   /// \param theParentId an Id of the parent object
   ModuleBase_PagedContainer(QWidget* theParent, const Config_WidgetAPI* theData,
                            const std::string& theParentId);
   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 QIcon& theIcon );
+                       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();
+
+  /// Redefinition of virtual function
   virtual bool storeValueCustom() const;
+
+  /// Redefinition of virtual function
   virtual bool restoreValueCustom();
 
  protected slots:
+   /// A slot called on page change
   void onPageChanged();
 
  private: