Salome HOME
Updated copyright comment
[modules/shaper.git] / src / ModuleBase / ModuleBase_OperationDescription.h
index 79a7301109a410d96fe4b4833591e3091bcc0584..724c6b936ee7225907bd6e6b36264588e0e1ebe8 100644 (file)
@@ -1,9 +1,21 @@
-/*
- * ModuleBase_OperationDescription.h
- *
- *  Created on: Apr 2, 2014
- *      Author: sbh
- */
+// Copyright (C) 2014-2024  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_OPERATIONDESCRIPTION_H
 #define MODULEBASE_OPERATIONDESCRIPTION_H
 
 /*!
  * \class ModuleBase_OperationDescription
- *
+ * \ingroup GUI
+ * Description of operation from XML
  */
 class MODULEBASE_EXPORT ModuleBase_OperationDescription
 {
-public:
+ public:
   /// Constructor
   /// \param theId - the operation identifier
   ModuleBase_OperationDescription(const QString& theId = "");
@@ -36,10 +49,6 @@ public:
   /// \return string name of the operation.
   const QString& operationId() const;
 
-  /// Returns XML representation of the operation's widget.
-  /// \return XML QString
-  //const QString& xmlRepresentation() const;
-
   /// Returns a short description of operation (will be
   /// inserted in title of property panel)
   const QString& description() const;
@@ -48,17 +57,8 @@ public:
   /// inserted in title of property panel)
   void setDescription(const QString& theDescription);
 
-  /// Sets a list of model widgets, according to the operation feature xml definition
-  /// \param theWidgets a list of widgets
-  //void setModelWidgets(const std::string& theXmlRepresentation,
-  //                     const QList<ModuleBase_ModelWidget*>& theWidgets);
-
-  /// Sets a list of model widgets, according to the operation feature xml definition
-  /// \param theWidgets a list of widgets
-  //const QList<ModuleBase_ModelWidget*>& modelWidgets() const;
-
-   /// Returns XML representation of the operation's widget.
-   /// \return XML QString
+  /// Returns XML representation of the operation's widget.
+  /// \return XML QString
   const QString& xmlRepresentation() const;
 
   /// Sets XML representation of the operation's widget.
@@ -69,12 +69,16 @@ public:
   /// \return the boolean value
   bool hasXmlRepresentation() const;
 
-private:
+ private:
   //!< Next fields could be extracted into a subclass;
-  QString myOperationId; /// the operation identifier
-  QString myDescription; /// the short description of the opertaion
-  QString myXmlRepresentation; /// the xml definition
-  //QList<ModuleBase_ModelWidget*> myWidgets; /// the list of operation widgets
+   /// the operation identifier
+  QString myOperationId;
+
+  /// the short description of the opertaion
+  QString myDescription;
+
+  /// the xml definition
+  QString myXmlRepresentation;
 };
 
 #endif //ModuleBase_OperationDescription_H