X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_ResultField.h;h=4e2be6a4090e102188bdd8b1e88978c490ba3b37;hb=bb4d0036dd0785056ab21fc237ec7fcc0870ae5f;hp=65888b55592cbbe7a0b1caad9eb80cb7edc91349;hpb=266f5a5c2132719049c303265adee362d0e702b4;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_ResultField.h b/src/ModelAPI/ModelAPI_ResultField.h index 65888b555..4e2be6a40 100644 --- a/src/ModelAPI/ModelAPI_ResultField.h +++ b/src/ModelAPI/ModelAPI_ResultField.h @@ -1,8 +1,21 @@ -// Copyright (C) 2014-20xx CEA/DEN, EDF R&D - -// File: ModelAPI_ResultField.hxx -// Created: 16 Nov 2016 -// Author: Mikhail PONIKAROV +// Copyright (C) 2014-2019 CEA/DEN, EDF R&D +// +// 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 ModelAPI_ResultField_H_ #define ModelAPI_ResultField_H_ @@ -21,6 +34,51 @@ class ModelAPI_ResultField : public ModelAPI_Result { public: + + class ModelAPI_FieldStep : public ModelAPI_Object + { + public: + virtual ModelAPI_ResultField* field() const = 0; + + virtual int id() const = 0; + + /// Returns the group identifier of this result + inline static std::string group() + { + static std::string MY_GROUP = "FieldRersultStep"; + return MY_GROUP; + } + + /// Returns the group identifier of this object + virtual std::string groupName() { return group(); } + + /// Request for initialization of data model of the object: adding all attributes + virtual void initAttributes() {} + + /// Returns the feature is disabled or not. + virtual bool isDisabled() { return false; } + + /// Returns true if object must be displayed in the viewer: flag is stored in the + /// data model, so on undo/redo, open/save or recreation of object by history-playing it keeps + /// the original state in the current transaction. + virtual bool isDisplayed() { return myIsDisplayed; } + + /// Sets the displayed/hidden state of the object. If it is changed, sends the "redisplay" + /// signal. + MODELAPI_EXPORT virtual void setDisplayed(const bool theDisplay); + + /// Returns a GUI name of this step + MODELAPI_EXPORT virtual std::string name() = 0; + + protected: + /// This method is called just after creation of the object: it must initialize + /// all fields, normally initialized in the constructor + MODELAPI_EXPORT virtual void init() {} + + private: + bool myIsDisplayed; + }; + MODELAPI_EXPORT virtual ~ModelAPI_ResultField(); /// Returns the group identifier of this result MODELAPI_EXPORT virtual std::string groupName(); @@ -39,9 +97,27 @@ public: return RESULT_GROUP_COLOR; } + /// Returns number of steps + virtual int stepsSize() const = 0; + + /// Returns a text line by its number + /// \param theLine a number of line + virtual std::string textLine(int theLine) const = 0; + + /// Returns step object + /// \param theId an id of the object + virtual std::shared_ptr step(int theId) const = 0; + + /// Sets the displayed/hidden state of the object. If it is changed, sends the "redisplay" + /// signal. + MODELAPI_EXPORT virtual void setDisplayed(const bool theDisplay); + + /// To refresh the steps of a field + MODELAPI_EXPORT virtual void updateSteps() = 0; }; //! Pointer on feature object typedef std::shared_ptr ResultFieldPtr; +typedef std::shared_ptr FieldStepPtr; #endif