Salome HOME
updated copyright message
[modules/shaper.git] / src / ModuleBase / ModuleBase_PageWidget.h
index eb21a6daac9dab25ecc7ce56a3682db78bdd714a..38d1f9546a883ced591eb14c8813d49ed14dd3a2 100644 (file)
@@ -1,9 +1,21 @@
-/*
- * ModuleBase_PageWidget.h
- *
- *  Created on: Mar 4, 2015
- *      Author: sbh
- */
+// Copyright (C) 2014-2023  CEA, EDF
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
 
 #ifndef MODULEBASE_PAGEWIDGET_H_
 #define MODULEBASE_PAGEWIDGET_H_
 #include <QList>
 
 class ModuleBase_ModelWidget;
-class QGridLayout;
+class QVBoxLayout;
 
 /*!
+ * \ingroup GUI
  * Represent a property panel's list of ModuleBase_ModelWidgets.
  */
 class MODULEBASE_EXPORT ModuleBase_PageWidget : public QFrame, public ModuleBase_PageBase
 {
+  Q_OBJECT
  public:
+  /// Constructs a page that looks like a QFrame
   explicit ModuleBase_PageWidget(QWidget* theParent = 0);
+  /// Destructs the page
   virtual ~ModuleBase_PageWidget();
 
  protected:
+  /// Adds the given widget to page's layout
   virtual void placeModelWidget(ModuleBase_ModelWidget* theWidget);
-  virtual void placePageWidget(ModuleBase_PageBase* theWidget);
+  /// Adds the given page to page's layout
+  virtual void placeWidget(QWidget* theWidget);
+  /// Returns page's layout (QGridLayout)
   virtual QLayout* pageLayout();
+  /// Adds a stretch to page's layout
   virtual void addPageStretch();
 
  private:
-  QGridLayout* myMainLayout;
+  QVBoxLayout* myMainLayout; ///< page's layout
 };
 
 #endif /* MODULEBASE_PAGEWIDGET_H_ */