1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
4 * ModuleBase_OperationDescription.h
6 * Created on: Apr 2, 2014
10 #ifndef MODULEBASE_OPERATIONDESCRIPTION_H
11 #define MODULEBASE_OPERATIONDESCRIPTION_H
13 #include <ModuleBase.h>
14 #include <ModuleBase_Operation.h>
22 //class ModuleBase_ModelWidget;
25 * \class ModuleBase_OperationDescription
27 * Description of operation from XML
29 class MODULEBASE_EXPORT ModuleBase_OperationDescription
33 /// \param theId - the operation identifier
34 ModuleBase_OperationDescription(const QString& theId = "");
36 virtual ~ModuleBase_OperationDescription();
38 /// Unique name of the operation
39 /// \return string name of the operation.
40 const QString& operationId() const;
42 /// Returns a short description of operation (will be
43 /// inserted in title of property panel)
44 const QString& description() const;
46 /// Sets a short description of operation (will be
47 /// inserted in title of property panel)
48 void setDescription(const QString& theDescription);
50 /// Returns XML representation of the operation's widget.
51 /// \return XML QString
52 const QString& xmlRepresentation() const;
54 /// Sets XML representation of the operation's widget.
55 /// \param theXMLRepresentation - XML QString
56 void setXmlRepresentation(const QString& theXMLRepresentation);
58 /// Returns true if there are no model widgets
59 /// \return the boolean value
60 bool hasXmlRepresentation() const;
63 //!< Next fields could be extracted into a subclass;
64 /// the operation identifier
65 QString myOperationId;
67 /// the short description of the opertaion
68 QString myDescription;
70 /// the xml definition
71 QString myXmlRepresentation;
74 #endif //ModuleBase_OperationDescription_H