-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File: ModelAPI_Session.hxx
-// Created: 20 Mar 2014
-// Author: Mikhail PONIKAROV
+// Copyright (C) 2014-2023 CEA, EDF
+//
+// 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_Session_H_
#define ModelAPI_Session_H_
class ModelAPI_Plugin;
class ModelAPI_Document;
class ModelAPI_ValidatorsFactory;
+class ModelAPI_FiltersFactory;
/**\class ModelAPI_Session
* \ingroup DataModel
class MODELAPI_EXPORT ModelAPI_Session
{
+protected:
+ bool myIsLoading; ///< keeps the state of the loading of the document
+
public:
/// Returns the real implementation (the alone instance per application) of the plugin manager
static std::shared_ptr<ModelAPI_Session> get();
//! \returns true if file was loaded successfully
virtual bool load(const char* theFileName) = 0;
+ //! Returns true if a loading process is performed (so, no need to react on a new part creation)
+ virtual bool isLoading() { return myIsLoading; };
+
//! Saves the OCAF document to the file.
//! \param theFileName full name of the file to store
//! \param theResults the result full file names that were stored by "save"
virtual std::list<std::string> undoList() = 0;
//! Returns stack of rolled back operations (from last rolled back to first)
virtual std::list<std::string> redoList() = 0;
+ //! Clears undo and redo lists of all documents in the session
+ virtual void clearUndoRedo() = 0;
/// Registers the plugin that creates features.
/// It is obligatory for each plugin to call this function on loading to be found by
/// the plugin manager on call of the feature)
virtual void registerPlugin(ModelAPI_Plugin* thePlugin) = 0;
+ /// Verifies the license for the plugin is valid
+ virtual bool checkLicense(const std::string& thePluginName) = 0;
+
/// Returns the root document of the application (that may contains sub-documents)
virtual std::shared_ptr<ModelAPI_Document> moduleDocument() = 0;
virtual std::list<std::shared_ptr<ModelAPI_Document> > allOpenedDocuments() = 0;
/// Returns true if document is not loaded yet
- virtual bool isLoadByDemand(const std::string theDocID) = 0;
+ virtual bool isLoadByDemand(const std::wstring theDocID, const int theDocIndex) = 0;
/// Copies the document to the new one with the given id
virtual std::shared_ptr<ModelAPI_Document> copy(
/// Returns the validators factory: the only one instance per application
virtual ModelAPI_ValidatorsFactory* validators() = 0;
+ /// Returns the filters factory: the only one instance per application
+ virtual ModelAPI_FiltersFactory* filters() = 0;
+
/// To virtually destroy the fields of successors
virtual ~ModelAPI_Session()
{
/// Returns the global identifier of the current transaction (needed for the update algo)
virtual int transactionID() = 0;
- /// Load plugin by its name
- virtual void forceLoadPlugin(const std::string& thePluginName) = 0;
+ /// Returns true if auto-update in the application is blocked
+ virtual bool isAutoUpdateBlocked() = 0;
+
+ /// Set state of the auto-update of features result in the application
+ virtual void blockAutoUpdate(const bool theBlock) = 0;
protected:
/// Sets the session interface implementation (once per application launch)
