Salome HOME
Sources formated according to the codeing standards
[modules/shaper.git] / src / ModuleBase / ModuleBase_OperationDescription.h
index 79a7301109a410d96fe4b4833591e3091bcc0584..fdcd0b3fb57c239d65348f7a54542408ac20452a 100644 (file)
@@ -1,80 +1,80 @@
-/*
- * ModuleBase_OperationDescription.h
- *
- *  Created on: Apr 2, 2014
- *      Author: sbh
- */
-
-#ifndef MODULEBASE_OPERATIONDESCRIPTION_H
-#define MODULEBASE_OPERATIONDESCRIPTION_H
-
-#include <ModuleBase.h>
-#include <ModuleBase_Operation.h>
-
-#include <QObject>
-#include <QString>
-#include <QList>
-
-#include <memory>
-
-//class ModuleBase_ModelWidget;
-
-/*!
- * \class ModuleBase_OperationDescription
- *
- */
-class MODULEBASE_EXPORT ModuleBase_OperationDescription
-{
-public:
-  /// Constructor
-  /// \param theId - the operation identifier
-  ModuleBase_OperationDescription(const QString& theId = "");
-  /// Destructor
-  virtual ~ModuleBase_OperationDescription();
-
-  /// Unique name of the operation
-  /// \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;
-
-  /// Sets a short description of operation (will be
-  /// 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
-  const QString& xmlRepresentation() const;
-
-  /// Sets XML representation of the operation's widget.
-  /// \param theXMLRepresentation - XML QString
-  void setXmlRepresentation(const QString& theXMLRepresentation);
-
-  /// Returns true if there are no model widgets
-  /// \return the boolean value
-  bool hasXmlRepresentation() const;
-
-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
-};
-
-#endif //ModuleBase_OperationDescription_H
+/*\r
+ * ModuleBase_OperationDescription.h\r
+ *\r
+ *  Created on: Apr 2, 2014\r
+ *      Author: sbh\r
+ */\r
+\r
+#ifndef MODULEBASE_OPERATIONDESCRIPTION_H\r
+#define MODULEBASE_OPERATIONDESCRIPTION_H\r
+\r
+#include <ModuleBase.h>\r
+#include <ModuleBase_Operation.h>\r
+\r
+#include <QObject>\r
+#include <QString>\r
+#include <QList>\r
+\r
+#include <memory>\r
+\r
+//class ModuleBase_ModelWidget;\r
+\r
+/*!\r
+ * \class ModuleBase_OperationDescription\r
+ *\r
+ */\r
+class MODULEBASE_EXPORT ModuleBase_OperationDescription\r
+{\r
+ public:\r
+  /// Constructor\r
+  /// \param theId - the operation identifier\r
+  ModuleBase_OperationDescription(const QString& theId = "");\r
+  /// Destructor\r
+  virtual ~ModuleBase_OperationDescription();\r
+\r
+  /// Unique name of the operation\r
+  /// \return string name of the operation.\r
+  const QString& operationId() const;\r
+\r
+  /// Returns XML representation of the operation's widget.\r
+  /// \return XML QString\r
+  //const QString& xmlRepresentation() const;\r
+\r
+  /// Returns a short description of operation (will be\r
+  /// inserted in title of property panel)\r
+  const QString& description() const;\r
+\r
+  /// Sets a short description of operation (will be\r
+  /// inserted in title of property panel)\r
+  void setDescription(const QString& theDescription);\r
+\r
+  /// Sets a list of model widgets, according to the operation feature xml definition\r
+  /// \param theWidgets a list of widgets\r
+  //void setModelWidgets(const std::string& theXmlRepresentation,\r
+  //                     const QList<ModuleBase_ModelWidget*>& theWidgets);\r
+\r
+  /// Sets a list of model widgets, according to the operation feature xml definition\r
+  /// \param theWidgets a list of widgets\r
+  //const QList<ModuleBase_ModelWidget*>& modelWidgets() const;\r
+\r
+  /// Returns XML representation of the operation's widget.\r
+  /// \return XML QString\r
+  const QString& xmlRepresentation() const;\r
+\r
+  /// Sets XML representation of the operation's widget.\r
+  /// \param theXMLRepresentation - XML QString\r
+  void setXmlRepresentation(const QString& theXMLRepresentation);\r
+\r
+  /// Returns true if there are no model widgets\r
+  /// \return the boolean value\r
+  bool hasXmlRepresentation() const;\r
+\r
+ private:\r
+  //!< Next fields could be extracted into a subclass;\r
+  QString myOperationId;  /// the operation identifier\r
+  QString myDescription;  /// the short description of the opertaion\r
+  QString myXmlRepresentation;  /// the xml definition\r
+  //QList<ModuleBase_ModelWidget*> myWidgets; /// the list of operation widgets\r
+};\r
+\r
+#endif //ModuleBase_OperationDescription_H\r
\ No newline at end of file