Salome HOME
Define Rename as an operation
[modules/shaper.git] / src / ModuleBase / ModuleBase_WidgetSwitch.h
index 5772a3d0878dd2b03be3bf56c77cc83df163b4c8..1f278042bc650f11fd704e3f2e7de7db5f2ef2b3 100644 (file)
@@ -18,28 +18,40 @@ class QStackedLayout;
 
 /**
 * \ingroup GUI
-* Implements a model widget for swithch as a container widget. It can be defined in XML with "switch" keyword
+* Implements a model widget for switch as a container widget. It can be defined in XML with "switch" keyword
 */
 class MODULEBASE_EXPORT ModuleBase_WidgetSwitch : public ModuleBase_PagedContainer
 {
   Q_OBJECT
  public:
    /// Constructor
-   /// \param parent a parent widget
+  /// \param theParent the parent object
+  /// \param theData the widget configuration. The attribute of the model widget is obtained from
+  /// \param theParentId is Id of a parent of the current attribute
   ModuleBase_WidgetSwitch(QWidget* theParent,
                           const Config_WidgetAPI* theData,
                           const std::string& theParentId);
   virtual ~ModuleBase_WidgetSwitch();
 
+  /// Defines if it is supported to set the value in this widget
+  /// It returns false because this is an info widget
+  virtual bool canSetValue() const { return false; };
+
   /// Add a page to the widget
   /// \param theWidget a page widget
   /// \param theName a name of page
-  virtual int addPage(ModuleBase_PageBase* theWidget,
-                        const QString& theName, const QString& theCaseId);
+  /// \param theCaseId an Id of the page
+  /// \param theIcon an icon of the page
+  virtual int addPage( ModuleBase_PageBase* theWidget,
+                       const QString& theName,
+                       const QString& theCaseId,
+                       const QPixmap& theIcon );
 
  protected:
+   /// Returns index of the current page
   virtual int currentPageIndex() const;
-   /// Set current page by index
+
+  /// Set current page by index
   /// \param index index of the page
   virtual void setCurrentPageIndex(int index);