X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModuleBase%2FModuleBase_OperationDescription.h;h=7de7c3288dac0b3e69684bdd98ba6d3702df7b49;hb=f96e7958a6b68c45e722aea764ecc075d0797233;hp=56b37c28eec66a01ceae2117a82bcc3e24a44f44;hpb=ef523c1c20fecaf086c9f9fe712750ae8e180ec0;p=modules%2Fshaper.git diff --git a/src/ModuleBase/ModuleBase_OperationDescription.h b/src/ModuleBase/ModuleBase_OperationDescription.h index 56b37c28e..7de7c3288 100644 --- a/src/ModuleBase/ModuleBase_OperationDescription.h +++ b/src/ModuleBase/ModuleBase_OperationDescription.h @@ -1,59 +1,74 @@ -/* - * ModuleBase_OperationDescription.h - * - * Created on: Apr 2, 2014 - * Author: sbh - */ - -#ifndef MODULEBASE_OPERATIONDESCRIPTION_H -#define MODULEBASE_OPERATIONDESCRIPTION_H - -#include -#include - -#include -#include - -#include - -/*! - * \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; - - /// Sets XML representation of the operation's widget. - /// \param xmlRepr - XML QString - void setXmlRepresentation(const QString& xmlRepr); - - /// 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); - -private: - //!< Next fields could be extracted into a subclass; - QString myOperationId; /// the operation identifier - QString myXmlRepr; /// the XML representation of the operation's widget - QString myDescription; /// the short description of the opertaion -}; - -#endif //ModuleBase_OperationDescription_H +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D + +/* + * ModuleBase_OperationDescription.h + * + * Created on: Apr 2, 2014 + * Author: sbh + */ + +#ifndef MODULEBASE_OPERATIONDESCRIPTION_H +#define MODULEBASE_OPERATIONDESCRIPTION_H + +#include +#include + +#include +#include +#include + +#include + +//class ModuleBase_ModelWidget; + +/*! + * \class ModuleBase_OperationDescription + * \ingroup GUI + * Description of operation from XML + */ +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 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); + + /// 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; + /// the operation identifier + QString myOperationId; + + /// the short description of the opertaion + QString myDescription; + + /// the xml definition + QString myXmlRepresentation; +}; + +#endif //ModuleBase_OperationDescription_H