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