Merge branch 'Dev_0.7.1' of newgeom:newgeom into Dev_0.7.1

[modules/shaper.git] / src / ModuleBase / ModuleBase_WidgetSwitch.h

diff --git a/src/ModuleBase/ModuleBase_WidgetSwitch.h b/src/ModuleBase/ModuleBase_WidgetSwitch.h
index 08ce3bc711721e9fd37f55681b1f99066b5f2780..f105bc6fda25ba4c75eb4220ecc5f581f445c5bc 100644 (file)
--- a/src/ModuleBase/ModuleBase_WidgetSwitch.h
+++ b/src/ModuleBase/ModuleBase_WidgetSwitch.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 /*
  * ModuleBase_WidgetSwitch.h
  *
@@ -14,39 +16,95 @@
 class QComboBox;
 class QVBoxLayout;
 
-class MODULEBASE_EXPORT ModuleBase_WidgetSwitch: public QFrame
+/**
+* \ingroup GUI
+* Implements a model widget for swithch as a container widget. It can be defined in XML with "switch" keyword
+*/
+class MODULEBASE_EXPORT ModuleBase_WidgetSwitch : public QFrame
 {
-  Q_OBJECT
-public:
+Q_OBJECT
+ public:
+   /// Constructor
+   /// \param parent a parent widget
   ModuleBase_WidgetSwitch(QWidget* parent = NULL);
   virtual ~ModuleBase_WidgetSwitch();
 
+  /// Add a page to the widget
+  /// \param theWidget a page widget
+  /// \param theName a name of page
   int addPage(QWidget * theWidget, const QString & theName);
+
+  /// Returns count of pages
   int count() const;
+
+  /// Returns index of current page
   int currentIndex() const;
+
+  /// Returns current widget (page)
   QWidget * currentWidget() const;
+
+  /// Returns index of widget (page)
+  /// \param theWidget a widget page
   int indexOf(QWidget * theWidget) const;
+
+  /// Insert page
+  /// \param index an index (position) to insert 
+  /// \param theWidget a page widget
+  /// \param theName a name of the page
   int insertPage(int index, QWidget * theWidget, const QString & theName);
+
+  /// Returns True if a page by given index is enabled
+  /// \param index index of the page
   bool isPageEnabled(int index) const;
+
+  /// Returns text of the page by its id
+  /// \param index index of the page
   QString pageText(int index) const;
+
+  /// Returns tooltip of the page by its id
+  /// \param index index of the page
   QString pageToolTip(int index) const;
+
+  /// Remove page by its id
+  /// \param index index of the page
   void removePage(int index);
+
+  /// Enale/disable a page by its Id
+  /// \param index index of the page
+  /// \param enabled an enable flag
   void setPageEnabled(int index, bool enabled);
+
+  /// Set page name
+  /// \param index index of the page
+  /// \param text a name of the page
   void setPageName(int index, const QString & text);
+
+  /// Set page tooltip
+  /// \param index index of the page
+  /// \param toolTip a tooltip of the page
   void setPageToolTip(int index, const QString & toolTip);
 
-public slots:
+ public slots:
+   /// Set current page by index
+  /// \param index index of the page
   void setCurrentIndex(int index);
 
 signals:
+  /// Emitted on current page change
   void currentPageChanged(int);
 
-protected:
+ protected:
+  /// Update widget
   void refresh();
 
-private:
+ private:
+   /// Layout
   QVBoxLayout* myMainLay;
+
+  /// Combo box
   QComboBox* myCombo;
+
+  /// List of pages
   QWidgetList myCases;
 };